/ cake / libs / configure.php
Configure Class Info:
- Class Declaration:
class Configure extends Object
- File name:
- cake/libs/configure.php
- Description:
Configuration class (singleton). Used for managing runtime configuration information.
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs
- Link
- http://book.cakephp.org/view/924/The-Configuration-Class
Properties:
-
debug integer
Current debug level.
Method Summary:
- buildPaths( $paths )
- cakeError( $method, $messages = array ( ) )
- __construct( )
- corePaths( $type = NULL )
- delete( $var = NULL )
- dispatchMethod( $method, $params = array ( ) )
- getInstance( $boot = true )
- listObjects( $type, $path = NULL, $cache = true )
- load( $fileName )
- log( $msg, $type = 2 )
- Object( )
- _persist( $name, $return, $object, $type = NULL )
- read( $var = 'debug' )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- _stop( $status = 0 )
- store( $type, $name, $data = array ( ) )
- toString( )
- version( )
- write( $config, $value = NULL )
buildPaths
topcakeError
topUsed 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 required
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
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
__construct
topClass constructor, overridden in descendant classes.
- Method defined in:
- cake/libs/object.php on line 54
corePaths
top- Parameters:
-
-
$type optional NULL
-
- Method defined in:
- cake/libs/configure.php on line 368
- Deprecated
- See
delete
topUsed 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
-
- Method defined in:
- cake/libs/configure.php on line 205
- Link
- http://book.cakephp.org/view/928/delete
- Return
void
- Access
public
dispatchMethod
topCalls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
- Parameters:
-
-
string $method required
Name of the method to call
-
array $params optional array ( )
Parameter list to use when calling $method
-
- Method defined in:
- cake/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
getInstance
topReturns a singleton instance of the Configure class.
- Parameters:
-
-
$boot optional true
-
- Method defined in:
- cake/libs/configure.php on line 45
- Return
Configure instance
- Access
public
listObjects
top- Parameters:
-
-
$type required
-
$path optional NULL
-
$cache optional true
-
- Method defined in:
- cake/libs/configure.php on line 360
- Deprecated
- See
load
topLoads 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 required
name of file to load, extension must be .php and only the name should be used, not the extenstion
-
- Method defined in:
- cake/libs/configure.php on line 233
- Link
- http://book.cakephp.org/view/929/load
- Return
mixed false if file not found, void if load successful
- Access
public
log
topConvience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/config/core.php.
-
- Method defined in:
- cake/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
Object
topA 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()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
_persist
topChecks 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 required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
read
topUsed 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.
-
- Method defined in:
- cake/libs/configure.php on line 155
- Link
- http://book.cakephp.org/view/927/read
- Return
string value of Configure::$var
- Access
public
requestAction
topCalls 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 required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_set
topAllows 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.
-
- Method defined in:
- cake/libs/object.php on line 166
- Return
void
- Access
protected
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
store
topUsed to write a config file to disk.
Configure::store('Model', 'class_paths', array('Users' => array(
'path' => 'users', 'plugin' => true
)));- Parameters:
-
-
string $type required
Type of config file to write, ex: Models, Controllers, Helpers, Components
-
string $name required
file name.
-
array $data optional array ( )
array of values to store.
-
- Method defined in:
- cake/libs/configure.php on line 307
- Return
void
- Access
public
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
version
topUsed to determine the current version of CakePHP.
Usage Configure::version();
- Method defined in:
- cake/libs/configure.php on line 282
- Link
- http://book.cakephp.org/view/930/version
- Return
string Current version of CakePHP
- Access
public
write
topUsed 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 required
Name of var to write
-
mixed $value optional NULL
Value to set for var
-
- Method defined in:
- cake/libs/configure.php on line 81
- Link
- http://book.cakephp.org/view/926/write
- Return
boolean True if write was successful
- Access
public
App Class Info:
- Class Declaration:
class App extends Object
- File name:
- cake/libs/configure.php
- Description:
Class/file loader and path management.
- Class Inheritance
- Link
- http://book.cakephp.org/view/933/The-App-Class
- Since
CakePHP(tm) v 1.2.0.6001
- Package
- cake
- Subpackage
- cake.cake.libs
Properties:
-
behaviors array
List of additional path(s) where behavior files reside.
-
components array
List of additional path(s) where component files reside.
-
controllers array
List of additional path(s) where controller files reside.
-
datasources array
List of additional path(s) where datasource files reside.
-
helpers array
List of additional path(s) where helper files reside.
-
libs array
List of additional path(s) where libs files reside.
-
locales array
List of additional path(s) where locale files reside.
-
models array
List of additional path(s) where model files reside.
-
plugins array
List of additional path(s) where plugins reside.
-
return boolean
Whether or not to return the file that is loaded.
-
search array
Paths to search for files.
-
shells array
List of additional path(s) where console shell files reside.
-
types array
List of object types and their properties
-
vendors array
List of additional path(s) where vendor packages reside.
-
views array
List of additional path(s) where view files reside.
Method Summary:
- build( $paths = array ( ), $reset = false )
- cakeError( $method, $messages = array ( ) )
- __construct( )
- core( $type = NULL )
- dispatchMethod( $method, $params = array ( ) )
- getInstance( )
- import( $type = NULL, $name = NULL, $parent = true, $search = array ( ), $file = NULL, $return = false )
- log( $msg, $type = 2 )
- Object( )
- objects( $type, $path = NULL, $cache = true )
- path( $type )
- _persist( $name, $return, $object, $type = NULL )
- pluginPath( $plugin )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- _stop( $status = 0 )
- themePath( $theme )
- toString( )
build
topBuild path references. Merges the supplied $paths with the base paths and the default core paths.
- Parameters:
-
-
array $paths optional array ( )
paths defines in config/bootstrap.php
-
boolean $reset optional false
true will set paths, false merges paths [default] false
-
- Method defined in:
- cake/libs/configure.php on line 643
- Return
void
- Access
public
cakeError
topUsed 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 required
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
-
- Method defined in:
- cake/libs/object.php on line 187
- Return
error message
- Access
public
__construct
topClass constructor, overridden in descendant classes.
- Method defined in:
- cake/libs/object.php on line 54
core
topReturns 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'
-
- Method defined in:
- cake/libs/configure.php on line 739
- Return
array numeric keyed array of core lib paths
- Access
public
dispatchMethod
topCalls a method on this object with the given parameters. Provides an OO wrapper
for call_user_func_array
- Parameters:
-
-
string $method required
Name of the method to call
-
array $params optional array ( )
Parameter list to use when calling $method
-
- Method defined in:
- cake/libs/object.php on line 107
- Return
mixed Returns the result of the method call
- Access
public
getInstance
topReturns a single instance of App.
- Method defined in:
- cake/libs/configure.php on line 979
- Return
object
- Access
public
import
topFinds classes based on $name or specific file(s) to search. Calling App::import() will not construct any classes contained in the files. It will only find and require() the file.
- Parameters:
-
-
mixed $type optional NULL
The type of Class if passed as a string, or all params can be passed as an single array to $type,
-
string $name optional NULL
Name of the Class or a unique name for the file
-
mixed $parent optional true
boolean true if Class Parent should be searched, accepts key => value array('parent' => $parent ,'file' => $file, 'search' => $search, 'ext' => '$ext'); $ext allows setting the extension of the file name based on Inflector::underscore($name) . ".$ext";
-
array $search optional array ( )
paths to search for files, array('path 1', 'path 2', 'path 3');
-
string $file optional NULL
full name of the file to search for including extension
-
$return optional false
-
- Method defined in:
- cake/libs/configure.php on line 859
- Link
- http://book.cakephp.org/view/934/Using-App-import
- Return
boolean true if Class is already in memory or if file is found and loaded, false if not
- Access
public
log
topConvience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
- Parameters:
-
-
string $msg required
Log message
-
integer $type optional 2
Error type constant. Defined in app/config/core.php.
-
- Method defined in:
- cake/libs/object.php on line 148
- Return
boolean Success of log write
- Access
public
Object
topA 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()
- Method defined in:
- cake/libs/object.php on line 43
- Return
Object
objects
topReturns an array of objects of the given type.
Example usage:
App::objects('plugin'); returns array('DebugKit', 'Blog', 'User');
- Parameters:
-
-
string $type required
Type of object, i.e. 'model', 'controller', 'helper', or 'plugin'
-
mixed $path optional NULL
Optional Scan only the path given. If null, paths for the chosen type will be used.
-
boolean $cache optional true
Set to false to rescan objects of the chosen type. Defaults to true.
-
- Method defined in:
- cake/libs/configure.php on line 785
- Return
mixed Either false on incorrect / miss. Or an array of found objects.
- Access
public
path
topUsed to read information stored path
Usage:
App::path('models'); will return all paths for models
- Parameters:
-
-
string $type required
type of path
-
- Method defined in:
- cake/libs/configure.php on line 626
- Return
string array
- Access
public
_persist
topChecks 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 required
name of the class to persist
-
$return required
-
string $object required
the object to persist
-
$type optional NULL
-
- Method defined in:
- cake/libs/object.php on line 218
- Return
boolean Success
- Access
protected
- Todo
add examples to manual
pluginPath
topGet the path that a plugin is on. Searches through the defined plugin paths.
- Parameters:
-
-
string $plugin required
CamelCased/lower_cased plugin name to find the path of.
-
- Method defined in:
- cake/libs/configure.php on line 702
- Return
string full path to the plugin.
requestAction
topCalls 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 required
String or array-based url.
-
array $extra optional array ( )
if array includes the key "return" it sets the AutoRender to true.
-
- Method defined in:
- cake/libs/object.php on line 80
- Return
mixed Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.
- Access
public
_savePersistent
topYou should choose a unique name for the persistent file
There are many uses for this method, see manual for examples
- Parameters:
-
-
string $name required
name used for object to cache
-
object $object required
the object to persist
-
- Method defined in:
- cake/libs/object.php on line 247
- Return
boolean true on save, throws error if file can not be created
- Access
protected
_set
topAllows 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.
-
- Method defined in:
- cake/libs/object.php on line 166
- Return
void
- Access
protected
_stop
topStop execution of the current script. Wraps exit() making testing easier.
- Parameters:
-
-
$status optional 0
-
- Method defined in:
- cake/libs/object.php on line 135
- Return
void
- Access
public
themePath
topFind the path that a theme is on. Search through the defined theme paths.
- Parameters:
-
-
string $theme required
lower_cased theme name to find the path of.
-
- Method defined in:
- cake/libs/configure.php on line 719
- Return
string full path to the theme.
toString
topObject-to-string conversion. Each class can override this method as necessary.
- Method defined in:
- cake/libs/object.php on line 64
- Return
string The name of this class
- Access
public
