README

这是一个为 Laravel 5、6 和 7 简单实现的购物车。

安装

通过 Composer 安装此包。

从终端运行 Composer require 命令

composer require olimortimer/laravelshoppingcart

Laravel <= 5.4

如果你仍然在使用 Laravel 5.4 版本，那么你需要添加包的服务提供者和别名。为此，打开你的 config/app.php 文件。

在 providers 数组中添加新行

Gloudemans\Shoppingcart\ShoppingcartServiceProvider::class

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

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

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

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

概述

查看以下主题以了解更多关于 LaravelShoppingcart 的信息

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

用法

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

Cart::add()

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

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

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

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

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

add() 方法将返回一个 CartItem 实例，该实例是您刚刚添加到购物车中的项目。

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

Cart::add(['id' => '293ad', 'name' => 'Product 1', 'qty' => 1, 'price' => 9.99, '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],
  ['id' => '4832k', 'name' => 'Product 2', 'qty' => 1, 'price' => 10.00, 'options' => ['size' => 'large']]
]);

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

Cart::update()

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

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

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

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

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

Cart::content();

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

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

Cart::destroy()

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

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

Cart::search()

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

此方法在版本2中进行了更改。

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

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

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

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

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

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

Cart::addCost()

如果您想向购物车添加额外费用，您可以使用addCost()方法。此方法接受费用名称和费用价格。这可以用于例如运费或交易费用。

Cart::addCost($name, $price)

在总结整个购物车之前添加此方法。这些费用尚未保存到会话中。

Cart::getCost()

获取通过addCost()添加的额外费用。接受费用名称。返回格式化后的费用价格。

Cart::getCost($name, $decimals, $decimalPoint, $thousandSeperator)

集合

在多个实例中，购物车会返回一个集合。这是一个简单的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);

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

Cart::instance('wishlist')->add('sdjk922', 'Product 2', 1, 19.95, ['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();

注意：请记住，在脚本执行期间没有设置不同实例的情况下，购物车会保留到最后设置的实例。

注意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, ['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, ['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');

异常

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

事件

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

示例

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

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

// Set an additional cost (on the same page where you display your cart content)
Cart::addCost(Cart::COST_TRANSACTION, 0.10);
Cart::addCost(Cart::COST_SHIPPING, 5.00);
Cart::addCost('somethingelse', 1.11);

// 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>Transaction cost</td>
			<td><?php echo Cart::getCost(\Gloudemans\Shoppingcart\Cart::COST_TRANSACTION); ?></td>
		</tr>
		<tr>
			<td colspan="2">&nbsp;</td>
			<td>Transaction cost</td>
			<td><?php echo Cart::getCost(\Gloudemans\Shoppingcart\Cart::COST_SHIPPING); ?></td>
		</tr>
		<tr>
			<td colspan="2">&nbsp;</td>
			<td>Transaction cost</td>
			<td><?php echo Cart::getCost('somethingelse'); ?></td>
		</tr>
   		<tr>
   			<td colspan="2">&nbsp;</td>
   			<td>Total</td>
   			<td><?php echo Cart::total(); ?></td>
   		</tr>
   	</tfoot>
</table>