README

从 https://github.com/Crinsane/LaravelShoppingcart 为 CodeIgniter4 适配

为 CodeIgniter4 简单实现的购物车。

安装

通过 Composer 安装包。

从终端运行 Composer require 命令

composer require agungsugiarto/codeigniter4-shoppingcart

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

概述

查看以下主题之一，了解更多关于 CodeIgniter4 ShoppingCart 的信息

• 用法
• 集合
• 实例
• 模型
• 数据库
• 异常
• 事件
• 示例

用法

如何加载库的示例

// Via services
$cart = \Fluent\ShoppingCart\Config\Services::cart();
$cart->add();

// Traditional way
$cart = new \Fluent\ShoppingCart\Cart();
$cart->add();

// Static call
use Fluent\ShooppingCart\Facades\Cart;

Cart::add()

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

Cart::add()

添加商品到购物车非常简单，您只需使用 add() 方法，该方法接受各种参数。

在最基本的形式中，您可以指定要添加到购物车的商品的 id、名称、数量和价格。

Cart::add('293ad', 'Product 1', 1, 9.99);

作为可选的第五个参数，您可以传递选项，这样您就可以添加具有相同 id 但（例如）尺寸不同的多个商品。

Cart::add('293ad', 'Product 1', 1, 9.99, ['size' => 'large']);

add() 方法将返回一个 CartItem 实例，表示您刚刚添加到购物车的商品。

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

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

包的第 2 版新增了使用 Buyable 接口的可能性。这种方法的工作方式是，您有一个模型实现了 Buyable 接口，这将使您实现一些方法，以便包知道如何从您的模型中获取 id、名称和价格。这样，您只需将模型传递给 add() 方法以及数量，它就会自动将其添加到购物车。

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

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

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

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

最后，您还可以一次性将多个商品添加到购物车。您只需将数组或 Buyables 的数组传递给 add() 方法即可。

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

Cart::add([
  ['id' => '293ad', 'name' => 'Product 1', 'qty' => 1, 'price' => 10.00],
  ['id' => '4832k', 'name' => 'Product 2', 'qty' => 1, 'price' => 10.00, 'options' => ['size' => 'large']]
]);

Cart::add([$product1, $product2]);

Cart::update()

要更新购物车中的商品，您首先需要商品的 rowId。接下来，您可以使用 update() 方法来更新它。

如果您只想更新数量，您只需将 update 方法传递 rowId 和新数量即可。

$rowId = 'da39a3ee5e6b4b0d3255bfef95601890afd80709';

Cart::update($rowId, 2); // Will update the quantity

如果您想更新商品的更多属性，您可以将数组或 Buyable 作为第二个参数传递给 update 方法。这样，您可以更新给定 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方法。这将移除当前购物车实例中的所有CartItems。

Cart::destroy();

Cart::total()

total()方法可用于获取购物车中所有项目的计算总价，前提是知道其价格和数量。

Cart::total();

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

Cart::total($decimals, $decimalSeperator, $thousandSeperator);

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

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

Cart::taxt()

tax()方法可用于获取购物车中所有项目的计算税额，前提是知道其价格和数量。

Cart::taxt();

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

Cart::taxt($decimals, $decimalSeperator, $thousandSeperator);

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

如果您没有使用外观(Facade)，而是在您的控制器(例如)中使用依赖注入，您也可以简单地获取税属性$cart->tax

Cart::subtotal()

subtotal()方法可用于获取购物车中所有项目的总价，减去总税额。

Cart::subtotal();

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

Cart::subtotal($decimals, $decimalSeperator, $thousandSeperator);

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

如果您没有使用外观(Facade)，而是在您的控制器(例如)中使用依赖注入，您也可以简单地获取小计属性$cart->subtotal

Cart::count()

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

Cart::count();

Cart::search()

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

此方法在版本2中已更改

在幕后，该方法只是简单使用Laravel Collection类的filter方法。这意味着您必须传递一个闭包，在其中指定您的搜索条件。

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

$cart = Services::cart();

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

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

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

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

集合

在多个实例上，购物车将返回一个集合。这只是一个简单的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);

// Get the content of the 'shopping' cart
Cart::content();

Cart::instance('wishlist')->add('sdjk922', 'Product 2', 1, 19.95, ['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();

注意：购物车在脚本执行期间，如果没有设置不同的实例，将保持在最后一个实例中。

注意2：默认的购物车实例名为 default，因此当您不使用实例时，Cart::content(); 与 Cart::instance('default')->content() 是相同的。

模型

由于能够直接从购物车项访问模型非常方便，因此可以将模型与购物车中的项关联起来。假设您在应用程序中有一个 Product 模型。通过 associate() 方法，您可以告诉购物车，购物车中的某个项与 Product 模型相关联。

这样您就可以直接从 CartItem 访问您的模型了！

您可以通过购物车项上的 model 属性来访问模型。

如果您的模型实现了 Buyable 接口，并且您使用该模型将项添加到购物车中，它将自动关联。

以下是一个示例

// First we'll add the item to the cart.
$cartItem = Cart::add('293ad', 'Product 1', 1, 9.99, ['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, ['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 的表。如果您想更改这些选项，您必须发布 config 文件。

php spark config:publish

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

为了方便起见，该包还包含一个可立即使用的 migration，您可以通过运行以下命令来发布它：

php spark migrate -all

存储购物车

要将您的购物车实例存储到数据库中，您必须调用 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');

异常

如果发生错误，购物车包将抛出异常。这样，您就可以更容易地使用购物车包调试代码或根据异常类型处理错误。购物车包可以抛出以下异常

事件

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

示例

以下是一个如何在表中列出购物车内容的示例

// 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><?= $row->name; ?></strong></p>
               		<p><?= ($row->options->has('size') ? $row->options->size : ''); ?></p>
           		</td>
           		<td><input type="text" value="<?= $row->qty; ?>"></td>
           		<td>$<?= $row->price; ?></td>
           		<td>$<?= $row->total; ?></td>
       		</tr>

	   	<?php endforeach;?>

   	</tbody>
   	
   	<tfoot>
   		<tr>
   			<td colspan="2">&nbsp;</td>
   			<td>Subtotal</td>
   			<td><?= Cart::subtotal(); ?></td>
   		</tr>
   		<tr>
   			<td colspan="2">&nbsp;</td>
   			<td>Tax</td>
   			<td><?= Cart::tax(); ?></td>
   		</tr>
   		<tr>
   			<td colspan="2">&nbsp;</td>
   			<td>Total</td>
   			<td><?= Cart::total(); ?></td>
   		</tr>
   	</tfoot>
</table>

许可证

本软件包是免费软件，根据 MIT 许可证 的条款分发。