rkwebsolution/laravel-cart-manager

轻松管理 Laravel 应用程序的购物车

dev-master 2021-05-02 21:48 UTC

This package is auto-updated.

Last update: 2024-09-29 05:42:55 UTC


README

Latest Stable Version Total Downloads License StyleCI Build Status Buy us a tree

购物车管理器(Laravel 5.5+)

让我们轻松实现 Laravel 的购物车管理。

这只是另一个购物车包吗?

虽然有一些维护良好的购物车包可用,但我想要一个感觉像 “Laravel 风格” 的解决方案,它与数据库耦合更紧密,并提供诸如 运费折扣税费总计四舍五入访客购物车 等功能,同时仍然非常易于使用。

何时/为什么使用?

让我们决定何时使用此包

  1. 您正在寻找一个易于使用的解决方案,该方案为用户和访客提供购物车功能。
  2. 您想确保购物车可以通过 API 使用,以支持移动应用程序。
  3. 您想要诸如运费、税费、折扣、四舍五入等功能。
  4. 您想将购物车数据存储在数据库、会话或自定义位置。
  5. 您喜欢使用更像是 “Laravel 风格” 的包。

要求

  • PHP 7.2.5+
  • Laravel 5.5+

注意:

  • 如果您仍在使用 PHP <7.2.5 和 <Laravel 6.x,您可以使用此包的 v1.2.0 版本。

安装

1) 在您的终端/命令提示符中运行此命令以安装包

composer require rkwebsolution/laravel-cart-manager

2) 在您的终端/命令提示符中运行此命令以导入配置文件

php artisan vendor:publish --tag=laravel-cart-manager-config

3) 在您的终端/命令提示符中运行以下命令以导入迁移文件

php artisan vendor:publish --tag=laravel-cart-manager-migrations
php artisan migrate

4) 将一个特质添加到购物车项的模型中

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Rkwebsolution\LaravelCartManager\Traits\Cartable;

class Product extends Model
{
    use Cartable;
    // ...
}

使用方法 - 简单如 1 2 3

// Add to cart
$cart = Product::addToCart($productId);

// Remove from cart
$cart = cart()->removeAt($cartItemIndex);

// Apply discount
$cart = cart()->applyDiscount($percentage);

// Fetch cart
$cart = cart()->toArray();

在线演示

此包的演示可以在以下位置找到 - https://laravel-cart-manager.freshbits.in

要求

PHP 7.0.0+ Laravel 5.5+

目录

配置选项

cart_manager.php 文件包含以下配置选项

  1. driver : (默认: DatabaseDriver) 应用于存储和检索购物车详情的 驱动器。您可以使用现有的或创建自己的。

  2. auth_guard : (默认: web) 应用于识别登录客户的身份验证守卫。此包可以存储访客用户和登录用户的购物车。

  3. shipping_charges : (默认: 10) 应应用于订单的运费金额。

  4. shipping_charges_threshold : (默认: 100) 避免运费的最小订单金额。请注意,订单金额是购物车项的小计减去折扣金额。

  5. tax_percentage : (默认: 6%) 税费应用于购物车项的小计减去折扣金额加上运费,并四舍五入到两位小数。

  6. round_off_to : (默认: 0.05) 您可能希望将订单金额四舍五入到最接近的小数点。选项为(0 或 0.05 或 0.1 或 0.5 或 1)

  7. cookie_name : (默认: cart_identifier) 此包存储以识别 Web 应用程序的访客并存储其购物车数据。

  8. cookie_lifetime : (默认: 1 week) 购物车cookie在客户浏览器中有效的分钟数。

  9. LC_MONETARY : (默认: en_US.UTF-8) 此选项用于以货币符号显示购物车的各项总计。我们使用PHP的本地money_format()函数来显示货币金额。

  10. cart_data_validity : (默认: 1周) (仅数据库驱动) 您可能希望从数据库中删除旧的/无效的购物车数据。您可以指定有效期并运行/计划ClearCartDataCommand

⬆ 返回顶部

驱动器

您可以在cart_manager.php配置文件中设置用于存储和检索购物车详情的驱动程序。您可以使用现有的驱动程序或创建自己的驱动程序。

数据库驱动程序

数据库驱动程序将购物车数据存储在2个表中:cartscart_items。您也可以通过运行ClearCartDataCommand来删除陈旧的数据。

使用此驱动程序允许您在服务器上存储购物车数据,客户可以在移动应用、网站等各个渠道中查看相同的购物车。

会话驱动程序

此驱动程序根据会话驱动程序将购物车数据存储在会话中。此驱动程序不支持通过API对访客进行购物车管理,因为我们无法以统一的方式跟踪用户。

⬆ 返回顶部

购物车管理

所有这些操作都会返回包含商品的完整购物车数据。

添加到购物车

/**
 * Add to cart
 *
 * @return json
 */
 public function addToCart()
{
    return Product::addToCart(request('productId'));
}

