README

一个灵活且现代的购物车软件包。

先决条件

• PHP >=5.6.0

安装

composer require mike182uk/cart

使用方法

• 购物车
• 购物车项
• 购物车存储实现

购物车

创建一个新的购物车

要创建一个新的购物车实例，您必须将一个 ID 和存储实现传递给购物车构造函数

use Cart\Cart;
use Cart\Storage\SessionStore;

$id = 'cart-01';
$cartSessionStore = new SessionStore();

$cart = new Cart($id, $cartSessionStore);

存储实现必须实现 Cart\Storage\Store。

ID 用于通过存储实现保存/恢复购物车状态。

向购物车添加项目

使用 add 方法向购物车添加项目。必须向此方法传递一个有效的 Cart\CartItem。

use Cart\CartItem;

$item = new CartItem;
$item->name = 'Macbook Pro';
$item->sku = 'MBP8GB';
$item->price = 1200;
$item->tax = 200;

$cart->add($item);

如果项目已存在于购物车中，现有项目的数量将更新以包含要添加的项目数量。

从购物车中删除项目

通过将项目 ID 传递给 remove 方法从购物车中删除项目。

$cart->remove('e4df90d236966195b49b0f01f5ce360a356bc76b');

更新购物车中的项目

要更新购物车中项目的属性，请使用 update 方法。您需要传递购物车项目 ID、要更新的属性的名称和新值。此方法将返回项目 ID（以防由于更新而更改）。

$newId = $cart->update('e4df90d236966195b49b0f01f5ce360a356bc76b', 'price', 959.99);

如果您尝试更新购物车中不存在的项目，将抛出 InvalidArgumentException。

检索购物车中的项目

使用 get 方法通过其 ID 检索购物车中的项目。如果项目不存在，则返回 null。

$item = $cart->get('e4df90d236966195b49b0f01f5ce360a356bc76b');

if ($item) {
    // ...
}

检索购物车中的所有项目

使用 all 方法检索购物车中的所有项目。这将返回包含购物车中所有项目的数组。

$cartItems = $cart->all();

if (count($cartItems) > 0) {
    foreach ($cartItems as $item) {
        // ...
    }
}

确定购物车中是否存在项目

使用 has 方法确定购物车中是否存在项目。返回 true 或 false。

if ($cart->has('e4df90d236966195b49b0f01f5ce360a356bc76b')) {
    // ...
}

清空购物车

使用 clear 方法清空购物车。

$cart->clear();

这还将清除存储中此购物车的保存状态。

保存/恢复购物车状态

使用 save 方法保存购物车。

$cart->save();

这将保存当前购物车项和购物车 ID 到存储中。

使用 restore 方法恢复购物车。

$cart->restore();

这将添加任何存储的购物车项回购物车并设置购物车 ID。如果恢复购物车出现问题，将抛出 Cart\CartRestoreException。这只会发生以下情况：

• 保存的数据不可序列化
• 反序列化的数据无效（不是数组）
• 购物车 ID 不存在于反序列化的数据中
• 购物车项不存在于反序列化的数据中
• 购物车 ID 无效（不是字符串）
• 购物车项无效（不是数组）

其他购物车方法

totalUniqueItems

获取购物车中唯一项目的总数。

$cart->totalUniqueItems();

totalItems

获取购物车中项目的总数。

$cart->totalItems();

total

获取所有购物车项的总价，包括税。

$cart->total();

您可以通过使用 totalExcludingTax 方法获取不包括税的总价。

$cart->totalExcludingTax();

tax

获取所有购物车项的总税额。

$cart->tax();

toArray

将购物车导出为数组。

$cartData = $cart->toArray();

数组将结构如下

[
    'id' => 'cart-01', // cart id
    'items' => [
        // cart items as array
    ]
]

getId

获取购物车的 ID。

$cart->getId();

getStore

获取购物车存储实现。

$cart->getStore();

购物车项

创建一个新的购物车项

use Cart\CartItem;

$item = new CartItem;

$item->name = 'Macbook Pro';
$item->sku = 'MBP8GB';
$item->price = 1200;
$item->tax = 200;
$item->options = [
    'ram' => '8 GB',
    'ssd' => '256 GB'
];

