## Apache Zeta Components Manual :: Package Authentication Element Index

## Element index for package Authentication

#### Package indexes

- Document
- NoPackageName
- SystemInformation
- File
- UserInput
- PersistentObjectDatabaseSchemaTiein
- ConsoleTools
- Cache
- Database
- UnitTest
- Feed
- Base
- AuthenticationDatabaseTiein
- TemplateTranslationTiein
- MvcMailTiein
- MvcTools
- MvcTemplateTiein
- Reflection
- Execution
- TranslationCacheTiein
- Archive
- Url
- PhpGenerator
- WorkflowDatabaseTiein
- SignalSlot
- DatabaseSchema
- TreePersistentObjectTiein
- EventLog
- Tree
- Workflow
- ImageConversion
- PersistentObject
- Graph
- EventLogDatabaseTiein
- Translation
- WorkflowSignalSlotTiein
- Template
- Webdav
- Debug
- GraphDatabaseTiein
- MvcAuthenticationTiein
- MvcFeedTiein
- Mail
- TreeDatabaseTiein
- ImageAnalysis
- Search
- Configuration
- WorkflowEventLogTiein

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ _ ]

### Letter '_'

__construct
  in file openid_exception.php, method ezcAuthenticationOpenidException::__construct()
  Constructs a new ezcAuthenticationOpenidException with error message $message.
__construct
  in file openid_file_store.php, method ezcAuthenticationOpenidFileStore::__construct()
  Creates a new object of this class.
__construct
  in file openid_file_store_options.php, method ezcAuthenticationOpenidFileStoreOptions::__construct()
  Constructs an object with the specified values.
__construct
  in file openid_connection_exception.php, method ezcAuthenticationOpenidConnectionException::__construct()
  Constructs a new ezcAuthenticationOpenidConnectionException for the URL $url.
__construct
  in file authentication.php, method ezcAuthentication::__construct()
  Creates a new object of this class.
__construct
  in file ldap_options.php, method ezcAuthenticationLdapOptions::__construct()
  Constructs an object with the specified values.
__construct
  in file openid_association.php, method ezcAuthenticationOpenidAssociation::__construct()
  Constructs a new ezcAuthenticationOpenidAssociation object.
__construct
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::__construct()
  Creates a new object of this class.
__construct
  in file openid_mode_exception.php, method ezcAuthenticationOpenidModeNotSupportedException::__construct()
  Constructs a new ezcAuthenticationOpenidModeNotSupportedException with OpenID mode $mode.
__construct
  in file typekey_exception.php, method ezcAuthenticationTypekeyException::__construct()
  Constructs a new ezcAuthenticationTypekeyException with error message $message.
__construct
  in file token_options.php, method ezcAuthenticationTokenOptions::__construct()
  Constructs an object with the specified values.
__construct
  in file session_options.php, method ezcAuthenticationSessionOptions::__construct()
  Constructs an object with the specified values.
__construct
  in file password_credentials.php, method ezcAuthenticationPasswordCredentials::__construct()
  Constructs a new ezcAuthenticationPasswordCredentials object.
__construct
  in file openid_store_options.php, method ezcAuthenticationOpenidStoreOptions::__construct()
  Constructs an object with the specified values.
__construct
  in file openid_options.php, method ezcAuthenticationOpenidOptions::__construct()
  Constructs an object with the specified values.
__construct
  in file openid_redirect_exception.php, method ezcAuthenticationOpenidRedirectException::__construct()
  Constructs a new ezcAuthenticationOpenidRedirectException concerning $url.
__construct
  in file typekey_filter.php, method ezcAuthenticationTypekeyFilter::__construct()
  Creates a new object of this class.
__construct
  in file ldap_info.php, method ezcAuthenticationLdapInfo::__construct()
  Constructs a new ezcAuthenticationLdapInfo object.
__construct
  in file filter_options.php, method ezcAuthenticationFilterOptions::__construct()
  Constructs an object with the specified values.
__construct
  in file group_exception.php, method ezcAuthenticationGroupException::__construct()
  Constructs a new ezcAuthenticationGroupException with error message $message.
__construct
  in file group_filter.php, method ezcAuthenticationGroupFilter::__construct()
  Creates a new object of this class.
__construct
  in file typekey_options.php, method ezcAuthenticationTypekeyOptions::__construct()
  Constructs an object with the specified values.
