App Class Info:

Class Declaration:
class App extends Object
File name:
cake/libs/configure.php
Summary:
Class and file loader.
Class Inheritance

Object

link
http://book.cakephp.org/view/499/The-App-Class
since
CakePHP(tm) v 1.2.0.6001
package
cake
subpackage
cake.cake.libs

Properties:

Show/Hide parent properties
protected _log Log object
public return Whether or not to return the file that is loaded.
public search Paths to search for files.

Method Summary:

Show/Hide parent methods
public cakeError( $method, $messages = array ( ) )
public __construct( )
public dispatchMethod( $method, $params = array ( ) )
public getInstance( )
public import( $type = NULL, $name = NULL, $parent = true, $search = array ( ), $file = NULL, $return = false )
public log( $msg, $type = 2 )
public Object( )
protected _persist( $name, $return, $object, $type = NULL )
public requestAction( $url, $extra = array ( ) )
protected _savePersistent( $name, $object )
protected _set( $properties = array ( ) )
public _stop( $status = 0 )
public toString( )

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:
$method string Method to be called in the error class (AppError or ErrorHandler classes) required (no default)
$messages array Message that is to be displayed by the error class optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 188
return
error message
access
public

__construct

top
Class constructor, overridden in descendant classes.
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 62

dispatchMethod

top
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:
$method string Name of the method to call required (no default)
$params array Parameter list to use when calling $method optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 112
return
mixed Returns the result of the method call
access
public

getInstance

top
Returns a single instance of App.
Method defined in class:
App
Method defined in file:
cake/libs/configure.php on line 890
return
object
access
public

import

top
Finds classes based on $name or specific file(s) to search.
Parameters:
$type mixed The type of Class if passed as a string, or all params can be passed as an single array to $type, optional NULL
$name string Name of the Class or a unique name for the file optional NULL
$parent mixed 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"; optional true
$search array paths to search for files, array('path 1', 'path 2', 'path 3'); optional array ( )
$file string full name of the file to search for including extension optional NULL
$return optional false
Method defined in class:
App
Method defined in file:
cake/libs/configure.php on line 768
link
http://book.cakephp.org/view/529/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

top
API for logging events.
Parameters:
$msg string Log message required (no default)
$type integer Error type constant. Defined in app/config/core.php. optional 2
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 149
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 class:
Object
Method defined in file:
cake/libs/object.php on line 52
return
Object

_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:
$name string name of the class to persist required (no default)
$return required (no default)
$object string the object to persist required (no default)
$type optional NULL
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 218
return
boolean Success
access
protected
todo
add examples to manual

requestAction

top
Calls a controller's method from any location.
Parameters:
$url mixed String or array-based url. required (no default)
$extra array if array includes the key "return" it sets the AutoRender to true. optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 85
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:
$name string name used for object to cache required (no default)
$object object the object to persist required (no default)
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 246
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.
Parameters:
$properties array An associative array containing properties and corresponding values. optional array ( )
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 168
return
void
access
protected

_stop

top
Stop execution of the current script
Parameters:
$status optional 0
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 138
return
void
access
public

toString

top
Object-to-string conversion. Each class can override this method as necessary.
Method defined in class:
Object
Method defined in file:
cake/libs/object.php on line 72
return
string The name of this class
access
public