Tidy up doc blocks.

These kind of changes make tidyier method summaries in apigen.
This commit is contained in:
mark_story 2013-02-26 21:43:53 -05:00
parent 33bd7a571a
commit d9fbe5e00a
5 changed files with 53 additions and 24 deletions

View file

@ -158,7 +158,7 @@ class Component extends Object {
* @param integer $status The status code of the redirect * @param integer $status The status code of the redirect
* @param boolean $exit Will the script exit. * @param boolean $exit Will the script exit.
* @return array|void Either an array or null. * @return array|void Either an array or null.
* @link @link http://book.cakephp.org/2.0/en/controllers/components.html#Component::beforeRedirect * @link http://book.cakephp.org/2.0/en/controllers/components.html#Component::beforeRedirect
*/ */
public function beforeRedirect(Controller $controller, $url, $status = null, $exit = true) { public function beforeRedirect(Controller $controller, $url, $status = null, $exit = true) {
} }

View file

@ -385,6 +385,8 @@ class AuthComponent extends Component {
} }
/** /**
* Check if the provided user is authorized for the request.
*
* Uses the configured Authorization adapters to check whether or not a user is authorized. * Uses the configured Authorization adapters to check whether or not a user is authorized.
* Each adapter will be checked in sequence, if any of them return true, then the user will * Each adapter will be checked in sequence, if any of them return true, then the user will
* be authorized for the request. * be authorized for the request.
@ -506,7 +508,9 @@ class AuthComponent extends Component {
} }
/** /**
* Maps action names to CRUD operations. Used for controller-based authentication. Make sure * Maps action names to CRUD operations.
*
* Used for controller-based authentication. Make sure
* to configure the authorize property before calling this method. As it delegates $map to all the * to configure the authorize property before calling this method. As it delegates $map to all the
* attached authorize objects. * attached authorize objects.
* *
@ -525,7 +529,9 @@ class AuthComponent extends Component {
} }
/** /**
* Log a user in. If a $user is provided that data will be stored as the logged in user. If `$user` is empty or not * Log a user in.
*
* If a $user is provided that data will be stored as the logged in user. If `$user` is empty or not
* specified, the request will be used to identify a user. If the identification was successful, * specified, the request will be used to identify a user. If the identification was successful,
* the user record is written to the session key specified in AuthComponent::$sessionKey. Logging in * the user record is written to the session key specified in AuthComponent::$sessionKey. Logging in
* will also change the session id in order to help mitigate session replays. * will also change the session id in order to help mitigate session replays.
@ -548,11 +554,13 @@ class AuthComponent extends Component {
} }
/** /**
* Logs a user out, and returns the login action to redirect to. * Log a user out.
* Triggers the logout() method of all the authenticate objects, so they can perform *
* custom logout logic. AuthComponent will remove the session data, so * Returns the login action to redirect to. Triggers the logout() method of
* there is no need to do that in an authentication object. Logging out * all the authenticate objects, so they can perform custom logout logic.
* will also renew the session id. This helps mitigate issues with session replays. * AuthComponent will remove the session data, so there is no need to do that
* in an authentication object. Logging out will also renew the session id.
* This helps mitigate issues with session replays.
* *
* @return string AuthComponent::$logoutRedirect * @return string AuthComponent::$logoutRedirect
* @see AuthComponent::$logoutRedirect * @see AuthComponent::$logoutRedirect
@ -635,6 +643,8 @@ class AuthComponent extends Component {
} }
/** /**
* Get the URL a use should be redirected to upon login.
*
* If no parameter is passed, gets the authentication redirect URL. Pass a url in to * If no parameter is passed, gets the authentication redirect URL. Pass a url in to
* set the destination a user should be redirected to upon logging in. Will fallback to * set the destination a user should be redirected to upon logging in. Will fallback to
* AuthComponent::$loginRedirect if there is no stored redirect value. * AuthComponent::$loginRedirect if there is no stored redirect value.

View file

@ -1096,7 +1096,9 @@ class Controller extends Object implements CakeEventListener {
/** /**
* The beforeRedirect method is invoked when the controller's redirect method is called but before any * The beforeRedirect method is invoked when the controller's redirect method is called but before any
* further action. If this method returns false the controller will not continue on to redirect the request. * further action.
*
* If this method returns false the controller will not continue on to redirect the request.
* The $url, $status and $exit variables have same meaning as for the controller's method. You can also * The $url, $status and $exit variables have same meaning as for the controller's method. You can also
* return a string which will be interpreted as the url to redirect to or return associative array with * return a string which will be interpreted as the url to redirect to or return associative array with
* key 'url' and optionally 'status' and 'exit'. * key 'url' and optionally 'status' and 'exit'.

View file

@ -103,7 +103,9 @@ class CakeRoute {
} }
/** /**
* Compiles the route's regular expression. Modifies defaults property so all necessary keys are set * Compiles the route's regular expression.
*
* Modifies defaults property so all necessary keys are set
* and populates $this->names with the named routing elements. * and populates $this->names with the named routing elements.
* *
* @return array Returns a string regular expression of the compiled route. * @return array Returns a string regular expression of the compiled route.
@ -117,8 +119,10 @@ class CakeRoute {
} }
/** /**
* Builds a route regular expression. Uses the template, defaults and options * Builds a route regular expression.
* properties to compile a regular expression that can be used to parse request strings. *
* Uses the template, defaults and options properties to compile a
* regular expression that can be used to parse request strings.
* *
* @return void * @return void
*/ */
@ -172,6 +176,7 @@ class CakeRoute {
/** /**
* Checks to see if the given URL can be parsed by this route. * Checks to see if the given URL can be parsed by this route.
*
* If the route can be parsed an array of parameters will be returned; if not * If the route can be parsed an array of parameters will be returned; if not
* false will be returned. String urls are parsed if they match a routes regular expression. * false will be returned. String urls are parsed if they match a routes regular expression.
* *
@ -324,8 +329,10 @@ class CakeRoute {
} }
/** /**
* Return true if a given named $param's $val matches a given $rule depending on $context. Currently implemented * Check if a named parameter matches the current rules.
* rule types are controller, action and match that can be combined with each other. *
* Return true if a given named $param's $val matches a given $rule depending on $context.
* Currently implemented rule types are controller, action and match that can be combined with each other.
* *
* @param string $val The value of the named parameter * @param string $val The value of the named parameter
* @param array $rule The rule(s) to apply, can also be a match string * @param array $rule The rule(s) to apply, can also be a match string
@ -379,7 +386,9 @@ class CakeRoute {
} }
/** /**
* Attempt to match a url array. If the url matches the route parameters and settings, then * Check if a url array matches this route instance.
*
* If the url matches the route parameters and settings, then
* return a generated string url. If the url doesn't match the route parameters, false will be returned. * return a generated string url. If the url doesn't match the route parameters, false will be returned.
* This method handles the reverse routing or conversion of url arrays into string urls. * This method handles the reverse routing or conversion of url arrays into string urls.
* *
@ -472,7 +481,9 @@ class CakeRoute {
} }
/** /**
* Converts a matching route array into a url string. Composes the string url using the template * Converts a matching route array into a url string.
*
* Composes the string url using the template
* used to create the route. * used to create the route.
* *
* @param array $params The params to convert to a string url. * @param array $params The params to convert to a string url.

View file

@ -1008,9 +1008,11 @@ class Router {
} }
/** /**
* Reverses a parsed parameter array into a string. Works similarly to Router::url(), but * Reverses a parsed parameter array into a string.
* Since parsed URL's contain additional 'pass' and 'named' as well as 'url.url' keys. *
* Those keys need to be specially handled in order to reverse a params array into a string url. * Works similarly to Router::url(), but since parsed URL's contain additional
* 'pass' and 'named' as well as 'url.url' keys. Those keys need to be specially
* handled in order to reverse a params array into a string url.
* *
* This will strip out 'autoRender', 'bare', 'requested', and 'return' param names as those * This will strip out 'autoRender', 'bare', 'requested', and 'return' param names as those
* are used for CakePHP internals and should not normally be part of an output url. * are used for CakePHP internals and should not normally be part of an output url.
@ -1043,9 +1045,10 @@ class Router {
} }
/** /**
* Normalizes a URL for purposes of comparison. Will strip the base path off * Normalizes a URL for purposes of comparison.
* and replace any double /'s. It will not unify the casing and underscoring *
* of the input value. * Will strip the base path off and replace any double /'s.
* It will not unify the casing and underscoring of the input value.
* *
* @param array|string $url URL to normalize Either an array or a string url. * @param array|string $url URL to normalize Either an array or a string url.
* @return string Normalized URL * @return string Normalized URL
@ -1115,8 +1118,9 @@ class Router {
} }
/** /**
* Instructs the router to parse out file extensions from the URL. For example, * Instructs the router to parse out file extensions from the URL.
* http://example.com/posts.rss would yield an file extension of "rss". *
* For example, http://example.com/posts.rss would yield an file extension of "rss".
* The file extension itself is made available in the controller as * The file extension itself is made available in the controller as
* `$this->params['ext']`, and is used by the RequestHandler component to * `$this->params['ext']`, and is used by the RequestHandler component to
* automatically switch to alternate layouts and templates, and load helpers * automatically switch to alternate layouts and templates, and load helpers
@ -1139,6 +1143,7 @@ class Router {
/** /**
* Get the list of extensions that can be parsed by Router. * Get the list of extensions that can be parsed by Router.
*
* To initially set extensions use `Router::parseExtensions()` * To initially set extensions use `Router::parseExtensions()`
* To add more see `setExtensions()` * To add more see `setExtensions()`
* *
@ -1154,6 +1159,7 @@ class Router {
/** /**
* Set/add valid extensions. * Set/add valid extensions.
*
* To have the extensions parsed you still need to call `Router::parseExtensions()` * To have the extensions parsed you still need to call `Router::parseExtensions()`
* *
* @param array $extensions List of extensions to be added as valid extension * @param array $extensions List of extensions to be added as valid extension