FUEL CMS User Guide : Version 1.4


Fuel Settings Class

This class extends the Fuel_base_library class.

Properties Reference

Property Default Value Description
protected
settings N/A Settings array of Form_builder form fields

Function Reference [+]

$this->fuel->settings->get('$module', ['$key'=''])

Returns an array of settings related to a particular module.

Returns

array

Parameters

(string) $module $module, Module name
(string) $key $key, Key name

$this->fuel->settings->process('$module', $settings, $new_settings, ['$skip_empty_vals'=FALSE])

Process the new settings & save it to fuel_settings.

Returns

boolean

Parameters

(string) $module $module, Module name
(array) $settings $settings, An array containing the defined settings
(array) $new_settings $new_settings, An array containing the new settings
(boolean) $skip_empty_vals $skip_empty_vals, Store empty vals

$this->fuel->settings->get_validation()

Returns the fuel_settings_model's validation.

Returns

object

$this->fuel->settings->model()

Returns the FUEL logs_model object.

Returns

object

$this->fuel->settings->save('$module', ['$key'=NULL], ['$value'=NULL])

Saves settings to the database.

Returns

boolean

Parameters

(mixed) $module Either an array of data to save or a string value of the module to associate with this setting (must pass additional parameters if a string)
(string) $key The key setting value (required if first parameter is a string)
(mixed) $value The value of the setting (required if first parameter is a string)

$this->fuel->settings->delete($where)

Deletes settings to the database.

Returns

boolean

Parameters

(array) $where Array of where conditions to delete