Auth_Yadis_Discovery Klassenreferenz

Öffentliche Methoden
	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)
Datenfelder
	$DEFAULT_SUFFIX = 'auth'
	$PREFIX = '_yadis_services_'

---

Ausführliche Beschreibung

Definiert in Zeile 369 der Datei Manager.php.

---

Dokumentation der Elementfunktionen

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

Initialize a discovery object.

Parameter:

	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

Definiert in Zeile 390 der Datei 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;
    }

cleanup

(

$

force = false

)

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

Parameter:

$force

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

Definiert in Zeile 441 der Datei Manager.php.

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

        return $service;
    }

& createManager	(	$	services,
		$	yadis_url = null
	)

private

Definiert in Zeile 493 der Datei 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;
        } else {
            // Oh, PHP.
            $unused = null;
            return $unused;
        }
    }

destroyManager

(

$

force = false

)

private

Parameter:

$force

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

Definiert in Zeile 520 der Datei Manager.php.

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

& getManager

(

$

force = false

)

private

Parameter:

$force

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

Definiert in Zeile 469 der Datei 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;
        } else {
            $unused = null;
            return $unused;
        }
    }

getNextService	(	$	discover_cb,
		&$	fetcher
	)

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

Definiert in Zeile 408 der Datei 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;
    }

getSessionKey

(

)

private

Definiert in Zeile 457 der Datei Manager.php.

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

---

Dokumentation der Datenelemente

$DEFAULT_SUFFIX = 'auth'

private

Definiert in Zeile 374 der Datei Manager.php.

$PREFIX = '_yadis_services_'

private

Definiert in Zeile 379 der Datei Manager.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• Auth/Yadis/Manager.php