CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (GitHub)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • Slack
    • Paid Support
CakePHP

C CakePHP 2.2 API

  • Overview
  • Tree
  • Deprecated
  • Version:
    • 2.2
      • 4.2
      • 4.1
      • 4.0
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Packages

  • Cake
    • Cache
      • Engine
    • Configure
    • Console
      • Command
        • Task
    • Controller
      • Component
        • Acl
        • Auth
    • Core
    • Error
    • Event
    • I18n
    • Log
      • Engine
    • Model
      • Behavior
      • Datasource
        • Database
        • Session
      • Validator
    • Network
      • Email
      • Http
    • Routing
      • Filter
      • Route
    • TestSuite
      • Coverage
      • Fixture
      • Reporter
    • Utility
    • View
      • Helper

Classes

  • ActionsAuthorize
  • BaseAuthenticate
  • BaseAuthorize
  • BasicAuthenticate
  • ControllerAuthorize
  • CrudAuthorize
  • DigestAuthenticate
  • FormAuthenticate

Class BaseAuthenticate

Base Authentication class with common methods and properties.

Direct Subclasses
  • BasicAuthenticate
  • DigestAuthenticate
  • FormAuthenticate
Abstract
Package: Cake\Controller\Component\Auth
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: Cake/Controller/Component/Auth/BaseAuthenticate.php

Properties summary

  • $_Collection protected
    ComponentCollection
    A Component collection, used to get more components.
  • $settings public
    array
    Settings for this object.

Method Summary

  • __construct() public
    Constructor
  • _findUser() protected
    Find a user record using the standard options.
  • _password() protected

    Hash the plain text password so that it matches the hashed/encrypted password in the datasource.

  • authenticate() abstract public
    Authenticate a user based on the request information.
  • getUser() public

    Get a user based on information in the request. Primarily used by stateless authentication systems like basic and digest auth.

  • logout() public

    Allows you to hook into AuthComponent::logout(), and implement specialized logout behavior.

Method Detail

__construct() public ¶

__construct( ComponentCollection $collection , array $settings )

Constructor

Parameters
ComponentCollection $collection
The Component collection used on this request.
array $settings
Array of settings to use.

_findUser() protected ¶

_findUser( string $username , string $password )

Find a user record using the standard options.

Parameters
string $username
The username/identifier.
string $password
The unhashed password.
Returns
Mixed
Either false on failure, or an array of user data.

_password() protected ¶

_password( string $password )

Hash the plain text password so that it matches the hashed/encrypted password in the datasource.

Parameters
string $password
The plain text password.
Returns
string
The hashed form of the password.

authenticate() abstract public ¶

authenticate( CakeRequest $request , CakeResponse $response )

Authenticate a user based on the request information.

Parameters
CakeRequest $request
Request to get authentication information from.
CakeResponse $response
A response object that can have headers added.
Returns
mixed
Either false on failure, or an array of user data on success.

getUser() public ¶

getUser( CakeRequest $request )

Get a user based on information in the request. Primarily used by stateless authentication systems like basic and digest auth.

Parameters
CakeRequest $request
Request object.
Returns
mixed
Either false or an array of user information

logout() public ¶

logout( array $user )

Allows you to hook into AuthComponent::logout(), and implement specialized logout behavior.

All attached authentication objects will have this method called when a user logs out.

Parameters
array $user
The user about to be logged out.

Properties detail

$_Collection ¶

protected ComponentCollection

A Component collection, used to get more components.

$settings ¶

public array

Settings for this object.

  • fields The fields to use to identify a user by.
  • userModel The model name of the User, defaults to User.
  • scope Additional conditions to use when looking up and authenticating users, i.e. array('User.is_active' => 1).
  • recursive The value of the recursive key passed to find(). Defaults to 0.
  • contain Extra models to contain and store in session.
array(
    'fields' => array(
        'username' => 'username',
        'password' => 'password'
    ),
    'userModel' => 'User',
    'scope' => array(),
    'recursive' => 0,
    'contain' => null,
)
OpenHub
Rackspace
Rackspace
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (GitHub)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • Slack
  • Paid Support

Generated using CakePHP API Docs