adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2025-09-06 19:42:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updating AuthComponent docblocks

Browse source 
git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@4326 3807eeeb-6ff5-0310-8944-8be069107fe0
This commit is contained in:
nate 2007-01-24 04:38:39 +00:00
parent 138a5001cf
commit 5654ae2f63
1 changed files with 8 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
cake/libs/controller/components/auth.php
View file

@ -288,7 +288,7 @@ class AuthComponent extends Object {
return true; return true;
} }
/** /**
* Takes a list of actions in the current controller for which validation is not required, or * Takes a list of actions in the current controller for which authentication is not required, or
* no parameters to allow all actions. * no parameters to allow all actions.
* *
* @access public * @access public
@ -306,7 +306,12 @@ class AuthComponent extends Object {
} }
} }
/** /**
* Manually log-in a user with the given parameter data. * Manually log-in a user with the given parameter data. The $data provided can be any data
* structure used to identify a user in AuthComponent::identify(). If $data is empty or not
* specified, POST data from Controller::$data will be used automatically.
*
* After (if) login is successful, the user record is written to the session key specified in
* AuthComponent::$sessionKey.
* *
* @access public * @access public
* @param mixed $data User object * @param mixed $data User object
@ -331,6 +336,7 @@ class AuthComponent extends Object {
* @access public * @access public
* @param mixed $url Optional URL to redirect the user to after logout * @param mixed $url Optional URL to redirect the user to after logout
* @return string AuthComponent::$loginAction * @return string AuthComponent::$loginAction
* @see AuthComponent::$loginAction
*/ */
function logout() { function logout() {
$this->Session->del($this->sessionKey, $user); $this->Session->del($this->sessionKey, $user);