__construct
  in file authentication_session.php, method ezcAuthenticationSession::__construct()
  Creates a new object of this class.
__construct
  in file authentication_exception.php, method ezcAuthenticationException::__construct()
  Constructs a new ezcAuthenticationException with error message $message.
__construct
  in file authentication_options.php, method ezcAuthenticationOptions::__construct()
  Constructs an object with the specified values.
__construct
  in file group_options.php, method ezcAuthenticationGroupOptions::__construct()
  Constructs an object with the specified values.
__construct
  in file htpasswd_filter.php, method ezcAuthenticationHtpasswdFilter::__construct()
  Creates a new object of this class.
__construct
  in file ldap_exception.php, method ezcAuthenticationLdapException::__construct()
  Constructs a new ezcAuthenticationLdapException with error message $message and error code $code.
__construct
  in file ldap_filter.php, method ezcAuthenticationLdapFilter::__construct()
  Creates a new object of this class.
__construct
  in file typekey_invalid_exception.php, method ezcAuthenticationTypekeyPublicKeysInvalidException::__construct()
  Constructs a new ezcAuthenticationTypekeyPublicKeysInvalidException with error message $message.
__construct
  in file typekey_missing_exception.php, method ezcAuthenticationTypekeyPublicKeysMissingException::__construct()
  Constructs a new ezcAuthenticationTypekeyPublicKeysMissingException with error message $message.
__construct
  in file htpasswd_options.php, method ezcAuthenticationHtpasswdOptions::__construct()
  Constructs an object with the specified values.
__construct
  in file id_credentials.php, method ezcAuthenticationIdCredentials::__construct()
  Constructs a new ezcAuthenticationIdCredentials object.
__construct
  in file token_filter.php, method ezcAuthenticationTokenFilter::__construct()
  Creates a new object of this class.
__set_state
  in file openid_association.php, method ezcAuthenticationOpenidAssociation::__set_state()
  Returns a new instance of this class with the data specified by $array.
__set_state
  in file id_credentials.php, method ezcAuthenticationIdCredentials::__set_state()
  Returns a new instance of this class with the data specified by $array.
__set_state
  in file ldap_info.php, method ezcAuthenticationLdapInfo::__set_state()
  Returns a new instance of this class with the data specified by $array.
__set_state
  in file password_credentials.php, method ezcAuthenticationPasswordCredentials::__set_state()
  Returns a new instance of this class with the data specified by $array.
__toString
  in file credentials.php, method ezcAuthenticationCredentials::__toString()
  Returns string representation of the credentials.
__toString
  in file id_credentials.php, method ezcAuthenticationIdCredentials::__toString()
  Returns string representation of the credentials.
__toString
  in file password_credentials.php, method ezcAuthenticationPasswordCredentials::__toString()
  Returns string representation of the credentials.

### Letter 'a'

addFilter
  in file authentication.php, method ezcAuthentication::addFilter()
  Adds an authentication filter at the end of the filter list.
addFilter
  in file group_filter.php, method ezcAuthenticationGroupFilter::addFilter()
  Adds an authentication filter at the end of the filter list.
append
  in file authentication_status.php, method ezcAuthenticationStatus::append()
  Adds a new status to the list of statuses.
appendQuery
  in file url.php, method ezcAuthenticationUrl::appendQuery()
  Appends a query value to the provided URL and returns the complete URL.
associate
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::associate()
  Attempts to establish a shared secret with the OpenID provider and returns it (for "smart" mode).
authentication.php
  procedural page authentication.php
authentication_exception.php
  procedural page authentication_exception.php
authentication_filter.php
  procedural page authentication_filter.php
authentication_options.php
  procedural page authentication_options.php
authentication_session.php
  procedural page authentication_session.php
authentication_status.php
  procedural page authentication_status.php

### Letter 'b'

$base
  in file ldap_info.php, variable ezcAuthenticationLdapInfo::$base
  The base of the directory entry, for example 'dc=example,dc=com'.
bcmath_library.php
  procedural page bcmath_library.php
bignum_library.php
  procedural page bignum_library.php
buildUrl
  in file url.php, method ezcAuthenticationUrl::buildUrl()
  Creates a string URL from the provided $parts array.

### Letter 'c'

credentials.php
  procedural page credentials.php
