README

为 Laravel (6.x) 设计的轻量级购物车包。

安装

通过 Composer 安装此包。

在终端运行 Composer require 命令

composer require shahadat/shoppingcart

如果你使用的是 Laravel 5.5 或更早版本，只需完成以下步骤。

对于你的最终步骤是添加包的服务提供程序和别名。为此，打开你的 config/app.php 文件。

向 providers 数组中添加新行

Shahadat\Shoppingcart\ShoppingcartServiceProvider::class

可选地，向 aliases 数组中添加新行

'Cart' => Shahadat\Shoppingcart\Facades\Cart::class,

如果你想要更改配置选项，你必须发布 config 文件。

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

这将给你一个 cart.php 配置文件，你可以在此处进行更改。

现在你已准备好在你的应用程序中使用 shoppingcart。

概述

查看以下主题之一以了解更多关于 Laravel Shoppingcart 的信息

• 用法
• 集合
• 实例
• 模型
• 数据库
• 异常
• 事件
• 示例

用法

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

Cart::add()

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

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

Cart::add('123', 'Product Name', 1, 100.00);

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

Cart::add('123', 'Product Name', 1, 9.99, ['color' => 'blue', 'size' => 'XXL']);

add() 方法将返回一个代表你刚刚添加到购物车的项的 CartItem 实例。

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

Cart::add(['id' => '123', 'name' => 'Product Name', 'qty' => 1, 'price' => 9.99, 'options' => ['color' => 'blue', 'size' => 'XXL']]);

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

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

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

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

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

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

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

Cart::add([
  ['id' => '123', 'name' => 'Product Name', 'qty' => 1, 'price' => 100.00],
  ['id' => '123', 'name' => 'Product Name', 'qty' => 1, 'price' => 100.00, 'options' => ['size' => 'XXL']]
]);

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

Cart::update()

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

向购物车添加项时，为每一行生成一个唯一的 rowId。

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

$rowId = '2decca212ac0e35428b051aa0cc488ed';

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

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

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

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

Cart::remove()

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

向购物车添加项时，为每一行生成一个唯一的 rowId。

$rowId = '2decca212ac0e35428b051aa0cc488ed';

Cart::remove($rowId);

Cart::get()

如果您想通过rowId获取购物车中的项，可以简单地调用购物车的get()方法并传入rowId。

向购物车添加项时，为每一行生成一个唯一的 rowId。

$rowId = '2decca212ac0e35428b051aa0cc488ed';

Cart::get($rowId);

Cart::content()

当然，您也想获取购物车的商品内容。这里您将使用content方法。此方法将返回一个包含购物项的Collection，您可以遍历并展示给客户。

Cart::content();

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

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

Cart::destroy()

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

Cart::destroy();

Cart::total()

可以使用total()方法获取购物车中所有项的计算总价，包括价格和数量。

Cart::total();

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

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

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

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

Cart::tax()

可以使用tax()方法获取购物车中所有项的计算税额，包括价格和数量。

Cart::tax();

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

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

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

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

Cart::subtotal()

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

Cart::subtotal();

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

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

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

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

Cart::count()

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

Cart::count();

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

Cart::search()

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

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

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

如您所见，闭包将接收两个参数。第一个是用于检查的购物项。第二个参数是此购物项的rowId。

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

这种搜索方式让您完全控制搜索过程，并允许您创建非常精确和特定的搜索。

集合

在多个实例上，购物车会返回一个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('123', 'Product Name', 1, 100.00);

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

Cart::instance('wishlist')->add('123', 'Product Name', 1, 100.00, ['size' => 'XXL']);

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

注意：购物车会保持在脚本执行期间最后一次设置的实例中，除非你设置了不同的实例。

注意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('123', 'Product Name', 1, 100.00, ['size' => 'XXL']);

// 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('123', 'Product Name', 1, 100.00, ['size' => 'XXL'])->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/cart.php文件来更改这些选项。

为了方便，该包还包括一个现成的migration，你可以通过运行以下命令来发布它：

php artisan vendor:publish --provider="Shahadat\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');

异常

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

事件

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

示例

以下是列出购物车内容的一个小示例

// Add some items in your Controller.
Cart::add('123', 'Product Name', 1, 100);
Cart::add('123', 'Product Name', 2, 99.99, ['size' => 'XXL']);

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

   	<tbody>

   		@foreach(Cart::content() as $row)

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

	   	@endforeach

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

特别感谢Rob Gloudemans