gamefanpage/shoppingcart

Laravel购物车

2.8.6 2019-10-20 03:29 UTC

README

Build Status codecov StyleCI Total Downloads Latest Stable Version Latest Unstable Version License

这是Crisane的LaravelShoppingcart的一个分支,增加了与Laravel 6兼容的少量功能。

安装

通过使用Composer进行安装。

从终端运行Composer require命令

composer require bumbummen99/shoppingcart

现在您可以使用购物车功能了。

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

概述

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

使用方法

购物车提供了以下方法供您使用

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()方法将返回您刚刚添加到购物车的商品实例。

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

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

在包的2.0版本中新增加了使用可购买接口的功能。这是通过让模型实现可购买接口来实现的,这样您就需要实现一些方法,以便包知道如何从您的模型中获取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

如果您想更新商品的其他属性,您可以将数组或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()

如果您想通过行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);

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

如果您没有使用外观(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::initial();

此方法将自动格式化结果,您可以使用三个可选参数进行修改。

Cart::initial($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;
});

如您所见,闭包将接收两个参数。第一个是要执行检查的购物项。第二个参数是该购物项的行ID。

此方法将返回一个包含所有找到的购物项的集合

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

Cart::setTax($rowId, $taxRate)

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

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()方法来更改应用于购物项的折扣率。请注意,如果您之后为购物车设置了全局折扣,此值将发生变化。

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

可购买

为了方便快速将项目添加到购物车并自动关联,您的模型必须实现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;
    }
}

集合

在多个实例中,购物车将返回给您一个集合。这只是一个简单的 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的表。如果您想更改这些选项,您必须发布配置文件。

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

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

为了使您的生活更轻松,该包还包括一个可用的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方法指定的密钥。您还可以定义是否保留商品折扣和税率。

// Merge the contents of 'savedcart' into 'username'.
Cart::instance('username')->merge('savedcart', $keepDiscount, $keepTaxrate);

异常

如果出现错误,Cart包将抛出异常。这样就可以更容易地使用Cart包调试代码或根据异常类型处理错误。Cart包可以抛出以下异常

事件

购物车还内置了事件。有五个事件可供您监听。

示例

以下是如何在表格中列出购物车内容的简单示例

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