Class flSession

flSession Class

Base class to provide session management and storage.

Direct known subclasses

flSessionDb, flSessionFile, flSessionRedis

Indirect known subclasses

flSessionMemcache, flSessionMemcached

Abstract
Package: fusionLib
Copyright: Copyright (c) 2008 - 2015 fusionLib. All rights reserved.
Located at system/libs/Session/flSession.php

Methods summary

`protected`	# `__construct( flResponse $response, integer $life = null, boolean $expireCookieOnExit = true, string $cookieName = '__sessionid', string $cookieDomain = '', string $cookiePath = '/' )` Construct and initialize the session object. Construct and initialize the session object. Parameters `$response` The response object to use. `$life` The time in seconds a session should live for, must be greater than 0 or null to use the value of session.gc_maxlifetime. `$expireCookieOnExit` true to expire cookie at the end of the session or false to keep the cookie for the lifetime of the session data. `$cookieName` The name of the cookie holding session data. `$cookieDomain` The optional domain the cookie is available on, e.g. for all subdomains '.example.com' `$cookiePath` The options path the cookie is valid on
`protected string`	# `generateID( )` Generate a session ID. Generate a session ID. Returns string The session ID.
`public`	# `sessionClose( )` Store the session data. Store the session data.
`public`	# `regenerate( )` Regenerate the session ID. Regenerate the session ID.
`public string`	# `getSessionID( )` Get the current session ID. Get the current session ID. Returns string The session ID
`public`	# `loadSession( string $sessionID )` Force loading of a session ID. Force loading of a session ID. Parameters `$sessionID` The session ID to load.
`abstract public string`	# `_read( )` Read session data. Read session data. Returns string The session data.
`abstract public`	# `_write( string $data )` Write session data. Write session data. Parameters `$data` The session data to write.
`abstract public`	# `_destroy( )` Destroy the session data. Destroy the session data.
`abstract public`	# `_gc( )` Collect garbage. Collect garbage.
`public`	# `destroy( )` Destroy the current session. Destroy the current session.
`public flSessionData`	# `getNamespace( string $ns )` Get a namespace data object. Get a namespace data object. Parameters `$ns` The namespace to get. Returns `flSessionData` The data object for the namespace.
`public boolean`	# `hasNamespace( string $ns )` Test if the session has a namespace. Test if the session has a namespace. Parameters `$ns` The namespace to test for. Returns boolean true if the namespace is present; else false.
`public`	# `destroyNamespace( string $ns )` Destroy a namespace. Destroy a namespace. Parameters `$ns` The namespace to destroy.
`public`	# `flashSet( string $n, string $v )` Set flash data. Set flash data. Parameters `$n` The name of the data. `$v` The value of the data.
`public mixed`	# `flashGet( string $n, mixed $default = null )` Get the flash data. Get the flash data. Parameters `$n` The name of the data to get. `$default` The default value to return. Returns mixed The value of the data item.
`public`	# `flashKeep( string $n )` Make a flash data item available for the next request. Make a flash data item available for the next request. Parameters `$n` The name of the flash data item to keep.
`public`	# `flashDelete( string $n )` Delete a flash data item. Delete a flash data item. Parameters `$n` The name of the flash data item to delete.
`public`	# `flashKeepAll( )` Make all flash data available for the next request. Make all flash data available for the next request. Note: This must be called before setting any flash data.

Constants summary

`string`	`FLASHDATANS` The name of the flash data namespace. The name of the flash data namespace.	# `'__flSession::flashdata'`

Properties summary

`protected flResponse`	`$response` The response object to use. The response object to use.	#
`protected integer`	`$expireat` The time to expire the session data at. The time to expire the session data at.	#
`protected string`	`$cookieName` The name of the cookie. The name of the cookie.	#
`protected string`	`$cookieDomain` The domain the cookie is available on. The domain the cookie is available on.	#
`protected string`	`$cookiePath` The path the session cookie is valid on. The path the session cookie is valid on.	#
`protected string`	`$sessionID` The session ID. The session ID.	#
`protected boolean`	`$expireCookieOnExit` Flags if to expire cookie when browser closes or session expires. Flags if to expire cookie when browser closes or session expires.	#
`protected array`	`$data` The session data. The session data.	# `null`
`protected flSessionData`	`$lastFlash` The flash data from the last load. The flash data from the last load.	#