checkImmediate
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::checkImmediate()
  Connects to $provider (checkid_immediate OpenID request) and returns an URL (setup URL) which can be used by the application in a pop-up window.
checkSignature
  in file typekey_filter.php, method ezcAuthenticationTypekeyFilter::checkSignature()
  Checks the information returned by the TypeKey server.
checkSignature
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::checkSignature()
  Opens a connection with the OpenID provider and checks if $params are correct (check_authentication OpenID request).
checkSignatureSmart
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::checkSignatureSmart()
  Checks if $params are correct by signing with $association->secret.
convertToFilename
  in file openid_file_store.php, method ezcAuthenticationOpenidFileStore::convertToFilename()
  Creates a valid filename from the provided string.
createAssociateRequest
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::createAssociateRequest()
  Returns an array of parameters for use in an OpenID associate request.
createCheckidRequest
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::createCheckidRequest()
  Returns an array of parameters for use in an OpenID check_id request.

### Letter 'd'

$data
  in file openid_filter.php, variable ezcAuthenticationOpenidFilter::$data
  Holds the extra data fetched during the authentication process.
$data
  in file typekey_filter.php, variable ezcAuthenticationTypekeyFilter::$data
  Holds the extra data fetched during the authentication process.
$data
  in file ldap_filter.php, variable ezcAuthenticationLdapFilter::$data
  Holds the extra data fetched during the authentication process.
data_fetch.php
  procedural page data_fetch.php
destroy
  in file authentication_session.php, method ezcAuthenticationSession::destroy()
  Removes the variables used by this class from the session variables.
discover
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::discover()
  Discovers the OpenID server information from the provided URL.
discoverHtml
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::discoverHtml()
  Discovers the OpenID server information from the provided URL by parsing the HTML page source.
discoverXrds
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::discoverXrds()
  Discovers the OpenID server information from the provided URL using XRDS.
discoverYadis
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::discoverYadis()
  Discovers the OpenID server information from the provided URL using Yadis.

### Letter 'e'

ezcAuthentication
  in file authentication.php, class ezcAuthentication
  Container for authentication filters.
ezcAuthenticationCredentials
  in file credentials.php, class ezcAuthenticationCredentials
  Base class for all authentication credentials structures.
ezcAuthenticationDataFetch
  in file data_fetch.php, class ezcAuthenticationDataFetch
  Interface defining functionality for fetching extra data during the authentication process.
ezcAuthenticationException
  in file authentication_exception.php, class ezcAuthenticationException
  Thrown when an exceptional state occurs in the Authentication component.
ezcAuthenticationFilter
  in file authentication_filter.php, class ezcAuthenticationFilter
  Base class for all authentication filters.
ezcAuthenticationFilterOptions
  in file filter_options.php, class ezcAuthenticationFilterOptions
  Class containing the basic options for authentication filters.
ezcAuthenticationGroupException
  in file group_exception.php, class ezcAuthenticationGroupException
  Thrown when an error comes up with grouped filters authentication.
ezcAuthenticationGroupFilter
  in file group_filter.php, class ezcAuthenticationGroupFilter
  Group authentication filters together.
ezcAuthenticationGroupOptions
  in file group_options.php, class ezcAuthenticationGroupOptions
  Class containing the options for group authentication filter.
ezcAuthenticationHtpasswdFilter
  in file htpasswd_filter.php, class ezcAuthenticationHtpasswdFilter
  Filter to authenticate against an Unix htpasswd file.
ezcAuthenticationHtpasswdOptions
  in file htpasswd_options.php, class ezcAuthenticationHtpasswdOptions
  Class containing the options for the htpasswd authentication filter.
ezcAuthenticationIdCredentials
  in file id_credentials.php, class ezcAuthenticationIdCredentials
  Structure containing an id, used as authentication credentials.
ezcAuthenticationLdapException
  in file ldap_exception.php, class ezcAuthenticationLdapException
  Thrown when an exceptional state occurs in the LDAP authentication.
ezcAuthenticationLdapFilter
  in file ldap_filter.php, class ezcAuthenticationLdapFilter
  Filter to authenticate against an LDAP directory.
ezcAuthenticationLdapInfo
  in file ldap_info.php, class ezcAuthenticationLdapInfo
  Structure for defining the LDAP directory to authenticate against.
ezcAuthenticationLdapOptions
  in file ldap_options.php, class ezcAuthenticationLdapOptions
  Class containing the options for ldap authentication filter.
