README

由于某些个人和公司在理解MIT许可证的copyleft条款时遇到困难，并由此导致未经授权地重新许可我的作品和其他作品，我决定终止对该仓库的进一步开发和协助。鉴于此包旨在用于电子商务项目，预计您将能够为您的解决方案开发和提供必要的资源。

LaravelShoppingcart

这是Crinsane的LaravelShoppingcart的分支，扩展了一些与Laravel 8+兼容的微小特性。示例集成可以在这里找到。

安装

通过Composer安装此包。

从终端运行Composer require命令

composer require mdzahid-pro/shoppingcart

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

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

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

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

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

更新

从版本4.2.0开始，当与PostgreSQL一起使用时，由于保存包含零字节的值的问题，此包会将购物车内容编码为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()方法将返回您刚刚添加到购物车的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']);

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

当添加多个项目到购物车时，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方法的地方。此方法将返回一个CartItems集合，您可以遍历它并向您的客户展示内容。

Cart::content();

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

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

Cart::destroy()

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

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

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

如果您没有使用外观（Facade），而是在（例如）控制器中使用依赖注入，您也可以直接获取税率属性 $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。

该方法将返回一个包含所有找到的 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 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 访问您的模型！

您可以通过 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>

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

集合

实例

模型

数据库

配置

存储购物车

恢复购物车

合并购物车

删除购物车

计算器

异常

事件

示例

合作者

贡献者