Ecommercen Docs

Appearance

Metadata / Registry System ​

Flow ID: AD-37 Module(s): eshop, settings, application Complexity: Medium Last Updated: 2026-04-04

Business Overview ​

Ecommercen uses two distinct metadata systems that serve different purposes:

  1. Product Metadata (product_meta table) -- Dynamic, config-driven per-product fields that extend the product entity with arbitrary data types (text, HTML, dates, uploads). Configured per-client via application/config/product_meta_data.php.

  2. Registry (registry table) -- A global key-value store for application-wide configuration. Acts as a database-backed alternative to config files, supporting grouping, language-specific values, and encrypted storage. Used pervasively for payment gateway credentials, feature flags, email settings, and integration configuration.

Both systems have a legacy model layer for admin CRUD and a modern Domain + REST API layer for programmatic access.

API Reference ​

REST Endpoints -- Product Metadata ​

MethodPathActionAuth
GET/rest/product/product-metaList metadata records (paginated, filterable)JWT
GET/rest/product/product-meta/{id}Get single meta record by IDJWT
GET/rest/product/product-meta/itemGet single meta by filterJWT
POST/rest/product/product-metaCreate metadata recordJWT
POST/rest/product/product-meta/{id}Update metadata recordJWT
DELETE/rest/product/product-meta/{id}Delete metadata recordJWT

Filters: filter[id], filter[productId] (exact), filter[metaType] (exact), filter[category] (exact), filter[lang] (exact), filter[value] (partial) Sorts: id, productId, metaType, categoryRelations: include=product (BELONGS_TO)

Registry -- No REST API ​

The Registry is accessed only via the Registry library and registry_helper.php functions. There is no REST endpoint for registry operations -- all management happens through the admin settings UI (Adv_settings) and programmatic calls.

Code Flow ​

Product Metadata -- Admin Integration ​

Adv_products_admin::create() / edit()
  |
  +--> On save:
       +--> updateProductMetaDataFromPost($productId)
       |    |
       |    +--> For each field in metaDataFieldConfig():
       |         ├── Skip 'upload' type fields
       |         ├── If MUI: loop languages, add/update per (product_id, category, lang)
       |         └── If non-MUI: add/update per (product_id, category, lang=null)
       |
       +--> saveProductMetaDataFiles($productId, $filesData)
            |
            +--> For each 'upload' type field in metaDataFieldConfig():
                 ├── If MUI: save file per language
                 └── If non-MUI: save file per product

Product Metadata -- Config-Driven Fields ​

application/config/product_meta_data.php
  |
  +--> $config['product_meta'] = [
       |   'views' => [type => viewName mapping],
       |   'categories' => [
       |       'fieldName' => [
       |           'type' => 'text|html|date|datetime|checkbox|select|upload',
       |           'mui' => true|false,
       |           'validation' => 'CI form_validation rules',
       |           'upload' => ['allowed_types' => ..., 'size' => ...]  // for upload type
       |       ]
       |   ]
       ]

The categories array is empty by default and is configured per-client to define custom product fields.

Registry -- Read Flow ​

Registry::__construct()
  |
  +--> registry_model->all() (via pscache for caching)
  +--> parseDb() -- organize into $data[reggroup][regkey][lang] = regval
  |
  +--> Registry::value($regGroup, $regKey, $langAbbr, $encrypted)
  |    Returns single value, optionally decrypted
  |
  +--> Registry::getGroupAsArray($regGroup, $langAbbr, $encryptedKeys)
  |    Returns all keys in a group as assoc array
  |
  +--> Registry::getArray($regKey, $regGroup, $langAbbr)
       Returns pipe-delimited value as array

Registry -- Write Flow ​

Registry::setValue($regGroup, $regKey, $regVal, $langAbbr, $encrypted)
  |
  +--> addItem() -- update in-memory cache
  +--> registry_model->set_regval() -- upsert to DB
       (if row exists: UPDATE, else: INSERT)

Registry::setArray($regKey, $regGroup, $langAbbr, $regVal)
  |
  +--> implode('|', $regVal) → setValue()

Registry::delete($regGroup, $regKey, $langAbbr)
  |
  +--> Remove from in-memory cache
  +--> registry_model->delete()

