Modules in version 3.1+ support the use of a config.json file, that defines basic configuration settings for the module.
Due to backwards compatibility with version 3.0, config.json files are not required but are strongly recommended as they may be required in future versions.
Configuration Format
Example
{ "version": "1.0.0", "name": "My Module Name", "description": "A module like no other!", "type": "generic" "authors": [ { "name": "Phillips Data, Inc.", "url": "http://www.blesta.com" } ], "package": { "name_key": "input_name_key" }, "service": { "name_key": "service_field_key" }, "module": { "row": "Signular Form of Module Row", "rows": "Plural Form of Module Row", "group": "Module Group Name", "row_key": "module_row_field_key" }, "email_tags": { "module": ["tag_one", "tag_two"], "package": ["type", "package"], "service": ["service_field_key", "service_field_username"], } }
Definition
Option | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
version | The version of the module. This should be a semantic version number. | ||||||||||
name | The name of the module. This may also be a language definition. | ||||||||||
description | A brief description of the module. This may also be a language definition in Blesta v4.9.0+. | ||||||||||
type | Added in Blesta v5. A tag defining the module type. Currently the only type relevant to Blesta's code base is "registrar" as these will be used by the Domain Manager plugin. | ||||||||||
authors | An array of author objects.
| ||||||||||
logo | The path within the module to the logo file. If not set, defaults to views/default/images/logo.png. | ||||||||||
package | An object of service settings.
| ||||||||||
service | An object of service settings.
| ||||||||||
module | An object of module settings.
| ||||||||||
email_tags | An object containing tags for the module, service, package, and any other tag groups, each of which contain an array of strings representing each tag in that group. These tags will be displayed when an admin configures the welcome email template. |
Using the Configuration
To use the configuration file you must include it within the constructor of your module using the loadConfig() method.
<?php class MyModule extends Module { public function __construct() { $this->loadConfig(dirname(__FILE__) . DS . "config.json"); } } ?>
If your configuration uses any language definitions, be sure to include those before loading the config.
<?php class MyModule extends Module { public function __construct() { Language::loadLang("my_module", null, dirname(__FILE__) . DS . "language" . DS); $this->loadConfig(dirname(__FILE__) . DS . "config.json"); } } ?>