README

这是 Crinsane's LaravelShoppingcart 的分支，增加了与 Laravel 6 兼容的少量功能。

安装

通过 Composer 安装 package。

在终端运行 Composer require 命令

composer require bumbummen99/shoppingcart

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

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

概述

查看以下主题之一，以了解更多关于 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']]);

版本 2 的包中新增了使用 Buyable 接口的可能性。这的工作方式是您有一个模型实现 Buyable 接口，这将使您实现一些方法，这样包就知道如何从您的模型中获取 id、名称和价格。这样，您只需将模型和数量传递给 add() 方法，它就会自动将其添加到购物车中。

作为额外的好处，它将自动将模型与 CartItem 关联起来

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

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

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

最后，您还可以一次添加多个项到购物车。您只需将数组或 Buyables 的数组传递给 add() 方法即可。

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

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() 方法来更新它。

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

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

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

如果您想更新项的更多属性，您可以传递一个数组或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方法的地方。此方法将返回一个CartItems集合，您可以使用它遍历并显示内容给客户。

Cart::content();

此方法将返回当前购物车实例的内容；如果您想要其他实例的内容，只需简单地链式调用。

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

Cart::destroy()

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

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

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

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

Cart::discount()

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

Cart::discount();

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

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

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

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

Cart::initial()

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

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

Cart::initial();

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

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

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

Cart::priceTotal()

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

Cart::priceTotal();

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

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

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

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

Cart::count()

如果您想知道购物车中有多少商品，可以使用count()方法。此方法将返回购物车中的商品总数。例如，如果您添加了两本书和一件衬衫，它将返回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()方法更改购物车中所有商品的税率。新商品也将接收设置的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;
    }
}

集合

在多个实例中，购物车将返回一个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的表。如果您想更改这些选项，您必须发布config文件。

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

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

为了让您的生活更轻松，包还包括一个现成的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);

删除购物车

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

Cart::erase('username');

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

异常

如果出现问题，购物车包将抛出异常。这样，使用购物车包调试代码或根据异常类型处理错误都更容易。购物车包可以抛出以下异常

事件

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

示例

以下是一个如何在表格中列出购物车内容的简单示例

// 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>