Domain Layer ​

Product Metadata -- Modern Domain (src/) ​

FileResponsibility
src/Domains/Product/ProductMeta/Repository/Entity.phpEntity: id, product_id, meta_type, category, value, lang
src/Domains/Product/ProductMeta/Repository/Repository.phpRead repository (table: product_meta)
src/Domains/Product/ProductMeta/Repository/RepositoryConfigurator.phpRelations: product (BELONGS_TO)
src/Domains/Product/ProductMeta/Repository/WriteRepository.phpWrite repository
src/Domains/Product/ProductMeta/Service.phpRead service
src/Domains/Product/ProductMeta/WriteService.phpWrite service
src/Domains/Product/ProductMeta/WriteData.phpDTO: productId, metaType, category, value, lang
src/Domains/Product/ProductMeta/ListRequest.phpFilter/sort definitions

Product Metadata -- REST Layer (src/) ​

FileResponsibility
src/Rest/Product/Controllers/ProductMeta.phpREST controller with OpenAPI annotations
src/Rest/Product/Resources/ProductMeta/Resource.phpJSON resource: {id, productId, metaType, category, value, lang}
src/Rest/Product/Resources/ProductMeta/Collection.phpCollection wrapper

Product Metadata -- Legacy Layer (ecommercen/) ​

FileResponsibility
ecommercen/eshop/models/AdvProductMetaModel.phpModel: CRUD, metaDataFieldConfig(), getMetaDataObject()
ecommercen/eshop/controllers/Adv_products_admin.phpProduct admin: updateProductMetaDataFromPost(), saveProductMetaDataFiles()
application/config/product_meta_data.phpField configuration (types, MUI, validation, upload rules)

Registry Layer ​

FileResponsibility
application/libraries/Registry.phpMain library: value(), setValue(), getGroupAsArray(), getArray(), setArray(), delete()
application/models/Registry_model.phpDB model: all(), set_regval(), delete()
ecommercen/helpers/registry_helper.phpHelper functions: getRegistryValue(), getRegistryArrayValue(), payment/integration getters

Architecture ​

Product Metadata ​

Product Admin (Adv_products_admin)    REST API (ProductMeta controller)
  |                                       |
  +--> AdvProductMetaModel               +--> ProductMeta\Service
       (legacy model)                         ProductMeta\WriteService
       |                                      |
       v                                      v
  product_meta table  <==================>  product_meta table
       ^
       |
  application/config/product_meta_data.php  (field definitions)

The config file defines what fields exist; the model/service provides storage. Admin views are generated dynamically based on the views mapping (metaInputText, metaInputHtml, etc.).

Registry ​

Any controller / library / helper
  |
  +--> $this->registry->value('GROUP', 'KEY')     -- read
  +--> $this->registry->setValue('GROUP', 'KEY')   -- write
       |
       +--> In-memory cache (per-request)
       +--> pscache (file-based caching layer)
       +--> registry_model → DB

The Registry is loaded once per request (cached via pscache) and provides an in-memory lookup for the duration of the request. The live() method forces a cache refresh (used in cron jobs that need current values).

Data Model ​

product_meta ​

ColumnTypeDescription
idint(11)PK, auto-increment
product_idint(11)FK to shop_product
meta_typevarchar(255)Field type (text, html, upload, date, etc.)
categoryvarchar(255)Field name/key from config
valuelongtextStored value (text, HTML, filename, etc.)
langvarchar(2)Language code (NULL for non-MUI fields)

Indexes: category, product_category (product_id + category), product_category_lang (product_id + category + lang)

registry ​

ColumnTypeDescription
idint(11)PK, auto-increment
reggroupvarchar(150)Configuration group (e.g., VIVAWALLET, ESHOP, EMAIL)
regkeyvarchar(150)Configuration key within the group
regvaltextStored value (may be encrypted)
langvarchar(2)Language code (empty string for non-language-specific values)

Indexes: reggroup, regkey, key_lang, group_key_lang (composite for lookups)

Well-Known Registry Groups ​

