README

这是 Crinsane 的 LaravelShoppingcart 的分支，增加了与 Laravel 8+ 兼容的少量功能。示例集成可以在 此处 找到。

安装

通过 Composer 安装此包。

从终端运行 Composer require 命令

composer require bumbummen99/shoppingcart

现在你可以开始在你的应用程序中使用购物车了。

从本包的第 2 版开始，可以使用依赖注入将 Cart 类的实例注入到你的控制器或其他类中

你绝对应该发布 config 文件并查看它。

php artisan vendor:publish --provider="Gloudemans\Shoppingcart\ShoppingcartServiceProvider" --tag="config"

这将为你提供一个 cart.php 配置文件，其中你可以更改包的行为。

目录

查看以下主题之一以了解有关 LaravelShoppingcart 的更多信息

• 重要说明
• 用法
• 集合
• 实例
• 模型
• 数据库
• 计算器
• 异常
• 事件
• 示例
• 贡献者

重要说明

与其他所有计算包括税和折扣的购物车一样，此模块也可能受到“总计四舍五入问题”的影响（*），这是由于价格和结果使用的小数精度。为了避免（或至少最小化）此问题，在 Laravel 购物车包中，总计是使用 “每行” 方法计算的，并且已经根据配置文件（cart.php）中设置的默认数字格式进行了四舍五入。由于这个原因，我们 不建议将高精度设置为默认值，并且使用更少的数字格式来格式化输出结果。这样做可能会导致四舍五入问题。

基础价格（产品价格）未进行四舍五入。

用法

购物车提供了以下方法供您使用

Cart::add()

向购物车添加项非常简单，您只需使用 add() 方法，该方法接受各种参数。

在其最基本的形式中，您可以指定要添加到购物车的产品的 id、名称、数量、价格和重量。

Cart::add('293ad', 'Product 1', 1, 9.99, 550);

作为可选的第五个参数，您可以传递它选项，这样您就可以添加具有相同 id 但（例如）不同尺寸的多个项。

Cart::add('293ad', 'Product 1', 1, 9.99, 550, ['size' => 'large']);

add() 方法将返回您刚刚添加到购物车的 CartItem 实例。

也许您更喜欢使用数组添加项？只要数组包含所需的键，您就可以将其传递给该方法。选项键是可选的。

Cart::add(['id' => '293ad', 'name' => 'Product 1', 'qty' => 1, 'price' => 9.99, 'weight' => 550, 'options' => ['size' => 'large']]);

该软件包的第二个版本新增了与可购买接口一起工作的可能性。这种方式是：你需要让一个模型实现可购买接口，这样就会要求你实现一些方法，以便软件包知道如何从你的模型中获取id、名称和价格。这样，你只需将模型和数量传递给add()方法，它就会自动将其添加到购物车。

作为额外的好处，它将自动将模型与购物车项关联起来。

Cart::add($product, 1, ['size' => 'large']);

作为可选的第三个参数，你可以添加选项。

Cart::add($product, 1, ['size' => 'large']);

最后，你也可以一次将多个项目添加到购物车。你只需将数组（数组中的每个元素也是一个数组）或一个可购买对象数组传递给add()方法，它们就会被添加到购物车。

当添加多个项目到购物车时，add()方法将返回一个购物车项数组。

Cart::add([
  ['id' => '293ad', 'name' => 'Product 1', 'qty' => 1, 'price' => 10.00, 'weight' => 550],
  ['id' => '4832k', 'name' => 'Product 2', 'qty' => 1, 'price' => 10.00, 'weight' => 550, 'options' => ['size' => 'large']]
]);

Cart::add([$product1, $product2]);

Cart::update()

要更新购物车中的项目，首先需要项目的rowId。然后，你可以使用update()方法来更新它。

如果你只想更新数量，只需将rowId和新的数量传递给更新方法。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::update($rowId, 2); // Will update the quantity

如果你想要更新购物车中某个项目的选项，

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::update($rowId, ['options'  => ['size' => 'small']]); // Will update the size option with new value

