README

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

安装

通过Composer安装此包。

从终端运行Composer require命令

composer require surfsidemedia/shoppingcart

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

如果你仍然在使用Laravel 5.4，你需要完成以下步骤：将包的服务提供者添加到你的config/app.php文件中，并给包创建别名。

在providers数组中添加新的一行

Surfsidemedia\Shoppingcart\ShoppingcartServiceProvider::class

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

'Cart' => Surfsidemedia\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接口的路径是

Surfsidemedia\Shoppingcart\Contracts\Buyable;

作为额外的奖励，它将自动将模型与CartItem关联起来

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

作为可选的第三个参数，您可以添加选项。

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

最后，您还可以一次添加多个商品到购物车。您可以向add()方法传递数组（数组）或Buyables的数组，它们将被添加到购物车中。

当添加多个商品到购物车时，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()

要从购物车中删除一个商品，您还需要行ID。您只需将此行ID传递给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 Collection类的filter方法。这意味着您必须传递一个闭包，在其中指定您的搜索条件。

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

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

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

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

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

集合

在多个实例中，购物车将返回一个集合。这只是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.';
}

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 Surfsidemedia\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="Surfsidemedia\Shoppingcart\ShoppingcartServiceProvider" --tag="config"

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

为了让你的生活更轻松，该包还包括一个可立即使用的 migration，你可以通过运行以下命令来发布：

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

surfsidemedia / shoppingcart

维护者

详细信息

README

安装

概述

用法

Cart::add()

Cart::update()

Cart::remove()

Cart::get()

Cart::content()

Cart::destroy()

Cart::total()

Cart::tax()

Cart::subtotal()

Cart::count()

Cart::search()

集合

实例

模型

Buyable

数据库

配置

存储购物车

恢复购物车

异常

事件

示例