Configure Class Reference

Inheritance diagram for Configure:

Object

List of all members.


Public Member Functions

 delete ($var=null)
& getInstance ()
 load ($fileName)
 read ($var= 'debug')
 version ()
 write ($config, $value=null)

Public Attributes

 $componentPaths = array()
 $controllerPaths = array()
 $debug = null
 $helperPaths = array()
 $modelPaths = array()
 $viewPaths = array()

Detailed Description

Definition at line 37 of file configure.php.

Member Function Documentation

Configure::delete ( $  var = null  ) 

Used to delete a var from the Configure instance.

Usage: Configure::delete('Name'); will delete the entire Configure::Name Configure::delete('Name.key'); will delete only the Configure::Name[key]

Parameters:
string $var the var to be deleted
Returns:
void public

Definition at line 186 of file configure.php.

References getInstance().

& Configure::getInstance (  ) 

Return a singleton instance of Configure.

Returns:
Configure instance public

Definition at line 86 of file configure.php.

Referenced by View::_getLayoutFileName(), View::_getViewFileName(), delete(), load(), read(), View::renderElement(), version(), and write().

Configure::load ( $  fileName  ) 

Will load a file from app/config/configure_file.php variables in the files should be formated like: $config['name'] = 'value'; These will be used to create dynamic Configure vars.

Usage Configure::load('configure_file');

Parameters:
string $fileName name of file to load, extension must be .php and only the name should be used, not the extenstion
Returns:
Configure::write public

Definition at line 208 of file configure.php.

References $config, and getInstance().

Configure::read ( $  var = 'debug'  ) 

Used to read Configure::$var

Usage Configure::read('Name'); will return all values for Name Configure::read('Name.key'); will return only the value of Configure::Name[key]

Parameters:
string $var
Returns:
string value of Configure::$var public

Definition at line 153 of file configure.php.

References getInstance().

Referenced by CakeSession::_checkValid(), DboPear::connect(), DboSource::execute(), DataSource::listSources(), DboSource::queryAssociation(), View::render(), View::renderCache(), View::renderElement(), View::renderLayout(), DboSource::showQuery(), and CakeSession::valid().

Configure::version (  ) 

Used to determine the current version of CakePHP

Usage Configure::version();

Returns:
string Current version of CakePHP public

Definition at line 231 of file configure.php.

References $config, and getInstance().

Configure::write ( $  config,
$  value = null 
)

Used to write a dynamic var in the Configure instance.

Usage Configure::write('One.key1', 'value of the Configure::One[key1]'); Configure::write(array('One.key1' => 'value of the Configure::One[key1]')); Configure::write('One', array('key1'=>'value of the Configure::One[key1]', 'key2'=>'value of the Configure::One[key2]'); Configure::write(array('One.key1' => 'value of the Configure::One[key1]', 'One.key2' => 'value of the Configure::One[key2]'));

Parameters:
array $config
Returns:
void public

Definition at line 107 of file configure.php.

References $config, and getInstance().

Member Data Documentation

Configure::$componentPaths = array()

Definition at line 72 of file configure.php.

Configure::$controllerPaths = array()

Definition at line 51 of file configure.php.

Configure::$debug = null

Definition at line 79 of file configure.php.

Configure::$helperPaths = array()

Definition at line 65 of file configure.php.

Configure::$modelPaths = array()

Definition at line 58 of file configure.php.

Configure::$viewPaths = array()

Definition at line 44 of file configure.php.

The documentation for this class was generated from the following file: