islamrumon/laravelshoppingcart

Laravel 购物车

维护者

详细信息

github.com/islamrumon/laravel-shopping-cart

源代码

问题

安装: 3

依赖: 0

建议者: 0

安全: 0

星级: 0

关注者: 1

分支: 0

开放性问题: 0

dev-main 2024-02-27 21:58 UTC

Requires

Requires (Dev)

Suggests

  • islamrumon/notify: Simple flash notifications for Laravel

MIT 92c8225da91f47136304f5cbb832e9067c2e7550

laravelshoppingcart

This package is auto-updated.

Last update: 2024-09-27 23:12:05 UTC

README

StyleCI Total Downloads Latest Stable Version Latest Unstable Version License

这是一个基于 Crinsane 的 LaravelShoppingcart 的分支，扩展了与 Laravel 7+ 兼容的少量功能。示例集成可以在 这里 找到。

安装

通过 Composer 安装此包。

在终端运行 Composer require 命令

composer require Islamrumon/laravelshoppingcart

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

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

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

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

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

目录

查看以下主题以了解有关 LaravelShoppingcart 的更多信息

重要提示

由于所有包括税费和折扣在内的购物车都可能会受到“总计舍入问题”的影响（*），这是由于价格和结果使用的十进制精度造成的。为了避免（或至少最小化）此问题，在 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 中新增了与 Buyable 接口一起工作的可能性。这是通过在模型中实现 Buyable 接口来工作的，这将使您实现一些方法，这样包就知道如何从您的模型中获取 id、名称和价格。这样，您只需将模型和数量传递给 add() 方法，它就会自动将其添加到购物车。

作为额外的奖励，它将自动将模型与 CartItem 关联

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

要更新购物车中的项目，您首先需要项目的行ID。然后您可以使用 update() 方法来更新它。

如果您只想更新数量，您将行ID和新的数量传递给更新方法

$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 作为第二个参数传递给更新方法。这样，您就可以使用给定的行ID更新所有信息。

Cart::update($rowId, ['name' => 'Product 1']); // Will update the name

Cart::update($rowId, $product); // Will update the id, name and price

Cart::remove()

要从购物车中删除项目，您还需要行ID。您只需将此行ID传递给 remove() 方法，它就会从购物车中删除该项目。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::remove($rowId);

Cart::get()

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

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

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

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

Cart::total()

使用 total() 方法可以获取所有项目的计算总金额，给定其价格和数量。

Cart::total();

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

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

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

如果您没有使用外观，而是在控制器（例如）中使用依赖注入，您也可以简单地获取总属性 $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);

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

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

Cart::count()

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

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

Cart::search()

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

此方法在版本2中已更改

在幕后，该方法简单地使用 Laravel Collection 类的过滤器方法。这意味着您必须传递一个闭包，在其中指定您要搜索的术语。

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

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

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

该方法将返回一个包含所有找到的 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 Islamrumon\Shoppingcart\Contracts\Buyable;
use Illuminate\Database\Eloquent\Model;

class Product extends Model implements Buyable {
    use Islamrumon\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 Islamrumon\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 Islamrumon\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="Islamrumon\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 类中实现和定义。这些类实现了 Islamrumon\Shoppingcart\Contracts\Calculator 合约，并确定了价格是如何计算和四舍五入的。计算器可以在配置文件中进行配置。这是默认的计算器

<?php

namespace Islamrumon\Shoppingcart\Calculation;

use Islamrumon\Shoppingcart\CartItem;
use Islamrumon\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>

协作者

贡献者