README

一个简单的Laravel购物车实现。

安装

通过 Composer 安装此包。

从终端运行Composer require命令

composer require awesomecoder/shoppingcart

如果你使用的是Laravel 5.5，这样就足够了。此包也兼容laravel 9.1

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

在 providers 数组中添加新行

AwesomeCoder\Shoppingcart\ShoppingcartServiceProvider::class

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

'Cart' => AwesomeCoder\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() 方法将返回一个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]);

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()

如果您想通过行ID从购物车中获取项目，您可以简单地调用购物车的get()方法，并传递行ID。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::get($rowId);

Cart::content()

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

Cart::content();

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

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

Cart::destroy()

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

Cart::destroy();

Cart::total()

total()方法可用于获取购物车中所有项目的计算总价，包括价格和数量。

Cart::total();

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

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

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

如果您不使用外观，而是在（例如）控制器中使用依赖注入，您也可以简单获取总属性$cart->total

Cart::tax()

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

Cart::tax();

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

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

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

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

Cart::subtotal()

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

Cart::subtotal();

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

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

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

如果您不使用外观，而是在（例如）控制器中使用依赖注入，您也可以简单地获取小计属性$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;
});

如你所见，闭包将接收两个参数。第一个是要进行检查的购物项。第二个参数是此购物项的行ID。

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

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

集合

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

您可以通过 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="AwesomeCoder\Shoppingcart\ShoppingcartServiceProvider" --tag="config"

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

为了让您的生活更轻松，该包还包括一个现成的 migration，您可以通过运行以下命令发布：

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

        @foreach (Cart::content() as $item)
            <tr>
                <td>
                    <p><strong>{{ $item->name }}</strong></p>
                    <p>{{ $item->options->has('size') ? $item->options->size : '' }}</p>
                </td>
                <td><input type="text" value="{{ $item->qty }}"></td>
                <td>${{ $item->price }}</td>
                <td>${{ $item->total }}</td>
            </tr>
        @endforeach
    </tbody>

    <tfoot>
        <tr>
            <td colspan="2">&nbsp;</td>
            <td>Subtotal</td>
            <td>{{ Cart::subtotal() }}</td>
        </tr>
        <tr>
            <td colspan="2">&nbsp;</td>
            <td>Tax</td>
            <td>{{ Cart::tax() }}</td>
        </tr>
        <tr>
            <td colspan="2">&nbsp;</td>
            <td>Total</td>
            <td>{{ Cart::total() }}</td>
        </tr>
    </tfoot>
</table>