Configuration

FlexiCart provides extensive configuration options via the config/flexicart.php file.

Publishing Configuration

php artisan vendor:publish --tag="flexicart-config"

Storage Configuration

Configure how cart data is stored:

// config/flexicart.php

// Use session storage (default)
'storage' => 'session',

// Use database storage
'storage' => 'database',

// Use custom storage class
'storage_class' => App\Services\CustomCartStorage::class,

Session Key

Customize the session key when using session storage:

'session_key' => 'my_custom_cart_key',

Database Storage

When using database storage, run the migrations first:

php artisan vendor:publish --tag="flexicart-migrations"
php artisan migrate

Update your .env file:

CART_STORAGE=database

When using database storage, FlexiCart creates the following tables:

• carts: Stores cart metadata (ID, user association, timestamps)
• cart_items: Stores individual cart items and their properties

Cart Persistence

With database storage, carts are automatically persisted. You can also manually persist session-based carts:

// Manually persist cart data
Cart::persist();

// Get raw cart data for custom storage
$cartData = Cart::getRawCartData();

Multiple Carts

You can work with multiple carts by specifying cart IDs:

// Get a specific cart
$cart = Cart::getCartById('user_123_cart');

// Switch to a different cart
$guestCart = Cart::getCartById('guest_cart');

Currency and Locale

Set the default currency and locale for price formatting:

'currency' => 'USD', // ISO currency code
'locale' => 'en_US', // Locale for formatting

Custom Models

When using database storage, you can specify custom models:

'cart_model' => App\Models\CustomCart::class,
'cart_item_model' => App\Models\CustomCartItem::class,

Compound Discounts

Control how multiple discounts are calculated:

// Sequential calculation (each discount applies to the result of previous discounts)
'compound_discounts' => true,

// Parallel calculation (all discounts apply to the original price)
'compound_discounts' => false,

Example with $100 subtotal and two 10% discounts:

Cart Cleanup

Configure automatic cleanup of old carts when using database storage:

'cleanup' => [
    'enabled' => true,
    'lifetime' => 60 * 24 * 7, // 1 week in minutes
],

Running the Cleanup Command

FlexiCart provides an Artisan command to clean up old carts:

# Clean up carts older than the configured lifetime
php artisan flexicart:cleanup-carts

# Force delete ALL carts (use with caution!)
php artisan flexicart:cleanup-carts --force

Scheduling Automatic Cleanup

Add the cleanup command to your Laravel scheduler in routes/console.php:

use Illuminate\Support\Facades\Schedule;

// Run cleanup daily at midnight
Schedule::command('flexicart:cleanup-carts')->daily();

// Or run weekly on Sundays
Schedule::command('flexicart:cleanup-carts')->weekly();

Raw Cart Data

For debugging or custom integrations, you can access raw cart data:

$data = Cart::getRawCartData();

// Returns:
// [
//     'items' => Collection of CartItem objects,
//     'subtotal' => Price object,
//     'total' => Price object,
//     'count' => int,
//     'conditions' => Collection of conditions,
// ]

Events

Enable or disable cart lifecycle events:

'events' => [
    'enabled' => env('CART_EVENTS_ENABLED', true),
],

See Events for detailed event documentation.

Merge Settings

Configure default cart merging behavior:

'merge' => [
    // Default merge strategy: 'sum', 'replace', 'max', 'keep_target'
    'default_strategy' => env('CART_MERGE_STRATEGY', 'sum'),

    // Whether to clear the source cart after merging
    'delete_source' => env('CART_MERGE_DELETE_SOURCE', true),
],

See Merging for detailed merge documentation.

Full Configuration Reference

<?php

return [
    /*
    |--------------------------------------------------------------------------
    | Storage Driver
    |--------------------------------------------------------------------------
    |
    | The storage driver to use for persisting cart data.
    | Options: 'session', 'database'
    |
    */
    'storage' => env('CART_STORAGE', 'session'),

    /*
    |--------------------------------------------------------------------------
    | Custom Storage Class
    |--------------------------------------------------------------------------
    |
    | Optionally specify a custom storage class that implements StorageInterface.
    |
    */
    'storage_class' => null,

    /*
    |--------------------------------------------------------------------------
    | Session Key
    |--------------------------------------------------------------------------
    |
    | The session key used to store cart data when using session storage.
    |
    */
    'session_key' => 'flexicart',

    /*
    |--------------------------------------------------------------------------
    | Currency
    |--------------------------------------------------------------------------
    |
    | The default currency for price calculations (ISO 4217 code).
    |
    */
    'currency' => env('CART_CURRENCY', 'USD'),

    /*
    |--------------------------------------------------------------------------
    | Locale
    |--------------------------------------------------------------------------
    |
    | The locale used for price formatting.
    |
    */
    'locale' => env('CART_LOCALE', 'en_US'),

    /*
    |--------------------------------------------------------------------------
    | Compound Discounts
    |--------------------------------------------------------------------------
    |
    | When true, discounts are applied sequentially (compounding).
    | When false, all discounts are calculated on the original price.
    |
    */
    'compound_discounts' => true,

    /*
    |--------------------------------------------------------------------------
    | Custom Models
    |--------------------------------------------------------------------------
    |
    | Override the default Eloquent models when using database storage.
    |
    */
    'cart_model' => null,
    'cart_item_model' => null,

    /*
    |--------------------------------------------------------------------------
    | Cart Cleanup
    |--------------------------------------------------------------------------
    |
    | Automatic cleanup of old/abandoned carts (database storage only).
    |
    */
    'cleanup' => [
        'enabled' => true,
        'lifetime' => 60 * 24 * 7, // 1 week in minutes
    ],

    /*
    |--------------------------------------------------------------------------
    | Events
    |--------------------------------------------------------------------------
    |
    | Enable or disable cart event dispatching.
    |
    */
    'events' => [
        'enabled' => env('CART_EVENTS_ENABLED', true),
    ],

    /*
    |--------------------------------------------------------------------------
    | Merge Settings
    |--------------------------------------------------------------------------
    |
    | Default settings for cart merging operations.
    |
    */
    'merge' => [
        'default_strategy' => env('CART_MERGE_STRATEGY', 'sum'),
        'delete_source' => env('CART_MERGE_DELETE_SOURCE', true),
    ],
];