A Zend_Auth Authentication Adapter allowing the use of OpenID protocol as an authentication mechanism

category Zend
package Zend_Auth
subpackage Zend_Auth_Adapter
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Constructor

__construct(string $id = null, \Zend_OpenId_Consumer_Storage $storage = null, string $returnTo = null, string $root = null, mixed $extensions = null, \Zend_Controller_Response_Abstract $response = null

Parameters

$id

string

the identity value

$storage

\Zend_OpenId_Consumer_Storage

an optional implementation of a storage object

$returnTo

string

HTTP URL to redirect response from server to

$root

string

HTTP URL to identify consumer on server

$extensions

mixed

extension object or array of extensions objects

$response

\Zend_Controller_Response_Abstract

an optional response object to perform HTTP or HTML form redirection

Authenticates the given OpenId identity.

authenticate() : \Zend_Auth_Result

Defined by Zend_Auth_Adapter_Interface.

inherited_from \Zend_Auth_Adapter_Interface::authenticate()

Exceptions

\Zend_Auth_Adapter_Exception If answering the authentication query is impossible

Returns

\Zend_Auth_Result

Enables or disables interaction with user during authentication on OpenID provider.

setCheckImmediate(boolean $check_immediate) : \Zend_Auth_Adapter_OpenId

Parameters

$check_immediate

boolean

Returns

\Zend_Auth_Adapter_OpenIdProvides a fluent interface

Sets OpenID extension(s)

setExtensions(mixed $extensions) : \Zend_Auth_Adapter_OpenId

Parameters

$extensions

mixed

Returns

\Zend_Auth_Adapter_OpenIdProvides a fluent interface

Sets HTTP client object to make HTTP requests

setHttpClient(\Zend_Http_Client $client) 

Parameters

$client

\Zend_Http_Client

HTTP client object to be used

Sets the value to be used as the identity

setIdentity(string $id) : \Zend_Auth_Adapter_OpenId

Parameters

$id

string

the identity value

Returns

\Zend_Auth_Adapter_OpenIdProvides a fluent interface

Sets an optional response object to perform HTTP or HTML form redirection

setResponse(string $response) : \Zend_Auth_Adapter_OpenId

Parameters

$response

string

Returns

\Zend_Auth_Adapter_OpenIdProvides a fluent interface

Sets the HTTP URL to redirect response from server to

setReturnTo(string $returnTo) : \Zend_Auth_Adapter_OpenId

Parameters

$returnTo

string

Returns

\Zend_Auth_Adapter_OpenIdProvides a fluent interface

Sets HTTP URL to identify consumer on server

setRoot(string $root) : \Zend_Auth_Adapter_OpenId

Parameters

$root

string

Returns

\Zend_Auth_Adapter_OpenIdProvides a fluent interface

Sets the storage implementation which will be use by OpenId

setStorage(\Zend_OpenId_Consumer_Storage $storage) : \Zend_Auth_Adapter_OpenId

Parameters

$storage

\Zend_OpenId_Consumer_Storage

Returns

\Zend_Auth_Adapter_OpenIdProvides a fluent interface

 Properties

 

Enables or disables interaction with user during authentication on OpenID provider.

$_check_immediate : boolean

Default

false
 

Extension object or array of extensions objects

$_extensions : string

Default

null
 

HTTP client to make HTTP requests

$_httpClient : \Zend_Http_Client

Default

null
 

The identity value being authenticated

$_id : string

Default

null
 

The response object to perform HTTP or HTML form redirection

$_response : \Zend_Controller_Response_Abstract

Default

null
 

The URL to redirect response from server to

$_returnTo : string

Default

null
 

The HTTP URL to identify consumer on server

$_root : string

Default

null
 

Reference to an implementation of a storage object

$_storage : \Zend_OpenId_Consumer_Storage

Default

null