spunQ_ISession Interface Reference

An array of consecutive HTTP requests. More...

Inheritance diagram for spunQ_ISession:

List of all members.

Public Member Functions
	getStartDateTime ()
	The DateTime this session has started.
	getEndDateTime ()
	The DateTime this session has ended.
	getUser ()
	Provides the acting user within this session.
	changeUser (spunQ_User $user)
	Changes the acting user within this session.
	userChanged ()
	Whether the user has changed while processing the current request.
	setData ($name, $value)
	Adds arbitrary data to this session as a key/value pair.
	getData ($name=NULL)
	Retrieves previously stored data.

---

Detailed Description

An array of consecutive HTTP requests.

Implementing classes are responsible for defining the start and the end of a session.

Definition at line 8 of file ISession.interface.php.

---

Member Function Documentation

spunQ_ISession::changeUser

(

spunQ_User $

user

)

Changes the acting user within this session.

Parameters:

$user

The new user owning this session.

Returns:

spunQ_ISession $this

Implemented in spunQ_ArraySession.

spunQ_ISession::getData

(

$

name = NULL

)

Retrieves previously stored data.

Parameters:

$name

Name of the data to store. Will return all data as an associative array if this parameter is omitted.

Returns:

any Guaranteed to be an associative array if the argument is omitted.

Implemented in spunQ_ArraySession.

spunQ_ISession::getEndDateTime

(

)

The DateTime this session has ended.

Returns:

datetime? NULL if this is an ongoing session (one that is still accepting requests).

Implemented in spunQ_ArraySession.

spunQ_ISession::getStartDateTime

(

)

The DateTime this session has started.

The DateTime of the first request within this session.

Returns:

datetime

Implemented in spunQ_ArraySession.

spunQ_ISession::getUser

(

)

Provides the acting user within this session.

Returns:

spunQ_User

Implemented in spunQ_ArraySession.

spunQ_ISession::setData	(	$	name,
		$	value
	)

Adds arbitrary data to this session as a key/value pair.

Parameters:

	$name	Name of the data to store.
	$value	The actual data to store.

Returns:

spunQ_ISession $this

Implemented in spunQ_ArraySession.

spunQ_ISession::userChanged

(

)

Whether the user has changed while processing the current request.

Returns:

boolean

Implemented in spunQ_ArraySession.

---

The documentation for this interface was generated from the following file:

• ISession.interface.php