Permalink
Browse files

Adding doc blocks for new methods.

  • Loading branch information...
markstory committed Feb 28, 2010
1 parent 37cf554 commit 3f0c0d88482b0dddf30f600c47f61cf51a849063
Showing with 14 additions and 0 deletions.
  1. +7 −0 cake/libs/controller/component.php
  2. +7 −0 cake/libs/controller/controller.php
@@ -167,6 +167,13 @@ function shutdown(&$controller) {
* 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
@@ -518,6 +518,10 @@ function constructClasses() {
* 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 @@ function startupProcess() {
* 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
*/

0 comments on commit 3f0c0d8

Please sign in to comment.