Class Zend_Auth_Adapter_OpenId

class Zend_Auth_Adapter_OpenId implements Zend_Auth_Adapter_Interface

Defined in line 46 of file Auth/Adapter/OpenId.php.

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-2009 Zend Technologies USA Inc. (http://www.zend.com)
License	http://framework.zend.com/license/new-bsd New BSD License

Overview

Instance fields$_check_immediate $_extensions $_httpClient $_id $_response $_returnTo $_root $_storage

Instance methods__construct() authenticate() setCheckImmediate() setExtensions() setHttpClient() setIdentity() setResponse() setReturnTo() setRoot() setStorage()

Summary

Instance fields

- $_check_immediate	Enables or disables interaction with user during authentication on
- $_extensions	Extension object or array of extensions objects
- $_httpClient	HTTP client to make HTTP requests
- $_id	The identity value being authenticated
- $_response	The response object to perform HTTP or HTML form redirection
- $_returnTo	The URL to redirect response from server to
- $_root	The HTTP URL to identify consumer on server
- $_storage	Reference to an implementation of a storage object

Instance methods

+ __construct()	Constructor
+ authenticate()	Authenticates the given OpenId identity.
+ setCheckImmediate()	Enables or disables interaction with user during authentication on
+ setExtensions()	Sets OpenID extension(s)
+ setHttpClient()	Sets HTTP client object to make HTTP requests
+ setIdentity()	Sets the value to be used as the identity
+ setResponse()	Sets an optional response object to perform HTTP or HTML form redirection
+ setReturnTo()	Sets the HTTP URL to redirect response from server to
+ setRoot()	Sets HTTP URL to identify consumer on server
+ setStorage()	Sets the storage implementation which will be use by OpenId

Details

Instance fields

$_check_immediate

private $_check_immediate = false

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

Var bool

Defined in Auth/Adapter/OpenId.php, line 96

$_extensions

private $_extensions = null

Extension object or array of extensions objects

Var string

Defined in Auth/Adapter/OpenId.php, line 81

$_httpClient

private $_httpClient = null

HTTP client to make HTTP requests

Var Zend_Http_Client $_httpClient

Defined in Auth/Adapter/OpenId.php, line 103

$_id

private $_id = null

The identity value being authenticated

Var string

Defined in Auth/Adapter/OpenId.php, line 53

$_response

private $_response = null

The response object to perform HTTP or HTML form redirection

Var Zend_Controller_Response_Abstract

Defined in Auth/Adapter/OpenId.php, line 88

$_returnTo

private $_returnTo = null

The URL to redirect response from server to

Var string

Defined in Auth/Adapter/OpenId.php, line 67

$_root

private $_root = null

The HTTP URL to identify consumer on server

Var string

Defined in Auth/Adapter/OpenId.php, line 74

$_storage

private $_storage = null

Reference to an implementation of a storage object

Var Zend_OpenId_Consumer_Storage

Defined in Auth/Adapter/OpenId.php, line 60

Instance methods

__construct()

public function __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`
`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`

Returns void

Defined in Auth/Adapter/OpenId.php, line 118

authenticate()

public function authenticate( )

Authenticates the given OpenId identity.
Defined by Zend_Auth_Adapter_Interface.

Returns Zend_Auth_Result

Throws Zend_Auth_Adapter_Exception If answering the authentication query is impossible

Defined in Auth/Adapter/OpenId.php, line 233

setCheckImmediate()

public function 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

Defined in Auth/Adapter/OpenId.php, line 211

setExtensions()

public function setExtensions( $extensions)

Sets OpenID extension(s)

Parameters

mixed $extensions

Returns Zend_Auth_Adapter_OpenId Provides a fluent interface

Defined in Auth/Adapter/OpenId.php, line 186

setHttpClient()

public function setHttpClient( $client)

Sets HTTP client object to make HTTP requests

Parameters

Zend_Http_Client $client HTTP client object to be used

Defined in Auth/Adapter/OpenId.php, line 222

setIdentity()

public function 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

Defined in Auth/Adapter/OpenId.php, line 138

setResponse()

public function setResponse( $response)

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

Parameters

$response

Returns Zend_Auth_Adapter_OpenId Provides a fluent interface

Defined in Auth/Adapter/OpenId.php, line 198

setReturnTo()

public function setReturnTo( $returnTo)

Sets the HTTP URL to redirect response from server to

Parameters

string $returnTo

Returns Zend_Auth_Adapter_OpenId Provides a fluent interface

Defined in Auth/Adapter/OpenId.php, line 162

setRoot()

public function setRoot( $root)

Sets HTTP URL to identify consumer on server

Parameters

string $root

Returns Zend_Auth_Adapter_OpenId Provides a fluent interface

Defined in Auth/Adapter/OpenId.php, line 174

setStorage()

public function 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

Defined in Auth/Adapter/OpenId.php, line 150