Auth_Yadis_Manager Class Reference

Collaboration diagram for Auth_Yadis_Manager:

Public Member Functions
	Auth_Yadis_Manager ($starting_url, $yadis_url, $services, $session_key)
	Intialize a new yadis service manager. More...
	length ()
	private More...
	nextService ()
	Return the next service. More...
	current ()
	private More...
	forURL ($url)
	private More...
	started ()
	private More...

Detailed Description

Definition at line 276 of file Manager.php.

Member Function Documentation

Auth_Yadis_Manager()

Auth_Yadis_Manager::Auth_Yadis_Manager	(		$starting_url,
			$yadis_url,
			$services,
			$session_key
	)

Intialize a new yadis service manager.

private

Definition at line 283 of file Manager.php.

    {
        // The URL that was used to initiate the Yadis protocol
        $this->starting_url = $starting_url;

        // The URL after following redirects (the identifier)
        $this->yadis_url = $yadis_url;

        // List of service elements
        $this->services = $services;

        $this->session_key = $session_key;

        // Reference to the current service object
        $this->_current = null;

        // Stale flag for cleanup if PHP lib has trouble.
        $this->stale = false;
    }

current()

Auth_Yadis_Manager::current

(

)

private

Definition at line 334 of file Manager.php.

    {
        // Return the current service.
        // Returns None if there are no services left.
        return $this->_current;
    }

forURL()

Auth_Yadis_Manager::forURL

(

$url

)

private

Definition at line 344 of file Manager.php.

    {
        return in_array($url, array($this->starting_url, $this->yadis_url));
    }

length()

Auth_Yadis_Manager::length

(

)

private

Definition at line 307 of file Manager.php.

    {
        // How many untried services remain?
        return count($this->services);
    }

nextService()

Auth_Yadis_Manager::nextService

(

)

Return the next service.

$this->current() will continue to return that service until the next call to this method.

Definition at line 319 of file Manager.php.

    {

        if ($this->services) {
            $this->_current = array_shift($this->services);
        } else {
            $this->_current = null;
        }

        return $this->_current;
    }

started()

Auth_Yadis_Manager::started

(

)

private

Definition at line 352 of file Manager.php.

    {
        // Has the first service been returned?
        return $this->_current !== null;
    }

---

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

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