ezcAuthenticationOpenidAssociation
  in file openid_association.php, class ezcAuthenticationOpenidAssociation
  Structure for defining an OpenID association between the server and the OpenID provider.
ezcAuthenticationOpenidConnectionException
  in file openid_connection_exception.php, class ezcAuthenticationOpenidConnectionException
  Thrown when a host cannot be reached in the OpenID authentication.
ezcAuthenticationOpenidException
  in file openid_exception.php, class ezcAuthenticationOpenidException
  Thrown when an exceptional state occurs in the OpenID authentication.
ezcAuthenticationOpenidFileStore
  in file openid_file_store.php, class ezcAuthenticationOpenidFileStore
  Class providing file storage for OpenID authentication.
ezcAuthenticationOpenidFileStoreOptions
  in file openid_file_store_options.php, class ezcAuthenticationOpenidFileStoreOptions
  Class containing the options for the OpenID file store.
ezcAuthenticationOpenidFilter
  in file openid_filter.php, class ezcAuthenticationOpenidFilter
  Filter to authenticate against OpenID. Currently supporting OpenID 1.0, 1.1 and 2.0.
ezcAuthenticationOpenidModeNotSupportedException
  in file openid_mode_exception.php, class ezcAuthenticationOpenidModeNotSupportedException
  Thrown when trying OpenID authentication with a mode which is not supported.
ezcAuthenticationOpenidOptions
  in file openid_options.php, class ezcAuthenticationOpenidOptions
  Class containing the options for the OpenID authentication filter.
ezcAuthenticationOpenidRedirectException
  in file openid_redirect_exception.php, class ezcAuthenticationOpenidRedirectException
  Thrown when the client could not be redirected in the OpenID authentication.
ezcAuthenticationOpenidStore
  in file openid_store.php, class ezcAuthenticationOpenidStore
  Abstract class which provides a base for store (backend) implementations to be used in OpenID authentication.
ezcAuthenticationOpenidStoreOptions
  in file openid_store_options.php, class ezcAuthenticationOpenidStoreOptions
  Class containing the options for the OpenID store.
ezcAuthenticationOptions
  in file authentication_options.php, class ezcAuthenticationOptions
  Class containing the basic options for the authentication main class.
ezcAuthenticationPasswordCredentials
  in file password_credentials.php, class ezcAuthenticationPasswordCredentials
  Structure containing an id and password, used as authentication credentials.
ezcAuthenticationSession
  in file authentication_session.php, class ezcAuthenticationSession
  Support for session authentication and saving of authentication information between requests.
ezcAuthenticationSessionOptions
  in file session_options.php, class ezcAuthenticationSessionOptions
  Class containing the options for the authentication session.
ezcAuthenticationStatus
  in file authentication_status.php, class ezcAuthenticationStatus
  Holds the statuses returned from each authentication filter.
ezcAuthenticationTokenFilter
  in file token_filter.php, class ezcAuthenticationTokenFilter
  Filter to authenticate against a server generated token.
ezcAuthenticationTokenOptions
  in file token_options.php, class ezcAuthenticationTokenOptions
  Class containing the options for the token authentication filter.
ezcAuthenticationTypekeyException
  in file typekey_exception.php, class ezcAuthenticationTypekeyException
  Thrown when an exceptional state occurs in the TypeKey authentication.
ezcAuthenticationTypekeyFilter
  in file typekey_filter.php, class ezcAuthenticationTypekeyFilter
  Filter to authenticate against TypeKey.
ezcAuthenticationTypekeyOptions
  in file typekey_options.php, class ezcAuthenticationTypekeyOptions
  Class containing the options for the TypeKey authentication filter.
ezcAuthenticationTypekeyPublicKeysInvalidException
  in file typekey_invalid_exception.php, class ezcAuthenticationTypekeyPublicKeysInvalidException
  Thrown the public keys file contained invalid data in TypeKey authentication.
ezcAuthenticationTypekeyPublicKeysMissingException
  in file typekey_missing_exception.php, class ezcAuthenticationTypekeyPublicKeysMissingException
  Thrown the public keys file could not be accessed in TypeKey authentication.
ezcAuthenticationUrl
  in file url.php, class ezcAuthenticationUrl
  Class which provides a methods for handling URLs.

### Letter 'f'

