Previous Page
Constants

Solar_Auth_Adapter_Ini
Properties

Next Page
Methods

Properties

Public

$active

(int) The Unix time at which the authenticated handle was last valid.

Inherited from Solar_Auth_Adapter.

Convenience reference to $this->_session->store['active'].

$allow

(bool) Whether or not to allow authentication actions (login/logout).

Inherited from Solar_Auth_Adapter.

$email

(string) The email address of the currently authenticated user.

Inherited from Solar_Auth_Adapter.

May or may not be populated by the adapter.

Convenience reference to $this->_session->store['email'].

$handle

(string) The currently authenticated user handle.

Inherited from Solar_Auth_Adapter.

Convenience reference to $this->_session->store['handle'].

$initial

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

Inherited from Solar_Auth_Adapter.

Convenience reference to $this->_session->store['initial'].

$moniker

(string) The "display name" or "full name" of the currently authenticated user.

Inherited from Solar_Auth_Adapter.

May or may not be populated by the adapter.

Convenience reference to $this->_session->store['moniker'].

$status

(string) The status code of the current user authentication.

Inherited from Solar_Auth_Adapter.

The string codes are ...

ANON
The user is anonymous/unauthenticated (no attempt to authenticate)
EXPIRED
The max time for authentication has expired
IDLED
The authenticated user has been idle for too long
VALID
The user is authenticated and has not timed out
WRONG
The user attempted authentication but failed

Convenience reference to $this->_session->store['status'].

$uid

(string) The numeric user ID for the currently authenticated user.

Inherited from Solar_Auth_Adapter.

May or may not be populated by the adapter.

Convenience reference to $this->_session->store['uid'].

$uri

(string) The URI for the currently authenticated user.

Inherited from Solar_Auth_Adapter.

May or may not be populated by the adapter.

Convenience reference to $this->_session->store['uri'].

Protected

$_Solar_Auth_Adapter

(array) User-supplied configuration values.

Inherited from Solar_Auth_Adapter.

Keys are ...

expire
(int) Authentication lifetime in seconds; zero is forever. Default is 14400 (4 hours).
idle
(int) Maximum allowed idle time in seconds; zero is forever. Default is 1800 (30 minutes).
allow
(bool) Whether or not to allow login/logout attempts.
source
(string) The source for auth credentials, 'get' (via the for GET request vars) or 'post' (via the POST request vars). Default is 'post'.
source_handle
(string) Username key in the credential array source, default 'handle'.
source_passwd
(string) Password key in the credential array source, default 'passwd'.
source_redirect
(string) Element key in the credential array source to indicate where to redirect on successful login or logout.
source_process
(string) Element key in the credential array source to indicate how to process the request, default 'process'.
process_login
(string) The source_process element value indicating a login request; default is the 'PROCESS_LOGIN' locale key value.
process_logout
(string) The source_process element value indicating a logout request; default is the 'PROCESS_LOGOUT' locale key value.
session_class
(string) The class name to use as the session storage segment name. Default is 'Solar_Auth_Adapter' regardless of the actual class name (this lets multiple adapters share the same credential information).

$_Solar_Auth_Adapter_Ini

(array) User-provided configuration values.

Keys are ...

file
(string) Path to .ini file.

$_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.

Inherited from Solar_Auth_Adapter.

$_handle

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

Inherited from Solar_Auth_Adapter.

$_passwd

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

Inherited from Solar_Auth_Adapter.

$_request

(Solar_Request) Details on the current request.

Inherited from Solar_Auth_Adapter.

$_session

(Solar_Session) Class-specific session object.

Inherited from Solar_Auth_Adapter.

$_source

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

Inherited from Solar_Auth_Adapter.

Private

None.