Auth/Adapter/OpenId.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Auth
subpackage: Zend_Auth_Adapter
version: $Id: OpenId.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Auth_Adapter_OpenId

Description

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.

Zend_Auth_Adapter_OpenId
jump to top

Implements: Zend_Auth_Adapter_Interface
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Auth
subpackage: Zend_Auth_Adapter
Properties: $_id; $_storage; $_returnTo; $_root; $_extensions; $_response; $_check_immediate; $_httpClient
Methods: __construct; setIdentity; setStorage; setReturnTo; setRoot; setExtensions; setResponse; setCheckImmediate; setHttpClient; authenticate

Description

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

Properties

$_check_immediate
jump to class

bool $_check_immediate = 'false'

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

Details

$_check_immediate: bool
visibility: private
default: false
final: false
static: false

$_extensions
jump to class

string $_extensions = 'null'

Extension object or array of extensions objects

Details

$_extensions: string
visibility: private
default: null
final: false
static: false

$_httpClient
jump to class

Zend_Http_Client $_httpClient = 'null'

HTTP client to make HTTP requests

Details

$_httpClient: Zend_Http_Client
visibility: private
default: null
final: false
static: false

$_id
jump to class

string $_id = 'null'

The identity value being authenticated

Details

$_id: string
visibility: private
default: null
final: false
static: false

$_response
jump to class

Zend_Controller_Response_Abstract $_response = 'null'

The response object to perform HTTP or HTML form redirection

Details

$_response: Zend_Controller_Response_Abstract
visibility: private
default: null
final: false
static: false

$_returnTo
jump to class

string $_returnTo = 'null'

The URL to redirect response from server to

Details

$_returnTo: string
visibility: private
default: null
final: false
static: false

$_root
jump to class

string $_root = 'null'

The HTTP URL to identify consumer on server

Details

$_root: string
visibility: private
default: null
final: false
static: false

$_storage
jump to class

Zend_OpenId_Consumer_Storage $_storage = 'null'

Reference to an implementation of a storage object

Details

$_storage: Zend_OpenId_Consumer_Storage
visibility: private
default: null
final: false
static: false

Methods

__construct
jump to class

__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

Arguments

$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

Details

visibility: public
final: false
static: false

authenticate
jump to class

authenticate(
          
          )
        
        :
        Zend_Auth_Result

Authenticates the given OpenId identity.

Defined by Zend_Auth_Adapter_Interface.

Output

Zend_Auth_Result

Details

visibility: public
final: false
static: false
throws: If answering the authentication query is impossible

setCheckImmediate
jump to class

setCheckImmediate(
          bool $check_immediate
          )
        
        :
        Zend_Auth_Adapter_OpenId

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

Arguments

$check_immediate: bool

Output

Zend_Auth_Adapter_OpenId: Provides a fluent interface

Details

visibility: public
final: false
static: false

setExtensions
jump to class

setExtensions(
          mixed $extensions
          )
        
        :
        Zend_Auth_Adapter_OpenId

Sets OpenID extension(s)

Arguments

$extensions: mixed

Output

Zend_Auth_Adapter_OpenId: Provides a fluent interface

Details

visibility: public
final: false
static: false

setHttpClient
jump to class

setHttpClient(
          Zend_Http_Client $client
          )
        
        :

Sets HTTP client object to make HTTP requests

Arguments

$client: Zend_Http_Client
HTTP client object to be used

Details

visibility: public
final: false
static: false

setIdentity
jump to class

setIdentity(
          string $id
          )
        
        :
        Zend_Auth_Adapter_OpenId

Sets the value to be used as the identity

Arguments

$id: string
the identity value

Output

Zend_Auth_Adapter_OpenId: Provides a fluent interface

Details

visibility: public
final: false
static: false

setResponse
jump to class

setResponse(
           $response
          )
        
        :
        Zend_Auth_Adapter_OpenId

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

Arguments

$response

Output

Zend_Auth_Adapter_OpenId: Provides a fluent interface

Details

visibility: public
final: false
static: false

setReturnTo
jump to class

setReturnTo(
          string $returnTo
          )
        
        :
        Zend_Auth_Adapter_OpenId

Sets the HTTP URL to redirect response from server to

Arguments

$returnTo: string

Output

Zend_Auth_Adapter_OpenId: Provides a fluent interface

Details

visibility: public
final: false
static: false

setRoot
jump to class

setRoot(
          string $root
          )
        
        :
        Zend_Auth_Adapter_OpenId

Sets HTTP URL to identify consumer on server

Arguments

$root: string

Output

Zend_Auth_Adapter_OpenId: Provides a fluent interface

Details

visibility: public
final: false
static: false

setStorage
jump to class

setStorage(
          Zend_OpenId_Consumer_Storage $storage
          )
        
        :
        Zend_Auth_Adapter_OpenId

Sets the storage implementation which will be use by OpenId

Arguments

$storage: Zend_OpenId_Consumer_Storage

Output

Zend_Auth_Adapter_OpenId: Provides a fluent interface

Details

visibility: public
final: false
static: false

API Documentation

Auth/Adapter/OpenId.php

Description

Zend_Auth_Adapter_OpenIdjump to top

Description

Properties

$_check_immediatejump to class

Details

$_extensionsjump to class

Details

$_httpClientjump to class

Details

$_idjump to class

Details

$_responsejump to class

Details

$_returnTojump to class

Details

$_rootjump to class

Details

$_storagejump to class

Details

Methods

__constructjump to class

Arguments

Details

authenticatejump to class

Output

Details

setCheckImmediatejump to class

Arguments

Output

Details

setExtensionsjump to class

Arguments

Output

Details

setHttpClientjump to class

Arguments

Details

setIdentityjump to class

Arguments

Output

Details

setResponsejump to class

Arguments

Output

Details

setReturnTojump to class

Arguments

Output

Details

setRootjump to class

Arguments

Output

Details

setStoragejump to class

Arguments

Output

Details

Zend_Auth_Adapter_OpenId
jump to top

$_check_immediate
jump to class

$_extensions
jump to class

$_httpClient
jump to class

$_id
jump to class

$_response
jump to class

$_returnTo
jump to class

$_root
jump to class

$_storage
jump to class

__construct
jump to class

authenticate
jump to class

setCheckImmediate
jump to class

setExtensions
jump to class

setHttpClient
jump to class

setIdentity
jump to class

setResponse
jump to class

setReturnTo
jump to class

setRoot
jump to class

setStorage
jump to class