$filters
  in file group_filter.php, variable ezcAuthenticationGroupFilter::$filters
  Authentication filters.
$filters
  in file authentication.php, variable ezcAuthentication::$filters
  The filter queue of the authentication process.
$format
  in file ldap_info.php, variable ezcAuthenticationLdapInfo::$format
  The format of the directory entry, for example 'uid=%id'. %id% is a placeholder name which will be replaced by the actual value.
filter_options.php
  procedural page filter_options.php
fetchData
  in file typekey_filter.php, method ezcAuthenticationTypekeyFilter::fetchData()
  Returns the extra data which was fetched during the authentication process.
fetchData
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::fetchData()
  Returns the extra data fetched during the authentication process.
fetchData
  in file ldap_filter.php, method ezcAuthenticationLdapFilter::fetchData()
  Returns the extra data fetched during the authentication process.
fetchData
  in file data_fetch.php, method ezcAuthenticationDataFetch::fetchData()
  Returns the extra data fetched during the authentication process.
fetchPublicKeys
  in file typekey_filter.php, method ezcAuthenticationTypekeyFilter::fetchPublicKeys()
  Fetches the public keys from the specified file or URL $file.
fetchQuery
  in file url.php, method ezcAuthenticationUrl::fetchQuery()
  Fetches the value of key $key from the query of the provided URL.

### Letter 'g'

group_exception.php
  procedural page group_exception.php
group_filter.php
  procedural page group_filter.php
gmp_library.php
  procedural page gmp_library.php
group_options.php
  procedural page group_options.php
generateNonce
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::generateNonce()
  Generates a new nonce value with the specified length (default 6).
get
  in file authentication_status.php, method ezcAuthenticationStatus::get()
  Returns the list of authentication statuses.
getAssociation
  in file openid_store.php, method ezcAuthenticationOpenidStore::getAssociation()
  Returns the association linked to the OpenID provider URL.
getAssociation
  in file openid_file_store.php, method ezcAuthenticationOpenidFileStore::getAssociation()
  Returns the unserialized association linked to the OpenID provider URL.
getOptions
  in file authentication_filter.php, method ezcAuthenticationFilter::getOptions()
  Returns the options of this class.
getOptions
  in file openid_store.php, method ezcAuthenticationOpenidStore::getOptions()
  Returns the options of this class.
getOptions
  in file authentication.php, method ezcAuthentication::getOptions()
  Returns the options of this class.
getOptions
  in file authentication_session.php, method ezcAuthenticationSession::getOptions()
  Returns the options of this class.
getProvider
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::getProvider()
  Returns the first provider in the $providers array if exists, otherwise returns false.
getSetupUrl
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::getSetupUrl()
  Returns the setup URL.
getStatus
  in file authentication.php, method ezcAuthentication::getStatus()
  Returns the status of authentication.
getUrl
  in file url.php, method ezcAuthenticationUrl::getUrl()
  Retrieves the headers and contents of $url using the HTTP method $method (GET, HEAD, POST), with an optional Accept $type (default 'text/html').

### Letter 'h'

$handle
  in file openid_association.php, variable ezcAuthenticationOpenidAssociation::$handle
  The handle given by the OpenID provider to this association.
$host
  in file ldap_info.php, variable ezcAuthenticationLdapInfo::$host
  The hostname of the LDAP server, for example 'localhost'.
htpasswd_filter.php
  procedural page htpasswd_filter.php
htpasswd_options.php
  procedural page htpasswd_options.php

### Letter 'i'

$id
  in file password_credentials.php, variable ezcAuthenticationPasswordCredentials::$id
  Username or userID or url.
$id
  in file id_credentials.php, variable ezcAuthenticationIdCredentials::$id
  Username or userID or url.
$issued
  in file openid_association.php, variable ezcAuthenticationOpenidAssociation::$issued
  The UNIX timestamp when the secret was generated.
id_credentials.php
  procedural page id_credentials.php
isValid
  in file authentication_session.php, method ezcAuthenticationSession::isValid()
  Runs through the session and returns true if the session is correct.

### Letter 'l'

ldap_exception.php
  procedural page ldap_exception.php
ldap_filter.php
  procedural page ldap_filter.php
ldap_info.php
  procedural page ldap_info.php
ldap_options.php
  procedural page ldap_options.php
ldapConnect
  in file ldap_filter.php, method ezcAuthenticationLdapFilter::ldapConnect()
  Wraps around the ldap_connect() function.
