AtkCache - Revision history

bahtiar at 06:43, 1 August 2008

2008-08-01T06:43:18Z

← Older revision		Revision as of 06:43, 1 August 2008
Line 1:		Line 1:
			{{atkclass\|atk/cache}}

	When you want to cache some data, you can use atkCache for it. At this moment atkCache has support for the following:		When you want to cache some data, you can use atkCache for it. At this moment atkCache has support for the following:

bahtiar: ATK Cache moved to AtkCache

2008-08-01T06:37:42Z

ATK Cache moved to AtkCache

← Older revision	Revision as of 06:37, 1 August 2008
(No difference)

Sandy: /* Available Methods */

2008-04-03T18:24:00Z

Available Methods

← Older revision		Revision as of 18:24, 3 April 2008
Line 73:		Line 73:
	'''Parameters'''		'''Parameters'''

	$key		''key''

	Store the variable using this name. key's are cache-unique, so attempting to use add() to store data with a key that already exists will not overwrite the existing data, and will instead return FALSE. (This is the only difference between add() and set().)		Store the variable using this name. key's are cache-unique, so attempting to use add() to store data with a key that already exists will not overwrite the existing data, and will instead return FALSE. (This is the only difference between add() and set().)

	$data		''data''

	The variable to store		The variable to store

	$lifetime		''lifetime''

	Lifetime, store var in the cache for lifetime seconds. After the lifetime has passed, the stored variable will be expunged from the cache (on the next request). If no lifetime is supplied it will use the default lifetime.		Lifetime, store var in the cache for lifetime seconds. After the lifetime has passed, the stored variable will be expunged from the cache (on the next request). If no lifetime is supplied it will use the default lifetime.
Line 95:		Line 95:
	'''Parameters'''		'''Parameters'''

	$key		''key''

	Set the variable using this name. key's are cache-unique, so storing a second value with the same key will overwrite the original value.		Set the variable using this name. key's are cache-unique, so storing a second value with the same key will overwrite the original value.

	$data		''data''

	The variable to store		The variable to store

	$lifetime		''lifetime''

	Lifetime, store var in the cache for lifetime seconds. After the lifetime has passed, the stored variable will be expunged from the cache (on the next request). If no lifetime is supplied it will use the default lifetime.		Lifetime, store var in the cache for lifetime seconds. After the lifetime has passed, the stored variable will be expunged from the cache (on the next request). If no lifetime is supplied it will use the default lifetime.
Line 117:		Line 117:
	'''Parameters'''		'''Parameters'''

	$key		''key''

	The key used to store the value (with set or add)		The key used to store the value (with set or add)
Line 131:		Line 131:
	'''Parameters'''		'''Parameters'''

	$key		''key''

	The key used to store the value (with set or add)		The key used to store the value (with set or add)

Sandy: /* Available Methods */

2008-04-03T18:22:30Z

Available Methods

← Older revision		Revision as of 18:22, 3 April 2008
Line 110:		Line 110:

	Returns TRUE on success or FALSE on failure.		Returns TRUE on success or FALSE on failure.


	* Get ($key)		* Get ($key)
Line 123:		Line 124:

	The stored variable on success; FALSE on failure		The stored variable on success; FALSE on failure


	* Delete ($key)		* Delete ($key)
Line 132:		Line 134:

	The key used to store the value (with set or add)		The key used to store the value (with set or add)


	* DeleteAll ()		* DeleteAll ()

Sandy at 18:20, 3 April 2008

2008-04-03T18:20:59Z

