README

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

安装

通过 Composer 安装此包。

在终端中运行 Composer require 命令

composer require hsali/shoppingcart_api

如果您使用的是 Laravel 5.5，这就是全部的操作。

如果您仍然在使用 Laravel 5.4，您需要执行以下最终步骤：添加包的服务提供者和别名。为此，打开您的 config/app.php 文件。

在 providers 数组中添加新行

Redsignal\Shoppingcart\ShoppingcartServiceProvider::class

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

'Cartapi' => Redsignal\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()

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

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

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

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

如果您想更新项目的更多属性，您可以将一个数组或一个 Buyable 作为第二个参数传递给更新方法。这样，您就可以使用给定的行号更新项目的所有信息。

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

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

Cart::remove()

要从一个购物车中删除一个项目，您还需要项目的行号。您只需将行号传递给 remove() 方法，它就会从购物车中删除该项目。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::remove($rowId);

Cart::get()

如果您想通过行ID从购物车中获取项目，您可以直接在购物车上调用get()方法，并传入行ID。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::get($rowId);

Cart::content()

当然，您也想获取购物车的商品内容。这就是您将使用content方法的地方。此方法将返回一个包含购物车项的集合，您可以遍历该集合并向您的客户显示商品内容。

Cartapi::content();

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

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

Cartapi::destroy()

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

Cartapi::destroy();

Cartapi::total()

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

Cartapi::total();

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

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

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

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

Cartapi::tax()

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

Cartapi::tax();

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

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

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

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

Cartapi::subtotal()

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

Cartapi::subtotal();

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

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

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

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

Cartapi::count()

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

Cartapi::count();

Cartapi::search()

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

此方法在版本2中已更改

在幕后，此方法只是简单地使用了Laravel Collection类的filter方法。这意味着您必须传递一个闭包，在其中指定您要搜索的术语。

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

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

如您所见，闭包将接收两个参数。第一个是要进行检查的购物车项。第二个参数是此购物车项的行ID。

此方法将返回一个包含所有找到的购物车项的集合。

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

集合

在多个实例中，购物车将返回一个集合。这只是一个简单的Laravel Collection，所以您可以在结果上调用所有可以在Laravel Collection上调用的方法。

例如，您可以快速获取购物车中独特产品的数量

Cartapi::content()->count();

或者，您可以按产品ID对内容进行分组

Cartapi::content()->groupBy('id');

实例

该包支持购物车的多个实例。这样工作的方式是这样的

您可以通过调用Cartapi::instance('newInstance')来设置当前的购物车实例。从那时起，活动的购物车实例将是newInstance，所以当您添加、删除或获取购物车的内容时，您将处理购物车的newInstance实例。如果您想切换实例，只需再次调用Cartapi::instance('otherInstance')即可，然后您将再次使用otherInstance。

以下是一个简单的示例

Cartapi::instance('shopping')->add('192ao12', 'Product 1', 1, 9.99);

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

Cartapi::instance('wishlist')->add('sdjk922', 'Product 2', 1, 19.95, ['size' => 'medium']);

// Get the content of the 'wishlist' cart
Cartapi::content();

// If you want to get the content of the 'shopping' cart again
Cartapi::instance('shopping')->content();

// And the count of the 'wishlist' cart again
Cartapi::instance('wishlist')->count();

注意。请记住，购物车会保持在上一个实例中，直到你在脚本执行期间没有设置另一个实例。

注意2。默认的购物车实例称为 default，所以当你不使用实例时，Cartapi::content(); 等同于 Cartapi::instance('default')->content()。

模型

由于能够直接从 CartItem 访问模型非常方便，因此可以将模型与购物车中的项目关联起来。假设你在应用程序中有一个 Product 模型。通过 associate() 方法，你可以告诉购物车，购物车中的一个项目与 Product 模型相关联。

这样你就可以直接从 CartItem 访问你的模型了！

模型可以通过 CartItem 上的 model 属性访问。

如果你的模型实现了 Buyable 接口，并且你使用了你的模型将项目添加到购物车，它将自动关联。

以下是一个示例

// First we'll add the item to the cart.
$cartItem = Cartapi::add('293ad', 'Product 1', 1, 9.99, ['size' => 'large']);

// Next we associate a model with the item.
Cartapi::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
Cartapi::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(Cartapi::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 或用户名。

Cartapi::store('username');

// To store a cart instance named 'wishlist'
Cartapi::instance('wishlist')->store('username');

恢复购物车

如果你想从数据库中检索购物车并将其恢复，你只需要调用 restore($identifier)，其中 $identifier 是你为 store 方法指定的密钥。

Cartapi::restore('username');

// To restore a cart instance named 'wishlist'
Cartapi::instance('wishlist')->restore('username');

异常

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

事件

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

示例

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

// Add some items in your Controller.
Cartapi::add('192ao12', 'Product 1', 1, 9.99);
Cartapi::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(Cartapi::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 Cartapi::subtotal(); ?></td>
   		</tr>
   		<tr>
   			<td colspan="2">&nbsp;</td>
   			<td>Tax</td>
   			<td><?php echo Cartapi::tax(); ?></td>
   		</tr>
   		<tr>
   			<td colspan="2">&nbsp;</td>
   			<td>Total</td>
   			<td><?php echo Cartapi::total(); ?></td>
   		</tr>
   	</tfoot>
</table>