Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitCoreModuleUserOpenIDAuthentificationFilter

Core::arbitCoreModuleUserOpenIDAuthentificationFilter

Class arbitCoreModuleUserOpenIDAuthentificationFilter

Filter class for OpenID user authentication mechanism

Filter class for OpenID user authentication mechanism

ezcAuthenticationOpenidFilter
   |
   --arbitCoreModuleUserOpenIDAuthentificationFilter
Author(s):
Version:   $Revision: 1236 $
License:   GPL

Member Variables

protected array(string) $requestedMandatoryData = array()
Holds the mandatory attributes which will be requested during the authentication process.

Holds the mandatory attributes which will be requested during the authentication process. The array should look like this: array( 'fullname', 'gender', 'country', 'language' );

Method Summary

public array(string=>array) createCheckidRequest( $id , $providers )
Returns an array of parameters for use in an OpenID check_id request.
public void registerMandatoryFetchData( [ $data = array()] )
Registers which mandatory extra data to fetch during the auth process.

Methods

createCheckidRequest

array(string=>array) createCheckidRequest( string $id , $providers )

Returns an array of parameters for use in an OpenID check_id request.

Returns an array of parameters for use in an OpenID check_id request. This method calls the ezcAuthenticationOpenidFilter::createCheckidRequest and adds fields that are required for mandatory data to the returning array.

Parameters:
Name Type Description
$id string The OpenID identifier from the user
$providers array(string) OpenID providers retrieved during discovery

registerMandatoryFetchData

void registerMandatoryFetchData( [ $data = array()] )

Registers which mandatory extra data to fetch during the auth process.

Registers which mandatory extra data to fetch during the auth process. If you want to know, which data can be fetched, see ezcAuthenticationOpenidFilter.

Parameters:
Name Type Description
$data array(string)
Documentation generated on Mon, 05 Apr 2010 14:02:08 +0200 by phpDocumentor 1.4.3