 |
VOOZH | about |
|
VOOZH | about |
This document explains how the GP247/Shop package uses database seeders to populate initial system data and how configurations stored in the AdminConfig table drive system behavior at runtime. The shop system relies heavily on configuration-driven design, allowing administrators to control feature enablement, field visibility, validation rules, and business logic without code changes.
For information about the multi-store architecture that affects configuration scope, see Multi-Store and Multi-Vendor Architecture. For details on how configuration values control specific subsystems, see Configuration-Driven System Behavior.
The GP247/Shop package uses a two-phase initialization strategy to separate global system setup from store-specific configuration:
Sources: src/DB/seeders/DataShopInitializeSeeder.php16-28 src/DB/seeders/DataShopDefaultSeeder.php12-33
The DataShopInitializeSeeder runs once during package installation to establish the foundational data structures required by all stores. This seeder is idempotent and safe to run multiple times.
The seeder creates a hierarchical menu structure with six primary blocks:
Implementation: The seeder first deletes existing menu items src/DB/seeders/DataShopInitializeSeeder.php30-48 to ensure clean installation, then inserts the block structure src/DB/seeders/DataShopInitializeSeeder.php54-126 followed by leaf menu items src/DB/seeders/DataShopInitializeSeeder.php137-163
Sources: src/DB/seeders/DataShopInitializeSeeder.php30-163
The seeder populates several reference tables that define system-wide lookup values:
Two default currencies are inserted:
| ID | Code | Name | Symbol | Exchange Rate | Precision | Symbol First |
|---|---|---|---|---|---|---|
| 1 | USD | USD Dola | $ | 1 | 2 | 1 |
| 2 | VND | VietNam Dong | ₫ | 20000 | 0 | 0 |
Sources: src/DB/seeders/DataShopInitializeSeeder.php130-135
The seeder invokes private methods to populate three status types:
These statuses are used throughout the order lifecycle to track payment state, shipping progress, and overall order workflow.
Sources: src/DB/seeders/DataShopInitializeSeeder.php167-174
The seeder registers four dashboard components for the admin homepage:
Each component maps to a Blade view in the gp247-shop-admin::component namespace.
Sources: src/DB/seeders/DataShopInitializeSeeder.php178-193
The seeder inserts global configuration keys by calling dataConfigShop() method src/DB/seeders/DataShopInitializeSeeder.php196-197 This populates the AdminConfig table with system-level defaults that are not store-specific.
The seeder populates the Languages table with translations for menu items, form labels, and email templates. Each translation is stored with a unique code, position, and location (language code):
The seeder inserts translations for both Vietnamese (vi) and English (en) src/DB/seeders/DataShopInitializeSeeder.php200-256
Sources: src/DB/seeders/DataShopInitializeSeeder.php200-416
The DataShopDefaultSeeder runs for each new store created in the system, populating store-specific configurations and interface elements.
The seeder determines which store to configure using session state:
Sources: src/DB/seeders/DataShopDefaultSeeder.php22-29
The seeder populates store-specific configurations organized into logical groups:
| Group Code | Purpose | Configuration Keys |
|---|---|---|
admin_config | Admin interface settings | ADMIN_NAME, ADMIN_TITLE, hidden_copyright_footer, hidden_copyright_footer_admin |
display_config | Product display limits | product_top, product_list, product_relation, product_viewed, item_list, item_top |
captcha_config | CAPTCHA settings | captcha_mode, captcha_page, captcha_method |
config_layout | UI element visibility | link_account, link_language, link_currency, link_cart |
sendmail_config | Email trigger control | welcome_customer, order_success_to_admin, order_success_to_customer, contact_to_customer, contact_to_admin |
Configuration Structure: Each configuration entry has the following schema:
Sources: src/DB/seeders/DataShopDefaultSeeder.php94-123
The seeder creates navigation links attached to the store:
Each link is created with a UUID and attached to the store using the polymorphic relationship src/DB/seeders/DataShopDefaultSeeder.php46-60
Sources: src/DB/seeders/DataShopDefaultSeeder.php35-60
The seeder registers two layout blocks for displaying shop content:
Each block is tied to the store's template and can render on specific pages src/DB/seeders/DataShopDefaultSeeder.php63-88
Sources: src/DB/seeders/DataShopDefaultSeeder.php63-88
All configuration values are stored in the AdminConfig table with a hierarchical organization:
The system provides two helper functions for retrieving configuration values:
| Function | Scope | Usage |
|---|---|---|
gp247_config($key, $default) | Current store context | General application code |
gp247_config_admin($key, $default) | Admin-specified store | Administrative interfaces |
Sources: Referenced in src/Views/admin/screen/config_shop/config_sendmail.blade.php8 src/Library/Helpers/order.php10
The configuration system drives behavior across multiple subsystems without requiring code changes. This section demonstrates key examples.
The gp247_order_mapping_validate() function constructs validation rules dynamically based on configuration values:
Implementation Details:
customer_[field] config is false, the field is not collected at allcustomer_[field]_required is true, validation adds required rule; otherwise nullableSources: src/Library/Helpers/order.php89-210
Email sending is controlled by multiple configuration layers:
Configuration Keys:
email_action_mode: Master switch for all email functionality (0 = OFF, 1 = ON)order_success_to_admin: Send order notification to store adminorder_success_to_customer: Send order confirmation to customerwelcome_customer: Send welcome email on registrationcontact_to_admin: Send contact form submission to admincontact_to_customer: Send contact confirmation to customerSources: src/Library/Helpers/order.php7-84 src/Library/Helpers/customer.php85-102
Customer forms dynamically render fields based on configuration:
This allows different stores to have completely different registration forms based on their regional or business requirements (e.g., Japanese stores can require katakana name fields, European stores can require company tax IDs).
Sources: src/Library/Helpers/customer.php183-395
Display limits for various product listings are configurable:
| Configuration Key | Purpose | Default Value |
|---|---|---|
product_top | Products shown on homepage | 12 |
product_list | Products per page in listings | 12 |
product_relation | Related products shown | 4 |
product_viewed | Recently viewed products | 4 |
item_list | Generic item listing limit | 12 |
item_top | Top items display | 12 |
These values are queried at runtime when controllers build product queries, affecting pagination and limit clauses.
Sources: src/DB/seeders/DataShopDefaultSeeder.php100-105
The config_layout group controls visibility of header/footer elements:
This allows stores to hide functionality they don't need (e.g., single-currency stores can hide the currency selector).
Sources: src/DB/seeders/DataShopDefaultSeeder.php109-112
CAPTCHA protection is configurable per page:
Sources: src/DB/seeders/DataShopDefaultSeeder.php106-108
Administrators can modify configuration values through the admin panel. The sendmail configuration interface demonstrates the pattern:
The interface uses the .check-data-config class with data-store attribute to enable real-time configuration updates without page reloads src/Views/admin/screen/config_shop/config_sendmail.blade.php18
Sources: src/Views/admin/screen/config_shop/config_sendmail.blade.php1-27
Email templates reference configuration values to conditionally render content:
Email Templates:
email.order_success_to_admin: Notify admin of new orderemail.order_success_to_customer: Confirm order to customeremail.welcome_customer: Welcome new customer registrationemail.forgot_password: Password reset linkemail.customer_verify: Email address verificationEach template uses internationalized labels fetched via gp247_language_render() for the current locale.
Sources: src/Views/front/email/order_success_to_admin.blade.php1-68 src/Views/front/email/order_success_to_customer.blade.php1-68 src/Library/Helpers/order.php32-81
The GP247/Shop configuration system provides:
DataShopInitializeSeeder for global setup, DataShopDefaultSeeder for per-store configurationgroup → code → key with store isolationgp247_config, gp247_config_admin) provide simple configuration retrievalThis architecture allows the same codebase to support dramatically different store behaviors and requirements through configuration alone, enabling multi-tenant and international deployments without code customization.
Refresh this wiki