README

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

本库的所有权利归原作者 Crinsane 所有

安装

通过 Composer 安装此包。

从终端运行 Composer require 命令

composer require alhoqbani/shoppingcart

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

从本包的版本 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() 方法来更新它。

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

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

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

如果您想更新商品的更多属性，您可以将数组或 Buyable 作为第二个参数传递给 update 方法。这样，您就可以更新具有给定 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 方法的地方。此方法将返回一个 CartItem 集合，您可以通过迭代来展示给客户。

Cart::content();

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

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

Cart::destroy()

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

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 的行 ID。

此方法将返回一个包含所有找到的 CartItem 的集合。

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

集合

在多个实例中，购物车将返回一个集合。这只是一个简单的 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 访问您的模型了！

您可以通过购物车商品的 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="Alhoqbani\Shoppingcart\ShoppingcartServiceProvider" --tag="config"

这将为您提供一个 cart.php 配置文件，您可以在其中进行更改。

为了使您的生活更轻松，该软件包还包括一个可用的 migration，您可以通过运行以下命令来发布它：

php artisan vendor:publish --provider="Alhoqbani\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>