如果你想更新更多属性，你可以将一个数组或一个Buyable对象作为第二个参数传递给更新方法。这样，你可以使用给定的rowId更新所有项目信息。

Cart::update($rowId, ['name' => 'Product 1']); // Will update the name

Cart::update($rowId, $product); // Will update the id, name and price

Cart::remove()

要从购物车中删除项目，你需要再次使用rowId。只需将rowId传递给remove()方法，它就会从购物车中删除项目。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::remove($rowId);

Cart::get()

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

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::get($rowId);

Cart::content()

当然，你还需要获取购物车的内容。这是使用content方法的地方。此方法将返回一个购物车项集合，你可以遍历它并显示给客户。

Cart::content();

此方法将返回当前购物车实例的内容。如果你想获取另一个实例的内容，只需链式调用。

Cart::instance('wishlist')->content();

Cart::destroy()

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

Cart::destroy();

Cart::weight()

weight()方法可以用来获取购物车中所有项目的总重量，给定它们的重量和数量。

Cart::weight();

此方法将自动格式化结果，你可以使用三个可选参数进行微调。

Cart::weight($decimals, $decimalSeperator, $thousandSeperator);

你可以在配置文件中设置默认的数字格式。

如果你没有使用外观，而是在控制器（例如）中使用依赖注入，你还可以直接获取总属性$cart->weight。

Cart::total()

total()方法可以用来获取购物车中所有项目的计算总价，给定它们的价格和数量。

Cart::total();

此方法将自动格式化结果，你可以使用三个可选参数进行微调。

Cart::total($decimals, $decimalSeparator, $thousandSeparator);

你可以在配置文件中设置默认的数字格式。

如果你没有使用外观，而是在控制器（例如）中使用依赖注入，你还可以直接获取总属性$cart->total。

Cart::tax()

tax()方法可以用来获取购物车中所有项目的计算税费总额，给定它们的价格和数量。

Cart::tax();

此方法将自动格式化结果，你可以使用三个可选参数进行微调。

Cart::tax($decimals, $decimalSeparator, $thousandSeparator);

你可以在配置文件中设置默认的数字格式。

如果你没有使用外观，而是在控制器（例如）中使用依赖注入，你还可以直接获取税费属性$cart->tax。

Cart::subtotal()

subtotal()方法可以用来获取购物车中所有项目的总价，减去总税费。

Cart::subtotal();

此方法将自动格式化结果，你可以使用三个可选参数进行微调。

Cart::subtotal($decimals, $decimalSeparator, $thousandSeparator);

你可以在配置文件中设置默认的数字格式。

如果您没有使用外观模式（Facade），而是使用依赖注入（例如在Controller中），您也可以简单地获取小计属性 $cart->subtotal

Cart::discount()

使用discount()方法可以获取购物车中所有项目的总折扣。

Cart::discount();

此方法将自动格式化结果，你可以使用三个可选参数进行微调。

Cart::discount($decimals, $decimalSeparator, $thousandSeparator);

你可以在配置文件中设置默认的数字格式。

如果您没有使用外观模式，而是使用依赖注入（例如在Controller中），您也可以简单地获取折扣属性 $cart->discount

Cart::initial()

使用initial()方法可以获取购物车中所有项目在应用折扣和税之前的总价格。

该函数可能在将来被弃用。 当四舍五入可能受到舍入问题的影响时，请谨慎使用或使用 Cart::priceTotal()

Cart::initial();

该方法将自动格式化结果，您可以使用三个可选参数进行修改。

Cart::initial($decimals, $decimalSeparator, $thousandSeparator);

你可以在配置文件中设置默认的数字格式。

Cart::priceTotal()

使用priceTotal()方法可以获取购物车中所有项目在应用折扣和税之前的总价格。

Cart::priceTotal();

该方法返回基于默认数字格式舍入的结果，但您可以使用三个可选参数进行修改

Cart::priceTotal($decimals, $decimalSeparator, $thousandSeparator);

你可以在配置文件中设置默认的数字格式。

如果您没有使用外观模式，而是使用依赖注入（例如在Controller中），您也可以简单地获取初始价格属性 $cart->initial

