Class Configure
Configuration class (singleton). Used for managing runtime configuration information.
- Object
-
Configure
Link: http://book.cakephp.org/view/42/The-Configuration-Class
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: configure.php
Properties summary
-
$__objectspublicarrayHolds and key => value array of objects' types. -
$behaviorPathspublicarrayList of additional path(s) where behavior files reside. -
$componentPathspublicarrayList of additional path(s) where component files reside. -
$controllerPathspublicarrayList of additional path(s) where controller files reside. -
$debugpublicintegerCurrent debug level. -
$helperPathspublicarrayList of additional path(s) where helper files reside. -
$localePathspublicarrayList of additional path(s) where locale files reside. -
$modelPathspublicarrayList of additional path(s) where model files reside. -
$pluginPathspublicarrayList of additional path(s) where plugins reside. -
$shellPathspublicarrayList of additional path(s) where console shell files reside. -
$vendorPathspublicarrayList of additional path(s) where vendor packages reside. -
$viewPathspublicarrayList of additional path(s) where view files reside.
Inherited Properties
Method Summary
-
__configVarNames() public
Checks $name for dot notation to create dynamic Configure::$var as an array when needed. -
__destruct() public
Caches the object map when the instance of the Configure class is destroyed -
__list() public
Returns an array of filenames of PHP files in the given directory. -
__loadBootstrap() public
Loads app/config/bootstrap.php. If the alternative paths are set in this file they will be added to the paths vars.
-
__resetCache() public
Determines if $__objects cache should be reset. -
__writeConfig() public
Creates a cached version of a configuration file. Appends values passed from Configure::store() to the cached file
-
buildPaths() public
Build path references. Merges the supplied $paths with the base paths and the default core paths.
-
corePaths() public
Returns a key/value list of all paths where core libs are found. Passing $type only returns the values for a given value of $key.
-
delete() public
Used to delete a variable from the Configure instance. -
getInstance() public
Returns a singleton instance of the Configure class. -
listObjects() public
Returns an index of objects of the given type, with the physical path to each object. -
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.
-
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
__configVarNames() public ¶
__configVarNames( mixed $name )
Checks $name for dot notation to create dynamic Configure::$var as an array when needed.
Parameters
- mixed $name
- Name to split
Returns
Name separated in items through dot notation
__destruct() public ¶
__destruct( )
Caches the object map when the instance of the Configure class is destroyed
__list() public ¶
__list( string $path , string $suffix = false , $extension = false )
Returns an array of filenames of PHP files in the given directory.
Parameters
- string $path
- Path to scan for files
- string $suffix optional false
- if false, return only directories. if string, match and return files
- $extension optional false
Returns
List of directories or files in directory
__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)
__resetCache() public ¶
__resetCache( boolean $reset = null )
Determines if $__objects cache should be reset.
Parameters
- boolean $reset optional null
Returns
__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
buildPaths() public ¶
buildPaths( array $paths )
Build path references. Merges the supplied $paths with the base paths and the default core paths.
Parameters
- array $paths
- paths defines in config/bootstrap.php
corePaths() public ¶
corePaths( string $type = null )
Returns a key/value list of all paths where core libs are found. Passing $type only returns the values for a given value of $key.
Parameters
- string $type optional null
valid values are: 'model', 'behavior', 'controller', 'component', 'view', 'helper', 'datasource', 'libs', and 'cake'
Returns
numeric keyed array of core lib paths
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 ¶
listObjects( string $type , mixed $path = null , $cache = true )
Returns an index of objects of the given type, with the physical path to each object.
Parameters
- string $type
- Type of object, i.e. 'model', 'controller', 'helper', or 'plugin'
- mixed $path optional null
- Optional
- $cache optional true
Returns
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.
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
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
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
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.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script
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, and improves performance by using straight method calls in most cases.
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 )
API for logging events.
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.
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