ldapStartTls
  in file ldap_filter.php, method ezcAuthenticationLdapFilter::ldapStartTls()
  Wraps around the ldap_start_tls() function.
load
  in file authentication_session.php, method ezcAuthenticationSession::load()
  Loads the authenticated username from the session or null if it doesn't exist.

### Letter 'm'

math.php
  procedural page math.php
MODE_AND
  in file group_filter.php, class constant ezcAuthenticationGroupFilter::MODE_AND
  All the filters need to succeed in order for the group to succeed.
MODE_DUMB
  in file openid_filter.php, class constant ezcAuthenticationOpenidFilter::MODE_DUMB
  OpenID authentication mode where the OpenID provider generates a secret for every request.
MODE_OR
  in file group_filter.php, class constant ezcAuthenticationGroupFilter::MODE_OR
  At least one filter needs to succeed in order for the group to succeed.
MODE_SMART
  in file openid_filter.php, class constant ezcAuthenticationOpenidFilter::MODE_SMART
  OpenID authentication mode where the server generates a secret which will be shared with the OpenID provider.

### Letter 'n'

normalize
  in file url.php, method ezcAuthenticationUrl::normalize()
  Normalizes the provided URL.

### Letter 'o'

$options
  in file openid_store.php, variable ezcAuthenticationOpenidStore::$options
  Options for OpenID stores.
$options
  in file authentication.php, variable ezcAuthentication::$options
  Options for the Authentication object.
$options
  in file authentication_session.php, variable ezcAuthenticationSession::$options
  Options for authentication filters.
$options
  in file authentication_filter.php, variable ezcAuthenticationFilter::$options
  Options for authentication filters.
openid_connection_exception.php
  procedural page openid_connection_exception.php
openid_exception.php
  procedural page openid_exception.php
openid_mode_exception.php
  procedural page openid_mode_exception.php
openid_redirect_exception.php
  procedural page openid_redirect_exception.php
openid_association.php
  procedural page openid_association.php
openid_file_store.php
  procedural page openid_file_store.php
openid_filter.php
  procedural page openid_filter.php
openid_store.php
  procedural page openid_store.php
openid_file_store_options.php
  procedural page openid_file_store_options.php
openid_options.php
  procedural page openid_options.php
openid_store_options.php
  procedural page openid_store_options.php

### Letter 'p'

$password
  in file password_credentials.php, variable ezcAuthenticationPasswordCredentials::$password
  Password for the id.
$port
  in file ldap_info.php, variable ezcAuthenticationLdapInfo::$port
  Port to connect to $host.
$protocol
  in file ldap_info.php, variable ezcAuthenticationLdapInfo::$protocol
  Protocol to use to connect to LDAP.
password_credentials.php
  procedural page password_credentials.php
parseQueryString
  in file url.php, method ezcAuthenticationUrl::parseQueryString()
  Parses the provided string and returns an associative array structure.
PROTOCOL_PLAIN
  in file ldap_filter.php, class constant ezcAuthenticationLdapFilter::PROTOCOL_PLAIN
  Use plain-text password and no encryption for the connection (default).
PROTOCOL_TLS
  in file ldap_filter.php, class constant ezcAuthenticationLdapFilter::PROTOCOL_TLS
  Use plain-text password and TLS connection.

### Letter 'r'

$requestedData
  in file ldap_filter.php, variable ezcAuthenticationLdapFilter::$requestedData
  Holds the attributes which will be requested during the authentication process.
$requestedData
  in file openid_filter.php, variable ezcAuthenticationOpenidFilter::$requestedData
  Holds the attributes which will be requested during the authentication process.
redirectToOpenidProvider
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::redirectToOpenidProvider()
  Performs a redirection to $provider with the specified parameters $params (checkid_setup OpenID request).
regenerateId
  in file authentication_session.php, method ezcAuthenticationSession::regenerateId()
  Regenerates the session ID.
registerFetchData
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::registerFetchData()
  Registers which extra data to fetch during the authentication process.
registerFetchData
  in file ldap_filter.php, method ezcAuthenticationLdapFilter::registerFetchData()
  Registers which extra data to fetch during the authentication process.
registerFetchData
  in file data_fetch.php, method ezcAuthenticationDataFetch::registerFetchData()
  Registers which extra data to fetch during the authentication process.