Cart::count()

如果您想知道购物车中有多少个项目，您可以使用count()方法。此方法将返回购物车中的项目总数。因此，如果您添加了2本书和1件衬衫，它将返回3个项目。

Cart::count();
$cart->count();

Cart::search()

要查找购物车中的项目，您可以使用search()方法。

此方法在版本2中已更改

在幕后，该方法简单地使用了Laravel Collection类的filter方法。这意味着您必须传递一个闭包，在其中指定您的搜索条件。

如果您想找到所有ID为1的项目

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

如您所见，闭包将接收两个参数。第一个是要检查的CartItem。第二个参数是此CartItem的rowId。

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

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

Cart::setTax($rowId, $taxRate)

您可以使用setTax()方法更改适用于CartItem的税率。这将覆盖配置文件中设置的值。

Cart::setTax($rowId, 21);
$cart->setTax($rowId, 21);

Cart::setGlobalTax($taxRate)

您可以使用setGlobalTax()方法更改购物车中所有项目的税率。新项目也将接收设置的全局税率。

Cart::setGlobalTax(21);
$cart->setGlobalTax(21);

Cart::setGlobalDiscount($discountRate)

您可以使用setGlobalDiscount()方法更改购物车中所有项目的折扣率。新项目也将接收折扣。

Cart::setGlobalDiscount(50);
$cart->setGlobalDiscount(50);

Cart::setDiscount($rowId, $taxRate)

您可以使用setDiscount()方法更改适用于CartItem的折扣率。请注意，如果您之后为购物车设置全局折扣，此值将被更改。

Cart::setDiscount($rowId, 21);
$cart->setDiscount($rowId, 21);

Buyable

为了快速添加项目到购物车及其自动关联，您的模型必须实现Buyable接口。您可以使用CanBeBought特质来实现所需的方法，但请注意，这些将使用模型上预定义的字段作为所需值。

<?php
namespace App\Models;

use Gloudemans\Shoppingcart\Contracts\Buyable;
use Illuminate\Database\Eloquent\Model;

class Product extends Model implements Buyable {
    use Gloudemans\Shoppingcart\CanBeBought;
}

如果特质对模型不起作用或您想手动映射字段，模型必须实现Buyable接口方法。为此，它必须实现以下函数

    public function getBuyableIdentifier(){
        return $this->id;
    }
    public function getBuyableDescription(){
        return $this->name;
    }
    public function getBuyablePrice(){
        return $this->price;
    }
    public function getBuyableWeight(){
        return $this->weight;
    }

示例

<?php
namespace App\Models;

use Gloudemans\Shoppingcart\Contracts\Buyable;
use Illuminate\Database\Eloquent\Model;

class Product extends Model implements Buyable {
    public function getBuyableIdentifier($options = null) {
        return $this->id;
    }
    public function getBuyableDescription($options = null) {
        return $this->name;
    }
    public function getBuyablePrice($options = null) {
        return $this->price;
    }
    public function getBuyableWeight($options = null) {
        return $this->weight;
    }
}

集合

在多个实例中，购物车将返回一个Collection。这只是一个简单的Laravel Collection，因此您可以在结果上调用所有可以在Laravel Collection上调用的方法。

例如，您可以快速获取购物车中独特产品的数量

Cart::content()->count();

或者您可以通过产品的ID来对内容进行分组

Cart::content()->groupBy('id');

实例

该包支持多个购物车实例。其工作方式如下

您可以通过调用 Cart::instance('newInstance') 来设置当前的购物车实例。从这一刻起，活动实例将是 newInstance，因此当您添加、删除或获取购物车的内 容时，您将操作购物车的 newInstance 实例。如果您想切换实例，只需再次调用 Cart::instance('otherInstance')，然后您将再次使用 otherInstance。

以下是一个小例子

Cart::instance('shopping')->add('192ao12', 'Product 1', 1, 9.99, 550);

// Get the content of the 'shopping' cart
Cart::content();

Cart::instance('wishlist')->add('sdjk922', 'Product 2', 1, 19.95, 550, ['size' => 'medium']);

