Adding doc blocks for new methods.

This commit is contained in:
Mark Story 2010-02-28 01:55:23 -05:00
parent 37cf55470f
commit 3f0c0d8848
2 changed files with 14 additions and 0 deletions

View file

@ -167,6 +167,13 @@ class Component extends Object {
* 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.
*
* @param Controller $controller Controller instance
* @param string $callback Callback to trigger.
* @return void

View file

@ -518,6 +518,10 @@ class Controller extends Object {
* Perform the startup process for this controller.
* Fire the Component and Controller callbacks in the correct order.
*
* - Initializes components, which fires their `initialize` callback
* - Calls the controller `beforeFilter`.
* - triggers Component `startup` methods.
*
* @return void
* @access public
*/
@ -531,6 +535,9 @@ class Controller extends Object {
* Perform the various shutdown processes for this controller.
* Fire the Component and Controller callbacks in the correct order.
*
* - triggers the component `shutdown` callback.
* - calls the Controller's `afterFilter` method.
*
* @return void
* @access public
*/