README

这是一个Bumbummen99的LaravelShoppingcart的分支，兼容Laravel 10及以上。

安装

在终端运行Composer require命令

composer require mirbaagheri/laravel-cart

现在你可以开始在应用程序中使用购物车了。

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

php artisan vendor:publish --provider="Mirbaagheri\Cart\CartServiceProvider" --tag="config"

这将给你一个cart.php配置文件，你可以在这里修改包的行为。

目录

查看以下主题以了解更多关于Laravel购物车的信息

• 重要提示
• 使用方法
• 集合
• 实例
• 模型
• 数据库
• 计算器
• 异常
• 事件
• 示例
• 贡献者

重要提示

由于所有包括税费和折扣的价格计算在内的购物车，这个模块也可能受到“总价四舍五入问题”的影响（*），这是由于价格和结果使用的十进制精度。为了避免（或至少最小化）这个问题，在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']]);

从包的第二个版本开始，你可以使用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()

要删除购物车中的商品，同样需要行号。您只需将行号传递给remove()方法，它就会从购物车中删除该商品。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::remove($rowId);

Cart::get()

如果您想通过行号(rowId)从购物车中获取商品，可以在购物车上调用get()方法并传递行号。

$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::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 集合类的过滤器方法。这意味着您必须传递一个闭包，在闭包中您将指定搜索条件。

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

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

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

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

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

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 设置了全局折扣，此值将发生变化。

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

Buyable

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

<?php
namespace App\Models;

use Mirbaagheri\Cart\Contracts\Buyable;
use Illuminate\Database\Eloquent\Model;

class Product extends Model implements Buyable {
    use Mirbaagheri\Cart\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 Mirbaagheri\Cart\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 Mirbaagheri\Cart\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.';
}

数据库

• 配置
• 存储购物车
• 恢复购物车

配置

为了将购物车保存到数据库以便稍后检索，包需要知道要使用哪个数据库连接以及表的名称。默认情况下，包将使用默认的数据库连接并使用名为 cart 的表。你可以在配置中更改这些设置。

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

php artisan vendor:publish --provider="Mirbaagheri\Cart\CartServiceProvider" --tag="migrations"

这将把 cart 表的迁移文件放入 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 类中实现并定义。这些类实现了 Mirbaagheri\Cart\Contracts\Calculator 接口，并确定价格是如何计算和四舍五入的。计算器可以在配置文件中进行配置。这是默认的计算器

<?php

namespace Mirbaagheri\Cart\Calculation;

use Mirbaagheri\Cart\CartItem;
use Mirbaagheri\Cart\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>