model/modx/modsessionhandler.class.php

Classes

package: modx
Classes: modSessionHandler

Description

Default database session handler class for MODX.

\modSessionHandler
jump to top

package: modx
Properties: $cacheLifetime; $gcMaxLifetime; $modx; $session
Methods: __construct; _getSession; close; destroy; gc; open; read; write

Description

Default database session handler class for MODX.

Properties

$cacheLifetime
jump to class

$cacheLifetime = 'false'

Details

visibility: public
default: false
final: false
static: false

$gcMaxLifetime
jump to class

$gcMaxLifetime = '0'

Details

visibility: public
default: 0
final: false
static: false

$modxA reference to the modX instance controlling this session handler.
jump to class

\modX $modx = 'null'

Details

: \modX
A reference to the modX instance controlling this session handler.
visibility: public
default: null
final: false
static: false
access: public

$session
jump to class

$session = 'null'

Details

visibility: private
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          \modX $modx
          )
        
        :
        \modSessionHandler

Creates an instance of a modSessionHandler class.

Arguments

$modx: \modX
&$modx A reference to a {@link modX} instance.

Output

\modSessionHandler

Details

visibility: public
final: false
static: false

_getSession
jump to class

_getSession(
          integer $id, boolean $autoCreate
              =
              false
          )
        
        :
        \modSession|null

Gets the {@link modSession} object, respecting the cache flag represented by cacheLifetime.

Arguments

$id: integer
The PK of the {@link modSession} record.
$autoCreate: boolean
If true, will automatically create the session record if none is found.

Output

\modSession|null: The modSession instance loaded from db or auto-created; null if it could not be retrieved and/or created.

Details

visibility: protected
final: false
static: false
access: protected

close
jump to class

close(
          
          )
        
        :
        boolean

Closes the connection for the session handler.

Output

boolean: Always returns true; actual connection is managed by {@link modX}

Details

visibility: public
final: false
static: false
access: public

destroy
jump to class

destroy(
          integer $id
          )
        
        :
        boolean

Destroy a specific {@link modSession} record.

Arguments

$id: integer

Output

boolean: True if the session record was destroyed.

Details

visibility: public
final: false
static: false
access: public

gc
jump to class

gc(
          integer $max
          )
        
        :
        boolean

Remove any expired sessions.

Arguments

$max: integer
The amount of time since now to expire any session longer than.

Output

boolean: True if session records were removed.

Details

visibility: public
final: false
static: false
access: public

open
jump to class

open(
          
          )
        
        :
        boolean

Opens the connection for the session handler.

Output

boolean: Always returns true; actual connection is managed by {@link modX}.

Details

visibility: public
final: false
static: false
access: public

read
jump to class

read(
          integer $id
          )
        
        :
        string

Reads a specific {@link modSession} record's data.

Arguments

$id: integer
The pk of the {@link modSession} object.

Output

string: The data read from the {@link modSession} object.

Details

visibility: public
final: false
static: false
access: public

write
jump to class

write(
          integer $id, mixed $data
          )
        
        :
        boolean

Writes data to a specific {@link modSession} object.

Arguments

$id: integer
The PK of the modSession object.
$data: mixed
The data to write to the session.

Output

boolean: True if successfully written.

Details

visibility: public
final: false
static: false
access: public

model/modx/modsessionhandler.class.php

Description

\modSessionHandlerjump to top

Description

Properties

$cacheLifetimejump to class

Details

$gcMaxLifetimejump to class

Details

$modxA reference to the modX instance controlling this session handler.jump to class

Details

$sessionjump to class

Details

Methods

__constructjump to class

Arguments

Output

Details

_getSessionjump to class

Arguments

Output

Details

closejump to class

Output

Details

destroyjump to class

Arguments

Output

Details

gcjump to class

Arguments

Output

Details

openjump to class

Output

Details

readjump to class

Arguments

Output

Details

writejump to class

Arguments

Output

Details

\modSessionHandler
jump to top

$cacheLifetime
jump to class

$gcMaxLifetime
jump to class

$modxA reference to the modX instance controlling this session handler.
jump to class

$session
jump to class

__construct
jump to class

_getSession
jump to class

close
jump to class

destroy
jump to class

gc
jump to class

open
jump to class

read
jump to class

write
jump to class