PHP Class Prado\Web\UI\TCachePageStatePersister

TCachePageStatePersister implements a page state persistent method based on cache. Page state are stored in cache (e.g. memcache, DB cache, etc.), and only a small token is passed to the client side to identify the state. This greatly reduces the size of the page state that needs to be transmitted between the server and the client. Of course, this is at the cost of using server side resource. A cache module has to be loaded in order to use TCachePageStatePersister. By default, TCachePageStatePersister will use the primary cache module. A non-primary cache module can be used by setting {@link setCacheModuleID CacheModuleID}. Any cache module, as long as it implements the interface {@link ICache}, may be used. For example, one can use {@link TDbCache}, {@link TMemCache}, {@link TAPCCache}, etc. TCachePageStatePersister uses {@link setCacheTimeout CacheTimeout} to limit the data that stores in cache. Since server resource is often limited, be cautious if you plan to use TCachePageStatePersister for high-traffic Web pages. You may consider using a small {@link setCacheTimeout CacheTimeout}. There are a couple of ways to use TCachePageStatePersister. One can override the page's {@link TPage::getStatePersister()} method and create a TCachePageStatePersister instance there. Or one can configure the pages to use TCachePageStatePersister in page configurations as follows,

Note in the above, we use StatePersister.CacheModuleID to configure the cache module ID for the TCachePageStatePersister instance. The above configuration will affect the pages under the directory containing this configuration and all its subdirectories. To configure individual pages to use TCachePageStatePersister, use

Since: 3.1.1

Author: Qiang Xue ([email protected])

Inheritance: extends Prado\TComponent, implements Prado\Web\UI\IPageStatePersister

Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode	Description
getCache ( ) : Prado\Caching\ICache
getCacheModuleID ( ) : string
getCacheTimeout ( ) : integer
getKeyPrefix ( ) : string
getPage ( )
load ( ) : mixed	Loads page state from cache.
save ( $data )	Saves state in cache.
setCacheModuleID ( $value )
setCacheTimeout ( $value )
setKeyPrefix ( $value )
setPage ( TPage $page )

Méthodes protégées

Méthode	Description
calculateKey ( $timestamp ) : string

Method Details

calculateKey() protected méthode

protected calculateKey ( $timestamp ) : string
Résultat	string	a key that is unique per user request

getCache() public méthode

public getCache ( ) : Prado\Caching\ICache
Résultat	Prado\Caching\ICache	the cache module being used for data storage

getCacheModuleID() public méthode

public getCacheModuleID ( ) : string
Résultat	string	the ID of the cache module.

getCacheTimeout() public méthode

public getCacheTimeout ( ) : integer
Résultat	integer	the number of seconds in which the cached state will expire. Defaults to 1800.

getKeyPrefix() public méthode

public getKeyPrefix ( ) : string
Résultat	string	prefix of cache variable name to avoid conflict with other cache data. Defaults to 'statepersister'.

getPage() public méthode

public getPage ( )

load() public méthode

Loads page state from cache.

public load ( ) : mixed
Résultat	mixed	the restored state

save() public méthode

Saves state in cache.

public save ( $data )

setCacheModuleID() public méthode

public setCacheModuleID ( $value )

setCacheTimeout() public méthode

public setCacheTimeout ( $value )

setKeyPrefix() public méthode

public setKeyPrefix ( $value )

setPage() public méthode

public setPage ( TPage $page )
$page	TPage