 |
VOOZH | about |
|
VOOZH | about |
This document explains how the GP247/Shop package uses runtime configuration values stored in the database to control system behavior without requiring code changes. Configuration determines field visibility, validation rules, feature enablement, email triggers, and business logic across the entire application.
For information about how configurations are initially populated, see Data Seeders and Initialization. For multi-store configuration isolation, see Multi-Store and Multi-Vendor Architecture.
The system stores all configuration values in the admin_config table, accessed through the AdminConfig model. Each configuration entry uses a hierarchical structure with three identifying fields:
| Field | Purpose | Example |
|---|---|---|
group | Logical category | gp247_cart |
code | Sub-category | customer_config, display_config |
key | Specific setting | customer_phone, product_top |
value | Stored value | 1, 12, json_array |
store_id | Store isolation | Store-specific values |
Sources: src/DB/seeders/DataShopInitializeSeeder.php196-197 src/DB/seeders/DataShopDefaultSeeder.php94-123
The system organizes configurations into logical groups that control different aspects of behavior:
| Group Code | Purpose | Key Examples |
|---|---|---|
admin_config | Admin panel settings | ADMIN_NAME, ADMIN_TITLE, hidden_copyright_footer |
display_config | Display limits | product_top, product_list, product_relation, product_viewed |
customer_config | Customer field control | customer_phone, customer_lastname, customer_address1_required |
sendmail_config | Email triggers | welcome_customer, order_success_to_admin, order_success_to_customer |
captcha_config | Captcha settings | captcha_mode, captcha_page, captcha_method |
config_layout | UI element visibility | link_account, link_language, link_currency, link_cart |
The system uses a two-level pattern for customer fields:
customer_phone (0 or 1) - Show/hide fieldcustomer_phone_required (0 or 1) - Make field mandatoryThis pattern applies to: lastname, phone, address1, address2, address3, country, postcode, company, sex, birthday, group, name_kana
Sources: src/DB/seeders/DataShopDefaultSeeder.php94-123 src/DB/seeders/DataShopInitializeSeeder.php196-197
gp247_config()The gp247_config() helper function retrieves configuration values within the current store context. It automatically resolves the active store from session or application configuration.
Throughout the codebase, gp247_config() is called to make runtime decisions:
Sources: src/Library/Helpers/customer.php257-266 src/Library/Helpers/order.php136-142
The most significant impact of configuration-driven behavior is on validation. The system constructs validation rules at runtime based on configuration values.
The gp247_order_mapping_validate() function constructs validation rules for checkout:
Base Requirements:
first_name: Always requiredemail: Always requiredshippingMethod: Required if gp247_config('use_shipping') is enabledpaymentMethod: Required if gp247_config('use_payment') is enabledConditional Fields: Each customer field follows this pattern:
The function returns an array with validate and messages keys, ready for Laravel validator usage.
Sources: src/Library/Helpers/order.php89-211
The gp247_customer_data_insert_mapping() function builds validation for new customer registration:
Base Requirements:
first_name: Always requiredemail: Always required, unique in shop_customer tablepassword: Always required, with configurable strength requirementsConfigurable Password Validation:
Password requirements are themselves configuration-driven via gp247_customer_validate_password():
gp247_config('customer_password_min', null, 6)gp247_config('customer_password_max', null, 16)gp247_config('customer_password_letter')gp247_config('customer_password_mixedcase')gp247_config('customer_password_number')gp247_config('customer_password_symbol')Sources: src/Library/Helpers/customer.php183-396 src/Library/Helpers/customer.php644-670
The system uses configuration to control which customer fields appear in forms and whether they are mandatory.
| Field Name | Visibility Config | Required Config |
|---|---|---|
| Last Name | customer_lastname | customer_lastname_required |
| Phone | customer_phone | customer_phone_required |
| Address 1 | customer_address1 | customer_address1_required |
| Address 2 | customer_address2 | customer_address2_required |
| Address 3 | customer_address3 | customer_address3_required |
| Country | customer_country | customer_country_required |
| Postcode | customer_postcode | customer_postcode_required |
| Company | customer_company | customer_company_required |
| Sex | customer_sex | customer_sex_required |
| Birthday | customer_birthday | customer_birthday_required |
| Group | customer_group | customer_group_required |
| Name Kana | customer_name_kana | customer_name_kana_required |
Sources: src/Library/Helpers/customer.php212-333 src/Library/Helpers/order.php105-175
Email sending is entirely configuration-driven. The system checks configuration values before sending any email notification.
| Configuration Key | Purpose | Checked In |
|---|---|---|
email_action_mode | Master email on/off switch | All email functions |
welcome_customer | Send welcome email on registration | gp247_customer_sendmail_welcome() |
order_success_to_admin | Send order notification to admin | gp247_order_process_after_success() |
order_success_to_customer | Send order confirmation to customer | gp247_order_process_after_success() |
contact_to_customer | Send contact form copy to customer | Contact form handler |
contact_to_admin | Send contact form to admin | Contact form handler |
The gp247_order_process_after_success() function demonstrates the pattern:
Sources: src/Library/Helpers/order.php7-84 src/Views/front/email/order_success_to_admin.blade.php1-68 src/Views/front/email/order_success_to_customer.blade.php1-68
The gp247_customer_sendmail_welcome() function sends welcome emails to new customers:
Sources: src/Library/Helpers/customer.php84-102
Display configurations control pagination limits and list sizes throughout the frontend.
| Key | Purpose | Default Value |
|---|---|---|
product_top | Featured products on homepage | 12 |
product_list | Products per page in listings | 12 |
product_relation | Related products on detail page | 4 |
product_viewed | Recently viewed products | 4 |
item_list | Generic items per page | 12 |
item_top | Featured items | 12 |
These values are seeded by DataShopDefaultSeeder:
Controllers query these configurations to set pagination:
Sources: src/DB/seeders/DataShopDefaultSeeder.php100-105
Layout configurations control the visibility of UI elements in the frontend header/navigation.
| Key | Purpose | Controls |
|---|---|---|
link_account | Show/hide account menu | Customer login/register links |
link_language | Show/hide language switcher | Language selection dropdown |
link_currency | Show/hide currency switcher | Currency selection dropdown |
link_cart | Show/hide cart icon | Shopping cart link |
All layout configurations default to 1 (visible):
Template files check these configurations before rendering:
Sources: src/DB/seeders/DataShopDefaultSeeder.php109-112
Configuration values are populated during system installation and store creation through two seeders.
This seeder populates global, non-store-specific data:
Sources: src/DB/seeders/DataShopInitializeSeeder.php16-573
This seeder populates store-specific configurations:
dataConfigShop($storeId) to build arrayThe dataConfigShop() method returns an array of configuration records:
Sources: src/DB/seeders/DataShopDefaultSeeder.php12-125
Administrators manage sendmail configurations through a dedicated interface.
The config_sendmail.blade.php view renders the configuration interface:
Each checkbox has:
check-data-config class: JavaScript hook for AJAX updatesdata-store attribute: Identifies which store's configuration to updatename attribute: Configuration key to updatechecked state: Current configuration valueThe interface displays the master email_action_mode status at the top, indicating whether email functionality is globally enabled.
Sources: src/Views/admin/screen/config_shop/config_sendmail.blade.php1-27
When application code requests a configuration value, the system follows this resolution process:
The gp247_config() function signature typically supports default values:
Sources: Based on common implementation patterns observed in src/Library/Helpers/order.php and src/Library/Helpers/customer.php
The configuration system enables different stores within a multi-store installation to have dramatically different behaviors without code modification:
Store A Configuration:
Store B Configuration:
Both stores share the same codebase but behave differently based on their admin_config entries. This architecture enables:
Sources: src/DB/seeders/DataShopDefaultSeeder.php32-33 src/DB/seeders/DataShopDefaultSeeder.php94-123
Refresh this wiki