Authentication control component class
Binds access control with user authentication and session management.
_getUser( )
Similar to AuthComponent::user() except if the session user cannot be found, connected authentication objects will have their getUser() methods called. This lets stateless authentication methods function correctly.
boolean
_isAllowed( Controller $controller )
Checks whether current action is accessible without authentication.
Controller
$controller
boolean
_isLoginAction( Controller $controller )
Normalizes $loginAction and checks if current request URL is same as login action.
Controller
$controller
boolean
_setDefaults( )
Attempts to introspect the correct values for object properties.
boolean
_unauthenticated( Controller $controller )
Handles unauthenticated access attempt. First the unathenticated()
method of the last authenticator in the chain will be called. The authenticator can handle sending response or redirection as appropriate and return true
to indicate no furthur action is necessary. If authenticator returns null this method redirects user to login action. If it's an ajax request and $ajaxLogin is specified that element is rendered else a 403 http status code is returned.
Controller
$controller
boolean
_unauthorized( Controller $controller )
Handle unauthorized access attempt
Controller
$controller
boolean
ForbiddenException
AuthComponent::$unauthorizedRedirect
allow( string|array $action null )
Takes a list of actions in the current controller for which authentication is not required, or no parameters to allow all actions.
You can use allow with either an array, or var args.
$this->Auth->allow(array('edit', 'add'));
or $this->Auth->allow('edit', 'add');
or $this->Auth->allow();
to allow all actions
$action
optional null constructAuthenticate( )
Loads the configured authentication objects.
mixed
CakeException
constructAuthorize( )
Loads the authorization objects configured.
mixed
CakeException
deny( string|array $action null )
Removes items from the list of allowed/no authentication required actions.
You can use deny with either an array, or var args.
$this->Auth->deny(array('edit', 'add'));
or $this->Auth->deny('edit', 'add');
or $this->Auth->deny();
to remove all items from the allowed list
$action
optional null AuthComponent::allow()
flash( string $message )
Set a flash message. Uses the Session component, and values from AuthComponent::$flash.
$message
identify( CakeRequest $request , CakeResponse $response )
Use the configured authentication adapters, and attempt to identify the user by credentials contained in $request.
CakeRequest
$request
CakeResponse
$response
array
initialize( Controller $controller )
Initializes AuthComponent for use in the controller.
Controller
$controller
Component::initialize()
isAuthorized( array $user null , CakeRequest $request null )
Check if the provided user is authorized for the request.
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 be authorized for the request.
$user
optional null CakeRequest
$request
optional null boolean
loggedIn( )
Check whether or not the current user has data in the session, and is considered logged in.
boolean
login( array $user null )
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, 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.
$user
optional null boolean
logout( )
Log a user out.
Returns the logout action to redirect to. Triggers the logout() method of 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 in an authentication object. Logging out will also renew the session id. This helps mitigate issues with session replays.
string
AuthComponent::$logoutRedirect
mapActions( array $map array() )
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 attached authorize objects.
actionMap
config key on authorize objects instead$map
optional array() BaseAuthorize::mapActions()
password( string $password )
Hash a password with the application's salt value (as defined with Configure::write('Security.salt');
This method is intended as a convenience wrapper for Security::hash(). If you want to use a hashing/encryption system not supported by that method, do not use this method.
$password
string
redirect( string|array $url null )
Backwards compatible alias for AuthComponent::redirectUrl().
$url
optional null string
redirectUrl( string|array $url null )
Get the URL a user should be redirected to upon login.
Pass a URL in to set the destination a user should be redirected to upon logging in.
If no parameter is passed, gets the authentication redirect URL. The URL returned is as per following rules:
- Returns the normalized URL from session Auth.redirect value if it is present and for the same domain the current app is running on. - If there is no session value and there is a $loginRedirect, the $loginRedirect value is returned. - If there is no session and no $loginRedirect, / is returned.
$url
optional null string
startup( Controller $controller )
Main execution method. Handles redirecting of invalid users, and processing of login form data.
Controller
$controller
boolean
Component::startup()
user( string $key null )
Get the current user.
Will prefer the static user cache over sessions. The static user cache is primarily used for stateless authentication. For stateful authentication, cookies + sessions will be used.
$key
optional null mixed|null
__construct( ComponentCollection $collection , array $settings array() )
Constructor
ComponentCollection
$collection
$settings
optional array() Object::__construct()
__get( string $name )
Magic method for lazy loading $components.
$name
mixed
beforeRedirect( Controller $controller , string|array $url , integer $status null , boolean $exit true )
Called before Controller::redirect(). Allows you to replace the URL that will be redirected to with a new URL. The return of this method can either be an array or a string.
If the return is an array and contains a 'url' key. You may also supply the following:
status
The status code for the redirectexit
Whether or not the redirect should exit.If your response is a string or an array that does not contain a 'url' key it will be used as the new URL to redirect to.
Controller
$controller
$url
$status
optional null $exit
optional true array|null
beforeRender( Controller $controller )
Called before the Controller::beforeRender(), and before the view class is loaded, and before Controller::render()
Controller
$controller
shutdown( Controller $controller )
Called after Controller::render() and before the output is printed to the browser.
Controller
$controller
_mergeVars( array $properties , string $class , boolean $normalize true )
Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'
This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.
$properties
$class
$normalize
optional true _set( array $properties array() )
Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.
$properties
optional array() _stop( integer|string $status 0 )
Stop execution of the current script. Wraps exit() making testing easier.
$status
optional 0 dispatchMethod( string $method , array $params array() )
Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array
$method
$params
optional array() mixed
log( string $msg , integer $type LOG_ERR , null|string|array $scope null )
Convenience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
$msg
$type
optional LOG_ERR $scope
optional null boolean
requestAction( string|array $url , array $extra array() )
Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()
POST and GET data can be simulated in requestAction. Use $extra['url']
for GET data. The $extra['data']
parameter allows POST data simulation.
$url
$extra
optional array() mixed
toString( )
Object-to-string conversion. Each class can override this method as necessary.
string
string | ALL Constant for 'all' | 'all' |
protected ComponentCollection
Component collection class used to lazy load components.
protected array
A component lookup table used to lazy load component objects.
array()
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.7/class-AuthComponent.html