README

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

LaravelShoppingcart

这是Bumbummen99的LaravelShoppingcart的一个分支，增加了与Laravel 10+兼容的少量功能。

安装

通过Composer安装此包。

在终端中运行Composer require命令

composer require ilasisi/laravel-shopping-cart

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

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

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

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

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

重要提示

由于所有包含计算包括税和折扣的价格的购物车，这个模块也可能受到“总价舍入问题”的影响（*），这是由于价格和结果使用的小数精度。为了避免（或至少最小化）这个问题，在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()方法将返回您刚刚添加到购物车的项目的CartItem实例。

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

Cart::add(['id' => '293ad', 'name' => 'Product 1', 'qty' => 1, 'price' => 9.99, 'weight' => 550, 'options' => ['size' => 'large']]);

本软件包版本2新增了与可购买界面的兼容性。其工作原理是，你需要让模型实现可购买接口，这将使你实现一些方法，从而使软件包知道如何从模型中获取id、名称和价格。这样，你只需将模型和数量传递给add()方法，它就会自动将其添加到购物车。

作为额外的福利，它将自动将模型与购物项关联。

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

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

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

最后，你也可以一次性将多个项目添加到购物车。你可以将一个数组（数组的数组）或一个可购买的数组传递给add()方法，它们将被添加到购物车。

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

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方法的地方。此方法将返回一个购物项集合，你可以遍历并显示给客户。

Cart::content();

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

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

Cart::destroy()

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

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

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

如果您没有使用外观模式，而是在（例如）控制器中使用依赖注入，您也可以简单地获取小计属性 $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 Collection 类的 filter 方法。这意味着您必须传递一个闭包，在闭包中指定您的搜索条件。

例如，如果您想找到所有 id 为 1 的商品

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

如您所见，闭包将接收两个参数。第一个是要检查的商品项。第二个参数是此商品项的行号。

此方法将返回一个包含找到的所有 CartItems 的 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::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;
    }
}

集合

在多个实例中，购物车将返回一个 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() 相同。

模型

因为能够直接从购物车项访问模型是非常方便的，所以可以将模型与购物车中的项关联起来。假设您在应用程序中有一个 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 的表。您可以在配置中更改这些设置。

为了使您的生活更加轻松，该软件包还包括一个现成的 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>

ilasisi / laravel-shopping-cart

维护者

详细信息

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

集合

实例

模型

数据库

配置

存储购物车

恢复购物车

合并购物车

删除购物车

计算器

异常

事件

示例

合作者

贡献者