README

由于某些个人和公司难以理解 MIT 许可证的 copyleft 条款，正如未经授权重新许可我的作品和其他人的作品所证明的那样，我决定终止对此存储库的所有进一步开发和协助。鉴于此包旨在用于电子商务项目，预计将提供必要的资源来开发和支持您自己的解决方案。

LaravelShoppingcart

这是 Crinsane 的 LaravelShoppingcart 的分支，增加了与 Laravel 8+ 兼容的少量功能。示例集成可以在这里找到。

安装

通过 Composer 安装此包。

从终端运行 Composer require 命令

composer require bumbummen99/shoppingcart

现在您可以使用购物车功能开始使用应用程序了。

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

您绝对应该发布 config 文件并查看它。

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

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

更新

从版本 4.2.0 开始，当与 PostgreSQL 一起使用时，由于涉及零字节值的保存问题（问题 #167），此包将购物车内容编码为 base64 然后存储到数据库中。如果您正在使用 PostgreSQL 从版本 <4.2.0 升级，请考虑清除您的购物车表。

重要提示

由于所有包含计算包括税费和折扣的价格的购物车，本模块也可能受到“总计四舍五入问题”的影响（*），这是由于用于价格和结果的十进制精度引起的。为了避免（或至少最小化）此问题，在 Laravel 购物车包中，总计是使用 “每行” 方式计算的，并且已经根据配置文件（cart.php）中设置的默认数字格式四舍五入返回。由于这个原因，我们不鼓励将高精度作为默认值，并且使用更少的十进制数格式化输出结果。这样做可能会导致四舍五入问题。

基本价格（产品价格）未进行四舍五入。

用法

购物车为您提供了以下方法

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() 方法将返回您刚刚添加到购物车的商品实例。

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

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() 方法来更新它。

如果您只想更新数量，您可以将 rowId 和新数量传递给更新方法

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

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

如果您想更新购物车中商品的选项，

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::update($rowId, ['options'  => ['size' => 'small']]); // Will update the size option with new value

如果您想更新商品的更多属性，您可以通过传递数组或 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 集合，您可以遍历并显示给您的客户。

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

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

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

Cart::subtotal()

subtotal()方法可以用来获取购物车中所有商品的总价，减去总税额。

Cart::subtotal();

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

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

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

如果你没有使用外观模式，而是在（例如）控制器中使用依赖注入，你也可以简单地获取小计属性$cart->subtotal

Cart::discount()

discount()方法可以用来获取购物车中所有商品的总折扣。

Cart::discount();

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

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

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

如果你没有使用外观模式，而是在（例如）控制器中使用依赖注入，你也可以简单地获取小计属性$cart->discount

Cart::initial()

initial()方法可以用来获取购物车中所有商品在应用折扣和税额之前的价格总和。

它可能在将来被弃用。当四舍五入可能受到舍入问题的影响时，请谨慎使用，或使用Cart::priceTotal()

Cart::initial();

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

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

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

Cart::priceTotal()

priceTotal()方法可以用来获取购物车中所有商品在应用折扣和税额之前的价格总和。

Cart::priceTotal();

该方法返回根据默认数字格式四舍五入的结果，但您可以使用三个可选参数进行微调。

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

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

如果你没有使用外观模式，而是在（例如）控制器中使用依赖注入，你也可以简单地获取初始属性$cart->initial

Cart::count()

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

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

Cart::search()

要查找购物车中的商品，你可以使用search()方法。

此方法在版本2中进行了更改

在幕后，该方法简单地使用了Laravel集合类的filter方法。这意味着你必须传递一个闭包，在其中指定你的搜索条件。

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

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

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

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

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

Cart::setTax($rowId, $taxRate)

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

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

Cart::setGlobalTax($taxRate)

你可以使用setGlobalTax()方法来更改购物车中所有商品的税率。新项目也将收到setGlobalTax。

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

Cart::setGlobalDiscount($discountRate)

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

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

Cart::setDiscount($rowId, $taxRate)

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

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;
    }
    public function getBuyableWeight($options = null) {
        return $this->weight;
    }
}

集合

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

模型

因为可以直接从购物车项访问模型，所以可以将模型与购物车中的项目相关联。假设您在应用程序中有一个Product模型。使用associate()方法，您可以告诉购物车购物车中的项目与Product模型相关联。

这样，您就可以直接从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的表。您可以在配置中更改这些设置。

为了让您的生活更轻松，该包还包括一个可用的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');

合并购物车

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

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

删除购物车

如果您想从数据库中删除购物车，只需调用 erase($identifier) 即可，其中 $identifier 是您为 store 方法指定的键。

Cart::erase('username');

// To erase a cart switching to an instance named 'wishlist'
Cart::instance('wishlist')->erase('username');

计算器

包裹的计算逻辑已在 Calculator 类中实现和定义。这些类实现了 Gloudemans\Shoppingcart\Contracts\Calculator 接口，并确定如何计算和四舍五入价格。计算器可以在配置文件中进行配置。这是默认计算器

<?php

namespace Gloudemans\Shoppingcart\Calculation;

use Gloudemans\Shoppingcart\CartItem;
use Gloudemans\Shoppingcart\Contracts\Calculator;

class DefaultCalculator implements Calculator
{
    public static function getAttribute(string $attribute, CartItem $cartItem)
    {
        $decimals = config('cart.format.decimals', 2);

        switch ($attribute) {
            case 'discount':
                return $cartItem->price * ($cartItem->getDiscountRate() / 100);
            case 'tax':
                return round($cartItem->priceTarget * ($cartItem->taxRate / 100), $decimals);
            case 'priceTax':
                return round($cartItem->priceTarget + $cartItem->tax, $decimals);
            case 'discountTotal':
                return round($cartItem->discount * $cartItem->qty, $decimals);
            case 'priceTotal':
                return round($cartItem->price * $cartItem->qty, $decimals);
            case 'subtotal':
                return max(round($cartItem->priceTotal - $cartItem->discountTotal, $decimals), 0);
            case 'priceTarget':
                return round(($cartItem->priceTotal - $cartItem->discountTotal) / $cartItem->qty, $decimals);
            case 'taxTotal':
                return round($cartItem->subtotal * ($cartItem->taxRate / 100), $decimals);
            case 'total':
                return round($cartItem->subtotal + $cartItem->taxTotal, $decimals);
            default:
                return;
        }
    }
}

异常

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

事件

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

示例

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

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

omnitask / shoppingcart

维护者

详细信息

README

LaravelShoppingcart

安装

更新

目录

重要提示

用法

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

Cart::count()

Cart::search()

Cart::setTax($rowId, $taxRate)

Cart::setGlobalTax($taxRate)

Cart::setGlobalDiscount($discountRate)

Cart::setDiscount($rowId, $taxRate)

Buyable

集合

实例

模型

数据库

配置

存储购物车

恢复购物车

合并购物车

删除购物车

计算器

异常

事件

示例

协作者

贡献者