Session class - Documentation for SproutCMS

Info Page:

Page options:

class Session

Session library.

File: /sprout/Helpers/Session.php
Namespace: Sprout\Helpers

Variables

Name	Visibility	Description
`$config`	(static)
`$driver`	(static)
`$flash`	(static)
`$instance`	(static)
`$protect`	(static)

Functions

Name	Visibility	Description
__construct	public	On first session instance creation, sets up the driver and creates session.
create	public (static)	Create a new session.
deletall	public (static)	Removes all session variables.
delete	public (static)	Delete one or more variables.
destroy	public (static)	Destroys the current session.
expireFlash	public (static)	Expires old flash data and removes it from the session.
get	public (static)	Get a variable. Access to sub-arrays is supported with key.subkey.
getOnce	public (static)	Get a variable, and delete it.
has	public (static)
id	public (static)	Get the session id.
instance	public (static)	Singleton instance of Session.
keepFlash	public (static)	Freshen one, multiple or all flash variables.
regenerate	public (static)	Regenerates the global session id.
set	public (static)	Set a session variable.
setFlash	public (static)	Set a flash variable.
writeClose	public (static)	Runs the system.session_write event, then calls session_write_close.

public __construct

void $Session->__construct ( );

On first session instance creation, sets up the driver and creates session.

public create

void Session::create ( [ array $vars ] );

Create a new session.

public deletall

void Session::deletall ( );

Removes all session variables.

public delete

void Session::delete ( string $keys );

Delete one or more variables.

public destroy

void Session::destroy ( );

Destroys the current session.

public expireFlash

void Session::expireFlash ( );

Expires old flash data and removes it from the session.

public get

mixed Session::get ( [ string $key [, mixed $default ]] );

Get a variable. Access to sub-arrays is supported with key.subkey.

public getOnce

mixed Session::getOnce ( string $key [, mixed $default ] );

Get a variable, and delete it.

public has

bool Session::has ( string $key );

This function does not have a description

public id

string Session::id ( );

Get the session id.

public instance

unknown Session::instance ( );

Singleton instance of Session.

public keepFlash

void Session::keepFlash ( [ string $keys ] );

Freshen one, multiple or all flash variables.

public regenerate

void Session::regenerate ( );

Regenerates the global session id.

public set

void Session::set ( string|array $keys [, mixed $val ] );

Set a session variable.

public setFlash

void Session::setFlash ( string|array $keys [, mixed $val ] );

Set a flash variable.

public writeClose

void Session::writeClose ( );

Runs the system.session_write event, then calls session_write_close.

SproutCMS

Search documentation