Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
A Zend_Auth Authentication Adapter allowing the use of OpenID protocol as an authentication mechanism

bool
$_check_immediate= 'false'
Enables or disables interaction with user during authentication on OpenID provider.
false
Details
string
$_extensions= 'null'
Extension object or array of extensions objects
null
Details
\Zend_Controller_Response_Abstract
$_response= 'null'
The response object to perform HTTP or HTML form redirection

string
$_returnTo= 'null'
The URL to redirect response from server to
null
Details
string
$_root= 'null'
The HTTP URL to identify consumer on server
null
Details
__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
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$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 |

authenticate(
)
:
\Zend_Auth_Result
Authenticates the given OpenId identity.
Defined by Zend_Auth_Adapter_Interface.
Type | Description |
---|---|
\Zend_Auth_Result |
Exception | Description |
---|---|
\Zend_Auth_Adapter_Exception | If answering the authentication query is impossible |

setCheckImmediate(
bool $check_immediate
)
:
\Zend_Auth_Adapter_OpenId
Enables or disables interaction with user during authentication on OpenID provider.
Name | Type | Description |
---|---|---|
$check_immediate | bool |
Type | Description |
---|---|
\Zend_Auth_Adapter_OpenId | Provides a fluent interface |

setExtensions(
mixed $extensions
)
:
\Zend_Auth_Adapter_OpenId
Sets OpenID extension(s)
Name | Type | Description |
---|---|---|
$extensions | mixed |
Type | Description |
---|---|
\Zend_Auth_Adapter_OpenId | Provides a fluent interface |

setHttpClient(
\Zend_Http_Client $client
)
:
void
Sets HTTP client object to make HTTP requests
Name | Type | Description |
---|---|---|
$client | \Zend_Http_Client | HTTP client object to be used |

setIdentity(
string $id
)
:
\Zend_Auth_Adapter_OpenId
Sets the value to be used as the identity
Name | Type | Description |
---|---|---|
$id | string | the identity value |
Type | Description |
---|---|
\Zend_Auth_Adapter_OpenId | Provides a fluent interface |

setResponse(
$response
)
:
\Zend_Auth_Adapter_OpenId
Sets an optional response object to perform HTTP or HTML form redirection
Name | Type | Description |
---|---|---|
$response |
Type | Description |
---|---|
\Zend_Auth_Adapter_OpenId | Provides a fluent interface |

setReturnTo(
string $returnTo
)
:
\Zend_Auth_Adapter_OpenId
Sets the HTTP URL to redirect response from server to
Name | Type | Description |
---|---|---|
$returnTo | string |
Type | Description |
---|---|
\Zend_Auth_Adapter_OpenId | Provides a fluent interface |

setRoot(
string $root
)
:
\Zend_Auth_Adapter_OpenId
Sets HTTP URL to identify consumer on server
Name | Type | Description |
---|---|---|
$root | string |
Type | Description |
---|---|
\Zend_Auth_Adapter_OpenId | Provides a fluent interface |

setStorage(
\Zend_OpenId_Consumer_Storage $storage
)
:
\Zend_Auth_Adapter_OpenId
Sets the storage implementation which will be use by OpenId
Name | Type | Description |
---|---|---|
$storage | \Zend_OpenId_Consumer_Storage |
Type | Description |
---|---|
\Zend_Auth_Adapter_OpenId | Provides a fluent interface |