1. sfXCacheCache.class.php
  2. /**
 * Cache class that stores cached content in XCache.
 *
 * @package    symfony
 * @subpackage cache
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfXCacheCache.class.php 17865 2009-05-02 09:23:55Z FabianLange $
 */
  3. class sfXCacheCache extends sfCache
  4. {
  5.   /**
  6.    * Initializes this sfCache instance.
  7.    *
  8.    * Available options:
  9.    *
  10.    * * see sfCache for options available for all drivers
  11.    *
  12.    * @see sfCache
  13.    */
  14.   public function initialize($options = array())
  15.   {
  16.     parent::initialize($options);
  18.     if (!function_exists('xcache_set'))
  19.     {
  20.       throw new sfInitializationException('You must have XCache installed and enabled to use sfXCacheCache class.');
  21.     }
  23.     if (!ini_get('xcache.var_size'))
  24.     {
  25.       throw new sfInitializationException('You must set the "xcache.var_size" variable to a value greater than 0 to use sfXCacheCache class.');
  26.     }
  27.   }
  29.  /**
  30.   * @see sfCache
  31.   */
  32.   public function get($key, $default = null)
  33.   {
  34.     
  35.     $set = $this->getBaseValue($key);
  36.     
  37.     if (!is_array($set) || !array_key_exists('data', $set))
  38.     {
  39.       
  40.       return $default;
  41.     }
  42.     
  43.     return $set['data'];
  44.   }
  46.   /**
  47.    * @see sfCache
  48.    */
  49.   public function has($key)
  50.   {
  51.     return xcache_isset($this->getOption('prefix').$key);
  52.   }
  54.   /**
  55.    * @see sfCache
  56.    */
  57.   public function set($key, $data, $lifetime = null)
  58.   {
  59.     $lifetime = $this->getLifetime($lifetime);
  61.     $set = array(
  62.       'timeout' => time() + $lifetime,
  63.       'data'    => $data,
  64.       'ctime'   => time()
  65.     );
  66.     
  67.     return xcache_set($this->getOption('prefix').$key, $set, $lifetime);
  68.   }
  70.   /**
  71.    * @see sfCache
  72.    */
  73.   public function remove($key)
  74.   {
  75.     return xcache_unset($this->getOption('prefix').$key);
  76.   }
  78.   /**
  79.    * @see sfCache
  80.    */
  81.   public function clean($mode = sfCache::ALL)
  82.   {
  83.     if ($mode !== sfCache::ALL)
  84.     {
  85.       return true;
  86.     }
  88.     $this->checkAuth();
  90.     for ($i = 0, $max = xcache_count(XC_TYPE_VAR); $i < $max; $i++)
  91.     {
  92.       if (false === xcache_clear_cache(XC_TYPE_VAR, $i))
  93.       {
  94.         return false;
  95.       }
  96.     }
  98.     return true;
  99.   }
  101.   /**
  102.    * @see sfCache
  103.    */
  104.   public function getLastModified($key)
  105.   {
  106.     $set = $this->getBaseValue($key);
  107.     
  108.     if (!is_array($set) || !array_key_exists('ctime', $set))
  109.     {
  110.       
  111.       return 0;
  112.     }
  113.     
  114.     return $set['ctime'];
  115.   }
  117.   /**
  118.    * @see sfCache
  119.    */
  120.   public function getTimeout($key)
  121.   {
  122.     
  123.     $set = $this->getBaseValue($key);
  124.     
  125.     if (!is_array($set) || !array_key_exists('timeout', $set))
  126.     {
  127.       
  128.       return 0;
  129.     }
  130.     
  131.     return $set['timeout'];
  132.   }
  133.   
  134.   public function getBaseValue($key)
  135.   {
  136.     return xcache_isset($this->getOption('prefix').$key) ? xcache_get($this->getOption('prefix').$key) : null;
  137.   }
  138.   
  139.   /**
  140.    * @see sfCache
  141.    */
  142.   public function removePattern($pattern)
  143.   {
  144.     $this->checkAuth();
  146.     $regexp = self::patternToRegexp($this->getOption('prefix').$pattern);
  148.     for ($i = 0, $max = xcache_count(XC_TYPE_VAR); $i < $max; $i++)
  149.     {
  150.       $infos = xcache_list(XC_TYPE_VAR, $i);
  151.       if (!is_array($infos['cache_list']))
  152.       {
  153.         return;
  154.       }
  156.       foreach ($infos['cache_list'] as $info)
  157.       {
  158.         if (preg_match($regexp, $info['name']))
  159.         {
  160.           xcache_unset($info['name']);
  161.         }
  162.       }
  163.     }
  164.   }
  166.   public function getCacheInfo($key)
  167.   {
  168.     $this->checkAuth();
  170.     for ($i = 0, $max = xcache_count(XC_TYPE_VAR); $i < $max; $i++)
  171.     {
  172.       $infos = xcache_list(XC_TYPE_VAR, $i);
  174.       if (is_array($infos['cache_list']))
  175.       {
  176.         foreach ($infos['cache_list'] as $info)
  177.         {
  178.           if ($this->getOption('prefix').$key == $info['name'])
  179.           {
  180.             return $info;
  181.           }
  182.         }
  183.       }
  184.     }
  186.     return null;
  187.   }
  189.   protected function checkAuth()
  190.   {
  191.     if (ini_get('xcache.admin.enable_auth'))
  192.     {
  193.       throw new sfConfigurationException('To use all features of the "sfXCacheCache" class, you must set "xcache.admin.enable_auth" to "Off" in your php.ini.');
  194.     }
  195.   }
  196. }
Debug toolbar