README

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

安装

通过 Composer 安装此包。

在终端中运行 Composer require 命令

composer require hardevine/shoppingcart

如果你使用的是 Laravel 5.5 或更高版本，这就足够了。

如果你还在使用 Laravel 5.4，那么你需要添加包的服务提供者和别名。为此，打开你的 config/app.php 文件。

在 providers 数组中添加新行

Gloudemans\Shoppingcart\ShoppingcartServiceProvider::class

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

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

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

从本包的第二个版本开始，你可以使用依赖注入将 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']);

你可以为项目传递不同的税率。

Cart::add('293ad', 'Product 1', 1, 9.99, ['size' => 'large'], 20);

add() 方法将返回一个代表你刚添加到购物车的项目的 CartItem 实例。

也许你更喜欢使用数组来添加项目？只要数组包含所需的键，你就可以将其传递给该方法。选项键是可选的。

Cart::add(['id' => '293ad', 'name' => 'Product 1', 'qty' => 1, 'price' => 9.99, 'options' => ['size' => 'large']]);

在包的第二个版本中新增了与 Buyable 接口一起工作的可能性。这种方式是，你有一个模型实现了 Buyable 接口，这将使你实现一些方法，这样包就知道如何从你的模型中获取 id、名称和价格。这样你就可以只需传递模型和数量给 add() 方法，它就会自动将其添加到购物车。

Buyable 接口的路径是

Gloudemans\Shoppingcart\Contracts\Buyable;

作为额外的奖励，它还会自动将模型与 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)。你只需将此行号传递给remove()方法，它就会从购物车中删除该商品。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::remove($rowId);

Cart::get()

如果你想要通过行号(rowId)从购物车中获取一个商品，你可以在购物车上调用get()方法，并传递行号。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::get($rowId);

Cart::content()

当然，你还需要获取购物车的商品内容。这就是你将使用content方法的地方。此方法将返回一个包含CartItems的集合，你可以遍历它并向客户展示内容。

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

例如，如果你想找到所有id为1的商品

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

如你所见，闭包将接收两个参数。第一个是执行检查的CartItem。第二个参数是此CartItem的行号。

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

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

集合

在多个实例中，购物车将返回一个集合。这只是一个简单的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();

注意：请记住，在脚本执行期间，除非您设置不同的实例，否则购物车将保持在最后设置的实例中。

注意：默认购物车实例称为 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.';
}

Buyable

为了方便更快地将商品添加到购物车并自动关联，您的模型可以实现 Buyable 接口。为此，它必须实现以下函数

    public function getBuyableIdentifier(){
        return $this->id;
    }

    public function getBuyableDescription(){
        return $this->name;
    }

    public function getBuyablePrice(){
        return $this->price;
    }

示例

<?php

namespace App\Models;

use Gloudemans\Shoppingcart\Contracts\Buyable;
use Illuminate\Database\Eloquent\Model;

class Product exends Model implements Buyable {
    public function getBuyableIdentifier($options = null) {
        return $this->id;
    }

    public function getBuyableDescription($options = null) {
        return $this->name;
    }

    public function getBuyablePrice($options = null) {
        return $this->price;
    }
}

数据库

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

配置

为了将购物车保存到数据库以便以后检索，该包需要知道要使用哪个数据库连接以及表名是什么。默认情况下，该包将使用默认数据库连接并使用名为 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 或用户名。

    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>