Auth/Adapter/OpenId.php

Show:

inherited

Classes
- \Zend_Auth_Adapter_OpenId

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Auth
Subpackage: Zend_Auth_Adapter
Version: $Id$

\Zend_Auth_Adapter_OpenId
jump to top

Package: Zend_Auth\Zend_Auth_Adapter

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

Implements
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

bool $_check_immediate = false

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

Default valuefalseDetails

Type: bool

string $_extensions = null

Extension object or array of extensions objects

Default valuenullDetails

Type: string

\Zend_Http_Client $_httpClient = null

HTTP client to make HTTP requests

Default valuenullDetails

Type: \Zend_Http_Client

string $_id = null

The identity value being authenticated

Default valuenullDetails

Type: string

\Zend_Controller_Response_Abstract $_response = null

The response object to perform HTTP or HTML form redirection

Default valuenullDetails

Type: \Zend_Controller_Response_Abstract

string $_returnTo = null

The URL to redirect response from server to

Default valuenullDetails

Type: string

string $_root = null

The HTTP URL to identify consumer on server

Default valuenullDetails

Type: string

\Zend_OpenId_Consumer_Storage $_storage = null

Reference to an implementation of a storage object

Default valuenullDetails

Type: \Zend_OpenId_Consumer_Storage

Methods

__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

Parameters

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.

Returns

Type	Description
\Zend_Auth_Result

Throws

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.

Parameters

Name	Type	Description
$check_immediate	bool

Returns

Type	Description
\Zend_Auth_Adapter_OpenId	Provides a fluent interface

setExtensions(mixed $extensions) : \Zend_Auth_Adapter_OpenId

Sets OpenID extension(s)

Parameters

Name	Type	Description
$extensions	mixed

Returns

Type	Description
\Zend_Auth_Adapter_OpenId	Provides a fluent interface

setHttpClient(\Zend_Http_Client $client) : void

Sets HTTP client object to make HTTP requests

Parameters

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

Parameters

Name	Type	Description
$id	string	the identity value

Returns

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

Parameters

Name	Type	Description
$response

Returns

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

Parameters

Name	Type	Description
$returnTo	string

Returns

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

Parameters

Name	Type	Description
$root	string

Returns

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

Parameters

Name	Type	Description
$storage	\Zend_OpenId_Consumer_Storage

Returns

Type	Description
\Zend_Auth_Adapter_OpenId	Provides a fluent interface