Auth_Yadis_Discovery Class Reference

Collaboration diagram for Auth_Yadis_Discovery:

Public Member Functions
	Auth_Yadis_Discovery ($session, $url, $session_key_suffix=null)
	Initialize a discovery object. More...
	getNextService ($discover_cb, $fetcher)
	Return the next authentication service for the pair of user_input and session. More...
	cleanup ($force=false)
	Clean up Yadis-related services in the session and return the most-recently-attempted service from the manager, if one exists. More...
	getSessionKey ()
	@access private More...
	getManager ($force=false)
	@access private More...
	createManager ($services, $yadis_url=null)
	@access private More...
	destroyManager ($force=false)
	@access private More...

Data Fields
	$DEFAULT_SUFFIX = 'auth'
	@access private More...
	$PREFIX = '_yadis_services_'
	@access private More...

Detailed Description

Definition at line 369 of file Manager.php.

Member Function Documentation

Auth_Yadis_Discovery()

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.

    {
        $this->session = $session;
        $this->url = $url;
        if ($session_key_suffix === null) {
            $session_key_suffix = $this->DEFAULT_SUFFIX;
        }
 
        $this->session_key_suffix = $session_key_suffix;
        $this->session_key = $this->PREFIX . $this->session_key_suffix;
    }

References $DEFAULT_SUFFIX, and $url.

cleanup()

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.

    {
        $manager = $this->getManager($force);
        if ($manager) {
            $service = $manager->current();
            $this->destroyManager($force);
        } else {
            $service = null;
        }
 
        return $service;
    }

References destroyManager(), and getManager().

Here is the call graph for this function:

createManager()

Auth_Yadis_Discovery::createManager	(		$services,
			$yadis_url = null
	)

@access private

Definition at line 490 of file Manager.php.

    {
        $key = $this->getSessionKey();
        if ($this->getManager()) {
            return $this->getManager();
        }
 
        if ($services) {
            $loader = new Auth_Yadis_ManagerLoader();
            $manager = new Auth_Yadis_Manager($this->url, $yadis_url,
                                              $services, $key);
            $this->session->set($this->session_key,
                                serialize($loader->toSession($manager)));
            return $manager;
        }
    }

References $loader, getManager(), and getSessionKey().

Referenced by getNextService().

Here is the call graph for this function:

Here is the caller graph for this function:

destroyManager()

Auth_Yadis_Discovery::destroyManager

(

$force = false

)

@access private

Parameters

$force

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

Definition at line 513 of file Manager.php.

    {
        if ($this->getManager($force) !== null) {
            $key = $this->getSessionKey();
            $this->session->del($key);
        }
    }

References getManager(), and getSessionKey().

Referenced by cleanup(), and getNextService().

Here is the call graph for this function:

Here is the caller graph for this function:

getManager()

Auth_Yadis_Discovery::getManager

(

$force = false

)

@access 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.

    {
        // Extract the YadisServiceManager for this object's URL and
        // suffix from the session.
 
        $manager_str = $this->session->get($this->getSessionKey());
        $manager = null;
 
        if ($manager_str !== null) {
            $loader = new Auth_Yadis_ManagerLoader();
            $manager = $loader->fromSession(unserialize($manager_str));
        }
 
        if ($manager && ($manager->forURL($this->url) || $force)) {
            return $manager;
        }
    }

References $loader, and getSessionKey().

Referenced by cleanup(), createManager(), destroyManager(), and getNextService().

Here is the call graph for this function:

Here is the caller graph for this function:

getNextService()

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.

    {
        $manager = $this->getManager();
        if (!$manager || (!$manager->services)) {
            $this->destroyManager();
 
            list($yadis_url, $services) = call_user_func($discover_cb,
                                                         $this->url,
                                                         $fetcher);
 
            $manager = $this->createManager($services, $yadis_url);
        }
 
        if ($manager) {
            $loader = new Auth_Yadis_ManagerLoader();
            $service = $manager->nextService();
            $this->session->set($this->session_key,
                                serialize($loader->toSession($manager)));
        } else {
            $service = null;
        }
 
        return $service;
    }

References $loader, createManager(), destroyManager(), and getManager().

Here is the call graph for this function:

getSessionKey()

Auth_Yadis_Discovery::getSessionKey

(

)

@access private

Definition at line 457 of file Manager.php.

    {
        // Get the session key for this starting URL and suffix
        return $this->PREFIX . $this->session_key_suffix;
    }

Referenced by createManager(), destroyManager(), and getManager().

Here is the caller graph for this function:

Field Documentation

$DEFAULT_SUFFIX

Auth_Yadis_Discovery::$DEFAULT_SUFFIX = 'auth'

@access private

Definition at line 374 of file Manager.php.

Referenced by Auth_Yadis_Discovery().

$PREFIX

Auth_Yadis_Discovery::$PREFIX = '_yadis_services_'

@access private

Definition at line 379 of file Manager.php.

---

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

• Services/OpenId/lib/Auth/Yadis/Manager.php