← Older revision		Revision as of 18:20, 3 April 2008
Line 65:		Line 65:
	$config_cache_namespace = 'default';		$config_cache_namespace = 'default';
	</syntaxhighlight>		</syntaxhighlight>

			==Available Methods==

			* Add (string $key, mixed $data, mixed $lifetime=false)
			Cache a variable in the data store (only if it's not stored)

			'''Parameters'''

			$key

			Store the variable using this name. key's are cache-unique, so attempting to use add() to store data with a key that already exists will not overwrite the existing data, and will instead return FALSE. (This is the only difference between add() and set().)

			$data

			The variable to store

			$lifetime

			Lifetime, store var in the cache for lifetime seconds. After the lifetime has passed, the stored variable will be expunged from the cache (on the next request). If no lifetime is supplied it will use the default lifetime.

			'''Return values'''

			Returns TRUE on success or FALSE on failure.


			* Set ($key,$data,$lifetime=false)
			Cache a variable in the data store

			'''Parameters'''

			$key

			Set the variable using this name. key's are cache-unique, so storing a second value with the same key will overwrite the original value.

			$data

			The variable to store

			$lifetime

			Lifetime, store var in the cache for lifetime seconds. After the lifetime has passed, the stored variable will be expunged from the cache (on the next request). If no lifetime is supplied it will use the default lifetime.

			'''Return values'''

			Returns TRUE on success or FALSE on failure.

			* Get ($key)
			Fetch a stored variable from the cache

			'''Parameters'''

			$key

			The key used to store the value (with set or add)

			'''Return values'''

			The stored variable on success; FALSE on failure

			* Delete ($key)
			Removes a stored variable from the cache

			'''Parameters'''

			$key

			The key used to store the value (with set or add)

			* DeleteAll ()
			Clears the cache

			Note: this function isn't supported by the Zend Platform Output cache.

Sandy at 17:59, 3 April 2008

2008-04-03T17:59:59Z

← Older revision		Revision as of 17:59, 3 April 2008
Line 59:		Line 59:
	// Or just set one cache method that should be used		// Or just set one cache method that should be used
	$config_cache_method = 'zp_disk';		$config_cache_method = 'zp_disk';
	</~~php~~		</syntaxhighlight>

	When you application is hosted on a shared hosting which provides one of the cache methods, you can set a namespace so your keys won't override any other existing keys.		When you application is hosted on a shared hosting which provides one of the cache methods, you can set a namespace so your keys won't override any other existing keys.

Sandy: New page: When you want to cache some data, you can use atkCache for it. At this moment atkCache has support for the following: * [http://pecl.php.net/package/APC APC] (Alternative PHP Cache) * [ht...

2008-03-30T14:07:05Z

New page: When you want to cache some data, you can use atkCache for it. At this moment atkCache has support for the following: * [http://pecl.php.net/package/APC APC] (Alternative PHP Cache) * [ht...

New page

When you want to cache some data, you can use atkCache for it. At this moment atkCache has support for the following:

* [http://pecl.php.net/package/APC APC] (Alternative PHP Cache)
* [http://eaccelerator.net/ eAccelerator]
* [http://www.danga.com/memcached/ Memcache] to store data in RAM on the localhost or on another server
* [http://xcache.lighttpd.net/ Xcache]
* File (which stores data in the file system)
* Var (a variable-based cache that lasts only for the duration of a page load)
* [http://www.zend.com/en/products/platform/ Zend Platform] (3 versions, output cache, disk cache and shared memory cache, the last two can only be used with version 3.6 and higher of Zend Platform).

==Configuration==
By the default the lifetime for a cached value will be 1 hour for every method. This can be altered by adding the followin config to you config.inc.php

<syntaxhighlight lang="php">$config_cache[<method>]['lifetime']=300;</syntaxhighlight>

Some cache method's also require some other settings.

File cache:
<syntaxhighlight lang="php">
// Directory where the cache will be written
$config_cache['file']['path']=atkconfig('atktempdir')."cache/";
// Context var for fopen
$config_cache['file']['context']=array();
</syntaxhighlight>

Memcache:
<syntaxhighlight lang="php">
// Servername
$config_cache['memcache']['host']='localhost';
// Port
$config_cache['memcache']['port']=11211;
// Connection timeout
$config_cache['memcache']['timeout']=1;
</syntaxhighlight>

xCache:
<syntaxhighlight lang="php">
// Admin Username (needed for deleteall method)
$config_cache['xcache']['user']='';
// Password
$config_cache['xcache']['passwd']='';
</syntaxhighlight>

There are 2 ways to set a default cache. Option 1 is by giving an array with available methods. atkCache will choose the first available cache method (fallback). Option 2 is just setting only 1 cache method. Available cache methods are:

* var (default)
* file
* apc
* eaccelerator
* xcache
* memcache
* zp_output (Zend Platform 3.6 and lower, it's deprecated in the 3.6)
* zp_shm (Zend Platform 3.6 and higher)
* zp_disk (Zend Platform 3.6 and higher)

<syntaxhighlight lang="php">
// Let atkCache choose the first available cache method
$config_cache_method = array('zp_shm','file');
// Or just set one cache method that should be used
$config_cache_method = 'zp_disk';
</php

When you application is hosted on a shared hosting which provides one of the cache methods, you can set a namespace so your keys won't override any other existing keys.
<syntaxhighlight lang="php">
$config_cache_namespace = 'default';
</syntaxhighlight>