Differences

This shows you the differences between two versions of the page.

--- v5:session:reference:index [2016/05/16 02:37] – created mnewnham
+++ v5:session:reference:index [2016/05/22 16:43] (current) – [Table] mnewnham
@@ Line 1: / Line 1: @@
 ====== Session Management Reference ======
-All of the commands are **static**, and should be preceded by **//ADOdb_session:://**
+===== Main Commands =====
+All of the following commands are **static**, and should be preceded by **//ADOdb_session:://**
 ^Command^Description|
-|config|Establishes a connection to the database for session management|
+|[[v5:session:reference:config|config()]]|Establishes a connection to the database for session management|
-|debug|Gets or sets debugging mode for the session management connection|
+|[[v5:session:reference:debug|debug()]]|Gets or sets debugging mode for the session management connection|
-|driver|Gets or sets the ADOdb database driver associated with the connection|
+|[[v5:session:reference:driver|driver()]]|Gets or sets the ADOdb database driver associated with the connection|
-|host|Gets or sets the host name for the session management connection|
+|[[v5:session:reference:host|host()]]|Gets or sets the host name for the session management connection|
-|user|Gets or sets the user name for the session management connection|
+|[[v5:session:reference:user|user()]]|Gets or sets the user name for the session management connection|
-|password|Gets or sets the password for the session management connection|
+|[[v5:session:reference:password|password()]]|Gets or sets the password for the session management connection|
-|database|Gets or sets the database name for the session management connection|
+|[[v5:session:reference:database|database()]]|Gets or sets the database name for the session management connection|
-|persist|Gets or sets persistent database connection mode for the session management connection|
+|[[v5:session:reference:persist|persist()]]|Gets or sets persistent database connection mode for the session management connection|
-|lifetime|Gets or sets the session lifetime|
+|[[v5:session:reference:lifetime|lifetime()]]|Gets or sets the session lifetime|
-|expireNotify|Gets or sets the garbage collection callback function for the session management connection|
+|[[v5:session:reference:expirenotify|expireNotify()]]|Gets or sets the garbage collection callback function for the session management connection|
-|table|Overrides the default table name for the storage of session data|
+|[[v5:session:reference:table|table()]]|Overrides the default table name for the storage of session data|
-|optimize|Gets or sets table optimization mode|
+|[[v5:session:reference:optimize|optimize()]]|Gets or sets table optimization mode|
-|clob|Gets or sets if clobs are available to store session data|
+|[[v5:session:reference:clob|clob()]]|Gets or sets if clobs are available to store session data|
+|[[v5:session:reference:filter|filter()]]|Gets or sets the session data filter|
+|[[v5:session:reference:encryptionKey|encryptionKey()]]|Gets or sets the encryption key if encrypted sessions are in use|
+===== Helper Functions =====
+^ Command                                                                             ^ Description                                                             ^
+| [[v5:session:reference:adodb_unserialize|adodb_unserialize()]]                      | Unpacks the session data from the database and makes it human-readable  |
+| [[v5:session:reference:adodb_session_regenerate_id|adodb_session_regenerate_id()]]  | Manually regenerate the session id (deprecated)                         |
+===== Global Variables =====
+^ Variable                                                                           ^ Description                                                     ^
+| [[v5:session:reference:adodb_session_expire_notify|$ADODB_SESSION_EXPIRE_NOTIFY]]  | Holds information about session expiration notifications        |
+| [[v5:session:reference:adodb_sess_conn|$ADODB_SESS_CONN]]                          | Holds a globalized instance of the session database connection  |