README

安装

1 - 安装 Laravel 框架后，在文件 composer.json 的 require 对象中插入此值

"syscover/shopping-cart": "~2.0"

并在控制台执行

composer update

2 - 注册服务提供者，在文件 config/app.php 中将以下内容添加到 providers 数组中

Syscover\ShoppingCart\ShoppingCartServiceProvider::class,

并注册别名，在文件 config/app.php 中将以下内容添加到 aliases 数组中

'CartProvider' => Syscover\ShoppingCart\Facades\CartProvider::class,

3 - 执行发布命令

php artisan vendor:publish

##运行 Laravel 测试

发布测试文件

php artisan vendor:publish --provider="Syscover\ShoppingCart\ShoppingCartServiceProvider"

并使用以下命令运行测试

phpunit tests/ShoppingCartProviderTest

通用配置环境值

我们列出可用的配置变量，要更改它们，您需要从 .env 文件中执行操作。

设置产品价格税 [默认值 1]

定义在产品中引入的价格类型，在创建或更新产品时会咨询此选项。您有以下值

值：1 不含税
值：2 含税

TAX_PRODUCT_PRICES=1

设置运费价格税 [默认值 1]

定义在运费价格中引入的价格类型，在创建或更新运费价格时会咨询此选项

值：1 不含税
值：2 含税

TAX_SHIPPING_PRICES=1

设置产品显示价格税 [默认值 1]

定义您想如何显示产品价格。您有以下值

值：1 不含税
值：2 含税

TAX_PRODUCT_DISPLAY_PRICES=1

设置运费显示价格税 [默认值 1]

定义您想如何显示运费价格

值：1 不含税
值：2 含税

TAX_SHIPPING_DISPLAY_PRICES=1

##Item Cart 提供以下方法供您使用

要添加项目，我们需要创建一个具有以下属性的 Item 对象

id:string = 产品 ID
name:string = 产品名称
quantity:float = 您想添加的产品数量
inputPrice:float = 单位产品价格
weight:float [默认 1.000] = 产品重量
transportable:boolean [默认 true] = 设置产品是否可以配送
taxRule:TaxRule[] [默认 []] = 设置此产品的税则
options:array [默认 []] = 设置关联数组以设置自定义选项

将车项添加到购物车，您需要创建 Item 对象以添加到购物车，如果您想添加多个元素，可以使用 Item 对象或 Items 数组。

// Basic add Item to Cart
CartProvider::instance()->add(new Item('293ad', 'Product 1', 1, 9.99));

// Multiple add Items to Cart
CartProvider::instance()->add([
    new Item('293ad', 'Product 1', 1, 9.99),
    new Item('979ze', 'Product 2', 1, 12.90)
]);

// Multiple add Items with options to Cart
CartProvider::instance()->add([
    new Item('293ad', 'Product 1', 1, 9.99, 1.000, true, [], ['size' => 'L']),
    new Item('979ze', 'Product 2', 1, 12.90, 1.000, true, [], ['size' => 'M'])
]);

我们创建了 TaxRule 对象来计算购物车中的税收，此对象具有以下属性

name:string = 税名
taxRate:float = 税率百分比
priority:int [默认 0] = 计算税款的顺序。如果有不同的优先级，则最高税额计算在未税总金额上，优先级较低的税款计算在较低未税总金额上
sortOrder:int [默认 0] = 税款在屏幕上出现的顺序

购物车已准备好 TaxRule 对象，您可以为每个 cartItem 对象添加税则。您可以添加一个 TaxRule 或多个 TaxRule 数组

// Multiple add Items to Cart with options and one tax rule
CartProvider::instance()->add([
    new Item('293ad', 'Product 1', 1, 9.99, 1.000, true, new TaxRule('IVA', 21), ['size' => 'L']),
    new Item('979ze', 'Product 2', 1, 12.90, 1.000, true, new TaxRule('IVA', 21), ['size' => 'M'])
]);

// Multiple add Items to Cart with options and various tax rules
CartProvider::instance()->add([
    new Item('293ad', 'Product 1', 1, 9.99, 1.000, true, [
            new TaxRule('IVA', 21, 0, 0),
            new TaxRule('Customs', 10, 1, 1),
        ], ['size' => 'L']),
    new Item('979ze', 'Product 2', 1, 12.90, 1.000, true, 
            new TaxRule('IVA', 21, 0, 0),
            new TaxRule('Customs', 10, 1, 1),
        ], ['size' => 'M'])
]);

一旦定义了规则，您就可以使用此方法修改它们

foreach (CartProvider::instance()->getCartItems() as $item)
{
    $item->resetTaxRules();
}

当然，如果需要，您也可以重新加载其他规则

foreach (CartProvider::instance()->getCartItems() as $item)
{
    $item->addTaxRule(new TaxRule('IVA', 18, 0, 0),);
}

请记住，如果您重置taxRules或向项目添加新税规则，您必须从小计强制计算金额

$item->calculateAmounts(Cart::PRICE_WITHOUT_TAX);

要更新您已设置的项目的数量，您需要传递update方法rowId和新的数量

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

CartProvider::instance()->setQuantity($rowId, 2);

