Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5. Some parts of this website may be subject to other licenses.
Source code for file /joomla/cache/storage/apc.php

Documentation is available at apc.php

  1. <?php
  2. /**
  3.  * @version        $Id: apc.php 9764 2007-12-30 07:48:11Z ircmaxell $
  4.  * @package        Joomla.Framework
  5.  * @subpackage    Cache
  6.  * @copyright    Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
  7.  * @license        GNU/GPL, see LICENSE.php
  8.  *  Joomla! is free software. This version may have been modified pursuant
  9.  *  to the GNU General Public License, and as distributed it includes or
  10.  *  is derivative of works licensed under the GNU General Public License or
  11.  *  other free or open source software licenses.
  12.  *  See COPYRIGHT.php for copyright notices and details.
  13.  */
  14.  
  15. // Check to ensure this file is within the rest of the framework
  16. defined('JPATH_BASE') or die();
  17.  
  18. /**
  19.  * APC cache storage handler
  20.  *
  21.  * @author        Louis Landry <louis.landry@joomla.org>
  22.  * @package        Joomla.Framework
  23.  * @subpackage    Cache
  24.  * @since        1.5
  25.  */
  26. class JCacheStorageApc extends JCacheStorage
  27. {
  28.     /**
  29.      * Constructor
  30.      *
  31.      * @access protected
  32.      * @param array $options optional parameters
  33.      */
  34.     function __construct( $options = array() )
  35.     {
  36.         parent::__construct($options);
  37.  
  38.         $config            =& JFactory::getConfig();
  39.         $this->_hash    = $config->getValue('config.secret');
  40.     }
  41.  
  42.     /**
  43.      * Get cached data from APC by id and group
  44.      *
  45.      * @access    public
  46.      * @param    string    $id            The cache data id
  47.      * @param    string    $group        The cache data group
  48.      * @param    boolean    $checkTime    True to verify cache time expiration threshold
  49.      * @return    mixed    Boolean false on failure or a cached data string
  50.      * @since    1.5
  51.      */
  52.     function get($id, $group, $checkTime)
  53.     {
  54.         $cache_id = $this->_getCacheId($id, $group);
  55.         $this->_setExpire($cache_id);
  56.         return apc_fetch($cache_id);
  57.     }
  58.  
  59.     /**
  60.      * Store the data to APC by id and group
  61.      *
  62.      * @access    public
  63.      * @param    string    $id        The cache data id
  64.      * @param    string    $group    The cache data group
  65.      * @param    string    $data    The data to store in cache
  66.      * @return    boolean    True on success, false otherwise
  67.      * @since    1.5
  68.      */
  69.     function store($id, $group, $data)
  70.     {
  71.         $cache_id = $this->_getCacheId($id, $group);
  72.         apc_store($cache_id.'_expire', time());
  73.         return apc_store($cache_id, $data, $this->_lifetime);
  74.     }
  75.  
  76.     /**
  77.      * Remove a cached data entry by id and group
  78.      *
  79.      * @access    public
  80.      * @param    string    $id        The cache data id
  81.      * @param    string    $group    The cache data group
  82.      * @return    boolean    True on success, false otherwise
  83.      * @since    1.5
  84.      */
  85.     function remove($id, $group)
  86.     {
  87.         $cache_id = $this->_getCacheId($id, $group);
  88.         apc_delete($cache_id.'_expire');
  89.         return apc_delete($cache_id);
  90.     }
  91.  
  92.     /**
  93.      * Clean cache for a group given a mode.
  94.      *
  95.      * group mode        : cleans all cache in the group
  96.      * notgroup mode    : cleans all cache not in the group
  97.      *
  98.      * @access    public
  99.      * @param    string    $group    The cache data group
  100.      * @param    string    $mode    The mode for cleaning cache [group|notgroup]
  101.      * @return    boolean    True on success, false otherwise
  102.      * @since    1.5
  103.      */
  104.     function clean($group, $mode)
  105.     {
  106.         return true;
  107.     }
  108.  
  109.     /**
  110.      * Test to see if the cache storage is available.
  111.      *
  112.      * @static
  113.      * @access public
  114.      * @return boolean  True on success, false otherwise.
  115.      */
  116.     function test()
  117.     {
  118.         return extension_loaded('apc');
  119.     }
  120.  
  121.     /**
  122.      * Set expire time on each call since memcache sets it on cache creation.
  123.      *
  124.      * @access private
  125.      *
  126.      * @param string  $key   Cache key to expire.
  127.      * @param integer $lifetime  Lifetime of the data in seconds.
  128.      */
  129.     function _setExpire($key)
  130.     {
  131.         $lifetime    = $this->_lifetime;
  132.         $expire        = apc_fetch($key.'_expire');
  133.  
  134.         // set prune period
  135.         if ($expire + $lifetime < time()) {
  136.             apc_delete($key);
  137.             apc_delete($key.'_expire');
  138.         } else {
  139.             apc_store($key.'_expire',  time());
  140.         }
  141.     }
  142.  
  143.     /**
  144.      * Get a cache_id string from an id/group pair
  145.      *
  146.      * @access    private
  147.      * @param    string    $id        The cache data id
  148.      * @param    string    $group    The cache data group
  149.      * @return    string    The cache_id string
  150.      * @since    1.5
  151.      */
  152.     function _getCacheId($id, $group)
  153.     {
  154.         $name    = md5($this->_application.'-'.$id.'-'.$this->_hash.'-'.$this->_language);
  155.         return 'cache_'.$group.'-'.$name;
  156.     }
  157. }
Documentation generated on Tue, 29 Jan 2008 18:44:09 +0000 by phpDocumentor 1.3.1