Brimbox Logo Brimbox Version 2.3.4 Released

Modules Table Data Dictionary>>

The modules table (modules_table) stores information like module type and interface for a specific module. Standard modules as well as installed modules must be referenced in this table. Module name and module path, and other information related to a module is stored and referenced from this table.

id: autoincrement

module_order: order of module partitioned by module_type, 0 if module is hidden.

module_path: full relative path to module from root.

module_name: file name of module without .php extension, must be alphanumeric with underscores.

friendly_name: name of module displayed in program.

interface: name of interface for module.

module_type:
-1 – Functions and Arrays (fixed for all interfaces)
0 – Hidden (fixed for all interfaces)
1 – Guest (standard interface)
2 – Viewer (standard interface)
3 – Tab (standard interface)
4 – Setup (standard interface)
5 – Admin (standard interface)

Note: user defined module types must have corresponding numbers greater than 1.

module_version: version of module from install.

standard_module:
0 – standard permanent module (always activated)
1 – optional hidden module without order
2 – standard hidden module without order
3 – optional module deactivated
4 – optional module activated
5 – standard module deactivated
6 – standard module activated

module_files: not used, reserved for update functionality

module_details: JSON object containing extra information and details (author, description etc) on a module.

change_date: updated by trigger

Revised: 2016-07-05

Updated: 2016-07-05

Documents

Definitions