xplo.re Medusa Core Framework 3.1
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Event
  • Todo
  • Download

Namespaces

  • Core
    • Authentication
      • Auto
        • Driver
      • Driver
    • Cache
      • Driver
    • Charset
      • Driver
    • Configuration
    • Controller
    • Converter
      • Driver
    • Decoder
      • Driver
    • Encoder
      • Driver
    • Env
      • Authentication
      • Locale
      • Proxy
      • Server
        • HTTP
        • Redirect
        • X
    • Exception
    • Exchange
      • Driver
    • Field
    • Filter
      • Driver
    • Formatter
      • Driver
        • coreuimarkup
          • Token
    • Hash
    • Loader
    • Locale
    • Log
      • Driver
    • Module
      • Dependency
        • Requirement
          • Core
          • PHP
      • Linkage
        • Driver
    • PDF
    • Plugin
    • Query
      • Driver
    • Server
      • Driver
    • Session
      • Driver
    • Set
    • Storage
      • Driver
      • Field
        • Element
    • Stream
      • Driver
    • String
    • Translation
      • Driver
      • Language
        • Driver
    • URI
      • Driver
    • Version
    • View
      • Driver
        • coreui
          • Control
            • Button
            • Table
          • Element
        • htmlbuilder
          • Tags
        • yui
          • Modules
  • None
  • PHP

Classes

  • ldap
  • ldap_Token
  • sspi
  • sspi_Token
  • storage
  • storage_Token

Class storage

Storage authentication driver.

Verifies user credentials against a chained storage driver instance using an arbitrary encoding scheme, including hashes.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\Authentication
Extended by Core\Authentication\Driver\storage
Namespace: Core\Authentication\Driver
Package: Core\Authentication
Since: 3.0
Requires: PHP 5.3
Version: 2.0
Located at Authentication/Driver/storage.inc.php

Methods summary

public
# __construct( Core\URI $uri )

Parameters

$uri
Authentication driver description from factory.

Throws

Core\Exception\InvalidArgument
Target object for auto-chaining does not implement Core\Chainable.
Core\Exception\MissingParameter
A mandatory parameter is missing.
Core\Exception\Parameter
Invalid value for enumeration parameter.

Since

3.0

Overrides

Core\Authentication::__construct
protected Core\Authentication_Token|false
# _validate( array $credentials )

Driver implementation of user credentials verification.

Driver implementation of user credentials verification.

Parameters

$credentials

Associative array of user credentials. Contains at least the following entries:

  • string user

    The username to verify.

  • string password

    The provided password or password hash to verify.

  • string domain

    The domain name to verify credentials for.

Returns

Core\Authentication_Token|false

Token instance for the specified user on success, otherwise false. Set the status and status message properties to provide additional information on why authentication failed.

If the back-end encounters a fatal error, it might throw an exception.

Since

3.0
public boolean
# chain( Core\Chainable $object, array $flags = null )

Sets the user storage driver instance.

Sets the user storage driver instance.

Parameters

$object
Storage instance for user data storage.
$flags
Unused.

Returns

boolean
Returns true on success, otherwise an exception is thrown.

Throws

Core\Exception\InvalidArgument
Class of provided object is not supported.

Since

3.0

Overrides

Core\Authentication::chain

Methods inherited from Core\Authentication

_validatePassword(), autocreate(), perform(), verify()

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), __toString(), attachMethod(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

string AutochainParameter

Configuration parameter name for a list of automatically chained registry keys.

Configuration parameter name for a list of automatically chained registry keys.

Since

3.1
# 'autochain'
string DataParameter

Configuration parameter name for the storage location reference of the user authentication data.

Configuration parameter name for the storage location reference of the user authentication data.

Since

3.0
# 'data'
string PasswordParameter

Configuration parameter name to control password authentication. If set to false, the user credentials password is ignored. This is useful to succeed authentication automatically within an authentication chain to filter users (e.g. check for user existence, then verify credentials using a different authentication driver). Defaults to true.

Configuration parameter name to control password authentication. If set to false, the user credentials password is ignored. This is useful to succeed authentication automatically within an authentication chain to filter users (e.g. check for user existence, then verify credentials using a different authentication driver). Defaults to true.

Since

3.0
# 'password-authentication'
string KeyFieldParameter

Configuration parameter name of unique storage user ID field.

Configuration parameter name of unique storage user ID field.

Since

3.0
# 'key'
string DomainFieldParameter

Configuration parameter name of storage domain name field.

Configuration parameter name of storage domain name field.

Since

3.0
# 'domain'
string UserFieldParameter

Configuration parameter name of storage user name field.

Configuration parameter name of storage user name field.

Since

3.0
# 'user'
string PasswordFieldParameter

Configuration parameter name of storage password field.

Configuration parameter name of storage password field.

Since

3.0
# 'password'

Constants inherited from Core\Authentication

AllowEmptyPasswordParameter, AllowEmptyUsernameParameter, FieldSelectorParameter, InvalidCredentials, PasswordEncryptionParameter, Success, TemporaryFailure, UnknownIdentifier

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

protected Core\Storage $_v_driver

Chained storage back-end driver instance.

Chained storage back-end driver instance.

Since

3.0
#

Properties inherited from Core\Authentication

$_v_parameters, $_v_status, $_v_statusMessage, $_v_successor

Magic properties

public read-only Core\Storage $driver

Chained storage back-end driver instance.

Magic properties inherited from Core\Authentication

$parameters, $status, $statusMessage, $successor

Magic properties inherited from Core\Object

$hash, $uuid

xplo.re Medusa Core Framework 3.1 API documentation generated by ApiGen