ClientSideSession Class Reference

Detailed Description

ClientSideSession has no server state as it stores the data in cookies.

Author

ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 30 of file ClientSideSession.php.

Inheritance diagram for ClientSideSession:

Public Member Functions
	__construct (Configuration $configuration)
	getHeaderName ()
	getCookieName ()
	isStarted ()
	getID ()
	get ($key, $default=null)
	set ($key, $value)
	remove ($key)
	exist ($key)
	clear ()
	destroy ()
	setAuthUser ($login)
	getAuthUser ()

Public Attributes
const	TOKEN_HEADER = 'Authorization'
const	AUTH_TYPE = 'Bearer'
const	AUTH_USER_NAME = 'auth_user'

Protected Member Functions
	getCookiePrefix ()
	createToken ($login)
	getTokenIssuer ()
	getTokenSigner ()
	getTokenData ()
	serializeValue ($value)
	unserializeValue ($value)

Constructor & Destructor Documentation

__construct()

__construct

(

Configuration

$configuration

)

Constructor.

Parameters

$configuration

Definition at line 46 of file ClientSideSession.php.

Member Function Documentation

getHeaderName()

getHeaderName

(

)

See also

TokenBasedSession::getHeaderName()

Implements TokenBasedSession.

Definition at line 55 of file ClientSideSession.php.

getCookieName()

getCookieName

(

)

See also

TokenBasedSession::getCookieName()

Implements TokenBasedSession.

Definition at line 62 of file ClientSideSession.php.

isStarted()

isStarted

(

)

See also

Session::isStarted()

Implements Session.

Definition at line 69 of file ClientSideSession.php.

getID()

getID

(

)

See also

Session::getID()

Implements Session.

Definition at line 78 of file ClientSideSession.php.

get()

get	(		$key,
			$default = null
	)

See also

Session::get()

Implements Session.

Definition at line 85 of file ClientSideSession.php.

set()

set	(		$key,
			$value
	)

See also

Session::set()

Implements Session.

Definition at line 100 of file ClientSideSession.php.

remove()

remove

(

$key

)

See also

Session::remove()

Implements Session.

Definition at line 112 of file ClientSideSession.php.

exist()

exist

(

$key

)

See also

Session::exist()

Implements Session.

Definition at line 122 of file ClientSideSession.php.

clear()

clear

(

)

See also

Session::clear()

Implements Session.

Definition at line 130 of file ClientSideSession.php.

destroy()

destroy

(

)

See also

Session::destroy()

Implements Session.

Definition at line 139 of file ClientSideSession.php.

setAuthUser()

setAuthUser

(

$login

)

See also

Session::setAuthUser()

Implements Session.

Definition at line 147 of file ClientSideSession.php.

getAuthUser()

getAuthUser

(

)

See also

Session::getAuthUser()

Implements Session.

Definition at line 155 of file ClientSideSession.php.

getCookiePrefix()

getCookiePrefix ( )

protected

Get the cookie prefix.

Returns

String

Definition at line 168 of file ClientSideSession.php.

createToken()

createToken (   $login )

protected

Create the token for the given login.

Parameters

$login

Returns

String

Definition at line 177 of file ClientSideSession.php.

getTokenIssuer()

getTokenIssuer ( )

protected

Get the token issuer.

Returns

String

Definition at line 191 of file ClientSideSession.php.

getTokenSigner()

getTokenSigner ( )

protected

Get the token issuer.

Returns

String

Definition at line 199 of file ClientSideSession.php.

getTokenData()

getTokenData ( )

protected

Get the claims stored in the JWT.

Returns

Associative array

Definition at line 207 of file ClientSideSession.php.

serializeValue()

serializeValue (   $value )

protected

Serialize a value to be used in a cookie.

Parameters

$value

Returns

String

Definition at line 231 of file ClientSideSession.php.

unserializeValue()

unserializeValue (   $value )

protected

Unserialize a value used in a cookie.

Parameters

$value

Returns

String

Definition at line 240 of file ClientSideSession.php.

Member Data Documentation

TOKEN_HEADER

const TOKEN_HEADER = 'Authorization'

Definition at line 32 of file ClientSideSession.php.

AUTH_TYPE

const AUTH_TYPE = 'Bearer'

Definition at line 33 of file ClientSideSession.php.

AUTH_USER_NAME

const AUTH_USER_NAME = 'auth_user'

Definition at line 34 of file ClientSideSession.php.