Class AuthComponent

Properties summary

• $_loggedIn public
  boolean
  Maintains current user login state.
• $_methods public
  array
  Method list for bound controller
• $actionMap public
  array
  Maps actions to CRUD operations. Used for controller-based validation ($validate = 'controller').
• $actionPath public
  string

  If using action-based access control, this defines how the paths to action ACO nodes is computed. If, for example, all controller nodes are nested under an ACO node named 'Controllers', $actionPath should be set to "Controllers/".

• $ajaxLogin public
  string

  The name of an optional view element to render when an Ajax request is made with an invalid or expired session

• $allowedActions public
  array
  Controller actions for which user validation is not required.
• $authError public
  string

  Error to display when user attempts to access an object or action to which they do not have acccess.

• $authenticate public
  object
  A reference to the object used for authentication
• $authorize public
  mixed

  The name of the component to use for Authorization or set this to 'controller' will validate against Controller::isAuthorized() 'actions' will validate Controller::action against an AclComponent::check() 'crud' will validate mapActions against an AclComponent::check() array('model'=> 'name'); will validate mapActions against model $name::isAuthorized(user, controller, mapAction) 'object' will validate Controller::action against object::isAuthorized(user, controller, action)

• $autoRedirect public
  boolean
  Determines whether AuthComponent will automatically redirect and exit if login is successful.
• $components public
  array
  Other components utilized by AuthComponent
• $data public
  array
  Form data from Controller::$data
• $fields public
  array

  Allows you to specify non-default login name and password fields used in $userModel, i.e. array('username' => 'login_name', 'password' => 'passwd').

• $flashElement public
  string
  The name of the element used for SessionComponent::setFlash
• $loginAction public
  mixed

  A URL (defined as a string or array) to the controller action that handles logins.

• $loginError public
  string

  Error to display when user login fails. For security purposes, only one error is used for all login failures, so as not to expose information on why the login failed.

• $loginRedirect public
  mixed

  Normally, if a user is redirected to the $loginAction page, the location they were redirected from will be stored in the session so that they can be redirected back after a successful login. If this session value is not set, the user will be redirected to the page specified in $loginRedirect.

• $logoutRedirect public
  mixed

  The default action to redirect to after the user is logged out. While AuthComponent does not handle post-logout redirection, a redirect URL will be returned from AuthComponent::logout(). Defaults to AuthComponent::$loginAction.

• $object public
  string
  The name of model or model object, or any other object has an isAuthorized method.
• $params public
  array
  Parameter data from Controller::$params
• $sessionKey public
  string

  The session key name where the record of the current user is stored. If unspecified, it will be "Auth.{$userModel name}".

• $userModel public
  string
  The name of the model that represents users which will be authenticated. Defaults to 'User'.
• $userScope public
  array

  Additional query conditions to use when looking up and authenticating users, i.e. array('User.is_active' => 1).

Method Summary

• __authType() public

  Get authorization type

• __setDefaults() public

  Attempts to introspect the correct values for object properties including $userModel and $sessionKey.

• action() public

  Returns the path to the ACO node bound to a controller/action.

• allow() public

  Takes a list of actions in the current controller for which authentication is not required, or no parameters to allow all actions.

• deny() public

  Removes items from the list of allowed actions.

• getModel() public

  Returns a reference to the model object specified, and attempts to load it if it is not found.

• hashPasswords() public

  Hash any passwords found in $data using $userModel and $fields['password']

• identify() public

  Identifies a user based on specific criteria.

• initialize() public

  Initializes AuthComponent for use in the controller

• isAuthorized() public

  Determines whether the given user is authorized to perform an action. The type of authorization used is based on the value of AuthComponent::$authorize or the passed $type param.

• login() public

  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.

• logout() public

  Logs a user out, and returns the login action to redirect to.

• mapActions() public

  Maps action names to CRUD operations. Used for controller-based authentication.

• password() public

  Hash a password with the application's salt value (as defined with Configure::write('Security.salt');

• redirect() public

  If no parameter is passed, gets the authentication redirect URL.

• shutdown() public

  Component shutdown. If user is logged in, wipe out redirect.

• startup() public

  Main execution method. Handles redirecting of invalid users, and processing of login form data.

• user() public

  Get the current user from the session.

• validate() public

  Validates a user against an abstract object.

Method Detail

Methods inherited from Object

Properties detail

false

array()

array(
    'index'     => 'read',
    'add'       => 'create',
    'edit'      => 'update',
    'view'      => 'read',
    'remove'    => 'delete'
)

null

null

array()

null

null

false

true

array('Session', 'RequestHandler')

array()

array('username' => 'username', 'password' => 'password')

'default'

null

null

null

null

null

array()

null

'User'

array()