README

关于

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

包安装

composer require icemix/laravel-shopping-cart

对于 Laravel 5.7，您不需要添加服务提供者 & 别名
在 config/app.php 的 'providers' 数组中添加服务提供者
Icemix\LaravelShoppingCart\CartServiceProvider::class,
在 config/app.php 的 'aliases' 数组中添加别名
'Cart' => Icemix\LaravelShoppingCart\Facades\Cart::class,

php artisan vendor:publish --provider="Icemix\LaravelShoppingCart\CartServiceProvider" --tag="config"
php artisan vendor:publish --provider="Icemix\LaravelShoppingCart\CartServiceProvider" --tag="migrations"

现在您可以进行迁移，创建 'shoppingcart' 表

php artisan migrate

您可以在 'config/cart.php' 文件中进行自定义更改。
注意： 请确保在 config/app.php 中 'product_model' 拥有正确的模型命名空间。

文档

概览

查看以下主题之一以了解更多关于 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 方法的地方。此方法将返回一个包含商品项的集合（CartItems），您可以遍历并显示给您的客户。

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 集合类的 filter 方法。这意味着您必须传递一个闭包，在其中指定您的搜索条件。

例如，如果您想找到所有 ID 为 1 的商品

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

如你所见，闭包将接收两个参数。第一个是要检查的商品项。第二个是这个商品项的 rowId。

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

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

集合

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

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

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.';
}

数据库

• 存储购物车
• 恢复购物车

存储购物车

要将你的购物车实例存储到数据库中，你必须调用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>

使用的资源

• 主要包
• 文章

开发者邮箱

ettaegbe40@gmail.com