AloFramework Sessions 1.2 API
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Namespaces

  • AloFramework
    • Session
  • PHP

Classes

  • AbstractSession
  • Config
  • MySQLNoEventSession
  • MySQLSession
  • RedisSession
  • Token

Exceptions

  • SessionException

Class Config

Configuration class

AloFramework\Config\AbstractConfig
Extended by AloFramework\Session\Config
Namespace: AloFramework\Session
Author: Art a.molcanovas@gmail.com
Since: 1.1 saveCLI added
Located at Config.php

Methods summary

public
# __construct( array $cfg = [] )

Constructor

Constructor

Parameters

$cfg
Your custom config overrides

Author

Art a.molcanovas@gmail.com

Constants summary

string CFG_TIMEOUT

Session timeout

Session timeout

# 'timeout'
string CFG_COOKIE_NAME

Session cookie name

Session cookie name

# 'cookie'
string CFG_FINGERPRINT_NAME

Session fingerprint name. This is used to prevent session hijacking and you must not set any session values using this key.

Session fingerprint name. This is used to prevent session hijacking and you must not set any session values using this key.

# 'fingerprint'
string CFG_PREFIX

How to prefix session keys if using cache engine-based handlers

How to prefix session keys if using cache engine-based handlers

# 'prefix'
string CFG_SECURE

If set to true the session cookie will only be sent via HTTPS connections

If set to true the session cookie will only be sent via HTTPS connections

# 'secure'
string CFG_SESSION_ID_ALGO

Session ID generator hash algorithm

Session ID generator hash algorithm

# 'sessionAlgo'
string CFG_TABLE

Table to use if using SQL-based handlers

Table to use if using SQL-based handlers

# 'table'
string CFG_GC

Garbage collection probability. If set to 100 (default) there is a 1/100 (i.e. 1% chance) that a garbage collection event will occur on session start.

Garbage collection probability. If set to 100 (default) there is a 1/100 (i.e. 1% chance) that a garbage collection event will occur on session start.

# 'gc'
string CFG_SAVE_CLI

Whether to save sessions in CLI mode. Defaults to false.

Whether to save sessions in CLI mode. Defaults to false.

Since

1.1
# 'saveCLI'
string CFG_TOKEN

Key to identify token data

Key to identify token data

Since

1.2
# 'tokenKey'

Properties summary

Magic properties

public integer $timeout

Session timeout

public string $cookie

Session cookie name

public string $fingerprint

Session fingerprint name. This is used to prevent session hijacking and you must not set any session values using this key.

public string $prefix

How to prefix session keys if using cache engine-based handlers

public boolean $secure

If set to true the session cookie will only be sent via HTTPS connections

public string $sessionAlgo

Session ID generator hash algorithm

public string $table

Which table to use if using SQL-based handlers

public integer $gc

Garbage collection probability. If set to 100 (default) there is a 1/100 (i.e. 1% chance) that a garbage collection event will occur on session start.

public boolean $saveCLI

Whether to save sessions in CLI mode. Defaults to false.

public string $tokenKey

The session key to identify token data. You must not set any session values using this key.

AloFramework Sessions 1.2 API API documentation generated by ApiGen