GroupPurposeExample Keys
ESHOPShop feature flags and settingsIMPORT_PRODUCTS_FROM_EXCEL_ENABLED
OTHERMiscellaneous settingsORDER_TAGS_ENABLED
GLOBALGlobal shop settingsADMIN_EMAIL
VIVAWALLETViva Wallet payment configMERCHANT_ID, API_KEY, SOURCE_CODE
PIRAEUSBANKPiraeus Bank payment configACQUIRER_ID, MERCHANT_ID, POS_ID
ETHNIKIBANKNBG payment configPUBLIC_KEY, PRIVATE_KEY
ALPHABANKAlpha Bank payment configID, SSK, SUBMIT
APCOPAYApcoPay payment configPROFILE_ID, SECRET, MERCHANT_ID
JCCJCC payment configUSERNAME, PASSWORD
IRISIris payment configUSERNAME, PASSWORD, CUSTOMER_CODE
PAY_BY_BANKPayByBank configAPI_KEY, API_URL, EXPIRATION
PAYPAL_ADVANCEDPayPal Advanced configCLIENT_ID, CLIENT_SECRET
KLARNA_PAYMENTSKlarna payment configUSERNAME, PASSWORD
AGORAProject Agora ad integrationIS_ENABLED, API_URL, API_KEY
SMARTCARTSkroutz Smart CartIS_ENABLED
PUBLIC_MARKETPLACEPublic marketplaceENABLED
SHOPFLIXShopFlix marketplaceIS_ENABLED
EMAIL_CONTACT_FORMContact form SMTPSMTP_HOST, SMTP_USER, SMTP_PASS
EMAIL_SHOP_MAILERShop email SMTPSMTP_HOST, SMTP_USER, SMTP_PASS

Configuration ​

Product Metadata ​

  • Field config: application/config/product_meta_data.php -- empty categories array by default; populated per-client
  • Supported types: text, html, date, datetime, checkbox, select, upload
  • MUI support: Each field can be marked as MUI ('mui' => true), which stores separate values per language
  • Validation: Uses CI form_validation rules defined per field
  • Upload limits: Per-field allowed_types and size (KB) configuration

Registry ​

  • Cache layer: pscache library provides file-based caching of all registry values
  • Encryption: Values can be stored encrypted via $this->registry->setValue(..., $encrypted = true) using CI's Encryption library
  • Live refresh: $this->registry->live() forces cache bypass and DB reload

Client Extension Points ​

Product Metadata ​

  • Define custom fields: Populate application/config/product_meta_data.php with client-specific field definitions
  • Override model: Override AdvProductMetaModel in application/models/ for custom behavior
  • Custom admin views: The view mapping in the config determines which partial is rendered for each field type

Registry ​

  • Add settings: Use Registry::setValue() from patchers or admin controllers to add new configuration
  • Custom helper functions: Add to registry_helper.php in application/helpers/ for client-specific settings retrieval
  • Settings admin: The Adv_settings controller reads/writes registry values for the admin settings UI

Business Rules ​

Product Metadata ​

  1. Config-driven schema: Fields exist only if defined in product_meta_data.php -- no UI for adding fields dynamically
  2. MUI isolation: MUI fields store one row per (product_id, category, lang); non-MUI fields use lang = NULL
  3. Upsert pattern: updateProductMetaDataFromPost() checks hasRecord() before deciding insert vs. update
  4. Upload handling: File uploads are handled separately from text fields via saveProductMetaDataFiles()
  5. HTML fields: HTML-type fields skip XSS filtering ($this->input->post($field, false)) to preserve markup

Registry ​

  1. Upsert on write: set_regval() checks if a row exists for (reggroup, regkey, lang) before deciding INSERT vs. UPDATE
  2. Non-language constant: When lang is empty, it is stored as an empty string in DB but mapped to the internal constant BASE in memory
  3. Pipe-delimited arrays: Array values are stored as pipe-separated strings (val1|val2|val3) and split on read
  4. Encrypted values: Encryption uses CI's Encryption library; decryption happens at read time via value(..., $encrypted = true)
  5. Cache coherence: In-memory cache is populated once per request; setValue() updates both memory and DB; live() forces full reload

Wiki Guide: Settings in Database -- developer guide for database-backed configuration