Fat-Free Framework  3.3.0  Overview Class List Hierarchy
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Auth Class Reference

Authorization/authentication plug-in. More...

Public Member Functions

 login ($id, $pw, $realm=NULL)
 
 basic ($func=NULL)
 
 __construct ($storage, array $args=NULL)
 

Public Attributes

 $mapper
 Mapper object.
 
 $args
 Storage options.
 
const E_LDAP ='LDAP connection failure'
 
const E_SMTP ='SMTP connection failure'
 

Protected Member Functions

 _jig ($id, $pw, $realm)
 
 _mongo ($id, $pw, $realm)
 
 _sql ($id, $pw, $realm)
 
 _ldap ($id, $pw)
 
 _smtp ($id, $pw)
 

Protected Attributes

 $storage
 Auth storage.
 

Detailed Description

Authorization/authentication plug-in.

Constructor & Destructor Documentation

Auth::__construct (   $storage,
array  $args = NULL 
)

Instantiate class

Returns
object
Parameters
$storagestring|object
$argsarray

Member Function Documentation

Auth::_jig (   $id,
  $pw,
  $realm 
)
protected

Jig storage handler

Returns
bool
Parameters
$idstring
$pwstring
$realmstring
Auth::_ldap (   $id,
  $pw 
)
protected

LDAP storage handler

Returns
bool
Parameters
$idstring
$pwstring
Auth::_mongo (   $id,
  $pw,
  $realm 
)
protected

MongoDB storage handler

Returns
bool
Parameters
$idstring
$pwstring
$realmstring
Auth::_smtp (   $id,
  $pw 
)
protected

SMTP storage handler

Returns
bool
Parameters
$idstring
$pwstring
Auth::_sql (   $id,
  $pw,
  $realm 
)
protected

SQL storage handler

Returns
bool
Parameters
$idstring
$pwstring
$realmstring
Auth::basic (   $func = NULL)

HTTP basic auth mechanism

Returns
bool
Parameters
$funccallback
Auth::login (   $id,
  $pw,
  $realm = NULL 
)

Login auth mechanism

Returns
bool
Parameters
$idstring
$pwstring
$realmstring

The documentation for this class was generated from the following file: