Description
AkObject | --AkCache
Located in File: /AkCache.php
Easy to use class for caching data using a database as container or the file system.
Akelos Framework provides an easy to use functionality for caching data using a database as container or the file system.
By default the cache container is defined in the following line
- define ('AK_CACHE_HANDLER', 1);
in the ''config/config.php'' file
Possible values are:
- 0: No cache at all
- 1: File based cache using the folder defined at AK_CACHE_DIR or the system /tmp dir
- 2: Database based cache. This one has a performance penalty, but works on most servers
- // First we include the cache class and
- // create a cache instance
- include_once(AK_LIB_DIR.'/AkCache.php');
- $Cache =& new AkCache();
- // Now we define some details for this cache
- $seconds = 3600; // seconds of life for this cache
- $cache_id = 'unique identifier for accesing this cache element';
- // Now we call the $Cache constructor (ALA AkFramework)
- $Cache->init($seconds);
- // If the data is not cached, we catch it now
- // if it was on cache, $data will hold its content
- if (!$data = $Cache->get($cache_id)) {
- $data = some_heavy_function_that_takes_too_many_time_or_resources();
- $Cache->save($data);
- }
- // Now you can use data no matter from where did it came from
- echo $data;
This class uses the [http://pear.php.net/manual/en/package.caching.cache-lite.php pear Cache_Lite] as driver for file based cache. In fact you can access an instance of Cache_Lite by accesing $Cache->_driverInstance.
- author: - Bermi Ferrer <at akelos dot com bermi at akelos dot com>
- version: - $Revision 0.1 $
- copyright: - Copyright (c) 2002-2005, Akelos Media, S.L. http://www.akelos.org
- since: - 0.1
- license: - GNU
Class Variables
Summary:
boolean
$cache_enabled
$cache_enabled = true (line 100)
Data type : boolean
Ecnables / Disables caching
- var: - true
- access: - public
Class Constants
Summary:Method Detail
Summary:
Method clean (line 244)
boolean clean( [string $group = false], [string $mode = 'ingroup'])
Clean the cache
If no group is specified all cache items will be destroyed else only cache items of the specified group will be destroyed
Parameters
- string $group: Name of the cache group. If no group is specified all cache items will be destroyed else only cache items of the specified group will be destroyed
- string $mode:
Flush cache mode. Options are:
- old
- ingroup
- notingroup
Info
- return - True if no problem
- access - public
Method get (line 190)
mixed get( string $id, [string $group = 'default'])
Test if a cache is available and (if yes) return it
Parameters
- string $id: Cache id
- string $group: Name of the cache group.
Info
- return - Data of the cache (or false if no cache available)
- access - public
Method init (line 151)
void init( [mixed $options = null], [integer $cache_type = AK_CACHE_HANDLER])
Class constructor (ALA Akelos Framework)
This method loads an instance of selected driver in order to use it class wide.
Parameters
- mixed $options:
You can pass a number specifying the second for the cache to expire or an array with the following options:
- $options = array(
- //This options are valid for both cache contains (database and file based)
- 'lifeTime' => cache lifetime in seconds
- (int),
- 'memoryCaching' => enable / disable memory caching (boolean),
- 'automaticSerialization' => enable / disable automatic serialization (boolean)
- //This options are for file based cache
- 'cacheDir' => directory where to put the cache files (string),
- 'caching' => enable / disable caching (boolean),
- 'fileLocking' => enable / disable fileLocking (boolean),
- 'writeControl' => enable / disable write control (boolean),
- 'readControl' => enable / disable read control (boolean),
- 'readControlType' => type of read control
- 'crc32', 'md5', 'strlen' (string),
- 'pearErrorMode' => pear error mode (when raiseError is called) (cf PEAR doc) (int),
- 'onlyMemoryCaching' => enable / disable only memory caching (boolean),
- 'memoryCachingLimit' => max nbr of records to store into memory caching (int),
- 'fileNameProtection' => enable / disable automatic file name protection (boolean),
- 'automaticCleaningFactor' => distable / tune automatic cleaning process (int)
- 'hashedDirectoryLevel' => level of the hashed directory system (int)
- );
- integer $cache_type:
The default value is set by defining the constant AK_CACHE_HANDLER in the following line
- define ('AK_CACHE_HANDLER', 1);
in the ''config/config.php'' file
Possible values are:
- 0: No cache at all
- 1: File based cache using the folder defined at AK_CACHE_DIR or the system /tmp dir
- 2: Database based cache. This one has a performance penalty, but works on most servers
Info
- access - public
Method remove (line 219)
boolean remove( string $id, [string $group = 'default'])
Remove a cache item
Parameters
- string $id: Cache id
- string $group: Name of the cache group
Info
- return - True if no problem
- access - public
Method save (line 205)
boolean save( string $data, [string $id = null], [string $group = 'default'])
Save some data in the cache
Parameters
- string $data: Data to put in cache
- string $id: Cache id
- string $group: Name of the cache group
Info
- return - True if no problem
- access - public
