Laravel Cart

To make a model compatible with the cart (allowing it to be stored as an item), your model must implement the Binafy\LaravelCart\Cartable interface and define a getPrice() method.

use Binafy\LaravelCart\Cartable;

class Product extends Model implements Cartable
{
    public function getPrice(): int
    {
        // Return the price of the product
    }
}

Install the package using Composer to add shopping cart functionality to your Laravel application.

composer require binafy/laravel-cart

You can publish the configuration file, migrations, or all assets at once using Artisan commands.

To publish only the config:

php artisan vendor:publish --tag="laravel-cart-config"

To publish only the migrations:

php artisan vendor:publish --tag="laravel-cart-migrations"

To publish everything (config, migrations, etc.) at once:

php artisan vendor:publish --provider="Binafy\LaravelCart\Providers\LaravelCartServiceProvider"

Note: After publishing migrations, you must run php artisan migrate to update your database schema.

If your application uses uuid or ulid for user identifiers, update the foreign_key_type in config/laravel-cart.php. Ensure your models include the relevant traits for these ID types.

'users' => [
    ...

    /*
     * Specify the type of foreign key being used (e.g., 'id', 'uuid', 'ulid').
     * For non-standard IDs, make sure to add the relevant traits to your models.
     */
    'foreign_key_type' => 'id', // Options: uuid, ulid, id
],

To use database-backed cart features, publish the package migrations to your database/migrations directory using the laravel-cart-migrations tag.

Note: The provider handles version compatibility for Laravel 11+ automatically when using the vendor:publish command.

php artisan vendor:publish --tag=laravel-cart-migrations

To customize the package behavior, publish the configuration file to your application's config directory using the laravel-cart-config tag.

php artisan vendor:publish --tag=laravel-cart-config

The LaravelCart facade provides a convenient way to manage carts using different drivers.

Supported Drivers:

• session: Stores cart data in the session.
• database: Stores cart data in the database (Default).

To switch drivers on the fly, use the driver() method.

<?php

use Binafy\
LaravelCart\
LaravelCart;

// Using a specific driver
LaravelCart::driver('session')->storeItem($item, $userId|null);

// Using the default driver
LaravelCart::storeItem($item, $userId|null);

// Removing an item using a specific driver
LaravelCart::driver('session')->removeItem($item);

The default driver used by the cart is determined by the laravel-cart.driver.default configuration key. You can switch between available drivers by updating this value in your configuration files.

// Example configuration setting in config/laravel-cart.php
'driver' => [
    'default' => 'session', // or 'database'
],

The Cart model uses a configurable table name. By default, it uses carts. You can override this in your Laravel configuration file.

Config Key: laravel-cart.carts.table

You can hook into the following events to trigger custom business logic (e.g., logging, analytics, or notifications):