Documentation

SessionHandlerProxy extends AbstractProxy
in package
implements SessionHandlerInterface, SessionUpdateTimestampHandlerInterface

Tags
author

Drak drak@zikula.org

Table of Contents

Interfaces

SessionHandlerInterface
SessionUpdateTimestampHandlerInterface

Properties

$handler  : mixed
$saveHandlerName  : string
$wrapper  : bool
Flag if handler wraps an internal PHP session handler (using \SessionHandler).

Methods

__construct()  : mixed
close()  : bool
destroy()  : bool
gc()  : int|false
getHandler()  : SessionHandlerInterface
getId()  : string
Gets the session ID.
getName()  : string
Gets the session name.
getSaveHandlerName()  : string|null
Gets the session.save_handler name.
isActive()  : bool
Has a session started?
isSessionHandlerInterface()  : bool
Is this proxy handler and instance of \SessionHandlerInterface.
isWrapper()  : bool
Returns true if this handler wraps an internal PHP session save handler using \SessionHandler.
open()  : bool
read()  : string|false
setId()  : mixed
Sets the session ID.
setName()  : mixed
Sets the session name.
updateTimestamp()  : bool
validateId()  : bool
write()  : bool

Properties

$wrapper

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

protected bool $wrapper = false

Methods

__construct()

public __construct(SessionHandlerInterface $handler) : mixed
Parameters
$handler : SessionHandlerInterface

destroy()

public destroy(string $sessionId) : bool
Parameters
$sessionId : string
Return values
bool

gc()

public gc(int $maxlifetime) : int|false
Parameters
$maxlifetime : int
Return values
int|false

getHandler()

public getHandler() : SessionHandlerInterface
Return values
SessionHandlerInterface

getId()

Gets the session ID.

public getId() : string
Return values
string

getName()

Gets the session name.

public getName() : string
Return values
string

getSaveHandlerName()

Gets the session.save_handler name.

public getSaveHandlerName() : string|null
Return values
string|null

isActive()

Has a session started?

public isActive() : bool
Return values
bool

isSessionHandlerInterface()

Is this proxy handler and instance of \SessionHandlerInterface.

public isSessionHandlerInterface() : bool
Return values
bool

isWrapper()

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

public isWrapper() : bool
Return values
bool

open()

public open(string $savePath, string $sessionName) : bool
Parameters
$savePath : string
$sessionName : string
Return values
bool

read()

public read(string $sessionId) : string|false
Parameters
$sessionId : string
Return values
string|false

setId()

Sets the session ID.

public setId(string $id) : mixed
Parameters
$id : string
Tags
throws
LogicException

setName()

Sets the session name.

public setName(string $name) : mixed
Parameters
$name : string
Tags
throws
LogicException

updateTimestamp()

public updateTimestamp(string $sessionId, string $data) : bool
Parameters
$sessionId : string
$data : string
Return values
bool

validateId()

public validateId(string $sessionId) : bool
Parameters
$sessionId : string
Return values
bool

write()

public write(string $sessionId, string $data) : bool
Parameters
$sessionId : string
$data : string
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results