SymfonyComponentHttpFoundationSessionStorageProxySessionHandlerProxy

SessionHandler proxy.

Summary

No protected methods found
N/A
No private methods found
No private properties found
N/A
File
vendorSymfonyComponentHttpFoundationSessionStorageProxySessionHandlerProxy.php
Package
Default
Class hierarchy
SymfonyComponentHttpFoundationSessionStorageProxySessionHandlerProxy
Implements
SessionHandlerInterface

Tags

author

Drak drak@zikula.org

Properties

$wrapper

$wrapper : boolean

Flag if handler wraps an internal PHP session handler (using SessionHandler).

Type

boolean

$active

$active : boolean

Type

boolean

$saveHandlerName

$saveHandlerName : string

Type

string

$handler

$handler : \SessionHandlerInterface

Type

SessionHandlerInterface

Tags

None found

Methods

getSaveHandlerName()

getSaveHandlerName() : string

Gets the session.save_handler name.

Returns

string

isSessionHandlerInterface()

isSessionHandlerInterface() : boolean

Is this proxy handler and instance of SessionHandlerInterface.

Returns

boolean

isWrapper()

isWrapper() : Boolean

Returns true if this handler wraps an internal PHP session save handler using SessionHandler.

Returns

Boolean

isActive()

isActive() : Boolean

Has a session started?

Returns

Boolean

setActive()

setActive(Boolean  $flag) 

Sets the active flag.

Parameters

Boolean $flag

getId()

getId() : string

Gets the session ID.

Returns

string

setId()

setId(string  $id) 

Sets the session ID.

Parameters

string $id

Throws

LogicException

getName()

getName() : string

Gets the session name.

Returns

string

setName()

setName(string  $name) 

Sets the session name.

Parameters

string $name

Throws

LogicException

__construct()

__construct(\SessionHandlerInterface  $handler) 

Constructor.

Parameters

SessionHandlerInterface $handler

Tags

None found

open()

open(string  $savePath, string  $sessionName) : boolean

Open session.

Parameters

string $savePath

Save path.

string $sessionName

Session Name.

Returns

boolean

Tags

None found

close()

close() : boolean

Close session.

Returns

boolean

Tags

None found

read()

read(  $id) : string

Read session.

Parameters

$id

Returns

string —

String as stored in persistent storage or empty string in all other cases.

Tags

None found

write()

write(  $id, string  $data) : boolean

Commit session to storage.

Parameters

$id
string $data

Session serialized data to save.

Returns

boolean

Tags

None found

destroy()

destroy(  $id) : boolean

Destroys this session.

Parameters

$id

Returns

boolean

Tags

None found

gc()

gc(  $maxlifetime) : boolean

Garbage collection for storage.

Parameters

$maxlifetime

Returns

boolean

Tags

None found