registerFetchData
  in file typekey_filter.php, method ezcAuthenticationTypekeyFilter::registerFetchData()
  Registers the extra data which will be fetched by the filter during the authentication process.
removeAssociation
  in file openid_file_store.php, method ezcAuthenticationOpenidFileStore::removeAssociation()
  Removes the association linked to the OpenID provider URL.
removeAssociation
  in file openid_store.php, method ezcAuthenticationOpenidStore::removeAssociation()
  Removes the association linked to the OpenID provider URL.
run
  in file typekey_filter.php, method ezcAuthenticationTypekeyFilter::run()
  Runs the filter and returns a status code when finished.
run
  in file token_filter.php, method ezcAuthenticationTokenFilter::run()
  Runs the filter and returns a status code when finished.
run
  in file openid_filter.php, method ezcAuthenticationOpenidFilter::run()
  Runs the filter and returns a status code when finished.
run
  in file ldap_filter.php, method ezcAuthenticationLdapFilter::run()
  Runs the filter and returns a status code when finished.
run
  in file authentication_filter.php, method ezcAuthenticationFilter::run()
  Runs the filter and returns a status code when finished.
run
  in file authentication_session.php, method ezcAuthenticationSession::run()
  Runs through the session and returns a status code when finished.
run
  in file group_filter.php, method ezcAuthenticationGroupFilter::run()
  Runs the filter and returns a status code when finished.
run
  in file htpasswd_filter.php, method ezcAuthenticationHtpasswdFilter::run()
  Runs the filter and returns a status code when finished.
run
  in file authentication.php, method ezcAuthentication::run()
  Runs through all the filters in the filter list.

### Letter 's'

$secret
  in file openid_association.php, variable ezcAuthenticationOpenidAssociation::$secret
  The shared secret generated by the OpenID provider.
$setupUrl
  in file openid_filter.php, variable ezcAuthenticationOpenidFilter::$setupUrl
  Holds the setup URL retrieved during the checkid_immediate OpenID request.
session_options.php
  procedural page session_options.php
save
  in file authentication_session.php, method ezcAuthenticationSession::save()
  Saves the authenticated username and the current timestamp in the session variables.
setOptions
  in file authentication_filter.php, method ezcAuthenticationFilter::setOptions()
  Sets the options of this class to $options.
setOptions
  in file openid_store.php, method ezcAuthenticationOpenidStore::setOptions()
  Sets the options of this class to $options.
setOptions
  in file authentication.php, method ezcAuthentication::setOptions()
  Sets the options of this class to $options.
setOptions
  in file authentication_session.php, method ezcAuthenticationSession::setOptions()
  Sets the options of this class to $options.
start
  in file authentication_session.php, method ezcAuthenticationSession::start()
  Starts the session.
STATUS_CANCELLED
  in file openid_filter.php, class constant ezcAuthenticationOpenidFilter::STATUS_CANCELLED
  User cancelled the OpenID authentication.
STATUS_EMPTY
  in file authentication_session.php, class constant ezcAuthenticationSession::STATUS_EMPTY
  The session is empty; normal behaviour is to continue with the other filters.
STATUS_EXPIRED
  in file authentication_session.php, class constant ezcAuthenticationSession::STATUS_EXPIRED
  The session expired; normal behaviour is to regenerate the session ID.
STATUS_GROUP_FAILED
  in file group_filter.php, class constant ezcAuthenticationGroupFilter::STATUS_GROUP_FAILED
  All or some of the filters in the group failed (depeding on the mode option).
STATUS_NONCE_INCORRECT
  in file openid_filter.php, class constant ezcAuthenticationOpenidFilter::STATUS_NONCE_INCORRECT
  The OpenID provider did not return a valid nonce in the response.
STATUS_OK
  in file authentication_filter.php, class constant ezcAuthenticationFilter::STATUS_OK
  Successful authentication.
STATUS_OK
  in file authentication_session.php, class constant ezcAuthenticationSession::STATUS_OK
  Successful authentication; normal behaviour is to skip the other filters.
STATUS_PASSWORD_INCORRECT
  in file ldap_filter.php, class constant ezcAuthenticationLdapFilter::STATUS_PASSWORD_INCORRECT
  Password is incorrect.
STATUS_PASSWORD_INCORRECT
  in file htpasswd_filter.php, class constant ezcAuthenticationHtpasswdFilter::STATUS_PASSWORD_INCORRECT
  Password is incorrect.
