Zend_Auth_Adapter_OpenId Class Reference

Public Member Functions
	__construct ($id=null, Zend_OpenId_Consumer_Storage $storage=null, $returnTo=null, $root=null, $extensions=null, Zend_Controller_Response_Abstract $response=null)
	Constructor.
	setIdentity ($id)
	Sets the value to be used as the identity.
	setStorage (Zend_OpenId_Consumer_Storage $storage)
	Sets the storage implementation which will be use by OpenId.
	setReturnTo ($returnTo)
	Sets the HTTP URL to redirect response from server to.
	setRoot ($root)
	Sets HTTP URL to identify consumer on server.
	setExtensions ($extensions)
	Sets OpenID extension(s)
	setResponse ($response)
	Sets an optional response object to perform HTTP or HTML form redirection.
	setCheckImmediate ($check_immediate)
	Enables or disables interaction with user during authentication on OpenID provider.
	setHttpClient ($client)
	Sets HTTP client object to make HTTP requests.
	authenticate ()
	Authenticates the given OpenId identity.

Constructor & Destructor Documentation

__construct	(		$id = null,
		Zend_OpenId_Consumer_Storage	$storage = null,
			$returnTo = null,
			$root = null,
			$extensions = null,
		Zend_Controller_Response_Abstract	$response = null
	)

Constructor.

Parameters

string	$id	the identity value
Zend_OpenId_Consumer_Storage	$storage	an optional implementation of a storage object
string	$returnTo	HTTP URL to redirect response from server to
string	$root	HTTP URL to identify consumer on server
mixed	$extensions	extension object or array of extensions objects
Zend_Controller_Response_Abstract	$response	an optional response object to perform HTTP or HTML form redirection

Returns

void

Member Function Documentation

authenticate

(

)

Authenticates the given OpenId identity.

Defined by Zend_Auth_Adapter_Interface.

Exceptions

Zend_Auth_Adapter_Exception

If answering the authentication query is impossible

Returns

Zend_Auth_Result

Implements Zend_Auth_Adapter_Interface.

setCheckImmediate

(

$check_immediate

)

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

Parameters

bool

$check_immediate

Returns

Zend_Auth_Adapter_OpenId Provides a fluent interface

setExtensions

(

$extensions

)

Sets OpenID extension(s)

Parameters

mixed

$extensions

Returns

Zend_Auth_Adapter_OpenId Provides a fluent interface

setHttpClient

(

$client

)

Sets HTTP client object to make HTTP requests.

Parameters

Zend_Http_Client

$client

HTTP client object to be used

setIdentity

(

$id

)

Sets the value to be used as the identity.

Parameters

string

$id

the identity value

Returns

Zend_Auth_Adapter_OpenId Provides a fluent interface

setResponse

(

$response

)

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

Parameters

string

$root

Returns

Zend_Auth_Adapter_OpenId Provides a fluent interface

setReturnTo

(

$returnTo

)

Sets the HTTP URL to redirect response from server to.

Parameters

string

$returnTo

Returns

Zend_Auth_Adapter_OpenId Provides a fluent interface

setRoot

(

$root

)

Sets HTTP URL to identify consumer on server.

Parameters

string

$root

Returns

Zend_Auth_Adapter_OpenId Provides a fluent interface

setStorage

(

Zend_OpenId_Consumer_Storage

$storage

)

Sets the storage implementation which will be use by OpenId.

Parameters

Zend_OpenId_Consumer_Storage

$storage

Returns

Zend_Auth_Adapter_OpenId Provides a fluent interface