Component Class Info:
- Class Declaration:
class Component extends Object
- File name:
- cake/libs/controller/component.php
- Description:
Handler for Controller::$components
- Class Inheritance
- Package
- cake
- Subpackage
- cake.cake.libs.controller
- Link
- http://book.cakephp.org/view/993/Components
Properties:
-
_loaded object
List of loaded components.
-
_primary object
List of components attached directly to the controller, which callbacks should be executed on.
Method Summary:
- beforeRedirect( $controller, $url, $status = NULL, $exit = true )
- beforeRender( $controller )
- cakeError( $method, $messages = array ( ) )
- __construct( )
- dispatchMethod( $method, $params = array ( ) )
- init( $controller )
- initialize( $controller )
- _loadComponents( $object, $parent = NULL )
- log( $msg, $type = 2 )
- Object( )
- _persist( $name, $return, $object, $type = NULL )
- requestAction( $url, $extra = array ( ) )
- _savePersistent( $name, $object )
- _set( $properties = array ( ) )
- shutdown( $controller )
- startup( $controller )
- _stop( $status = 0 )
- toString( )
- triggerCallback( $callback, $controller )
beforeRedirect
topCalled before Controller::redirect().
- Parameters:
-
-
object $controller required
Controller with components to beforeRedirect
-
$url required
-
$status optional NULL
-
$exit optional true
-
- Method defined in:
- cake/libs/controller/component.php on line 136
- Return
void
- Access
public
beforeRender
topCalled after the Controller::beforeRender(), after the view class is loaded, and before the Controller::render()
- Parameters:
-
-
object $controller required
Controller with components to beforeRender
-
- Method defined in:
- cake/libs/controller/component.php on line 125
- Return
void
- Access
public
- Deprecated
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
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
init
topUsed to initialize the components for current controller.
- Parameters:
-
-
object $controller required
Controller with components to load
-
- Method defined in:
- cake/libs/controller/component.php on line 69
- Return
void
- Access
public
initialize
topCalled before the Controller::beforeFilter().
- Parameters:
-
-
object $controller required
Controller with components to initialize
-
- Method defined in:
- cake/libs/controller/component.php on line 89
- Return
void
- Access
public
- Link
- http://book.cakephp.org/view/998/MVC-Class-Access-Within-Components
_loadComponents
topLoads components used by this component.
- Parameters:
-
-
object $object required
Object with a Components array
-
object $parent optional NULL
the parent of the current object
-
- Method defined in:
- cake/libs/controller/component.php on line 199
- Return
void
- Access
protected
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
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
shutdown
topCalled after Controller::render() and before the output is printed to the browser.
- Parameters:
-
-
object $controller required
Controller with components to shutdown
-
- Method defined in:
- cake/libs/controller/component.php on line 161
- Return
void
- Access
public
- Deprecated
startup
topCalled after the Controller::beforeFilter() and before the controller action
- Parameters:
-
-
object $controller required
Controller with components to startup
-
- Method defined in:
- cake/libs/controller/component.php on line 112
- Return
void
- Access
public
- Link
- http://book.cakephp.org/view/998/MVC-Class-Access-Within-Components
- Deprecated
_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
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
triggerCallback
topTrigger a callback on all primary components. Will fire $callback on all components that have such a method. You can implement and fire custom callbacks in addition to the standard ones.
example use, from inside a controller:
$this->Component->triggerCallback('beforeFilter', $this);
will trigger the beforeFilter callback on all components that have implemented one. You can trigger any method in this fashion.
- Parameters:
-
-
string $callback required
Callback to trigger.
-
Controller $controller required
Controller instance
-
- Method defined in:
- cake/libs/controller/component.php on line 182
- Return
void
- Access
public
