README

这是对 bumbummen99 LaravelShoppingcart 的分支，增加了与 Laravel 10+ 兼容的少量功能。一个示例集成可以在这里找到：此处。

此分支已修改，用于销售可按件数销售的产品。例如药店：1 个产品包含 6 件，购物车中可以有 1 包 3 件。

CartItem 类有新的属性 - pcs（件数）

安装

通过包使用 Composer 进行安装。

从终端运行 Composer require 命令

composer require forsxs/shoppingcart

现在您已经准备好在应用程序中使用购物车了。

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

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

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

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

更新

从版本 4.2.0 开始，当与 PostgreSQL 一起使用时，此包会将购物车内容编码为 base64，然后存储到数据库中，这是由于保存包含零字节值的值的错误。如果您使用 PostgreSQL 从版本 <4.2.0 升级，请考虑清除您的购物车表。

重要提示

由于所有计算包括税费和折扣的购物车，此模块也可能受到“总计四舍五入问题”的影响（*），这是由于价格和结果使用的十进制精度。为了避免（或至少最小化）此问题，在 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']]);

在包的版本2中，新增了使用可购买界面的功能。其工作方式是您让一个模型实现可购买接口，这将使您实现一些方法，这样包就知道如何从您的模型中获取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()

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

如果您只想更新数量，您可以将行ID和新的数量传递给更新方法。

$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作为第二个参数给更新方法。这样，您可以使用给定的行ID更新项目的所有信息。

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

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

Cart::remove()

要删除购物车中的项目，您同样需要项目的行ID。您只需将行ID传递给remove()方法，它就会从购物车中删除该项目。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::remove($rowId);

Cart::get()

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

$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);

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

如果您不是使用外观（Facade），而是在您的（例如）控制器中使用依赖注入，您也可以简单地获取总属性$cart->weight。

Cart::total()

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

Cart::total();

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

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

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

如果您不是使用外观（Facade），而是在您的（例如）控制器中使用依赖注入，您也可以简单地获取总属性$cart->total。

Cart::tax()

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

Cart::tax();

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

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

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

如果您不是使用外观（Facade），而是在您的（例如）控制器中使用依赖注入，您也可以简单地获取税属性$cart->tax。

Cart::subtotal()

可以使用 subtotal() 方法来获取购物车中所有商品的总金额，减去税额。

Cart::subtotal();

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

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

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

如果您没有使用 Facade，但在您的（例如）控制器中使用了依赖注入，您也可以直接获取小计属性 $cart->subtotal

Cart::discount()

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

Cart::discount();

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

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

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

如果您没有使用 Facade，但在您的（例如）控制器中使用了依赖注入，您也可以直接获取小计属性 $cart->discount

Cart::initial()

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

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

Cart::initial();

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

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

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

Cart::priceTotal()

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

Cart::priceTotal();

该方法将根据默认的数字格式进行四舍五入，但您可以使用三个可选参数进行微调。

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

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

如果您没有使用 Facade，但在您的（例如）控制器中使用了依赖注入，您也可以直接获取初始价格属性 $cart->initial

Cart::count()

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

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

Cart::search()

要查找购物车中的商品，可以使用 search() 方法。

此方法在版本2中已更改

在幕后，该方法只是使用了 Laravel 集合类的 filter 方法。这意味着您必须传递一个闭包，在其中指定您要搜索的术语。

例如，如果您想找到所有 ID 为 1 的商品

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

如你所见，闭包将接收两个参数。第一个是进行检查的 CartItem。第二个参数是此 CartItem 的行 ID。

此方法将返回一个包含所有找到的 CartItems 的集合

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

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 设置了全局折扣，此值将更改。

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;
    }
}

集合

在多个实例中，购物车会返回一个集合。这是一个简单的Laravel集合，所以你可以在结果上调用所有可以在Laravel集合上调用的方法。

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

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 访问你的模型了！

您可以通过 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>

forsxs / shoppingcart

维护者

详细信息

README

安装

更新

目录

重要提示

用法

Cart::add()

Cart::update()

Cart::remove()

Cart::get()

Cart::content()

Cart::destroy()

Cart::weight()

Cart::total()

Cart::tax()

Cart::subtotal()

Cart::discount()

Cart::initial()

Cart::priceTotal()

Cart::count()

Cart::search()

Cart::setTax($rowId, $taxRate)

Cart::setGlobalTax($taxRate)

Cart::setGlobalDiscount($discountRate)

Cart::setDiscount($rowId, $taxRate)

Buyable

集合

实例

模型

数据库

配置

存储购物车

恢复购物车

合并购物车

删除购物车

计算器

异常

事件

示例

合作者

贡献者