PHP Class Auth_Yadis_Discovery

High-level usage pattern is to call .getNextService(discover) in order to find the next available service for this user for this session. Once a request completes, call .cleanup() to clean up the session state.

Show file Open project: openid/php-openid

Public Properties

Property	Type	Description
$DEFAULT_SUFFIX
$PREFIX

Public Methods

Method	Description
__construct ( Auth_Yadis_PHPSession $session, string $url, string $session_key_suffix = null )	Initialize a discovery object.
cleanup ( $force = false )	Clean up Yadis-related services in the session and return the most-recently-attempted service from the manager, if one exists.
createManager ( $services, $yadis_url = null )
destroyManager ( $force = false )
getManager ( $force = false )
getNextService ( $discover_cb, $fetcher )	Return the next authentication service for the pair of user_input and session. This function handles fallback.
getSessionKey ( )

Method Details

__construct() public method

Initialize a discovery object.

public __construct ( Auth_Yadis_PHPSession $session, string $url, string $session_key_suffix = null )
$session	Auth_Yadis_PHPSession	An object which implements the Auth_Yadis_PHPSession API.
$url	string	The URL on which to attempt discovery.
$session_key_suffix	string	The optional session key suffix override.

cleanup() public method

Clean up Yadis-related services in the session and return the most-recently-attempted service from the manager, if one exists.

public cleanup ( $force = false )
$force		True if the manager should be deleted regardless of whether it's a manager for $this->url.

createManager() public method

public createManager ( $services, $yadis_url = null )

destroyManager() public method

public destroyManager ( $force = false )
$force		True if the manager should be deleted regardless of whether it's a manager for $this->url.

getManager() public method

public getManager ( $force = false )
$force		True if the manager should be returned regardless of whether it's a manager for $this->url.

getNextService() public method

Return the next authentication service for the pair of user_input and session. This function handles fallback.

public getNextService ( $discover_cb, $fetcher )

getSessionKey() public method

public getSessionKey ( )

Property Details

$DEFAULT_SUFFIX public property

public $DEFAULT_SUFFIX

$PREFIX public property

public $PREFIX