README

这是 Crisane's LaravelShoppingcart 的一个分支，增加了与 Laravel 6 兼容的少量特性。

安装

通过包，使用 Composer 安装。

在终端运行 Composer require 命令

composer require bumbummen99/shoppingcart

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

从版本 2 开始，可以使用依赖注入将 Cart 类的实例注入到控制器或其他类中

概述

查看以下主题之一，了解更多关于 LaravelShoppingcart 的信息

用法
集合
实例
模型
数据库
异常
事件
示例

用法

购物车提供了以下方法来使用

Cart::add()

将商品添加到购物车非常简单，您只需使用 add() 方法，该方法接受各种参数。

在其最基本的形式中，您可以指定要添加到购物车的商品的 id、名称、数量、价格和重量。

Cart::add('293ad', 'Product 1', 1, 9.99, 550);

作为可选的第五个参数，您可以传递选项，这样您就可以添加具有相同 id 但具有（例如）不同尺寸的多个商品。

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

add() 方法将返回您刚刚添加到购物车的商品的 CartItem 实例。

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

Cart::add(['id' => '293ad', 'name' => 'Product 1', 'qty' => 1, 'price' => 9.99, 'weight' => 550, '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, 'weight' => 550],
  ['id' => '4832k', 'name' => 'Product 2', 'qty' => 1, 'price' => 10.00, 'weight' => 550, 'options' => ['size' => 'large']]
]);

Cart::add([$product1, $product2]);

Cart::update()

要更新购物车中的商品，您首先需要商品的 rowId。接下来，您可以使用 update() 方法来更新它。

如果您只想更新数量，您只需将 update 方法传递 rowId 和新的数量即可。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::update($rowId, 2); // Will update the quantity

如果您想更新商品的其他属性，您可以将数组或 Buyable 作为第二个参数传递给 update 方法。这样，您可以使用给定的 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 方法的地方。此方法将返回一个包含 CartItems 的集合，您可以使用它遍历并展示给客户。

Cart::content();

此方法将返回当前购物车实例的内容，如果您想获取另一个实例的内容，只需链式调用。

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

Cart::destroy()

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

Cart::destroy();

Cart::weight()

weight() 方法可用于获取购物车中所有项目的总重量，前提是已知它们的重量和数量。

Cart::weight();

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

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

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

如果您没有使用 Facade，但在您的（例如）控制器中使用依赖注入，您也可以简单地获取总属性 $cart->weight

Cart::total()

total() 方法可用于获取购物车中所有项目的计算总价，前提是已知它们的价格和数量。

Cart::total();

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

Cart::total($decimals, $decimalSeparator, $thousandSeparator);

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

如果您没有使用 Facade，但在您的（例如）控制器中使用依赖注入，您也可以简单地获取总属性 $cart->total

Cart::tax()

tax() 方法可用于获取购物车中所有项目的计算税额，前提是已知它们的价格和数量。

Cart::tax();

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

Cart::tax($decimals, $decimalSeparator, $thousandSeparator);

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

如果您没有使用 Facade，但在您的（例如）控制器中使用依赖注入，您也可以简单地获取税属性 $cart->tax

Cart::subtotal()

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

Cart::subtotal();

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

Cart::subtotal($decimals, $decimalSeparator, $thousandSeparator);

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

如果您没有使用 Facade，但在您的（例如）控制器中使用依赖注入，您也可以简单地获取小计属性 $cart->subtotal

Cart::discount()

discount() 方法可用于获取购物车中所有项目的总折扣。

Cart::discount();

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

Cart::discount($decimals, $decimalSeparator, $thousandSeparator);

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

如果您没有使用 Facade，但在您的（例如）控制器中使用依赖注入，您也可以简单地获取小计属性 $cart->discount

Cart::initial()

initial() 方法可用于获取购物车中所有项目的总价，在折扣之前。

Cart::initial();

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

Cart::initial($decimals, $decimalSeparator, $thousandSeparator);

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

如果您没有使用 Facade，但在您的（例如）控制器中使用依赖注入，您也可以简单地获取小计属性 $cart->initial

Cart::count()

如果您想了解购物车中有多少个项目，您可以使用 count() 方法。此方法将返回购物车中的总项目数。所以如果您添加了2本书和1件衬衫，它将返回3个项目。

Cart::count();
$cart->count();

Cart::search()

要查找购物车中的项目，您可以使用 search() 方法。

此方法在版本2中已更改

在幕后，该方法只是使用了 Laravel Collection 类的 filter 方法。这意味着您必须传递一个闭包，在其中指定您的搜索条件。

例如，如果您想找到所有 ID 为 1 的项目

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

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

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

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

Cart::setTax($rowId, $taxRate)

您可以使用 setTax() 方法来更改适用于 CartItem 的税率。这将覆盖配置文件中设置的值。

