summaryrefslogtreecommitdiff
path: root/framework/caching/CZendDataCache.php
diff options
context:
space:
mode:
Diffstat (limited to 'framework/caching/CZendDataCache.php')
-rw-r--r--framework/caching/CZendDataCache.php99
1 files changed, 99 insertions, 0 deletions
diff --git a/framework/caching/CZendDataCache.php b/framework/caching/CZendDataCache.php
new file mode 100644
index 0000000..c1a341d
--- /dev/null
+++ b/framework/caching/CZendDataCache.php
@@ -0,0 +1,99 @@
+<?php
+/**
+ * CZendDataCache class file
+ *
+ * @author Steffen Dietz <steffo.dietz[at]googlemail[dot]com>
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright &copy; 2008-2011 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+/**
+ * CZendDataCache implements a cache application module based on the Zend Data Cache
+ * delivered with {@link http://www.zend.com/en/products/server/ ZendServer}.
+ *
+ * To use this application component, the Zend Data Cache PHP extension must be loaded.
+ *
+ * See {@link CCache} manual for common cache operations that are supported by CZendDataCache.
+ *
+ * @author Steffen Dietz <steffo.dietz[at]googlemail[dot]com>
+ * @version $Id: CZendDataCache.php 3515 2011-12-28 12:29:24Z mdomba $
+ * @package system.caching
+ */
+class CZendDataCache extends CCache
+{
+ /**
+ * Initializes this application component.
+ * This method is required by the {@link IApplicationComponent} interface.
+ * It checks the availability of Zend Data Cache.
+ * @throws CException if Zend Data Cache extension is not loaded.
+ */
+ public function init()
+ {
+ parent::init();
+ if(!function_exists('zend_shm_cache_store'))
+ throw new CException(Yii::t('yii','CZendDataCache requires PHP Zend Data Cache extension to be loaded.'));
+ }
+
+ /**
+ * Retrieves a value from cache with a specified key.
+ * This is the implementation of the method declared in the parent class.
+ * @param string $key a unique key identifying the cached value
+ * @return string the value stored in cache, false if the value is not in the cache or expired.
+ */
+ protected function getValue($key)
+ {
+ $result = zend_shm_cache_fetch($key);
+ return $result !== NULL ? $result : false;
+ }
+
+ /**
+ * Stores a value identified by a key in cache.
+ * This is the implementation of the method declared in the parent class.
+ *
+ * @param string $key the key identifying the value to be cached
+ * @param string $value the value to be cached
+ * @param integer $expire the number of seconds in which the cached value will expire. 0 means never expire.
+ * @return boolean true if the value is successfully stored into cache, false otherwise
+ */
+ protected function setValue($key,$value,$expire)
+ {
+ return zend_shm_cache_store($key,$value,$expire);
+ }
+
+ /**
+ * Stores a value identified by a key into cache if the cache does not contain this key.
+ * This is the implementation of the method declared in the parent class.
+ *
+ * @param string $key the key identifying the value to be cached
+ * @param string $value the value to be cached
+ * @param integer $expire the number of seconds in which the cached value will expire. 0 means never expire.
+ * @return boolean true if the value is successfully stored into cache, false otherwise
+ */
+ protected function addValue($key,$value,$expire)
+ {
+ return (NULL === zend_shm_cache_fetch($key)) ? $this->setValue($key,$value,$expire) : false;
+ }
+
+ /**
+ * Deletes a value with the specified key from cache
+ * This is the implementation of the method declared in the parent class.
+ * @param string $key the key of the value to be deleted
+ * @return boolean if no error happens during deletion
+ */
+ protected function deleteValue($key)
+ {
+ return zend_shm_cache_delete($key);
+ }
+
+ /**
+ * Deletes all values from cache.
+ * This is the implementation of the method declared in the parent class.
+ * @return boolean whether the flush operation was successful.
+ * @since 1.1.5
+ */
+ protected function flushValues()
+ {
+ return zend_shm_cache_clear();
+ }
+}