Class: SessionStorage

Source Location: /storage/SessionStorage.class.php

Class Overview

ParameterHolder
   |
   --Storage
      |
      --SessionStorage

SessionStorage allows you to store persistent Mojavi data in the user session.

Author(s):

Sean Kerr (skerr@mojavi.org)

Version:

$Id: SessionStorage.class.php 707 2004-12-28 17:48:28Z seank $

Copyright:

Methods

Child classes:

PostgreSQLSessionStorage: Provides support for session storage using a PostgreSQL brand database.

MySQLSessionStorage: Provides support for session storage using a MySQL brand database.

Inherited Variables

Class: ParameterHolder

ParameterHolder::$parameters

Inherited Methods

Class: Storage

Storage::getContext(): Retrieve the current application context.
Storage::initialize(): Initialize this Storage.
Storage::newInstance(): Retrieve a new Storage implementation instance.
Storage::read(): Read data from this storage.
Storage::remove(): Remove data from this storage.
Storage::shutdown(): Execute the shutdown procedure.
Storage::write(): Write data to this storage.

Class: ParameterHolder

ParameterHolder::clearParameters(): Clear all parameters associated with this request.
ParameterHolder::getParameter(): Retrieve a parameter.
ParameterHolder::getParameterNames(): Retrieve an array of parameter names.
ParameterHolder::getParameters(): Retrieve an array of parameters.
ParameterHolder::hasParameter(): Indicates whether or not a parameter exists.
ParameterHolder::removeParameter(): Remove a parameter.
ParameterHolder::setParameter(): Set a parameter.
ParameterHolder::setParameterByRef(): Set a parameter by reference.
ParameterHolder::setParameters(): Set an array of parameters.
ParameterHolder::setParametersByRef(): Set an array of parameters by reference.

Class Details

[line 30]
SessionStorage allows you to store persistent Mojavi data in the user session.

Optional parameters:

auto_start - [Yes] - Should session_start() automatically be called?
session_name - [Mojavi] - The name of the session.

Tags:

version:	$Id: SessionStorage.class.php 707 2004-12-28 17:48:28Z seank $
since:	3.0.0
copyright:	(c) Sean Kerr, http://www.mojavi.org
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

Class Methods

method initialize [line 52]

bool initialize(
Context
$context, [array
$parameters = null])

Initialize this Storage.

Tags:

return:	true, if initialization completes successfully, otherwise false.
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)
throws:	InitializationException If an error occurs while initializing this Storage.

Overridden in child classes as:

PostgreSQLSessionStorage::initialize(): Initialize this Storage.

MySQLSessionStorage::initialize(): Initialize this Storage.

Overrides Storage::initialize() (Initialize this Storage.)

Parameters:

Context	$context	A Context instance.
array	$parameters	An associative array of initialization parameters.

[ Top ]

method read [line 88]

mixed &read(
string
$key)

Read data from this storage.

The preferred format for a key is directory style so naming conflicts can be avoided.

Tags:

return:	Data associated with the key.
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overrides Storage::read() (Read data from this storage.)

Parameters:

string

$key

A unique key identifying your data.

[ Top ]

method remove [line 119]

mixed &remove(
string
$key)

Remove data from this storage.

The preferred format for a key is directory style so naming conflicts can be avoided.

Tags:

return:	Data associated with the key.
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overrides Storage::remove() (Remove data from this storage.)

Parameters:

string

$key

A unique key identifying your data.

[ Top ]

method shutdown [line 147]

void shutdown(
)

Execute the shutdown procedure.

Tags:

access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overridden in child classes as:

PostgreSQLSessionStorage::shutdown(): Execute the shutdown procedure.

MySQLSessionStorage::shutdown(): Execute the shutdown procedure.

Overrides Storage::shutdown() (Execute the shutdown procedure.)

[ Top ]

method write [line 170]

void write(
string
$key, mixed
&$data)

Write data to this storage.

The preferred format for a key is directory style so naming conflicts can be avoided.

Tags:

access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Overrides Storage::write() (Write data to this storage.)

Parameters:

string	$key	A unique key identifying your data.
mixed	&$data	Data associated with your key.

[ Top ]

Documentation generated on Tue, 21 Feb 2006 01:45:27 +0900 by phpDocumentor 1.3.0RC5