Previous Page
Constants

Solar_Auth_Adapter
Properties

Next Page
Methods

Properties

Public

$allow

(bool) Whether or not to allow automatic login/logout at start() time.

Protected

$_Solar_Auth_Adapter

(array) Default configuration values.

$_cache

(Solar_Cache_Adapter) A cache object to retain the current user information.

$_config

(array) Collection point for configuration values.

Inherited from Solar_Base.

Note that you do not define config defaults in $_config directly.

<?php
// DO NOT DO THIS
protected $_config = array(
    'foo' => 'bar',
    'baz' => 'dib',
);
?>

Instead, define config defaults in a protected property named for the class, withan underscore prefix.

For exmple, a "Vendor_Class_Name" class would define the default config array in "$_Vendor_Class_Name". This convention lets child classes inherit parent config keys and values.

<?php
// DO THIS INSTEAD
protected $_Vendor_Class_Name = array(
    'foo' => 'bar',
    'baz' => 'dib',
);
?>

$_err

(string) The current error code string.

$_handle

(string) The user-provided plaintext handle, if any.

$_magic

(array) Magic "public" properties that are actually stored in the cache.

The available magic properties are ...

  • status: (string) The Unix time at which the authenticated handle was last valid.

  • initial: (int) The Unix time at which the handle was initially authenticated.

  • active: (int) The status code of the current user authentication. The string codes are ...

    • Solar_Auth::ANON (or empty): The user is anonymous/unauthenticated (no attempt to authenticate)

    • Solar_Auth::EXPIRED: The max time for authentication has expired

    • Solar_Auth::IDLED: The authenticated user has been idle for too long

    • Solar_Auth::VALID: The user is authenticated and has not timed out

    • Solar_Auth::WRONG: The user attempted authentication but failed

  • handle: (string) The currently authenticated user handle.

  • email: (string) The email address of the currently authenticated user. May or may not be populated by the adapter.

  • moniker: (string) The "display name" or "full name" of the currently authenticated user. May or may not be populated by the adapter.

  • uri: (string) The URI for the currently authenticated user. May or may not be populated by the adapter.

  • uid: (mixed) The user ID (usually numeric) for the currently authenticated user. May or may not be populated by the adapter.

$_passwd

(string) The user-provided plaintext password, if any.

$_request

(Solar_Request) Details on the current request.

$_source

(string) The source of auth credentials, either 'get' or 'post'.

Private

None.