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

Object

Package
cake
Subpackage
cake.cake.libs
Link
http://book.cakephp.org/view/924/The-Configuration-Class

Properties:

Show/Hide parent properties

  • debug integer

    Current debug level.

Method Summary:

Show/Hide parent methods

buildPaths

top

Parameters:
  • $paths required

Method defined in:
cake/libs/configure.php on line 374
Deprecated

See

App::build()

cakeError

top

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 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

top

Class 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 366
Deprecated

See

App::core()

delete

top

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

Method defined in:
cake/libs/configure.php on line 203
Link
http://book.cakephp.org/view/928/delete
Return

void

Access

public

dispatchMethod

top

Calls 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

top

Returns 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 358
Deprecated

See

App::objects()

load

top

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 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 231
Link
http://book.cakephp.org/view/929/load
Return

mixed false if file not found, void if load successful

Access

public

__loadBootstrap

top

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 required

    Load application bootstrap (if true)

Method defined in:
cake/libs/configure.php on line 387
Return

void

Access

private

log

top

Convience 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

top

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()

Method defined in:
cake/libs/object.php on line 43
Return

Object

__openPersistent

top

Open the persistent class file for reading Used by Object::_persist()

Parameters:
  • string $name required

    Name of persisted class

  • string $type optional NULL

    Type of persistance (e.g: registry)

Method defined in:
cake/libs/object.php on line 268
Return

void

Access

private

_persist

top

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 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

top

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.

Method defined in:
cake/libs/configure.php on line 153
Link
http://book.cakephp.org/view/927/read
Return

string value of Configure::$var

Access

public

requestAction

top

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 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

top

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 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

top

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.

Method defined in:
cake/libs/object.php on line 166
Return

void

Access

protected

_stop

top

Stop 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

top

Used 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 305
Return

void

Access

public

toString

top

Object-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

top

Used to determine the current version of CakePHP.

Usage Configure::version();

Method defined in:
cake/libs/configure.php on line 280
Link
http://book.cakephp.org/view/930/version
Return

string Current version of CakePHP

Access

public

write

top

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 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

__writeConfig

top

Creates a cached version of a configuration file. Appends values passed from Configure::store() to the cached file

Parameters:
  • string $content required

    Content to write on file

  • string $name required

    Name to use for cache file

  • boolean $write optional true

    true if content should be written, false otherwise

Method defined in:
cake/libs/configure.php on line 328
Return

void

Access

private