[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: Auth_Yadis_PHPSession

Source Location: /zp-extensions/federated_logon/Auth/Yadis/Manager.php

Class Auth_Yadis_PHPSession

Class Overview

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.

Located in /zp-extensions/federated_logon/Auth/Yadis/Manager.php [line 17]



		
		
		
		

Methods

[ Top ]
Method Summary
void   contents()   Return the contents of the session in array form.
void   del()   Remove a key/value pair from the session.
string   get()   Get a key's value from the session.
void   set()   Set a session key/value pair.

[ Top ]
Methods
contents  [line 60]

  void contents( )

Return the contents of the session in array form.



[ Top ]
del  [line 52]

  void del( string $name  )

Remove a key/value pair from the session.

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


[ Top ]
get  [line 38]

  string get( string $name, [string $default = null]  )

Get a key's value from the session.

Parameters:
string   $name:  The name of the key to retrieve.
string   $default:  The optional value to return if the key is not found in the session.

API Tags:
Return:  The key's value in the session or $default if it isn't found.


[ Top ]
set  [line 24]

  void set( string $name, string $value  )

Set a session key/value pair.

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


[ Top ]

Documentation generated on Tue, 20 Dec 2011 16:07:40 +0100 by phpDocumentor 1.4.3