README

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

LaravelShoppingcart

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

安装

通过Composer安装此包。

从终端运行Composer require命令

composer require bumbummen99/shoppingcart

现在您已经准备好开始在您的应用程序中使用购物车。

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

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

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

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

更新

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

重要说明

由于所有包含税费和折扣的价格计算购物车，这个模块也可能受到“总计四舍五入问题”（*）的影响，因为价格和结果使用了小数精度。为了避免（或至少最小化）这个问题，在Laravel购物车包中，总计是使用“按行”方法计算的，并且已经根据config文件（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()方法将返回您刚刚添加到购物车的项目的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']);

最后，您还可以一次性将多个项目添加到购物车中。您可以仅传递一个数组数组给add()方法，或传递一个Buyables数组，它们将被添加到购物车中。

当添加多个项目到购物车时，add()方法将返回一个CartItem数组。

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方法的地方。此方法将返回一个CartItem集合，您可以遍历并展示给您的客户。

Cart::content();

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

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

Cart::destroy()

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

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

Cart::initial();

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

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

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

Cart::priceTotal()

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

Cart::priceTotal();

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

Cart::priceTotal($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 的行 ID。

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

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

Cart::setTax($rowId, $taxRate)

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

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

Cart::setGlobalTax($taxRate)

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

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

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

集合

实例

模型

数据库

配置

存储购物车

恢复购物车

合并购物车

清除购物车

计算器

异常

事件

示例

合作者

贡献者