Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitMemorySessionBackend

Core::arbitMemorySessionBackend

Class arbitMemorySessionBackend

Arbit memory session backend Session "backend" which keeps the data just in memory to replay it in the same request.

Arbit memory session backend Session "backend" which keeps the data just in memory to replay it in the same request. Does not persist any data. Useful for CLI scripts and testing.

arbitSessionBackend
   |
   --arbitMemorySessionBackend
Author(s):
Version:   $Revision: 1692 $
License:   GPL

Member Variables

protected array $data = array()
Session data container

Session data container

Method Summary

public void initialize( )
Initializes the sessioInitializes the session
public boolean offsetExists( $offset )
Check if variable is stored in the session.
public mixed offsetGet( $offset )
Get contents of the requested session item
public void offsetSet( $offset , $value )
Set variable in session Adds new item to the session, or overwrites an existing entry. value should be serializable.
public void offsetUnset( $offset )
Removes item from session
public void writeClose( )
Close the session After a call to this method no more write operations are allowed to the session.

Inherited Methods

From arbitSessionBackend
public abstract void arbitSessionBackend::initialize()
Initializes the sessioInitializes the session
public void arbitSessionBackend::regenerateId()
Regenerate ID Special function to regenerate optional user visible session IDs on certain circumstances like permission changes.
public abstract void arbitSessionBackend::writeClose()
Close the session After a call to this method no more write operations are allowed to the session.

Methods

initialize

void initialize( )

Initializes the sessioInitializes the session

Initializes the sessioInitializes the session

Redefinition of:
Method Description
arbitSessionBackend::initialize() Initializes the sessioInitializes the session

offsetExists

boolean offsetExists( string $offset )

Check if variable is stored in the session.

Check if variable is stored in the session. Returns false if the variable is not known in the session.

Parameters:
Name Type Description
$offset string

offsetGet

mixed offsetGet( string $offset )

Get contents of the requested session item

Get contents of the requested session item

Parameters:
Name Type Description
$offset string

offsetSet

void offsetSet( string $offset , mixed $value )

Set variable in session Adds new item to the session, or overwrites an existing entry. value should be serializable.

Set variable in session Adds new item to the session, or overwrites an existing entry. The added value should be serializable.

Parameters:
Name Type Description
$offset string
$value mixed

offsetUnset

void offsetUnset( string $offset )

Removes item from session

Removes item from session

Parameters:
Name Type Description
$offset string

writeClose

void writeClose( )

Close the session After a call to this method no more write operations are allowed to the session.

Close the session After a call to this method no more write operations are allowed to the session.

Redefinition of:
Method Description
arbitSessionBackend::writeClose() Close the session After a call to this method no more write operations are allowed to the session.
Documentation generated on Mon, 05 Apr 2010 14:02:04 +0200 by phpDocumentor 1.4.3