PHP code example of scott-lsi / laravelshoppingbasket
1. Go to this page and download the library: Download scott-lsi/laravelshoppingbasket library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
scott-lsi / laravelshoppingbasket example snippets
// Quick Usage with the Product Model Association & User session binding
$Product = Product::find($productId); // assuming you have a Product model with id, name, description & price
$rowId = 456; // generate a unique() row ID
$userID = 2; // the user ID to bind the basket contents
// add the product to basket
\Basket::session($userID)->add(array(
'id' => $rowId,
'name' => $Product->name,
'price' => $Product->price,
'quantity' => 4,
'attributes' => array(),
'associatedModel' => $Product
));
// update the item on basket
\Basket::session($userID)->update($rowId,[
'quantity' => 2,
'price' => 98.67
]);
// delete an item on basket
\Basket::session($userID)->remove($rowId);
// view the basket items
$items = \Basket::getContent();
foreach($items as $row) {
echo $row->id; // row ID
echo $row->name;
echo $row->qty;
echo $row->price;
echo $item->associatedModel->id; // whatever properties your model have
echo $item->associatedModel->name; // whatever properties your model have
echo $item->associatedModel->description; // whatever properties your model have
}
// FOR FULL USAGE, SEE BELOW..
$userId // the current login user id
// This tells the basket that we only need or manipulate
// the basket data of a specific user. It doesn't need to be $userId,
// you can use any unique key that represents a unique to a user or customer.
// basically this binds the basket to a specific user.
\Basket::session($userId);
// then followed by the normal basket usage
\Basket::add();
\Basket::update();
\Basket::remove();
\Basket::condition($condition1);
\Basket::getTotal();
\Basket::getSubTotal();
\Basket::addItemCondition($productID, $coupon101);
// and so on..
/**
* add item to the basket, it can be an array or multi dimensional array
*
* @param string|array $id
* @param string $name
* @param float $price
* @param int $quantity
* @param array $attributes
* @param BasketCondition|array $conditions
* @return $this
* @throws InvalidItemException
*/
# ALWAYS REMEMBER TO BIND THE CART TO A USER BEFORE CALLING ANY CART FUNCTION
# SO CART WILL KNOW WHO'S CART DATA YOU WANT TO MANIPULATE. SEE IMPORTANT NOTICE ABOVE.
# EXAMPLE: \Basket::session($userId); then followed by basket normal usage.
# NOTE:
# the 'id' field in adding a new item on basket is not intended for the Model ID (example Product ID)
# instead make sure to put a unique ID for every unique product or product that has it's own unique prirce,
# because it is used for updating basket and how each item on basket are segregated during calculation and quantities.
# You can put the model_id instead as an attribute for full flexibility.
# Example is that if you want to add same products on the basket but with totally different attribute and price.
# If you use the Product's ID as the 'id' field in basket, it will result to increase in quanity instead
# of adding it as a unique product with unique attribute and price.
// Simplest form to add item on your basket
Basket::add(455, 'Sample Item', 100.99, 2, array());
// array format
Basket::add(array(
'id' => 456, // inique row ID
'name' => 'Sample Item',
'price' => 67.99,
'quantity' => 4,
'attributes' => array()
));
// add multiple items at one time
Basket::add(array(
array(
'id' => 456,
'name' => 'Sample Item 1',
'price' => 67.99,
'quantity' => 4,
'attributes' => array()
),
array(
'id' => 568,
'name' => 'Sample Item 2',
'price' => 69.25,
'quantity' => 4,
'attributes' => array(
'size' => 'L',
'color' => 'blue'
)
),
));
// add basket items to a specific user
$userId = auth()->user()->id; // or any string represents user identifier
Basket::session($userId)->add(array(
'id' => 456, // inique row ID
'name' => 'Sample Item',
'price' => 67.99,
'quantity' => 4,
'attributes' => array(),
'associatedModel' => $Product
));
// NOTE:
// Please keep in mind that when adding an item on basket, the "id" should be unique as it serves as
// row identifier as well. If you provide same ID, it will assume the operation will be an update to its quantity
// to avoid basket item duplicates
/**
* update a basket
*
* @param $id (the item ID)
* @param array $data
*
* the $data will be an associative array, you don't need to pass all the data, only the key value
* of the item you want to update on it
*/
Basket::update(456, array(
'name' => 'New Item Name', // new item name
'price' => 98.67, // new item price, price can also be a string format like so: '98.67'
));
// you may also want to update a product's quantity
Basket::update(456, array(
'quantity' => 2, // so if the current product has a quantity of 4, another 2 will be added so this will result to 6
));
// you may also want to update a product by reducing its quantity, you do this like so:
Basket::update(456, array(
'quantity' => -1, // so if the current product has a quantity of 4, it will subtract 1 and will result to 3
));
// NOTE: as you can see by default, the quantity update is relative to its current value
// if you want to just totally replace the quantity instead of incrementing or decrementing its current quantity value
// you can pass an array in quantity value like so:
Basket::update(456, array(
'quantity' => array(
'relative' => false,
'value' => 5
),
));
// so with that code above as relative is flagged as false, if the item's quantity before is 2 it will now be 5 instead of
// 5 + 2 which results to 7 if updated relatively..
// updating a basket for a specific user
$userId = auth()->user()->id; // or any string represents user identifier
Basket::session($userId)->update(456, array(
'name' => 'New Item Name', // new item name
'price' => 98.67, // new item price, price can also be a string format like so: '98.67'
));
/**
* removes an item on basket by item ID
*
* @param $id
*/
Basket::remove(456);
// removing basket item for a specific user's basket
$userId = auth()->user()->id; // or any string represents user identifier
Basket::session($userId)->remove(456);
/**
* get an item on a basket by item ID
* if item ID is not found, this will return null
*
* @param $itemId
* @return null|array
*/
$itemId = 456;
Basket::get($itemId);
// You can also get the sum of the Item multiplied by its quantity, see below:
$summedPrice = Basket::get($itemId)->getPriceSum();
// get an item on a basket by item ID for a specific user's basket
$userId = auth()->user()->id; // or any string represents user identifier
Basket::session($userId)->get($itemId);
/**
* get the basket
*
* @return BasketCollection
*/
$basketCollection = Basket::getContent();
// NOTE: Because basket collection extends Laravel's Collection
// You can use methods you already know about Laravel's Collection
// See some of its method below:
// count baskets contents
$basketCollection->count();
// transformations
$basketCollection->toArray();
$basketCollection->toJson();
// Getting basket's contents for a specific user
$userId = auth()->user()->id; // or any string represents user identifier
Basket::session($userId)->getContent($itemId);
/**
* check if basket is empty
*
* @return bool
*/
Basket::isEmpty();
// Check if basket's contents is empty for a specific user
$userId = auth()->user()->id; // or any string represents user identifier
Basket::session($userId)->isEmpty();
/**
* get total quantity of items in the basket
*
* @return int
*/
$basketTotalQuantity = Basket::getTotalQuantity();
// for a specific user
$basketTotalQuantity = Basket::session($userId)->getTotalQuantity();
/**
* get basket sub total
*
* @return float
*/
$subTotal = Basket::getSubTotal();
// for a specific user
$subTotal = Basket::session($userId)->getSubTotal();
/**
* the new total in which conditions are already applied
*
* @return float
*/
$total = Basket::getTotal();
// for a specific user
$total = Basket::session($userId)->getTotal();
// add single condition on a basket bases
$condition = new \ScottLsi\Basket\BasketCondition(array(
'name' => 'VAT 12.5%',
'type' => 'tax',
'target' => 'subtotal', // this condition will be applied to basket's subtotal when getSubTotal() is called.
'value' => '12.5%',
'attributes' => array( // attributes field is optional
'description' => 'Value added tax',
'more_data' => 'more data here'
)
));
Basket::condition($condition);
Basket::session($userId)->condition($condition); // for a speicifc user's basket
// or add multiple conditions from different condition instances
$condition1 = new \ScottLsi\Basket\BasketCondition(array(
'name' => 'VAT 12.5%',
'type' => 'tax',
'target' => 'subtotal', // this condition will be applied to basket's subtotal when getSubTotal() is called.
'value' => '12.5%',
'order' => 2
));
$condition2 = new \ScottLsi\Basket\BasketCondition(array(
'name' => 'Express Shipping $15',
'type' => 'shipping',
'target' => 'subtotal', // this condition will be applied to basket's subtotal when getSubTotal() is called.
'value' => '+15',
'order' => 1
));
Basket::condition($condition1);
Basket::condition($condition2);
// Note that after adding conditions that are targeted to be applied on subtotal, the result on getTotal()
// will also be affected as getTotal() depends in getSubTotal() which is the subtotal.
// add condition to only apply on totals, not in subtotal
$condition = new \ScottLsi\Basket\BasketCondition(array(
'name' => 'Express Shipping $15',
'type' => 'shipping',
'target' => 'total', // this condition will be applied to basket's total when getTotal() is called.
'value' => '+15',
'order' => 1 // the order of calculation of basket base conditions. The bigger the later to be applied.
));
Basket::condition($condition);
// The property 'order' lets you control the sequence of conditions when calculated. Also it lets you add different conditions through for example a shopping process with multiple
// pages and still be able to set an order to apply the conditions. If no order is defined defaults to 0
// NOTE!! On current version, 'order' parameter is only applicable for conditions for basket bases. It does not support on per item conditions.
// or add multiple conditions as array
Basket::condition([$condition1, $condition2]);
// To get all applied conditions on a basket, use below:
$basketConditions = Basket::getConditions();
foreach($basketConditions as $condition)
{
$condition->getTarget(); // the target of which the condition was applied
$condition->getName(); // the name of the condition
$condition->getType(); // the type
$condition->getValue(); // the value of the condition
$condition->getOrder(); // the order of the condition
$condition->getAttributes(); // the attributes of the condition, returns an empty [] if no attributes added
}
// You can also get a condition that has been applied on the basket by using its name, use below:
$condition = Basket::getCondition('VAT 12.5%');
$condition->getTarget(); // the target of which the condition was applied
$condition->getName(); // the name of the condition
$condition->getType(); // the type
$condition->getValue(); // the value of the condition
$condition->getAttributes(); // the attributes of the condition, returns an empty [] if no attributes added
// You can get the conditions calculated value by providing the subtotal, see below:
$subTotal = Basket::getSubTotal();
$condition = Basket::getCondition('VAT 12.5%');
$conditionCalculatedValue = $condition->getCalculatedValue($subTotal);
$basketTotal = Basket::getSubTotal(); // the subtotal with the conditions targeted to "subtotal" applied
$basketTotal = Basket::getTotal(); // the total with the conditions targeted to "total" applied
$basketTotal = Basket::session($userId)->getSubTotal(); // for a specific user's basket
$basketTotal = Basket::session($userId)->getTotal(); // for a specific user's basket
// lets create first our condition instance
$saleCondition = new \ScottLsi\Basket\BasketCondition(array(
'name' => 'SALE 5%',
'type' => 'tax',
'value' => '-5%',
));
// now the product to be added on basket
$product = array(
'id' => 456,
'name' => 'Sample Item 1',
'price' => 100,
'quantity' => 1,
'attributes' => array(),
'conditions' => $saleCondition
);
// finally add the product on the basket
Basket::add($product);
// you may also add multiple condition on an item
$itemCondition1 = new \ScottLsi\Basket\BasketCondition(array(
'name' => 'SALE 5%',
'type' => 'sale',
'value' => '-5%',
));
$itemCondition2 = new BasketCondition(array(
'name' => 'Item Gift Pack 25.00',
'type' => 'promo',
'value' => '-25',
));
$itemCondition3 = new \ScottLsi\Basket\BasketCondition(array(
'name' => 'MISC',
'type' => 'misc',
'value' => '+10',
));
$item = array(
'id' => 456,
'name' => 'Sample Item 1',
'price' => 100,
'quantity' => 1,
'attributes' => array(),
'conditions' => [$itemCondition1, $itemCondition2, $itemCondition3]
);
Basket::add($item);
// the subtotal will be calculated based on the conditions added that has target => "subtotal"
// and also conditions that are added on per item
$basketSubTotal = Basket::getSubTotal();
/**
* clears all conditions on a basket,
* this does not remove conditions that has been added specifically to an item/product.
* If you wish to remove a specific condition to a product, you may use the method: removeItemCondition($itemId,$conditionName)
*
* @return void
*/
Basket::clearBasketConditions()
/**
* removes a condition on a basket by condition name,
* this can only remove conditions that are added on basket bases not conditions that are added on an item/product.
* If you wish to remove a condition that has been added for a specific item/product, you may
* use the removeItemCondition(itemId, conditionName) method instead.
*
* @param $conditionName
* @return void
*/
$conditionName = 'Summer Sale 5%';
Basket::removeBasketCondition($conditionName)
/**
* remove a condition that has been applied on an item that is already on the basket
*
* @param $itemId
* @param $conditionName
* @return bool
*/
Basket::removeItemCondition($itemId, $conditionName)
/**
* remove all conditions that has been applied on an item that is already on the basket
*
* @param $itemId
* @return bool
*/
Basket::clearItemConditions($itemId)
/**
* Get all the condition filtered by Type
* Please Note that this will only return condition added on basket bases, not those conditions added
* specifically on an per item bases
*
* @param $type
* @return BasketConditionCollection
*/
public function getConditionsByType($type)
/**
* Remove all the condition with the $type specified
* Please Note that this will only remove condition added on basket bases, not those conditions added
* specifically on an per item bases
*
* @param $type
* @return $this
*/
public function removeConditionsByType($type)
/**
* get the sum of price
*
* @return mixed|null
*/
public function getPriceSum()
/**
* get the single price in which conditions are already applied
*
* @return mixed|null
*/
public function getPriceWithConditions()
/**
* get the sum of price in which conditions are already applied
*
* @return mixed|null
*/
public function getPriceSumWithConditions()
// add the item to the basket.
$basketItem = Basket::add(455, 'Sample Item', 100.99, 2, array())->associate('Product');
// array format
Basket::add(array(
'id' => 456,
'name' => 'Sample Item',
'price' => 67.99,
'quantity' => 4,
'attributes' => array(),
'associatedModel' => 'Product'
));
// add multiple items at one time
Basket::add(array(
array(
'id' => 456,
'name' => 'Sample Item 1',
'price' => 67.99,
'quantity' => 4,
'attributes' => array(),
'associatedModel' => 'Product'
),
array(
'id' => 568,
'name' => 'Sample Item 2',
'price' => 69.25,
'quantity' => 4,
'attributes' => array(
'size' => 'L',
'color' => 'blue'
),
'associatedModel' => 'Product'
),
));
// Now, when iterating over the content of the basket, you can access the model.
foreach(Basket::getContent() as $row) {
echo 'You have ' . $row->qty . ' items of ' . $row->model->name . ' with description: "' . $row->model->description . '" in your basket.';
}
$this->app['wishlist'] = $this->app->share(function($app)
{
$storage = $app['session']; // laravel session storage
$events = $app['events']; // laravel event handler
$instanceName = 'wishlist'; // your basket instance name
$session_key = 'AsASDMCks0ks1'; // your unique session key to hold basket items
return new Basket(
$storage,
$events,
$instanceName,
$session_key
);
});
// for 5.4 or newer
use ScottLsi\Basket\Basket;
use Illuminate\Support\ServiceProvider;
class WishListProvider extends ServiceProvider
{
/**
* Bootstrap the application services.
*
* @return void
*/
public function boot()
{
//
}
/**
* Register the application services.
*
* @return void
*/
public function register()
{
$this->app->singleton('wishlist', function($app)
{
$storage = $app['session'];
$events = $app['events'];
$instanceName = 'basket_2';
$session_key = '88uuiioo99888';
return new Basket(
$storage,
$events,
$instanceName,
$session_key,
config('shopping_basket')
);
});
}
}
// add items to basket
Basket::add(array(
array(
'id' => 456,
'name' => 'Sample Item 1',
'price' => 67.99,
'quantity' => 4,
'attributes' => array()
),
array(
'id' => 568,
'name' => 'Sample Item 2',
'price' => 69.25,
'quantity' => 4,
'attributes' => array(
'size' => 'L',
'color' => 'blue'
)
),
));
// then you can:
$items = Basket::getContent();
foreach($items as $item)
{
$item->id; // the Id of the item
$item->name; // the name
$item->price; // the single price without conditions applied
$item->getPriceSum(); // the subtotal without conditions applied
$item->getPriceWithConditions(); // the single price with conditions applied
$item->getPriceSumWithConditions(); // the subtotal with conditions applied
$item->quantity; // the quantity
$item->attributes; // the attributes
// Note that attribute returns ItemAttributeCollection object that extends the native laravel collection
// so you can do things like below:
if( $item->attributes->has('size') )
{
// item has attribute size
}
else
{
// item has no attribute size
}
}
// or
$items->each(function($item)
{
$item->id; // the Id of the item
$item->name; // the name
$item->price; // the single price without conditions applied
$item->getPriceSum(); // the subtotal without conditions applied
$item->getPriceWithConditions(); // the single price with conditions applied
$item->getPriceSumWithConditions(); // the subtotal with conditions applied
$item->quantity; // the quantity
$item->attributes; // the attributes
if( $item->attributes->has('size') )
{
// item has attribute size
}
else
{
// item has no attribute size
}
});
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
class CreateBasketStorageTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('basket_storage', function (Blueprint $table) {
$table->string('id')->index();
$table->longText('basket_data');
$table->timestamps();
$table->primary('id');
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::dropIfExists('basket_storage');
}
}
namespace App;
use Illuminate\Database\Eloquent\Model;
class DatabaseStorageModel extends Model
{
protected $table = 'basket_storage';
/**
* The attributes that are mass assignable.
*
* @var array
*/
protected $fillable = [
'id', 'basket_data',
];
public function setBasketDataAttribute($value)
{
$this->attributes['basket_data'] = serialize($value);
}
public function getBasketDataAttribute($value)
{
return unserialize($value);
}
}
class DBStorage {
public function has($key)
{
return DatabaseStorageModel::find($key);
}
public function get($key)
{
if($this->has($key))
{
return new BasketCollection(DatabaseStorageModel::find($key)->basket_data);
}
else
{
return [];
}
}
public function put($key, $value)
{
if($row = DatabaseStorageModel::find($key))
{
// update
$row->basket_data = $value;
$row->save();
}
else
{
DatabaseStorageModel::create([
'id' => $key,
'basket_data' => $value
]);
}
}
}
namespace App\Basket;
use Carbon\Carbon;
use Cookie;
use ScottLsi\Basket\BasketCollection;
class CacheStorage
{
private $data = [];
private $basket_id;
public function __construct()
{
$this->basket_id = \Cookie::get('basket');
if ($this->basket_id) {
$this->data = \Cache::get('basket_' . $this->basket_id, []);
} else {
$this->basket_id = uniqid();
}
}
public function has($key)
{
return isset($this->data[$key]);
}
public function get($key)
{
return new BasketCollection($this->data[$key] ?? []);
}
public function put($key, $value)
{
$this->data[$key] = $value;
\Cache::put('basket_' . $this->basket_id, $this->data, Carbon::now()->addDays(30));
if (!Cookie::hasQueued('basket')) {
Cookie::queue(
Cookie::make('basket', $this->basket_id, 60 * 24 * 30)
);
}
}
}
use ScottLsi\Basket\Basket;
use Illuminate\Support\ServiceProvider;
class WishListProvider extends ServiceProvider
{
/**
* Bootstrap the application services.
*
* @return void
*/
public function boot()
{
//
}
/**
* Register the application services.
*
* @return void
*/
public function register()
{
$this->app->singleton('wishlist', function($app)
{
$storage = new DBStorage(); <-- Your new custom storage
$events = $app['events'];
$instanceName = 'basket_2';
$session_key = '88uuiioo99888';
return new Basket(
$storage,
$events,
$instanceName,
$session_key,
config('shopping_basket')
);
});
}
}
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.