mateusjatenee/shoppingcart

v1.2 2020-03-03 01:39 UTC

This package is auto-updated.

Last update: 2024-08-29 05:22:13 UTC


README

此包最初由Rob Gloudemans创建,我非常、非常感谢他。然而,我使用这个包在一个高负载的网站上,需要一些功能,并且我不确定Rob是否还对维护此包感兴趣或有时间。我已联系他,但需要添加一些功能,因此我立即创建了此仓库。

LaravelShoppingcart

Build Status Total Downloads Latest Stable Version Latest Unstable Version License

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

安装

通过Composer安装包。

在终端中运行Composer require命令。

composer require mateusjatenee/shoppingcart

现在您只需要将包的服务提供者和别名添加到您的应用程序中。为此,请打开您的config/app.php文件。

providers数组中添加一行新内容。

Mateusjatenee\Shoppingcart\ShoppingcartServiceProvider::class

可选地,在aliases数组中添加一行新内容。

'Cart' => Mateusjatenee\Shoppingcart\Facades\Cart::class,

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

从该包的第二个版本开始,您可以使用依赖注入将购物车类的实例注入到控制器或其他类中。

概述

查看以下主题之一以了解更多关于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]);

您还可以通过在创建后立即调用setFree方法将项目设置为免费(0价格)。

Cart::add($product, 1, ['size' => 'large'])->setFree();

### Cart::update()

To update an item in the cart, you'll first need the rowId of the item.
Next you can use the `update()` method to update it.

If you simply want to update the quantity, you'll pass the update method the rowId and the new quantity:

```php
$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 的 Collection,您可以使用它遍历并显示给客户的内容。

Cart::content();

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

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

Cart::destroy()

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

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

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

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

如你所见,闭包将接收两个参数。第一个是用于检查的 CartItem。第二个参数是这个 CartItem 的 rowId。

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

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

集合

在多个实例中,购物车将返回一个 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.';
}

折扣

现在可以创建 Discount 对象并将它们应用到项上。使用方法非常简单,您只需传递两个参数——折扣值和规则。规则遵循 Laravel 的验证模式。以下属性接受验证:priceqtysubtotal

$discount = new Discount(5, [
  'qty' => 'min:2|max:10',
  'price' => 'min:5|max:20',
]);

$item = Cart::add('293ad', 'Laravel T-Shirt', 1, 100);
$item->setDiscount($discount);

$item->price // returns the price with the discount if validation passes or the regular price if it does not.  

可以为项设置静态或动态的税费。例如,假设我们想添加 'Laravel T-Shirt' 并对其设置 10% 的税费。

$item = Cart::add('293ad', 'Laravel T-Shirt', 1, 100);

Cart::setTax($item->rowId, 10); // 10% percent 

$item->tax // 10
$item->priceTax // 110 (100 + 10)
$item->subtotal // 100 (quantity * price)
$item->total // 110 (quantity * priceTax)

// you can also set static taxes by passing a third argument as true. For instance, you want the tax to be 20, always.  

$item = Cart::add('293ad', 'Laravel T-Shirt', 1, 100);

Cart::setTax($item->rowId, 20, true); // 10% percent 

$item->tax // 20
$item->priceTax // 120 (100 + 20)
$item->subtotal // 100 (quantity * price)
$item->total // 120 (quantity * priceTax)

异常

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

事件

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

示例

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

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