 |
VOOZH | about |
|
VOOZH | about |
This document provides a high-level overview of the GP247/Shop e-commerce package, explaining its role within the GP247 ecosystem, architectural design, and core subsystems. GP247/Shop transforms a GP247-based application into a full-featured online store with product catalog management, order processing, customer accounts, and extensible payment/shipping integrations.
For detailed information about specific subsystems, see:
Sources: readme.md1-128 readme_vi.md1-135
GP247/Shop is a Laravel package that builds upon the GP247 ecosystem foundation. It requires gp247/core and gp247/front as dependencies and integrates through Laravel's service provider pattern.
Sources: readme.md14-17 readme_vi.md19-20
The package can be installed in two ways:
| Installation Method | Components Included | Primary Use Case |
|---|---|---|
| Option 1: Modular | composer require gp247/shop added to gp247/cms | Custom integration, selective features |
| Option 2: Full Stack | composer create-project gp247/s-cart | Complete e-commerce site, rapid deployment |
Sources: readme.md66-100 readme_vi.md69-108
GP247/Shop follows five core architectural principles that enable flexibility, scalability, and extensibility:
The ShopServiceProvider class acts as the integration hub, registering all package components with the Laravel application container. This includes middleware, commands, view namespaces, translations, and configuration files.
Sources: readme.md75-81 readme_vi.md78-85
Rather than hardcoding business rules, the system stores configurations in the admin_config table with a hierarchical group/code/key structure. This allows different stores to have different behaviors without code modifications.
| Configuration Group | Controls | Example Keys |
|---|---|---|
admin_config | Admin panel settings | ADMIN_NAME, ADMIN_TITLE, ADMIN_LOGO |
display_config | Product display rules | product_top, product_list, product_detail |
captcha_config | CAPTCHA requirements | captcha_mode, captcha_method |
email_config | Email triggers | email_action_new_order, email_action_register |
order_config | Order validation | Customer field requirements, checkout behavior |
Configurations are accessed via helper functions: gp247_config($key, $default) and gp247_config_admin($key, $default).
Sources: readme.md20-63 readme_vi.md23-66
The system supports two tenant modes: root store (marketplace administrator with omniscient access) and vendor stores (isolated access to own data).
Sources: readme.md46-50 readme_vi.md49-53
Plugins extend functionality at critical junctures: payment processing, shipping calculation, and order total calculation. The system discovers plugins dynamically from the admin_config table.
Sources: readme.md36-43 readme_vi.md39-46
The database schema organizes 39 tables into four logical domains:
| Domain | Tables | Isolation Strategy |
|---|---|---|
| Catalog | shop_product, shop_category, shop_brand, shop_supplier, etc. | Junction tables (shop_product_store, shop_category_store) |
| Transactions | shop_order, shop_order_detail, shop_order_history, shop_order_total, shop_shoppingcart | Direct store_id column |
| Customers | shop_customer, shop_customer_address | Direct store_id column |
| Reference | shop_currency, shop_order_status, shop_payment_status, shop_shipping_status, shop_tax | Shared (no isolation) |
Sources: readme.md21-25 readme_vi.md24-28
GP247/Shop organizes code into subsystems that correspond to business domains. Each subsystem includes models, controllers (admin/front), and views.
Sources: readme.md20-50 readme_vi.md23-53
| Directory | Purpose | Key Files |
|---|---|---|
src/DB/Migrations/ | Database table definitions | 39 migration files defining schema |
src/DB/Seeders/ | Initial data population | DataShopInitializeSeeder, DataShopDefaultSeeder |
src/Models/ | Eloquent models | ShopProduct, ShopOrder, ShopCustomer, ShopCategory, etc. |
src/Admin/Controllers/ | Admin panel controllers | AdminProductController, AdminOrderController, etc. |
src/Front/Controllers/ | Frontend controllers | ShopProductController, ShopCartController, etc. |
src/Api/Controllers/ | REST API endpoints | MemberAuthController, UserController |
src/Admin/Middleware/ | Admin middleware | AdminAuthenticate, AdminPermission, AdminStoreId |
src/Front/Middleware/ | Frontend middleware | Currency, EmailVerified, FrontStoreId |
src/Service/ | Business logic services | CartService |
src/Library/ | Utility libraries | Helpers/, Mapping/ |
Views/admin/ | Admin panel views | Blade templates for admin interface |
Views/front/ | Frontend views | Blade templates for store frontend |
config/ | Configuration files | gp247_config.php |
lang/ | Translations | Multi-language support files |
Sources: readme.md106-122 readme_vi.md113-130
When the package is installed and registered, the following initialization sequence occurs:
Sources: readme.md72-87 readme_vi.md75-93
| Command | Purpose |
|---|---|
gp247:shop-install | Run migrations and seeders to initialize shop database and configuration |
gp247:shop-sample | Populate database with sample products, categories, and orders for testing |
gp247:shop-uninstall | Remove shop tables and configurations (destructive) |
Sources: readme.md84-87 readme_vi.md89-93
GP247/Shop delivers comprehensive e-commerce capabilities across multiple functional areas:
| Feature Area | Capabilities | Admin Controllers | Frontend Controllers |
|---|---|---|---|
| Product Catalog | Categories, attributes, variants, inventory, bulk import/export | AdminProductController, AdminCategoryController, AdminAttributeGroupController | ShopProductController, ShopCategoryController, ShopBrandController |
| Order Processing | Order tracking, multiple payment gateways, shipping methods, status management | AdminOrderController, AdminOrderStatusController | ShopOrderController, ShopCartController |
| Customer Management | Profiles, addresses, order history, groups, discounts | AdminCustomerController | ShopAccountController, MemberAuthController |
| Marketing | Promotions, coupons, newsletters, reviews, ratings | AdminPromotionController, AdminNewsController | ShopNewsController |
| Shopping Experience | Cart, wishlist, comparison, recently viewed | N/A | ShopCartController |
| Multi-vendor | Vendor dashboard, commission management, vendor products/orders | AdminSupplierController, AdminReportController | N/A |
Sources: readme.md20-50 readme_vi.md23-53
The package inherits powerful CMS capabilities from the GP247 ecosystem:
Sources: readme.md52-62 readme_vi.md55-66
GP247/Shop provides multiple extension mechanisms for customization:
Views can be published and customized at two levels:
Sources: readme.md106-122 readme_vi.md113-130
Plugins can be added to extend functionality at three primary integration points:
| Plugin Type | Interface Methods | Use Cases |
|---|---|---|
| Shipping | getInfo(), endApp() | Custom shipping rate calculation, carrier integration, tracking |
| Payment | processOrder(), handleCallback() | Payment gateway integration, transaction processing |
| Total | processDataTotal() | Custom fees, tax calculation, loyalty point redemption |
Plugins are discovered dynamically via the admin_config table and must follow naming conventions (e.g., all plugins require an AppConfig class with defined interface methods).
Sources: readme.md27-33 readme_vi.md30-36
GP247/Shop requires the following technology stack:
| Component | Version/Requirement | Purpose |
|---|---|---|
| Laravel | 11.x | Application framework |
| PHP | ≥8.2 | Runtime environment |
| Database | MySQL 5.7+, MariaDB 10.3+, or PostgreSQL 10+ | Data persistence |
| gp247/core | ^9.0 | Core utilities and configuration system |
| gp247/front | ^9.0 | Frontend template system |
| Laravel Sanctum | ^4.0 | API authentication (for customer API) |
Sources: readme.md64-87 readme_vi.md67-93
For detailed information about specific subsystems and implementation details, refer to:
Sources: readme.md1-128 readme_vi.md1-135
Refresh this wiki