Show:

Q_Session Class

Defined in: platform/classes/Q/Session.php:6
Module: Q

Session-related functionality

Methods

clear

() static

Defined in platform/classes/Q/Session.php:392

You can call this function to clear out the contents of a session, but keep its ID.

clearNonce

()

Defined in platform/classes/Q/Session.php:941

Clears the nonce in the session ['Q']['nonce'] field and in cookie 'Q_nonce'

closeHandler

() static

Defined in platform/classes/Q/Session.php:503

destroyHandler

(
  • $id
)
Boolean static

Defined in platform/classes/Q/Session.php:783

Parameters:

  • $id String

Returns:

Boolean:

gc

(
  • $max_duration
)
static

Defined in platform/classes/Q/Session.php:845

Parameters:

  • $max_duration Integer

gcHandler

(
  • $max_duration
)
static

Defined in platform/classes/Q/Session.php:832

Parameters:

  • $max_duration Integer

getNonce

() String

Defined in platform/classes/Q/Session.php:906

Gets nonce from the session

Returns:

String:

id

(
  • [$id=null]
)
String static

Defined in platform/classes/Q/Session.php:118

Parameters:

  • [$id=null] String optional

    Pass a new session id, if you want to change it

Returns:

String:

The current session id

init

() static

Defined in platform/classes/Q/Session.php:166

name

(
  • [$name=null]
)
String static

Defined in platform/classes/Q/Session.php:96

Parameters:

  • [$name=null] String optional

Returns:

String:

openHandler

(
  • $save_path
  • $session_name
)
Boolean static

Defined in platform/classes/Q/Session.php:466

Parameters:

  • $save_path String
  • $session_name String

Returns:

Boolean:

readHandler

(
  • $id
)
String static

Defined in platform/classes/Q/Session.php:518

Parameters:

  • $id String

Returns:

String:

regenerateId

(
  • [$destroy_old_session=false]
  • [$duration=null]
)
String static

Defined in platform/classes/Q/Session.php:414

You should use this instead of simply calling session_regenerate_id(). Generates a new session id signed with "Q"/"external"/"secret", and clones the current session data into it.

Parameters:

  • [$destroy_old_session=false] Boolean optional

    Set to true if you want to get rid of the old session (to save space or for security purposes).

  • [$duration=null] Integer | String optional

    Set the duration of the regenerated session, otherwise it will use the default duration for Q_Session::durationName(). See Q/session/durations config field. Pass 0 to expire at the end of browser session.

Returns:

String:

The new session id.

row

() Db_Row | Null static

Defined in platform/classes/Q/Session.php:1040

Get the session Db_Row, if it has been retrieved, otherwise null

Returns:

Db_Row | Null:

savePath

(
  • [$savePath=null]
)
String static

Defined in platform/classes/Q/Session.php:138

Parameters:

  • [$savePath=null] String optional

Returns:

String:

setNonce

(
  • [$overwrite=false]
)

Defined in platform/classes/Q/Session.php:918

Sets a nonce in the session ['Q']['nonce'] field and in cookie 'Q_nonce'

Parameters:

  • [$overwrite=false] Boolean optional

    If true, sets a new nonce even if one is already there.

start

() Boolean static

Defined in platform/classes/Q/Session.php:213

Returns:

Boolean:

writeHandler

(
  • $id
  • $sess_data
)
Boolean static

Defined in platform/classes/Q/Session.php:589

Parameters:

  • $id String
  • $sess_data String

Returns:

Boolean:

Properties

$inited

Boolean protected static

Defined in platform/classes/Q/Session.php:1187

$nonceWasSet

Boolean public static

Defined in platform/classes/Q/Session.php:1195

$preventWrite

Boolean public static

Defined in platform/classes/Q/Session.php:1203

Set this to true to prevent writing the session to disk

$sess_data

Boolean static

Defined in platform/classes/Q/Session.php:89

$session_db

Boolean protected static

Defined in platform/classes/Q/Session.php:68

$session_db_connection

Db protected static

Defined in platform/classes/Q/Session.php:19

$session_db_data_field

String protected static

Defined in platform/classes/Q/Session.php:33

$session_db_duration_field

String protected static

Defined in platform/classes/Q/Session.php:54

$session_db_id_field

String protected static

Defined in platform/classes/Q/Session.php:40

$session_db_platform_field

String protected static

Defined in platform/classes/Q/Session.php:61

$session_db_row

Db_Row protected static

Defined in platform/classes/Q/Session.php:75

$session_db_row_class

String protected static

Defined in platform/classes/Q/Session.php:82

$session_db_table

String protected static

Defined in platform/classes/Q/Session.php:26

$session_db_updated_field

String protected static

Defined in platform/classes/Q/Session.php:47

$session_save_path

String protected static

Defined in platform/classes/Q/Session.php:12

Events

Q/session/close

Before

Defined in platform/classes/Q/Session.php:509

Q/session/destroy

After

Defined in platform/classes/Q/Session.php:817

Event Payload:

  • id String

Q/session/destroy

Before

Defined in platform/classes/Q/Session.php:791

Event Payload:

  • id String

Q/session/gc

After

Defined in platform/classes/Q/Session.php:892

Event Payload:

  • id String
  • max_duration Integer
  • since_time Integer

Q/session/gc

Before

Defined in platform/classes/Q/Session.php:853

Event Payload:

  • id String
  • max_duration Integer

Q/session/generate

Before

Defined in platform/classes/Q/Session.php:256

This hook is called before a new session id is generated. You can return false to cancel starting the session.

Event Payload:

  • id String

    An invalid id, if any, that was passed by the client

Q/session/id

Before

Defined in platform/classes/Q/Session.php:126

Event Payload:

  • id String

Q/session/name

Before

Defined in platform/classes/Q/Session.php:104

Event Payload:

  • name String

Q/session/open

After

Defined in platform/classes/Q/Session.php:490

Event Payload:

  • save_path String
  • session_name String
  • session_db_connection Db_Interface

Q/session/open

Before

Defined in platform/classes/Q/Session.php:478

Event Payload:

  • save_path String
  • session_name String
  • session_db_connection Db_Interface

Q/session/read

After

Defined in platform/classes/Q/Session.php:570

Event Payload:

Q/session/read

Before

Defined in platform/classes/Q/Session.php:526

Event Payload:

Q/session/save

Before

Defined in platform/classes/Q/Session.php:713

Event Payload:

  • sess_data String
  • old_data String
  • existing_data String
  • merged_data String
  • changed Boolean
  • row Db_Row

Q/session/savePath

Before

Defined in platform/classes/Q/Session.php:146

Event Payload:

  • savePath String

Q/session/start

After

Defined in platform/classes/Q/Session.php:379

This is a hook for after the session starts. You may want to do extra security checks here.

Event Payload:

  • $original Array

    The userAgentInfo values that were in the session originally

  • $changed Array

    Whether any of the userAgentInfo values changed.

  • $isNew Boolean

    Whether a new session has just been started

  • $id String

    The id of the session

Q/session/start

Before

Defined in platform/classes/Q/Session.php:224

Q/session/write

Before

Defined in platform/classes/Q/Session.php:618

Event Payload:

  • id String
  • sess_data String
  • old_data String
  • changed Boolean

Q/session/write

After

Defined in platform/classes/Q/Session.php:749

Event Payload:

  • id String
  • changed Boolean
  • sess_data String
  • old_data String
  • existing_data String
  • merged_data String
  • data_field String
  • updated_field String
  • duration_field String
  • platform_field String
  • sess_file String
  • row Integer