Auth_Yadis_Discovery Class Reference

List of all members.

---

Detailed Description

State management for 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.

Definition at line 369 of file Manager.php.

Public Member Functions
	Auth_Yadis_Discovery (&$session, $url, $session_key_suffix=null)
	getNextService ($discover_cb, &$fetcher)
	cleanup ($force=false)
	getSessionKey ()
&	getManager ($force=false)
&	createManager ($services, $yadis_url=null)
	destroyManager ($force=false)
Public Attributes
	$DEFAULT_SUFFIX = 'auth'
	$PREFIX = '_yadis_services_'

---

Member Function Documentation

Auth_Yadis_Discovery.Auth_Yadis_Discovery	(	&$	session,
		$	url,
		$	session_key_suffix = null
	)

Initialize a discovery object.

Parameters:

	Auth_Yadis_PHPSession	$session An object which implements the Auth_Yadis_PHPSession API.
	string	$url The URL on which to attempt discovery.
	string	$session_key_suffix The optional session key suffix override.

Initialize a discovery object

Definition at line 390 of file Manager.php.

Auth_Yadis_Discovery.getNextService	(	$	discover_cb,
		&$	fetcher
	)

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

Definition at line 408 of file Manager.php.

Auth_Yadis_Discovery.cleanup

(

$

force = false

)

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

Parameters:

$force

True if the manager should be deleted regardless of whether it's a manager for $this->url.

Definition at line 441 of file Manager.php.

Auth_Yadis_Discovery.getSessionKey

(

)

private

Definition at line 457 of file Manager.php.

& Auth_Yadis_Discovery.getManager

(

$

force = false

)

private

Parameters:

$force

True if the manager should be returned regardless of whether it's a manager for $this->url.

Definition at line 469 of file Manager.php.

& Auth_Yadis_Discovery.createManager	(	$	services,
		$	yadis_url = null
	)

private

Definition at line 493 of file Manager.php.

Auth_Yadis_Discovery.destroyManager

(

$

force = false

)

private

Parameters:

$force

True if the manager should be deleted regardless of whether it's a manager for $this->url.

Definition at line 520 of file Manager.php.

---

Member Data Documentation

Auth_Yadis_Discovery.$DEFAULT_SUFFIX = 'auth'

private

Definition at line 374 of file Manager.php.

Auth_Yadis_Discovery.$PREFIX = '_yadis_services_'

private

Definition at line 379 of file Manager.php.

---

The documentation for this class was generated from the following file:

• core/openid/Auth/Yadis/Manager.php