// Get the content of the 'wishlist' cart
Cart::content();

// If you want to get the content of the 'shopping' cart again
Cart::instance('shopping')->content();

// And the count of the 'wishlist' cart again
Cart::instance('wishlist')->count();

您还可以使用 InstanceIdentifier 合同来扩展所需的模型，并为它分配/创建一个购物车实例。这还允许直接设置全局折扣。

<?php

namespace App;
...
use Illuminate\Foundation\Auth\User as Authenticatable;
use Gloudemans\Shoppingcart\Contracts\InstanceIdentifier;

class User extends Authenticatable implements InstanceIdentifier
{
	...

	/**
     * Get the unique identifier to load the Cart from
     *
     * @return int|string
     */
    public function getInstanceIdentifier($options = null)
    {
        return $this->email;
    }

    /**
     * Get the unique identifier to load the Cart from
     *
     * @return int|string
     */
    public function getInstanceGlobalDiscount($options = null)
    {
        return $this->discountRate ?: 0;
    }
}

// Inside Controller
$user = \Auth::user();
$cart = Cart::instance($user);

注意：请记住，在脚本执行期间没有设置不同的实例之前，购物车将保持在最后设置的实例中。

注意2：默认购物车实例名为 default，因此当您不使用实例时，Cart::content(); 与 Cart::instance('default')->content() 相同。

模型

因为能够直接从购物车项访问模型非常方便，所以可以将模型与购物车中的项关联起来。比如说，您在应用程序中有一个 Product 模型。使用 associate() 方法，您可以告诉购物车，购物车中的项与 Product 模型相关联。

这样，您就可以直接从 CartItem 访问您的模型！

您可以通过购物车项上的 model 属性访问模型。

如果您的模型实现了 Buyable 接口并且您使用该模型将项添加到购物车中，它将自动关联。

以下是一个例子

// First we'll add the item to the cart.
$cartItem = Cart::add('293ad', 'Product 1', 1, 9.99, 550, ['size' => 'large']);

// Next we associate a model with the item.
Cart::associate($cartItem->rowId, 'Product');

// Or even easier, call the associate method on the CartItem!
$cartItem->associate('Product');

// You can even make it a one-liner
Cart::add('293ad', 'Product 1', 1, 9.99, 550, ['size' => 'large'])->associate('Product');

// Now, when iterating over the content of the cart, you can access the model.
foreach(Cart::content() as $row) {
	echo 'You have ' . $row->qty . ' items of ' . $row->model->name . ' with description: "' . $row->model->description . '" in your cart.';
}

数据库

• 配置
• 存储购物车
• 恢复购物车

配置

要将购物车保存到数据库以便以后检索，该包需要知道要使用哪个数据库连接以及表的名称。默认情况下，该包将使用默认的数据库连接并使用名为 shoppingcart 的表。您可以在配置中更改这些。

为了简化您的操作，该包还包括一个可立即使用的 migration，您可以通过运行以下命令来发布它：

php artisan vendor:publish --provider="Gloudemans\Shoppingcart\ShoppingcartServiceProvider" --tag="migrations"

这将把 shoppingcart 表的迁移文件放入 database/migrations 目录。现在，您只需运行 php artisan migrate 来迁移您的数据库。

存储购物车

要将您的购物车实例存储到数据库中，您必须调用 store($identifier) 方法。其中 $identifier 是一个随机键，例如用户的id或用户名。

Cart::store('username');

// To store a cart instance named 'wishlist'
Cart::instance('wishlist')->store('username');

恢复购物车

如果您想从数据库中检索购物车并将其恢复，只需调用 restore($identifier)，其中 $identifier 是您为 store 方法指定的键。

Cart::restore('username');

// To restore a cart instance named 'wishlist'
Cart::instance('wishlist')->restore('username');

合并购物车

如果您想将购物车与数据库中的另一个购物车合并，只需调用 merge($identifier)，其中 $identifier 是您为 store 方法指定的键。您还可以定义是否要保留项目的折扣和税率，以及是否要分发 "cart.added" 事件。

