README

此软件包是从 Crinsane/LaravelShoppingcart 分支出来的。

LaravelShoppingcart

为Laravel提供简单购物车实现。

安装

通过 Composer 安装包。

在终端运行Composer require命令

composer require hoej/shoppingcart

如果你使用的是Laravel 5.5，这就可以了。

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

在 providers 数组中添加新行

Gloudemans\Shoppingcart\ShoppingcartServiceProvider::class

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

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

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

从该包的2.0版本开始，你可以使用依赖注入将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.0版本新增了与 Buyable 接口一起工作的功能。这是通过你有一个模型实现 Buyable 接口来实现的，这将使你实现一些方法，这样包就知道如何从你的模型中获取id、名称和价格。这样，你只需将模型和数量传递给 add() 方法，它就会自动将其添加到购物车。

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

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

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

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

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

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

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

如果您想根据行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::total()

total()方法可用于获取购物车中所有项目的计算总价，前提是已知价格和数量。

Cart::total();

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

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

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

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

Cart::tax()

tax()方法可用于获取购物车中所有项目的计算税额，前提是已知价格和数量。

Cart::tax();

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

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

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

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

Cart::subtotal()

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

Cart::subtotal();

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

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

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

如果您没有使用外观，而是在您的（例如）控制器中使用依赖注入，您也可以直接获取小计属性$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的集合

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

集合

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

// 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']);

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