FUEL CMS User Guide : Version 1.5.2

Configs & Settings

There are various ways to configure FUEL CMS. Configuration files provide the most common way to make configurations. However, new in FUEL CMS 1.0 is the ability to create and manage your custom config settings in the CMS for Advanced Modules.

What's the Difference Between Configs and Settings?

An Advanced Module (including the FUEL Advanced Module) normally contains a single config file that is the same name as the Advanced Module (e.g. fuel/modules/{module}/config/{module}.php). This config file works just like the main CodeIgniter config file but is specific to Advanced Module's and contains an array of values you can change to affect the module's behavior. The config values can be accessed from the Advanced Module's object like so:

echo $this->fuel->config('site_name');

Config values are not editable in the CMS. To fix this issue, we've implemented Fuel_settings which allows you to create settings forms in the CMS to manage configuration aspects of your Advanced Modules. To do so, you add a settings key in the Advanced Modules config with Form_builder fields with keys that correspond to config values. This gives you the flexibility to expose as much or little of the configuration to CMS users. If no settings values are set, then they default to the static config values. A either be a "super" admin user or be subscribed to the {module}_settings permission to have access to an Advanced Module's settings in the CMS.

$config['my_module']['settings'] = array();
$config['my_module']['settings']['my_config'] = array();

Note that Advance Module config settings use their {module} as a key for namespacing purposes to prevent potential conflicts.

FUEL Specific Application Config Files

The following are configuration files specific to FUEL CMS (and not editable in the CMS):

CodeIgniter Specific Application Config Files

The following are configuration files specific to CodeIgniter (and not editable in the CMS):