[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: Auth_Yadis_Discovery

Source Location: /zp-extensions/federated_logon/Auth/Yadis/Manager.php

Class Auth_Yadis_Discovery

Class Overview

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.

Located in /zp-extensions/federated_logon/Auth/Yadis/Manager.php [line 369]



		
		
		
		

Methods

[ Top ]
Method Summary
Auth_Yadis_Discovery   Auth_Yadis_Discovery()   Initialize a discovery object.
void   cleanup()   Clean up Yadis-related services in the session and return the most-recently-attempted service from the manager, if one exists.
void   getNextService()   Return the next authentication service for the pair of user_input and session. This function handles fallback.

[ Top ]
Methods
Constructor Auth_Yadis_Discovery  [line 390]

  Auth_Yadis_Discovery Auth_Yadis_Discovery( Auth_Yadis_PHPSession $session, string $url, [string $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.


[ Top ]
cleanup  [line 441]

  void cleanup( [$force $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   $force:  True if the manager should be deleted regardless of whether it's a manager for $this->url.


[ Top ]
getNextService  [line 408]

  void getNextService( $discover_cb, $fetcher  )

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

Parameters:
   $discover_cb: 
   $fetcher: 


[ Top ]

Documentation generated on Sat, 05 Jan 2013 15:51:18 +0100 by phpDocumentor 1.4.3