Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
XCacheCache Class Reference
Inheritance diagram for XCacheCache:
GenericCache

Public Member Functions

 flush ()
 
 getCache ($id)
 
 getCacheTime ()
 
 setCache ($id, $value)
 
 setEntireCache (&$contents)
 
 XCacheCache ($context, $cacheId, $fallback)
 
- Public Member Functions inherited from GenericCache
 close ()
 
 flush ()
 
 GenericCache ($context, $cacheId, $fallback)
 
 get ($id)
 
 getCache ($id)
 
 getCacheId ()
 
 getCacheTime ()
 
 getContext ()
 
 set ($id, $value)
 
 setCache ($id, $value)
 
 setEntireCache (&$contents)
 

Additional Inherited Members

- Public Attributes inherited from GenericCache
 $cacheId
 
 $context
 
 $fallback
 

Detailed Description

Provides caching based on XCache's variable store.

See Also
GenericCache

Definition at line 20 of file XCacheCache.inc.php.

Member Function Documentation

XCacheCache::flush ( )

Flush the cache.

Definition at line 31 of file XCacheCache.inc.php.

References GenericCache\getCacheId(), and GenericCache\getContext().

XCacheCache::getCache (   $id)

Get an object from the cache.

Parameters
$id

Definition at line 51 of file XCacheCache.inc.php.

References GenericCache\getCacheId(), and GenericCache\getContext().

XCacheCache::getCacheTime ( )

Get the time at which the data was cached. Not implemented in this type of cache.

Definition at line 72 of file XCacheCache.inc.php.

XCacheCache::setCache (   $id,
  $value 
)

Set an object in the cache. This function should be overridden by subclasses.

Parameters
$id
$value

Definition at line 64 of file XCacheCache.inc.php.

References GenericCache\getCacheId(), and GenericCache\getContext().

Referenced by setEntireCache().

XCacheCache::setEntireCache ( $contents)

Set the entire contents of the cache. WARNING: THIS DOES NOT FLUSH THE CACHE FIRST!

Definition at line 80 of file XCacheCache.inc.php.

References setCache().

XCacheCache::XCacheCache (   $context,
  $cacheId,
  $fallback 
)

Instantiate a cache.

Definition at line 24 of file XCacheCache.inc.php.

References GenericCache\$cacheId, GenericCache\$context, and GenericCache\$fallback.


The documentation for this class was generated from the following file: