README

为 Laravel 8 & 9 & 10 提供简单的购物车实现。

安装

通过 Composer 安装此包。

在终端运行 Composer require 命令

composer require alijumaan/shoppingcart

Laravel <= 8.0

如果您仍在 Laravel 8.0 或 9.0 版本上，您需要添加包的服务提供者和别名。为此，打开您的 config/app.php 文件。

在 providers 数组中添加新行

Alijumaan\Shoppingcart\ShoppingcartServiceProvider::class

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

'Cart' => Alijumaan\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方法。此方法将返回一个包含购物项的Collection，你可以遍历并显示给客户。

Cart::content();

此方法将返回当前购物实例的内容，如果你想要其他实例的内容，只需链式调用。

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

Cart::destroy()

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

Cart::destroy();

Cart::total()

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

Cart::total();

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

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

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

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

Cart::tax()

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

Cart::tax();

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

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

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

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

Cart::subtotal()

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

Cart::subtotal();

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

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

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

如果你没有使用外观（Facade），而是在你的（例如）控制器中使用依赖注入，你也可以简单地获取subtotal属性$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。

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

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

Cart::addCost()

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

Cart::addCost($name, $price)

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

Cart::getCost()

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

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

集合

在多个实例中，Cart将返回一个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中访问您的模型！

您可以通过购物车项上的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.';
}

配置

要保存购物车到数据库以便稍后检索，该软件包需要知道要使用哪个数据库连接以及表名是什么。默认情况下，该软件包将使用默认数据库连接并使用名为shopping_cart的表。如果您想更改这些选项，您将需要发布config文件。

php artisan vendor:publish --provider="Alijumaan\Shoppingcart\ShoppingcartServiceProvider" --tag="config"

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

为了使您的生活更加简单，该软件包还包括一个现成的migration，您可以通过运行以下命令来发布它

php artisan vendor:publish --provider="Alijumaan\Shoppingcart\ShoppingcartServiceProvider" --tag="migrations"

这将把shopping_cart表的迁移文件放到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(\Alijumaan\Shoppingcart\Cart::COST_TRANSACTION); ?></td>
		</tr>
		<tr>
			<td colspan="2">&nbsp;</td>
			<td>Transaction cost</td>
			<td><?php echo Cart::getCost(\Alijumaan\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>

alijumaan / shoppingcart

维护者

详细信息

README

安装

Laravel <= 8.0

概述

用法

Cart::add()

Cart::update()

Cart::remove()

Cart::get()

Cart::content()

Cart::destroy()

Cart::total()

Cart::tax()

Cart::subtotal()

Cart::count()

Cart::search()

Cart::addCost()

Cart::getCost()

集合

实例

模型

数据库

配置

存储购物车

恢复购物车

异常

事件

示例