// Merge the contents of 'savedcart' into 'username'.
Cart::instance('username')->merge('savedcart', $keepDiscount, $keepTaxrate, $dispatchAdd, 'savedcartinstance');

删除购物车

如果您想从数据库中删除购物车，只需调用 erase($identifier)，其中 $identifier 是您为 store 方法指定的键。

Cart::erase('username');

// To erase a cart switching to an instance named 'wishlist'
Cart::instance('wishlist')->erase('username');

计算器

该包的计算逻辑由 Calculator 类实现并定义。这些类实现了 Gloudemans\Shoppingcart\Contracts\Calculator 合同，并确定价格是如何计算和舍入的。计算器可以在配置文件中进行配置。这是默认的计算器

<?php

namespace Gloudemans\Shoppingcart\Calculation;

use Gloudemans\Shoppingcart\CartItem;
use Gloudemans\Shoppingcart\Contracts\Calculator;

class DefaultCalculator implements Calculator
{
    public static function getAttribute(string $attribute, CartItem $cartItem)
    {
        $decimals = config('cart.format.decimals', 2);

        switch ($attribute) {
            case 'discount':
                return $cartItem->price * ($cartItem->getDiscountRate() / 100);
            case 'tax':
                return round($cartItem->priceTarget * ($cartItem->taxRate / 100), $decimals);
            case 'priceTax':
                return round($cartItem->priceTarget + $cartItem->tax, $decimals);
            case 'discountTotal':
                return round($cartItem->discount * $cartItem->qty, $decimals);
            case 'priceTotal':
                return round($cartItem->price * $cartItem->qty, $decimals);
            case 'subtotal':
                return max(round($cartItem->priceTotal - $cartItem->discountTotal, $decimals), 0);
            case 'priceTarget':
                return round(($cartItem->priceTotal - $cartItem->discountTotal) / $cartItem->qty, $decimals);
            case 'taxTotal':
                return round($cartItem->subtotal * ($cartItem->taxRate / 100), $decimals);
            case 'total':
                return round($cartItem->subtotal + $cartItem->taxTotal, $decimals);
            default:
                return;
        }
    }
}

异常

如果购物车包发生错误，它将抛出异常。这样，使用购物车包调试代码或根据异常类型处理错误都变得更简单。购物车包可以抛出以下异常：

事件

购物车还内置了事件。有五个事件可供您监听。

示例

下面是一个如何在表中列出购物车内容的示例：

// Add some items in your Controller.
Cart::add('192ao12', 'Product 1', 1, 9.99);
Cart::add('1239ad0', 'Product 2', 2, 5.95, ['size' => 'large']);

// Display the content in a View.
<table>
   	<thead>
       	<tr>
           	<th>Product</th>
           	<th>Qty</th>
           	<th>Price</th>
           	<th>Subtotal</th>
       	</tr>
   	</thead>

   	<tbody>

   		<?php foreach(Cart::content() as $row) :?>

       		<tr>
           		<td>
               		<p><strong><?php echo $row->name; ?></strong></p>
               		<p><?php echo ($row->options->has('size') ? $row->options->size : ''); ?></p>
           		</td>
           		<td><input type="text" value="<?php echo $row->qty; ?>"></td>
           		<td>$<?php echo $row->price; ?></td>
           		<td>$<?php echo $row->total; ?></td>
       		</tr>

	   	<?php endforeach;?>

   	</tbody>
   	
   	<tfoot>
   		<tr>
   			<td colspan="2">&nbsp;</td>
   			<td>Subtotal</td>
   			<td><?php echo Cart::subtotal(); ?></td>
   		</tr>
   		<tr>
   			<td colspan="2">&nbsp;</td>
   			<td>Tax</td>
   			<td><?php echo Cart::tax(); ?></td>
   		</tr>
   		<tr>
   			<td colspan="2">&nbsp;</td>
   			<td>Total</td>
   			<td><?php echo Cart::total(); ?></td>
   		</tr>
   	</tfoot>
</table>

合作者

贡献者