FUEL CMS User Guide : Version 1.3.2


Fuel Class

The master FUEL object that other objects attach to.

This class extends the Fuel_advanced_module class.

Properties Reference

Property Default Value Description
protected
name N/A Name of the advanced module... usually the same as the folder name
folder N/A Name of the folder for the advanced module
_attached N/A attached objects
_auto_attach N/A objects to automatically attach

Function Reference [+]

$this->fuel->get_instance()

Static method that returns the instance of the FUEL object. This object is auto-loaded and so you will most likely use $this->fuel instead of this method.

Returns

object

$this->fuel->initialize([$config=array()])

Initialize the FUEL object. Accepts an associative array as input containing the FUEL config parameters to set.

Returns

void

Parameters

(array) $config Config preferences

$this->fuel->set_config('$item', ['$value'=NULL], ['$module'='fuel'])

Sets a configuration value for FUEL (overwrites Fuel_advanced_module).

Returns

void

Parameters

(mixed) $item Can be a string that references the configuration key or an array of values
(mixed) $value The value of the key configuration item (only works if $item parameter is not an array) (optional)
(string) $module The module to set the configuration item. Default is fuel. (optional)

$this->fuel->version(['$part'=NULL])

Returns the FUEL version.

Returns

void

Parameters

(string) $part Value of what part of the version number to return. Options are "major", "minor", or "patch" (optional)

$this->fuel->install()

Installs the modules.

Returns

boolean

$this->fuel->__get('$var')

Magic method that will attach and return FUEL library objects.

Returns

object

Parameters

(string) $var The object

$this->fuel->__call('$name', '$args')

Magic method that will call any methods on an attached object that are "get".

Returns

object

Parameters

(string) $name The object
(string) $args An array of arguments