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

Namespaces

  • Core
    • Authentication
      • Auto
        • Driver
      • Driver
    • Cache
      • Driver
    • Charset
      • Driver
    • Configuration
      • Driver
    • Controller
    • Converter
      • Driver
    • Decoder
      • Driver
    • Encoder
      • Driver
    • Env
      • Authentication
      • Locale
      • Proxy
      • Server
        • HTTP
        • Redirect
        • X
    • Exception
    • Exchange
      • Driver
    • Fault
      • Formatter
        • Driver
      • Incident
        • Exception
      • Reporter
        • 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
    • Type
    • URI
      • Driver
    • Version
    • View
      • Driver
        • coreui
          • Control
            • Button
            • Table
          • Element
        • htmlbuilder
          • Tags
        • yui
          • Modules
  • None
  • PHP

Classes

  • Auto

Class Auto

Base interface for authentication automation helpers.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\Authentication\Auto

Direct known subclasses

Core\Authentication\Auto\Driver\basic, Core\Authentication\Auto\Driver\digest

Abstract
Namespace: Core\Authentication
Package: Core\Authentication\Automation
Since: 3.0
Requires: PHP 5.3
Version: 1.0
Located at Authentication/Auto.inc.php

Methods summary

public static Core\Authentication\Auto
# autocreate( Core\URI $uri )

Authentication automation factory.

Authentication automation factory.

Parameters

$uri
Authentication automation driver description.

Returns

Core\Authentication\Auto
New authentication helper instance.

Throws

Core\Exception\InvalidDriver
The driver description scheme refers to an unknown driver.

Since

3.0
abstract public array|false
# perform( string $realm = null, string $message = null )

Performs an automated authentication step.

Performs an automated authentication step.

Parameters

$realm

Optional name of authentication realm. Depending on the authentication method, the realm is displayed to the user and set to a driver-dependent default if not provided.

$message

Optional message presented to the user if an authentication step has been cancelled or was interrupted.

Returns

array|false

Associative array of authentication data on success, otherwise false. Contains at least the following entries but might contain additional driver-specific fields:

  • string user

    Username.

  • string domain

    Domain name.

  • string pass

    User password.

  • callable callback

    Callback to calculate driver-specific password hash.

Since

3.0

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

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

Constants summary

Constants inherited from Core\Object

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

Properties summary

Magic properties inherited from Core\Object

$hash, $uuid

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