Auth_Yadis_SessionLoader Class Reference

Inheritance diagram for Auth_Yadis_SessionLoader:

Collaboration diagram for Auth_Yadis_SessionLoader:

Public Member Functions
	check ($data)
	Override this. More...
	fromSession ($data)
	Given a session data value (an array), this creates an object (returned by $this->newObject()) whose attributes and values are those in $data. More...
	prepareForLoad ($data)
	Prepares the data array by making any necessary changes. More...
	newObject ($data)
	Returns a new instance of this loader's class, using the session data to construct it if necessary. More...
	toSession ($obj)
	Returns an array of keys and values built from the attributes of $obj. More...
	prepareForSave ($obj)
	Override this. More...

Detailed Description

Definition at line 76 of file Manager.php.

Member Function Documentation

check()

Auth_Yadis_SessionLoader::check

(

$data

)

Override this.

private

Definition at line 82 of file Manager.php.

    {
        return true;
    }

fromSession()

Auth_Yadis_SessionLoader::fromSession

(

$data

)

Given a session data value (an array), this creates an object (returned by $this->newObject()) whose attributes and values are those in $data.

Returns null if $data lacks keys found in $this->requiredKeys(). Returns null if $this->check($data) evaluates to false. Returns null if $this->newObject() evaluates to false.

private

Definition at line 97 of file Manager.php.

References $data.

    {
        if (!$data) {
            return null;
        }

        $required = $this->requiredKeys();

        foreach ($required as $k) {
            if (!array_key_exists($k, $data)) {
                return null;
            }
        }

        if (!$this->check($data)) {
            return null;
        }

        $data = array_merge($data, $this->prepareForLoad($data));
        $obj = $this->newObject($data);

        if (!$obj) {
            return null;
        }

        foreach ($required as $k) {
            $obj->$k = $data[$k];
        }

        return $obj;
    }

newObject()

Auth_Yadis_SessionLoader::newObject

(

$data

)

Returns a new instance of this loader's class, using the session data to construct it if necessary.

The object need only be created; $this->fromSession() will take care of setting the object's attributes.

private

Definition at line 149 of file Manager.php.

    {
        return null;
    }

prepareForLoad()

Auth_Yadis_SessionLoader::prepareForLoad

(

$data

)

Prepares the data array by making any necessary changes.

Returns an array whose keys and values will be used to update the original data array before calling $this->newObject($data).

private

Definition at line 136 of file Manager.php.

    {
        return array();
    }

prepareForSave()

Auth_Yadis_SessionLoader::prepareForSave

(

$obj

)

Override this.

private

Definition at line 185 of file Manager.php.

    {
        return array();
    }

toSession()

Auth_Yadis_SessionLoader::toSession

(

$obj

)

Returns an array of keys and values built from the attributes of $obj.

If $this->prepareForSave($obj) returns an array, its keys and values are used to update the $data array of attributes from $obj.

private

Definition at line 162 of file Manager.php.

References $data.

    {
        $data = array();
        foreach ($obj as $k => $v) {
            $data[$k] = $v;
        }

        $extra = $this->prepareForSave($obj);

        if ($extra && is_array($extra)) {
            foreach ($extra as $k => $v) {
                $data[$k] = $v;
            }
        }

        return $data;
    }

---

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

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