lib/ezsession/classes/ezpsessionhandlerdb.php
inherited
Classes
File containing DB session handler
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- lib
- Version
- 4.6.0
\ezpSessionHandlerDB
DB session handler class
CALLBACKS: destroy, gc, regenerate & cleanup functions MUST implement callbacks. Definition is documented in functions on this class, examples can be found in the handlers and examples of use can be sessin in ezsession.php class doc section.
- Parent(s)
- \ezpSessionHandler
- Since
- 4.4
Constants
Properties
int|false
$gcSessionsPrIteration= '50'
Specifies how many sessions should be deleted pr iteration when garbage collecting sessions (to avoid sql calls that lock db)
50Details- Type
- int | false
Methods
__construct(
bool $userHasCookie
=
false
)
:
void| Name | Type | Description |
|---|---|---|
| $userHasCookie | bool |
cleanup(
)
:
boolRemove all session data (Truncate table)
| Type | Description |
|---|---|
| bool |
close(
)
:
bool
| Type | Description |
|---|---|
| bool |
count(
)
:
int | nullCounts the number of session and returns it.
| Type | Description |
|---|---|
| int | null | Returns null if handler does not support this. |
dbRequired(
)
:
boolSignals that handler requires db instance
Inherited from: \ezpSessionHandler::dbRequired()| Type | Description |
|---|---|
| bool |
deleteByUserIDs(
\array(int) $userIDArray
)
:
voidRemove all session data for a specific user
| Name | Type | Description |
|---|---|---|
| $userIDArray | \array(int) |
destroy(
string $sessionId
)
:
boolSession destroy handler
| Name | Type | Description |
|---|---|---|
| $sessionId | string |
| Type | Description |
|---|---|
| bool |
gc(
int $maxLifeTime
)
:
boolSession gc (garbageCollector) handler
| Name | Type | Description |
|---|---|---|
| $maxLifeTime | int |
| Type | Description |
|---|---|
| bool |
hasBackendAccess(
)
:
boolSignals that handler has direct access to backend, thus is cable of supporting features like gc, cleanup, delete & count.
Inherited from: \ezpSessionHandler::hasBackendAccess()| Type | Description |
|---|---|
| bool |
isConnected(
)
:
boolChecks if session handler is connected with backend.
| Type | Description |
|---|---|
| bool |
open(
string $savePath, string $sessionName
)
:
bool
| Name | Type | Description |
|---|---|---|
| $savePath | string | |
| $sessionName | string |
| Type | Description |
|---|---|
| bool |
read(
string $sessionId
)
:
string | falseSession read handler
| Name | Type | Description |
|---|---|---|
| $sessionId | string |
| Type | Description |
|---|---|
| string | false | Binary session data |
regenerate(
bool $updateBackendData
=
true
)
:
boolRegenerate session id
| Name | Type | Description |
|---|---|---|
| $updateBackendData | bool | (true if we want to keep session data with the new session id) |
| Type | Description |
|---|---|
| bool |
setSaveHandler(
)
:
bool
| Type | Description |
|---|---|
| bool |
write(
string $sessionId, string $sessionData
)
:
boolSession write handler
| Name | Type | Description |
|---|---|---|
| $sessionId | string | |
| $sessionData | string | Binary session data |
| Type | Description |
|---|---|
| bool |