从购物车中删除

/**
 * Remove from cart
 *
 * @return json
 */
public function removeFromCart()
{
    return cart()->removeAt(request('cartItemIndex'));
}

增加/减少购物车项目的数量

/**
 * Increment cart item quantity
 *
 * @return json
 */
public function incrementCartItem()
{
    return cart()->incrementQuantityAt(request('cartItemIndex'));
}

/**
 * Decrement cart item quantity
 *
 * @return json
 */
public function decrementCartItem()
{
    return cart()->decrementQuantityAt(request('cartItemIndex'));
}

清空购物车

/**
 * Clear Cart
 *
 * @return json
 */
public function clearCart()
{
    return cart()->clear();
}

⬆ 返回顶部

获取购物车数据

获取完整的购物车详情

$cart = cart()->toArray();

获取购物车属性

$cartAttributes = cart()->data();

获取包含货币金额的购物车属性

$cartTotals = cart()->totals();

获取购物车单个属性

购物车具有以下属性:subtotaldiscountdiscountPercentagecouponIdshippingChargesnetTotaltaxtotalroundOffpayable

您可以使用getter方法访问它们中的任何一个。例如,

$subtotal = cart()->getSubtotal();

获取购物车项目

$cartItems = cart()->items();

获取包含货币金额的购物车项目

$cartItems = cart()->items($displayCurrency = true);

⬆ 返回顶部

折扣

应用百分比折扣

$cart = cart()->applyDiscount($percentage);

应用固定折扣

$cart = cart()->applyFlatDiscount($discountAmount);

⬆ 返回顶部

商品价格更新

由于此包将购物车项的详细信息存储在单独的表或会话中,因此更新购物车项的价格、名称或图像时,购物车数据不会更新。

如果您定期更新任何项目详情,我们建议在最终结账前运行以下代码,以确保订单总计与最新价格一致。

cart()->refreshAllItemsData();

此代码将遍历每个购物车项并更新为最新详情。

⬆ 返回顶部

与 API 一起使用

注意:此功能仅适用于数据库驱动程序。

此包使用cookie和会话在页面重新加载期间维护购物车数据。由于API是无状态的,我们无法使用它们来完成同样的任务。

要解决这个问题,您可以手动设置认证用户ID以维护购物车数据。

cart()->setUser($userId);

运行此代码将告诉包将购物车数据分配给指定的用户。

注意:访客无法通过API管理他们的购物车,因为我们无法以统一的方式跟踪用户。

⬆ 返回顶部

事件

与Laravel一起工作,怎么能忘记事件呢?

此包会触发各种与购物车相关的事件,您可以在应用更新时监听这些事件。

  1. CartCreated -> 当会话首次创建购物车时触发,变量$cartData包含完整的购物车数据。

  2. CartItemAdded -> 当项目被添加到购物车时触发,变量$entity包含新的Eloquent模型对象。

  3. CartItemRemoved -> 当项目从购物车中被移除时触发,变量$entity包含新的Eloquent模型对象。

  4. DiscountApplied -> 当折扣应用于购物车时触发,变量$cartData包含完整的购物车数据。

  5. CartCleared -> 当购物车被清空时触发。

示例用法

EventServiceProvider类中添加事件和监听器条目

protected $listen = [
	'Rkwebsolution\LaravelCartManager\Events\CartCreated' => [
		'App\Listeners\LogCartCreated',
	],
];

创建相应的监听器

<?php

namespace App\Listeners;

use Illuminate\Support\Facades\Log;
use Rkwebsolution\LaravelCartManager\Events\CartCreated;

class LogCartCreated
{
	/**
	 * Handle the event.
	 *
	 * @param CartCreated $event
	 * @return void
	 */
	public function handle(CartCreated  $event)
	{
		Log::info('cart', [$event->cartData]);
	}
}

⬆ 返回顶部

命令

注意:此操作仅适用于数据库驱动程序。

您可能希望从数据库中删除旧的/无效的购物车数据。

为同一目的安排 ClearCartDataCommand。

protected function schedule(Schedule $schedule)
{
    $schedule->command('lcm_carts:clear_old')->daily();
}

这将删除基于 cart_data_validity 配置选项考虑的旧/无效数据。

⬆ 返回顶部

测试

运行此命令以运行软件包的测试

composer test

许可证

本项目采用 MIT 许可证 - 有关详细信息,请参阅 LICENSE 文件

Treeware

您可自由使用此软件包,但如果它进入您的生产环境,我将非常感谢您为世界买一棵树。

众所周知,应对气候危机并保持我们的温度不超过 1.5C 的最佳工具之一是 植树。如果您为我们的森林做出贡献,您将创造当地家庭的工作机会并恢复野生动物栖息地。

您可以在offset.earth/treeware为我们森林购买树木

更多关于 Treeware 的信息请访问 treeware.earth

特别感谢