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,

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

从本包的第二个版本开始，可以使用依赖注入将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']]);

从包的第二个版本开始，新增了使用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()

如果你想通过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 方法。此方法将返回购物车中物品的总数。因此，如果您添加了两本书和一件衬衫，它将返回 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)

集合

在多个实例中，购物车将返回一个 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);

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