Class Component
Handler for Controller::$components
- Object
-
Component
Link: http://book.cakephp.org/1.3/en/The-Manual/Developing-with-CakePHP/Components.html
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: controller/component.php
Properties summary
-
$__controllerVarspublicobjectContains various controller variable information (plugin, name, base). -
$__settingspublicarraySettings for loaded components. -
$_loadedpublicobjectList of loaded components. -
$_primarypublicobjectList of components attached directly to the controller, which callbacks should be executed on.
Method Summary
-
_loadComponents() public
Loads components used by this component. -
beforeRedirect() public
Called before Controller::redirect(). -
beforeRender() public deprecated
Called after the Controller::beforeRender(), after the view class is loaded, and before the Controller::render()
-
init() public
Used to initialize the components for current controller. -
initialize() public
Called before the Controller::beforeFilter(). -
shutdown() public deprecated
Called after Controller::render() and before the output is printed to the browser. -
startup() public deprecated
Called after the Controller::beforeFilter() and before the controller action -
triggerCallback() public
Trigger 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.
Method Detail
_loadComponents() public ¶
_loadComponents( object $object , object $parent = null )
Loads components used by this component.
Parameters
- object $object
- Object with a Components array
- object $parent optional null
- the parent of the current object
beforeRedirect() public ¶
beforeRedirect( object $controller , $url , $status = null , $exit = true )
Called before Controller::redirect().
Parameters
- object $controller
- Controller with components to beforeRedirect
- $url
- $status optional null
- $exit optional true
beforeRender() public deprecated ¶
beforeRender( object $controller )
Called after the Controller::beforeRender(), after the view class is loaded, and before the Controller::render()
Deprecated
Parameters
- object $controller
- Controller with components to beforeRender
init() public ¶
init( object $controller )
Used to initialize the components for current controller.
Parameters
- object $controller
- Controller with components to load
initialize() public ¶
initialize( object $controller )
Called before the Controller::beforeFilter().
Parameters
- object $controller
- Controller with components to initialize
Link
shutdown() public deprecated ¶
shutdown( object $controller )
Called after Controller::render() and before the output is printed to the browser.
Deprecated
Parameters
- object $controller
- Controller with components to shutdown
startup() public deprecated ¶
startup( object $controller )
Called after the Controller::beforeFilter() and before the controller action
Deprecated
Parameters
- object $controller
- Controller with components to startup
Link
triggerCallback() public ¶
triggerCallback( Controller $callback , string $controller )
Trigger 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
-
Controller$callback - $controller Controller instance
- string $controller
- $callback Callback to trigger.
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. Will only set properties that are part of a class declaration.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script. Wraps exit() making testing easier.
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
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 )
Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
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. 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
- 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
Properties detail
$__controllerVars ¶
Contains various controller variable information (plugin, name, base).
array('plugin' => null, 'name' => null, 'base' => null)