Cart\CartItem实现了ArrayAccess接口，因此可以将属性分配给购物车项，就像访问数组一样

$item = new CartItem;

$item['name'] = 'Macbook Pro';
$item['sku'] = 'MBP8GB';
$item['price'] = 1200;
$item['tax'] = 200;
$item['options'] = [
    'ram' => '8 GB',
    'ssd' => '256 GB'
];

也可以将数据数组传递给购物车项构造函数来设置购物车项属性

$itemData = [
    'name' => 'Macbook Pro';
    'sku' => 'MBP8GB';
    'price' => 1200;
    'tax' => 200;
    'options' => [
        'ram' => '8 GB',
        'ssd' => '256 GB'
    ]
];

$item = new CartItem($itemData);

如果未传递数量给购物车项构造函数，则默认数量设置为1。

如果未传递价格给购物车项构造函数，则默认价格设置为0.00。

如果未传递税给购物车项构造函数，则默认税设置为0.00。

购物车项 ID

每个购物车都有一个唯一的ID。此ID使用在购物车项上设置的属性生成。您可以使用getId方法或通过访问属性id来获取购物车项ID。

$id = $item->getId();

$id = $item->id;

$id = $item['id'];

更改购物车项上的属性将更改其ID。

购物车项方法

get

获取设置在购物车项上的数据。

$name = $item->get('name');

这等同于做

$name = $item['name'];

$name = $item->name;

set

设置购物车项上的数据。

$item->set('name', 'Macbook Pro');

这等同于做

$item['name'] = 'Macbook Pro';

$item->name = 'Macbook Pro';

如果您正在设置项目数量，则值必须是整数，否则将抛出InvalidArgumentException异常。

$item->quantity = 1; // ok

$item->quantity = '1' // will throw exception

如果您正在设置项目价格或税，则值必须是数值，否则将抛出InvalidArgumentException异常。

$item->price = 10.00; // ok

$item->price = '10' // ok

$item->price = 'ten' // will throw exception

getTotalPrice

获取包括税的购物车项总价((项目价格 + 项目税) * 数量)。

$item->getTotalPrice();

您还可以使用getTotalPriceExcludingTax方法获取不包括税的总价(项目价格 * 数量)。

$item->getTotalPriceExcludingTax();

getSinglePrice

获取包括税的购物车项单价(项目价格 + 项目税)

$item->getSinglePrice();

您还可以使用getSinglePriceExcludingTax方法获取不包括税的单价。

$item->getSinglePriceExcludingTax();

getTotalTax

获取购物车项的总税额(项目税 * 数量)。

$item->getTotalTax();

getSingleTax

获取购物车项的单个税值。

$item->getSingleTax();

toArray

将项目导出到数组。

$itemArr = $item->toArray();

数组将结构如下

[
    'id' => 'e4df90d236966195b49b0f01f5ce360a356bc76b', // cart item unique id
    'data' => [
        'name' => 'Macbook Pro',
        'sku' => 'MBP8GB',
        'price' => 1200,

        // ... other cart item properties
    ]
]

购物车存储实现

购物车存储实现必须实现Cart\Storage\Store。

此包提供了2个基本存储实现：Cart\Storage\SessionStore和Cart\Storage\CookieStore。

当调用购物车的save方法时，购物车ID和序列化的购物车数据传递给存储实现的put方法。

当调用购物车的restore方法时，购物车ID传递给存储实现的get方法。

当调用购物车的clear方法时，购物车ID传递给存储实现的flush方法。

一个示例会话存储实现可能看起来像

use Cart\Store;

class SessionStore implements Store
{
    /**
     * {@inheritdoc}
     */
    public function get($cartId)
    {
        return isset($_SESSION[$cartId]) ? $_SESSION[$cartId] : serialize([]);
    }

    /**
     * {@inheritdoc}
     */
    public function put($cartId, $data)
    {
        $_SESSION[$cartId] = $data;
    }

    /**
     * {@inheritdoc}
     */
    public function flush($cartId)
    {
        unset($_SESSION[$cartId]);
    }
}