STATUS_SETUP_URL
  in file openid_filter.php, class constant ezcAuthenticationOpenidFilter::STATUS_SETUP_URL
  The OpenID server returned a setup URL after a checkid_immediate request, which is available by calling the getSetupUrl() method.
STATUS_SIGNATURE_EXPIRED
  in file typekey_filter.php, class constant ezcAuthenticationTypekeyFilter::STATUS_SIGNATURE_EXPIRED
  Login is outside of the timeframe.
STATUS_SIGNATURE_INCORRECT
  in file typekey_filter.php, class constant ezcAuthenticationTypekeyFilter::STATUS_SIGNATURE_INCORRECT
  Signature verification was incorect.
STATUS_SIGNATURE_INCORRECT
  in file openid_filter.php, class constant ezcAuthenticationOpenidFilter::STATUS_SIGNATURE_INCORRECT
  The OpenID provider did not authorize the provided URL.
STATUS_SIGNATURE_MISSING
  in file typekey_filter.php, class constant ezcAuthenticationTypekeyFilter::STATUS_SIGNATURE_MISSING
  The request does not contain the needed information (like $_GET['sig']).
STATUS_TOKEN_INCORRECT
  in file token_filter.php, class constant ezcAuthenticationTokenFilter::STATUS_TOKEN_INCORRECT
  Token is not the same as the provided one.
STATUS_URL_INCORRECT
  in file openid_filter.php, class constant ezcAuthenticationOpenidFilter::STATUS_URL_INCORRECT
  The URL provided by user was empty, or the required information could not be discovered from it.
STATUS_USERNAME_INCORRECT
  in file ldap_filter.php, class constant ezcAuthenticationLdapFilter::STATUS_USERNAME_INCORRECT
  Username is not found in the database.
STATUS_USERNAME_INCORRECT
  in file htpasswd_filter.php, class constant ezcAuthenticationHtpasswdFilter::STATUS_USERNAME_INCORRECT
  Username is not found in the htpasswd file.
storeAssociation
  in file openid_file_store.php, method ezcAuthenticationOpenidFileStore::storeAssociation()
  Stores an association in the store linked to the OpenID provider URL.
storeAssociation
  in file openid_store.php, method ezcAuthenticationOpenidStore::storeAssociation()
  Stores an association in the store linked to the OpenID provider URL.
storeNonce
  in file openid_file_store.php, method ezcAuthenticationOpenidFileStore::storeNonce()
  Stores the nonce in the store.
storeNonce
  in file openid_store.php, method ezcAuthenticationOpenidStore::storeNonce()
  Stores the nonce in the store.

### Letter 't'

$type
  in file openid_association.php, variable ezcAuthenticationOpenidAssociation::$type
  The type of the association. Currently only 'HMAC-SHA1' is supported by the OpenID implementations.
typekey_exception.php
  procedural page typekey_exception.php
typekey_invalid_exception.php
  procedural page typekey_invalid_exception.php
typekey_missing_exception.php
  procedural page typekey_missing_exception.php
token_filter.php
  procedural page token_filter.php
typekey_filter.php
  procedural page typekey_filter.php
token_options.php
  procedural page token_options.php
typekey_options.php
  procedural page typekey_options.php

### Letter 'u'

url.php
  procedural page url.php
useNonce
  in file openid_store.php, method ezcAuthenticationOpenidStore::useNonce()
  Checks if the nonce exists and afterwards deletes it.
useNonce
  in file openid_file_store.php, method ezcAuthenticationOpenidFileStore::useNonce()
  Checks if the nonce exists and afterwards deletes it.

### Letter 'v'

$validity
  in file openid_association.php, variable ezcAuthenticationOpenidAssociation::$validity
  The amount of seconds the association is valid.
VERSION_1_0
  in file openid_filter.php, class constant ezcAuthenticationOpenidFilter::VERSION_1_0
  OpenID version 1.0.
VERSION_1_1
  in file openid_filter.php, class constant ezcAuthenticationOpenidFilter::VERSION_1_1
  OpenID version 1.1.
VERSION_2_0
  in file openid_filter.php, class constant ezcAuthenticationOpenidFilter::VERSION_2_0
  OpenID version 2.0.

Documentation generated by phpDocumentor 1.4.3