Cart::setTax($rowId, 21);
$cart->setTax($rowId, 21);

Cart::setGlobalTax($taxRate)

您可以使用 setGlobalTax() 方法来更改购物车中所有项目的税率。新项目也将接收设置的 globalTax。

Cart::setGlobalTax(21);
$cart->setGlobalTax(21);

Cart::setGlobalDiscount($discountRate)

您可以使用 setGlobalDiscount() 方法来更改购物车中所有项目的折扣率。新项目也将接收折扣。

Cart::setGlobalDiscount(50);
$cart->setGlobalDiscount(50);

Cart::setDiscount($rowId, $taxRate)

您可以使用 setDiscount() 方法来更改适用于 CartItem 的折扣率。请注意，如果您之后为 Cart 设置了全局折扣，此值将会更改。

Cart::setDiscount($rowId, 21);
$cart->setDiscount($rowId, 21);

Buyable

为了方便更快地将项目添加到购物车并自动关联，您的模型必须实现 Buyable 接口。您可以使用 CanBeBought 特性来实现所需的方法，但请注意，这些方法将使用模型上预定义的字段来获取所需的值。

<?php
namespace App\Models;

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

class Product extends Model implements Buyable {
    use Gloudemans\Shoppingcart\CanBeBought;
}

如果特性对模型不起作用或您想手动映射字段，则模型必须实现 Buyable 接口方法。为此，它必须实现以下函数

    public function getBuyableIdentifier(){
        return $this->id;
    }
    public function getBuyableDescription(){
        return $this->name;
    }
    public function getBuyablePrice(){
        return $this->price;
    }
    public function getBuyableWeight(){
        return $this->weight;
    }

示例

<?php
namespace App\Models;

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

class Product extends 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;
    }
}

集合

在多个实例上，购物车将返回一个 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, 550);

// Get the content of the 'shopping' cart
Cart::content();

Cart::instance('wishlist')->add('sdjk922', 'Product 2', 1, 19.95, 550, ['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();

您还可以使用 InstanceIdentifier 合约来扩展所需的模型，为其分配/创建一个购物车实例。这也允许直接设置全局折扣。

<?php

namespace App;
...
use Illuminate\Foundation\Auth\User as Authenticatable;
use Gloudemans\Shoppingcart\Contracts\InstanceIdentifier;

class User extends Authenticatable implements InstanceIdentifier
{
	...

	/**
     * Get the unique identifier to load the Cart from
     *
     * @return int|string
     */
    public function getInstanceIdentifier($options = null)
    {
        return $this->email;
    }

    /**
     * Get the unique identifier to load the Cart from
     *
     * @return int|string
     */
    public function getInstanceGlobalDiscount($options = null)
    {
        return $this->discountRate ?: 0;
    }
}

// Inside Controller
$user = \Auth::user();
$cart = Cart::instance($user);

注意：请记住，在脚本执行期间没有设置不同实例的情况下，购物车将保留在最后一个设置的实例中。

注意2：默认购物车实例名为 default，因此当您不使用实例时，Cart::content(); 与 Cart::instance('default')->content() 相同。

模型

由于可以直接从 CartItem 访问模型，因此可以将模型与购物车中的项目关联起来。假设您在应用程序中有一个 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, 550, ['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, 550, ['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="Gloudemans\Shoppingcart\ShoppingcartServiceProvider" --tag="config"

这将在其中您可以进行更改的cart.php配置文件中。

为了使您的生活更加方便，该包还包括一个可立即使用的migration，您可以通过运行以下命令来发布：

php artisan vendor:publish --provider="Gloudemans\Shoppingcart\ShoppingcartServiceProvider" --tag="migrations"

这将在database/migrations目录中放置一个shoppingcart表的迁移文件。现在您只需运行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');

合并购物车

如果您想将购物车与数据库中的另一个购物车合并，只需调用merge($identifier)即可，其中$identifier是您为store方法指定的密钥。您还可以定义是否保留商品的折扣和税率，以及是否希望触发“cart.added”事件。

// Merge the contents of 'savedcart' into 'username'.
Cart::instance('username')->merge('savedcart', $keepDiscount, $keepTaxrate, $dispatchAdd);

异常

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

事件

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

示例

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

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

krisnaipaymu / shoppingcart

维护者

详情

README

安装

概述

用法

Cart::add()

Cart::update()

Cart::remove()

Cart::get()

Cart::content()

Cart::destroy()

Cart::weight()

Cart::total()

Cart::tax()

Cart::subtotal()

Cart::discount()

Cart::initial()

Cart::count()

Cart::search()

Cart::setTax($rowId, $taxRate)

Cart::setGlobalTax($taxRate)

Cart::setGlobalDiscount($discountRate)

Cart::setDiscount($rowId, $taxRate)

Buyable

集合

实例

模型

数据库

配置

存储购物车

恢复购物车

合并购物车

异常

事件

示例