如果您想更新项目的更多属性，您可以将Item对象传递给update方法，并带有要更新的项目的rowId。

CartProvider::instance()->update($rowId, new Item('293ad', 'Product 1', 1, 19.99, 1.000, true, new TaxRule('IVA', 21), ['size' => 'L']));

要从购物车中删除元素，请在购物车上调用remove()方法，并传递rowId。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

CartProvider::instance()->remove($rowId);

如果您想获取购物车中的项目，您有getCartItems方法。此方法将返回一个CartItems集合，您可以遍历并显示给客户的内容。

CartProvider::instance()->getCartItems();

如果您想获取每个项目的数量，您可以使用每个项目的getQuantity方法。

foreach(CartProvider::instance()->getCartItems() as $item)
{
  $item->getQuantity();
}

如果您想通过rowId从购物车中获取项目，您只需在购物车上调用get()方法并传递rowId即可。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

CartProvider::instance()->getCartItems()->get($rowId);

如果您想完全删除购物车的内容，您可以在购物车上调用destroy方法。这将从当前购物车实例中删除所有CartItems。

CartProvider::instance()->destroy();

获取不含税的小计价格

CartProvider::instance()->subtotal;

// or subtotal price formatted
CartProvider::instance()->getSubtotal();

获取所有项目的税额

CartProvider::instance()->taxAmount;

// or tax amount formatted
CartProvider::instance()->getTaxAmount();

获取总价格

CartProvider::instance()->total;

// or total price formatted
CartProvider::instance()->getTotal();

设置运费金额

CartProvider::instance()->shippingAmount = 10.00;

获取运费金额

CartProvider::instance()->shippingAmount;

// or shipping amount formatted
CartProvider::instance()->getShippingAmount();

要了解购物车中是否包含任何可运输的物品，您有此方法

CartProvider::instance()->hasItemTransportable();

获取购物车中的项目数量，总项目数

 CartProvider::instance()->getQuantity();

要查找购物车中的项目，您可以使用search()方法。如您所见，Closure将接收两个参数。第一个是要执行检查的CartItem。第二个参数是此CartItem的rowId。

此方法将返回一个包含所有找到的Items的Collection。

这种方式搜索让您完全控制搜索过程，并让您能够创建非常精确和具体的搜索。

  CartProvider::instance()->search(function ($cartItem, $rowId) {
      return $cartItem->id === 1;
  });

此包还支持购物车的多个实例。这样做的原理如下：您可以使用CartProvider::instance('newInstance')设置当前购物车实例，此时，活动的购物车实例是newInstance，因此当您添加、删除或获取购物车的内容时，您使用的是购物车的newInstance实例。如果您想切换实例，只需再次调用CartProvider::instance('otherInstance')即可，然后您又开始使用otherInstance实例。

默认购物车实例称为default，因此当您不使用实例时，CartProvider::instance()->getCartItems()与CartProvider::instance('default')->getCartItems()相同。

所以有一个小例子

CartProvider::instance('shopping')->add(new Item('192ao12', 'Product 1', 1, 9.99));

// Get items of the 'shopping' cart
CartProvider::instance('shopping')->getCartItems();

CartProvider::instance('wishlist')->add(new Item('sdjk922', 'Product 2', 1, 19.95));

// Get items of the 'wishlist' cart
CartProvider::instance('wishlist')->getCartItems();

我们已创建PriceRule对象以在购物车项目上应用折扣

name:string = 价格规则的名称
description:string = 规则的描述
discountType:int = 您有多种选择，以下列出了所有选项
freeShipping:boolean [默认为false] = 选中此选项以设置带有免费送货的规则
discountFixed:float [默认为null] = 设置固定折扣金额
discountPercentage:float [默认为null] = 设置折扣的百分比率
maximumDiscountAmount:float [默认为null] = 如果您选择折扣百分比，您可以设置折扣的最大金额
applyShippingAmount:boolean [默认为false] = 如果您想将折扣应用于运费金额，请选中此选项
combinable:boolean [默认为true] = 设置此价格规则是否可以与同一购物车中的其他规则共存

使用PriceRule类中的这些常量，您可以定义折扣类型

WITHOUT_DISCOUNT
DISCOUNT_SUBTOTAL_PERCENTAGE
DISCOUNT_SUBTOTAL_FIXED_AMOUNT
DISCOUNT_TOTAL_PERCENTAGE
DISCOUNT_TOTAL_FIXED_AMOUNT

要设置价格规则，您可以使用addCartPriceRule方法

    CartProvider::instance()->addCartPriceRule(
        new PriceRule(
            'My first price rule',                      // name
            'For being a good customer',                // description
            PriceRule::DISCOUNT_SUBTOTAL_PERCENTAGE,    // discount type
            false,                                      // free shipping
            10.00                                       // discount fixed amount
        )
    );

在应用定价规则时需要考虑的场景

我们已创建对小计和总价格进行折扣，但不能将两个折扣应用于同一购物车。
如果应用百分比折扣和固定折扣，首先应用固定折扣，然后应用百分比折扣。

syscover / shoppingcart

维护者

详细信息