adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2024-11-15 11:28:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Correct doc blocks for AuthComponent

Browse source
This commit is contained in:
euromark 2013-08-31 19:58:10 -07:00
parent f91eb3b508
commit a36456cc87
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lib/Cake/Controller/Component/AuthComponent.php
View file

@ -175,7 +175,7 @@ class AuthComponent extends Component {
/** /**
* An URL (defined as a string or array) to the controller action that handles * An URL (defined as a string or array) to the controller action that handles
* logins. Defaults to `/users/login` * logins. Defaults to `/users/login`.
* *
* @var mixed * @var mixed
*/ */
@ -250,14 +250,14 @@ class AuthComponent extends Component {
public $response; public $response;
/** /**
* Method list for bound controller * Method list for bound controller.
* *
* @var array * @var array
*/ */
protected $_methods = array(); protected $_methods = array();
/** /**
* Initializes AuthComponent for use in the controller * Initializes AuthComponent for use in the controller.
* *
* @param Controller $controller A reference to the instantiating controller object * @param Controller $controller A reference to the instantiating controller object
* @return void * @return void
@ -610,7 +610,7 @@ class AuthComponent extends Component {
/** /**
* Log a user out. * Log a user out.
* *
* Returns the login action to redirect to. Triggers the logout() method of * Returns the logout action to redirect to. Triggers the logout() method of
* all the authenticate objects, so they can perform custom logout logic. * all the authenticate objects, so they can perform custom logout logic.
* AuthComponent will remove the session data, so there is no need to do that * 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. * in an authentication object. Logging out will also renew the session id.
@ -688,7 +688,7 @@ class AuthComponent extends Component {
} }
/** /**
* Backwards compatible alias for AuthComponent::redirectUrl() * Backwards compatible alias for AuthComponent::redirectUrl().
* *
* @param string|array $url Optional URL to write as the login redirect URL. * @param string|array $url Optional URL to write as the login redirect URL.
* @return string Redirect URL * @return string Redirect URL
@ -760,7 +760,7 @@ class AuthComponent extends Component {
} }
/** /**
* loads the configured authentication objects. * Loads the configured authentication objects.
* *
* @return mixed either null on empty authenticate value, or an array of loaded objects. * @return mixed either null on empty authenticate value, or an array of loaded objects.
* @throws CakeException * @throws CakeException