[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/openid/Auth/Yadis/ -> Manager.php (summary)

[Source view] [Print] [Project Stats]

Yadis service manager to be used during yadis-driven authentication attempts.

File Size: 532 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 6 classes

Auth_Yadis_PHPSession:: (4 methods):
  set()
  get()
  del()
  contents()

Auth_Yadis_SessionLoader:: (6 methods):
  check()
  fromSession()
  prepareForLoad()
  newObject()
  toSession()
  prepareForSave()

Auth_OpenID_ServiceEndpointLoader:: (3 methods):
  newObject()
  requiredKeys()
  check()

Auth_Yadis_ManagerLoader:: (5 methods):
  requiredKeys()
  newObject()
  check()
  prepareForLoad()
  prepareForSave()

Auth_Yadis_Manager:: (6 methods):
  Auth_Yadis_Manager()
  length()
  nextService()
  current()
  forURL()
  started()

Auth_Yadis_Discovery:: (7 methods):
  Auth_Yadis_Discovery()
  getNextService()
  cleanup()
  getSessionKey()
  getManager()
  createManager()
  destroyManager()


Class: Auth_Yadis_PHPSession  - X-Ref

The base session class used by the Auth_Yadis_Manager.  This
class wraps the default PHP session machinery and should be
subclassed if your application doesn't use PHP sessioning.

set($name, $value)   X-Ref
Set a session key/value pair.

param: string $name The name of the session key to add.
param: string $value The value to add to the session.

get($name, $default=null)   X-Ref
Get a key's value from the session.

param: string $name The name of the key to retrieve.
param: string $default The optional value to return if the key
return: string $result The key's value in the session or

del($name)   X-Ref
Remove a key/value pair from the session.

param: string $name The name of the key to remove.

contents()   X-Ref
Return the contents of the session in array form.


Class: Auth_Yadis_SessionLoader  - X-Ref

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.

check($data)   X-Ref
Override this.


fromSession($data)   X-Ref
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.


prepareForLoad($data)   X-Ref
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).


newObject($data)   X-Ref
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.


toSession($obj)   X-Ref
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.


prepareForSave($obj)   X-Ref
Override this.


Class: Auth_OpenID_ServiceEndpointLoader  - X-Ref

A concrete loader implementation for Auth_OpenID_ServiceEndpoints.

newObject($data)   X-Ref
No description

requiredKeys()   X-Ref
No description

check($data)   X-Ref
No description

Class: Auth_Yadis_ManagerLoader  - X-Ref

A concrete loader implementation for Auth_Yadis_Managers.

requiredKeys()   X-Ref
No description

newObject($data)   X-Ref
No description

check($data)   X-Ref
No description

prepareForLoad($data)   X-Ref
No description

prepareForSave($obj)   X-Ref
No description

Class: Auth_Yadis_Manager  - X-Ref

The Yadis service manager which stores state in a session and
iterates over <Service> elements in a Yadis XRDS document and lets
a caller attempt to use each one.  This is used by the Yadis
library internally.

Auth_Yadis_Manager($starting_url, $yadis_url,$services, $session_key)   X-Ref
Intialize a new yadis service manager.


length()   X-Ref


nextService()   X-Ref
Return the next service

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

current()   X-Ref


forURL($url)   X-Ref


started()   X-Ref


Class: Auth_Yadis_Discovery  - X-Ref

State management for discovery.

High-level usage pattern is to call .getNextService(discover) in
order to find the next available service for this user for this
session. Once a request completes, call .cleanup() to clean up the
session state.

Auth_Yadis_Discovery(&$session, $url,$session_key_suffix = null)   X-Ref
Initialize a discovery object.

param: Auth_Yadis_PHPSession $session An object which
param: string $url The URL on which to attempt discovery.
param: string $session_key_suffix The optional session key

getNextService($discover_cb, &$fetcher)   X-Ref
Return the next authentication service for the pair of
user_input and session. This function handles fallback.


cleanup($force=false)   X-Ref
Clean up Yadis-related services in the session and return the
most-recently-attempted service from the manager, if one
exists.

param: $force True if the manager should be deleted regardless

getSessionKey()   X-Ref


getManager($force=false)   X-Ref

param: $force True if the manager should be returned regardless

createManager($services, $yadis_url = null)   X-Ref


destroyManager($force=false)   X-Ref

param: $force True if the manager should be deleted regardless


Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1