Class \Prado\Web\TCacheHttpSession

TCacheHttpSession class

TCacheHttpSession provides access for storing session data using a cache module (e.g. TMemCache, TDbCache). To specify the cache module for data storage, set the \Prado\Web\setCacheModuleID property which should refer to a valid cache module configured in the application configuration.

The following example shows how we configure TCacheHttpSession:

 <modules>
   <module id="cache" class="Prado\Caching\TMemCache" Host="localhost" Port="11211" />
   <module id="session" class="Prado\Web\TCacheHttpSession"
        CacheModuleID="cache" SessionName="SSID"
        CookieMode="Allow" AutoStart="true" GCProbability="1"
        UseTransparentSessionID="true" TimeOut="3600" />
 </modules>

Beware, by definition cache storage are volatile, which means the data stored on them may be swapped out and get lost. This may not be the case for certain cache storage, such as database. So make sure you manage your cache properly to avoid loss of session data.

Class hierarchy

\Prado\Web\TCacheHttpSession

\Prado\Web\THttpSession implements IteratorAggregate, ArrayAccess, Countable, IModule

\Prado\TApplicationComponent

\Prado\TComponent

Author: Carl G. Mathisen <carlgmathisen@gmail.com>
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.1.1

Methods summary
`public`	`_destroy(string $id) : bool` Session destroy handler. This method should be overriden if \Prado\Web\setUseCustomStorage is set true.
`public`	`_read(string $id) : string` Session read handler.
`public`	`_write(string $id, string $data) : bool` Session write handler.
`public`	`getCache() : ICache`
`public`	`getCacheModuleID() : string`
`public`	`getKeyPrefix() : string`
`public`	`init(TXmlElement $config) : mixed` Initializes the module. This method is required by IModule. It reads the CacheModule property.
`public`	`setCacheModuleID(string $value) : mixed`
`public`	`setKeyPrefix(string $value) : mixed`
`protected`	`calculateKey(string $id) : string`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, _close, _destroy, _gc, _open, _read, _write, add, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clear, clearBehaviors, close, contains, count, createdOnTemplate, destroy, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getApplication, getAutoGlobalListen, getAutoStart, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getCookie, getCookieMode, getCount, getEventHandlers, getGCProbability, getID, getIsStarted, getIterator, getKeys, getListeningToGlobalEvents, getRequest, getResponse, getSavePath, getService, getSession, getSessionID, getSessionName, getSubProperty, getTimeout, getUseCustomStorage, getUser, getUseTransparentSessionID, hasEvent, hasEventHandler, hasMethod, hasProperty, init, isa, itemAt, listen, offsetExists, offsetGet, offsetSet, offsetUnset, open, publishAsset, publishFilePath, raiseEvent, regenerate, remove, setAutoStart, setCookieMode, setGCProbability, setID, setSavePath, setSessionID, setSessionName, setSubProperty, setTimeout, setUseCustomStorage, setUseTransparentSessionID, toArray, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`

Classes

Interfaces

Traits

Search results

Class \Prado\Web\TCacheHttpSession

Class hierarchy