 |
VOOZH | about |
|
VOOZH | about |
The Product Management System is the core catalog management component of GP247/Shop, providing comprehensive functionality for organizing and managing product data. This system encompasses four primary entities: Products, Categories, Brands, and Suppliers, along with their supporting models for multilingual descriptions, images, attributes, and store associations.
This page provides an overview of the catalog architecture and entity relationships. For detailed information on specific components, see:
The product catalog is organized around four core entities with supporting models for descriptions, relationships, and metadata.
Sources: src/Models/ShopProduct.php40-87 src/Models/ShopCategory.php23-35
| Table | Purpose | Key Fields |
|---|---|---|
shop_product | Main product records | id, sku, alias, price, stock, kind, brand_id, supplier_id |
shop_category | Hierarchical categories | id, alias, parent, top, sort, status |
shop_brand | Product brands | id, name, alias, image, status |
shop_supplier | Product suppliers | id, name, alias, email, phone, store_id |
shop_product_category | Product-category M:N | product_id, category_id |
shop_product_store | Product-store M:N | product_id, store_id |
shop_product_description | Product i18n content | product_id, lang, name, description, content |
shop_category_description | Category i18n content | category_id, lang, title, description |
shop_product_image | Product image gallery | product_id, image, sort |
shop_product_attribute | Product attributes | product_id, attribute_group_id, name, add_price |
shop_product_promotion | Promotional pricing | product_id, price_promotion, date_start, date_end |
shop_product_build | Bundle components | build_id, product_id, quantity |
shop_product_group | Product variants | group_id, product_id |
Sources: src/Models/ShopProduct.php22 src/Models/ShopCategory.php16
The ShopProduct model src/Models/ShopProduct.php17-939 is the central entity in the catalog system, storing product information, pricing, inventory, and relationships.
Products are classified by the kind field src/Models/ShopProduct.php27:
| Kind | Constant | Description | Implementation |
|---|---|---|---|
| 0 | GP247_PRODUCT_SINGLE | Single standalone product | Standard product with stock tracking |
| 1 | GP247_PRODUCT_BUILD | Product bundle | Collection of products sold together; stock updates cascade to components src/Models/ShopProduct.php409-416 |
| 2 | GP247_PRODUCT_GROUP | Product group | Variants of the same product (e.g., different sizes/colors) |
Products are further classified by the tag field src/Models/ShopProduct.php28:
| Tag | Type | Description |
|---|---|---|
| 0 | Physical | Tangible products requiring shipping |
| 1 | Download | Digital downloadable products |
| 2 | View Only | Display-only products (not purchasable) |
| 3 | Service | Service-based offerings |
| Method | Purpose | Location |
|---|---|---|
getDetail($key, $type, $storeId, $checkActive) | Retrieve single product with all relationships | src/Models/ShopProduct.php192-258 |
getFinalPrice() | Calculate effective price (regular or promotional) | src/Models/ShopProduct.php115-123 |
allowSale() | Determine if product can be purchased | src/Models/ShopProduct.php358-377 |
updateStock($product_id, $qty_change) | Update stock and sold counts | src/Models/ShopProduct.php399-418 |
buildQuery() | Build filtered product query | src/Models/ShopProduct.php703-868 |
The ShopProduct model defines these Eloquent relationships src/Models/ShopProduct.php40-87:
For detailed product business logic, pricing, and query operations, see Product Model and Business Logic
Sources: src/Models/ShopProduct.php17-939
The ShopCategory model src/Models/ShopCategory.php10-298 provides hierarchical organization for products using a parent-child tree structure.
Categories form a three-level hierarchy:
Sources: src/Models/ShopCategory.php20-22 src/Models/ShopCategory.php291-296
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Auto-generated unique identifier |
alias | string | URL-friendly slug for routing |
image | string | Category thumbnail image path |
parent | string | Parent category ID (null/empty = root) |
top | boolean | Display in top navigation (1=yes) |
status | boolean | Active status (1=active) |
sort | integer | Display order within parent |
Sources: src/Models/ShopCategory.php16-22
| Method | Purpose | Location |
|---|---|---|
getDetail($key, $type, $checkActive) | Retrieve category with descriptions | src/Models/ShopCategory.php126-156 |
getListSub($cId) | Get all subcategory IDs recursively | src/Models/ShopCategory.php291-296 |
getCategoryRoot() | Filter to root categories only | src/Models/ShopCategory.php195-199 |
getCategoryTop() | Filter to top navigation categories | src/Models/ShopCategory.php202-208 |
buildQuery() | Build filtered category query | src/Models/ShopCategory.php213-282 |
Sources: src/Models/ShopCategory.php23-35
The AdminCategoryController src/Admin/Controllers/AdminCategoryController.php10-407 provides CRUD operations:
index() - List all categories with tree structure src/Admin/Controllers/AdminCategoryController.php20-153create() / postCreate() - Create new category src/Admin/Controllers/AdminCategoryController.php159-257edit($id) / postEdit($id) - Update existing category src/Admin/Controllers/AdminCategoryController.php262-371deleteList() - Bulk delete categories src/Admin/Controllers/AdminCategoryController.php377-397Categories support multilingual descriptions, multi-store assignment, custom fields, and SEO metadata.
For detailed category operations and frontend display, see Category Management
Sources: src/Models/ShopCategory.php10-298 src/Admin/Controllers/AdminCategoryController.php10-407
The ShopBrand model represents product manufacturers or brand identities. While the model file is not included in the provided sources, it follows the same architectural patterns as products and categories.
Brands contain these core fields:
| Field | Description |
|---|---|
id | Auto-generated UUID identifier |
name | Brand display name |
alias | URL-friendly slug |
image | Brand logo image path |
url | External brand website |
sort | Display order |
status | Active status (1=active) |
Brands support multi-store assignment and can be filtered in product queries. Products optionally belong to a single brand via the brand_id foreign key src/Models/ShopProduct.php40-43
Sources: src/Models/ShopProduct.php40-43 src/Commands/ShopSample.php433-467
The ShopSupplier model represents vendors or suppliers that provide products. Suppliers are store-specific entities used in multi-vendor scenarios.
| Field | Description |
|---|---|
id | Auto-generated UUID identifier |
name | Supplier display name |
alias | URL-friendly slug |
email | Contact email address |
phone | Contact phone number |
image | Supplier logo image path |
address | Physical address |
url | External supplier website |
store_id | Associated store (for multi-vendor) |
sort | Display order |
status | Active status (1=active) |
Products optionally belong to a single supplier via the supplier_id foreign key src/Models/ShopProduct.php45-48
Sources: src/Models/ShopProduct.php45-48 src/Commands/ShopSample.php469-515
All catalog entities support internationalization through separate description tables.
Sources: src/Models/ShopProduct.php71-110 src/Models/ShopCategory.php32-53
All entities provide consistent methods for accessing localized content:
| Method | Purpose | Location |
|---|---|---|
getText() | Get description record for current locale | src/Models/ShopProduct.php90-93 |
getName() / getTitle() | Get localized name/title | src/Models/ShopProduct.php94-97 |
getDescription() | Get short description | src/Models/ShopProduct.php98-101 |
getKeyword() | Get SEO keywords | src/Models/ShopProduct.php102-105 |
getContent() | Get full HTML content (products only) | src/Models/ShopProduct.php106-109 |
The current locale is determined by gp247_get_locale() and automatically filters description queries throughout the system.
Sources: src/Models/ShopProduct.php89-110 src/Models/ShopCategory.php36-53
The catalog system implements a hybrid multi-tenant architecture where products, categories, and brands can be shared or isolated across stores.
Sources: src/Models/ShopProduct.php58-61 src/Models/ShopProduct.php713-739 src/Models/ShopCategory.php27-30
Product and category queries automatically apply store filters when multi-store is enabled:
Key Implementation Points:
store_id columns; they use junction tables for M:N relationships src/Models/ShopProduct.php58-61buildQuery() methods automatically join and filter by store src/Models/ShopProduct.php714-730config('app.storeId') == GP247_STORE_ID_ROOT, all stores' products are accessible src/Models/ShopProduct.php207-211Sources: src/Models/ShopProduct.php58-61 src/Models/ShopProduct.php703-741 src/Models/ShopCategory.php231-238
The system includes a comprehensive sample data generator for testing and demonstration purposes.
The gp247:shop-sample command src/Commands/ShopSample.php20-633 creates a complete sample catalog:
Generated Data:
| Entity | Count | Details |
|---|---|---|
| Categories | 16 | 4 root categories with 3 subcategories each |
| Brands | 3 | Nike, Adidas, Puma |
| Suppliers | 3 | ABC Corp, XYZ Inc, DEF Ltd |
| Products (Single) | 36 | 3 per subcategory with promotions |
| Products (Bundle) | 3 | Bundles of single products |
| Products (Group) | 3 | Product variants |
Category Structure Example:
Ẩm thực (Food)
├── Phở Nam Định
├── Nem chua Thanh Hóa
└── Bún Chả Hà Nội
Du lịch (Travel)
├── Vịnh Hạ Long
├── Động Phong Nha
└── Tràng An
Văn hóa (Culture)
├── Gốm Bát Tràng
├── Tranh Đông Hồ
└── Chiếu cói Nga Sơn
Trái cây (Fruits)
├── Trái Cây Nam Bộ
├── Vải Thiều
└── Nhãn Lồng
Sources: src/Commands/ShopSample.php59-632
Usage:
This command is useful for:
Sources: src/Commands/ShopSample.php20-633
The Product Management System supports multiple languages through dedicated description tables.
Sources: src/Models/ShopProduct.php71-110 src/Models/ShopCategory.php32-53
The multi-language system:
Key language-related methods:
getText(): Retrieves the description record for the current languagegetName(), getDescription(), etc.: Convenience methods to directly access translated fieldsSources: src/Models/ShopProduct.php89-110 src/Models/ShopCategory.php36-53
The Product Management System in the GP247/Shop platform provides a comprehensive set of models, relationships, and methods for managing all aspects of product data. From basic product information to complex pricing, categorization, and multi-store support, the system is designed to be flexible, efficient, and feature-rich.
This system forms the foundation of the shop's catalog functionality and integrates with other systems such as the Shopping Cart, Order Processing, and Frontend Display components.
For details on how products are displayed on the frontend, see Product Frontend Display.
Refresh this wiki