Updated readme with syntax highlighting

This commit is contained in:
Rob Gloudemans
2013-05-30 17:13:16 +02:00
parent fd7fe0a617
commit e0fc3f0145

View File

@@ -2,10 +2,12 @@
Install the package through [Composer](http://getcomposer.org/). Edit your project's `composer.json` file by adding:
"require": {
```php
"require": {
"laravel/framework": "4.0.*",
"gloudemans/shoppingcart": "dev-master"
}
}
```
Next, run the Composer update command from the Terminal:
@@ -45,20 +47,23 @@ Cart::add('293ad', 'Product 1', 1, 9.99, array('size' => 'large'));
**Cart::addBatch()**
/**
```php
/**
* Add multiple rows to the cart
*
* @param Array $items An array of items to add, use array keys corresponding to the 'add' method's parameters
*/
Cart::addBatch(array(
Cart::addBatch(array(
array('id' => '293ad', 'name' => 'Product 1', 'qty' => 1, 'price' => 10.00),
array('id' => '4832k', 'name' => 'Product 2', 'qty' => 1, 'price' => 10.00, 'options' => array('size' => 'large'))
));
));
```
**Cart::update()**
/**
```php
/**
* Update the quantity of one row of the cart
*
* @param string $rowId The rowid of the item you want to update
@@ -67,15 +72,17 @@ Cart::add('293ad', 'Product 1', 1, 9.99, array('size' => 'large'));
*/
$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';
Cart::update($rowId, 2);
Cart::update($rowId, 2);
OR
OR
Cart::update($rowId, array('name' => 'Product 1'));
Cart::update($rowId, array('name' => 'Product 1'));
```
**Cart::remove()**
/**
```php
/**
* Remove a row from the cart
*
* @param string $rowId The rowid of the item
@@ -84,54 +91,64 @@ Cart::add('293ad', 'Product 1', 1, 9.99, array('size' => 'large'));
$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';
Cart::remove($rowId);
Cart::remove($rowId);
```
**Cart::get()**
/**
```php
/**
* Get a row of the cart by its ID
*
* @param string $rowId The ID of the row to fetch
* @return CartRowCollection
*/
$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';
$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';
Cart::get($rowId);
Cart::get($rowId);
```
**Cart::content()**
/**
```php
/**
* Get the cart content
*
* @return CartCollection
*/
Cart::content();
Cart::content();
```
**Cart::destroy()**
/**
```php
/**
* Empty the cart
*
* @return boolean
*/
Cart::destroy();
Cart::destroy();
```
**Cart::total()**
/**
```php
/**
* Get the price total
*
* @return float
*/
Cart::total();
Cart::total();
```
**Cart::count()**
/**
```php
/**
* Get the number of items in the cart
*
* @param boolean $totalItems Get all the items (when false, will return the number of rows)
@@ -140,6 +157,7 @@ Cart::add('293ad', 'Product 1', 1, 9.99, array('size' => 'large'));
Cart::count(); // Total items
Cart::count(false); // Total rows
```
## Collections
@@ -156,21 +174,23 @@ If you want to switch instances, you just call `Cart::instance('otherInstance')`
So a little example:
Cart::instance('shopping')->add('192ao12', 'Product 1', 1, 9.99);
```php
Cart::instance('shopping')->add('192ao12', 'Product 1', 1, 9.99);
// Get the content of the 'shopping' cart
Cart::content();
// Get the content of the 'shopping' cart
Cart::content();
Cart::instance('wishlist')->add('sdjk922', 'Product 2', 1, 19.95, array('size' => 'medium'));
Cart::instance('wishlist')->add('sdjk922', 'Product 2', 1, 19.95, array('size' => 'medium'));
// Get the content of the 'wishlist' cart
Cart::content();
// Get the content of the 'wishlist' cart
Cart::content();
// If you want to get the content of the 'shopping' cart again...
Cart::instance('shopping')->content();
// If you want to get the content of the 'shopping' cart again...
Cart::instance('shopping')->content();
// And the count of the 'wishlist' cart again
Cart::instance('wishlist')->count();
// And the count of the 'wishlist' cart again
Cart::instance('wishlist')->count();
```
N.B. Keep in mind that the cart stays in the last set instance for as long as you don't set a different one during script execution.
@@ -180,14 +200,15 @@ N.B.2 The default cart instance is called `main`, so when you're not using insta
Below is a little example of how to list the cart content in a table:
// Controller
```php
// Controller
Cart::add('192ao12', 'Product 1', 1, 9.99);
Cart::add('1239ad0', 'Product 2', 2, 5.95, array('size' => 'large'));
Cart::add('192ao12', 'Product 1', 1, 9.99);
Cart::add('1239ad0', 'Product 2', 2, 5.95, array('size' => 'large'));
// View
// View
<table>
<table>
<thead>
<tr>
<th>Product</th>
@@ -214,4 +235,5 @@ Below is a little example of how to list the cart content in a table:
<?php endforeach;?>
</tbody>
</table>
</table>
```