Class Configure
Configuration class (singleton). Used for managing runtime configuration information.
- Object
-
Configure
Link: http://book.cakephp.org/1.3/en/The-Manual/Developing-with-CakePHP/Configuration.html#the-configuration-class
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: configure.php
Properties summary
-
$debugpublicintegerCurrent debug level.
Method Summary
-
__loadBootstrap() public
Loads app/config/bootstrap.php. If the alternative paths are set in this file they will be added to the paths vars.
-
__writeConfig() public
Creates a cached version of a configuration file. Appends values passed from Configure::store() to the cached file
-
buildPaths() public deprecated
-
corePaths() public deprecated
-
delete() public
Used to delete a variable from the Configure instance. -
getInstance() public
Returns a singleton instance of the Configure class. -
listObjects() public deprecated
-
load() public
Loads a file from app/config/configure_file.php. Config file variables should be formated like:
$config['name'] = 'value';These will be used to create dynamic Configure vars. load() is also used to load stored config files created with Configure::store() -
read() public
Used to read information stored in the Configure instance. -
store() public
Used to write a config file to disk. -
version() public
Used to determine the current version of CakePHP. -
write() public
Used to store a dynamic variable in the Configure instance.
Method Detail
__loadBootstrap() public ¶
__loadBootstrap( boolean $boot )
Loads app/config/bootstrap.php. If the alternative paths are set in this file they will be added to the paths vars.
Parameters
- boolean $boot
- Load application bootstrap (if true)
__writeConfig() public ¶
__writeConfig( string $content , string $name , boolean $write = true )
Creates a cached version of a configuration file. Appends values passed from Configure::store() to the cached file
Parameters
- string $content
- Content to write on file
- string $name
- Name to use for cache file
- boolean $write optional true
- true if content should be written, false otherwise
delete() public ¶
delete( string $var = null )
Used to delete a variable 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 optional null
- the var to be deleted
Link
listObjects() public deprecated ¶
listObjects( $type , $path = null , $cache = true )
Deprecated
See
load() public ¶
load( string $fileName )
Loads a file from app/config/configure_file.php.
Config file variables should be formated like:
$config['name'] = 'value';
These will be used to create dynamic Configure vars. load() is also used to
load stored config files created with Configure::store()
- To load config files from app/config use
Configure::load('configure_file');. - To load config files from a plugin
Configure::load('plugin.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
false if file not found, void if load successful
Link
read() public ¶
read( string $var = 'debug' )
Used to read information stored in the Configure instance.
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 optional 'debug'
- Variable to obtain. Use '.' to access array elements.
Returns
value of Configure::$var
Link
store() public ¶
store( string $type , string $name , array $data = array() )
Used to write a config file to disk.
{{{ Configure::store('Model', 'class_paths', array('Users' => array( 'path' => 'users', 'plugin' => true ))); }}}
Parameters
- string $type
- Type of config file to write, ex: Models, Controllers, Helpers, Components
- string $name
- file name.
- array $data optional array()
- array of values to store.
version() public ¶
version( )
Used to determine the current version of CakePHP.
Usage Configure::version();
Returns
Current version of CakePHP
Link
write() public ¶
write( array $config , mixed $value = null )
Used to store a dynamic variable 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
- Name of var to write
- mixed $value optional null
- Value to set for var
Returns
True if write was successful
Link
Methods inherited from Object
Object() public ¶
Object( )
A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()
Returns
__openPersistent() public ¶
__openPersistent( string $name , string $type = null )
Open the persistent class file for reading Used by Object::_persist()
Parameters
- string $name
- Name of persisted class
- string $type optional null
- Type of persistance (e.g: registry)
_persist() public ¶
_persist( string $name , string $return , $object , $type = null )
Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples
Parameters
- string $name
- name of the class to persist
- string $return
- $object the object to persist
- $object
- $type optional null
Returns
Success
_savePersistent() public ¶
_savePersistent( string $name , object $object )
You should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
Parameters
- string $name
- name used for object to cache
- object $object
- the object to persist
Returns
true on save, throws error if file can not be created
_set() public ¶
_set( array $properties = array() )
Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script. Wraps exit() making testing easier.
Parameters
- $status optional 0
- http://php.net/exit for values
cakeError() public ¶
cakeError( string $method , array $messages = array() )
Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
Parameters
- string $method
- Method to be called in the error class (AppError or ErrorHandler classes)
- array $messages optional array()
- Message that is to be displayed by the error class
Returns
message
dispatchMethod() public ¶
dispatchMethod( string $method , array $params = array() )
Calls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
Parameters
- string $method
- Name of the method to call
- array $params optional array()
- Parameter list to use when calling $method
Returns
Returns the result of the method call
log() public ¶
log( string $msg , integer $type = LOG_ERROR )
Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $url , array $extra = array() )
Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
Parameters
- mixed $url
- String or array-based url.
- array $extra optional array()
- if array includes the key "return" it sets the AutoRender to true.
Returns
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
toString() public ¶
toString( )
Object-to-string conversion. Each class can override this method as necessary.
Returns
The name of this class