Auth_Yadis_SessionLoader Class Reference
Detailed Description
A session helper class designed to translate between arrays and objects. Note that the class used must have a constructor that takes no parameters. This is not a general solution, but it works for dumb objects that just need to have attributes set. The idea is that you'll subclass this and override $this->check($data) -> bool to implement your own session data validation.Definition at line 76 of file Manager.php.
Public Member Functions | |
| check ($data) | |
| fromSession ($data) | |
| prepareForLoad ($data) | |
| newObject ($data) | |
| toSession ($obj) | |
| prepareForSave ($obj) | |
Member Function Documentation
| Auth_Yadis_SessionLoader.check | ( | $ | data | ) |
Override this.
private
Reimplemented in Auth_OpenID_ServiceEndpointLoader, and Auth_Yadis_ManagerLoader.
Definition at line 82 of file Manager.php.
| 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.
| 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
Reimplemented in Auth_Yadis_ManagerLoader.
Definition at line 136 of file Manager.php.
| 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
Reimplemented in Auth_OpenID_ServiceEndpointLoader, and Auth_Yadis_ManagerLoader.
Definition at line 149 of file Manager.php.
| 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.
| Auth_Yadis_SessionLoader.prepareForSave | ( | $ | obj | ) |
Override this.
private
Reimplemented in Auth_Yadis_ManagerLoader.
Definition at line 185 of file Manager.php.
The documentation for this class was generated from the following file:
- core/openid/Auth/Yadis/Manager.php
