Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5
Source code for file /joomla/cache/storage/apc.php

Documentation is available at apc.php

  1. <?php
  2. /**
  3.  * @version        $Id: apc.php 6472 2007-02-03 10:47:26Z pasamio $
  4.  * @package        Joomla.Framework
  5.  * @subpackage    Cache
  6.  * @copyright    Copyright (C) 2005 - 2007 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 <[email protected]>
  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.         return apc_fetch($cache_id);
  56.     }
  57.  
  58.     /**
  59.      * Store the data to APC by id and group
  60.      *
  61.      * @access    public
  62.      * @param    string    $id        The cache data id
  63.      * @param    string    $group    The cache data group
  64.      * @param    string    $data    The data to store in cache
  65.      * @return    boolean    True on success, false otherwise
  66.      * @since    1.5
  67.      */
  68.     function store($id, $group, $data)
  69.     {
  70.         $cache_id = $this->_getCacheId($id, $group);
  71.         return apc_store($cache_id, $data, $this->_lifetime);
  72.     }
  73.  
  74.     /**
  75.      * Remove a cached data entry by id and group
  76.      *
  77.      * @access    public
  78.      * @param    string    $id        The cache data id
  79.      * @param    string    $group    The cache data group
  80.      * @return    boolean    True on success, false otherwise
  81.      * @since    1.5
  82.      */
  83.     function remove($id, $group)
  84.     {
  85.         $cache_id = $this->_getCacheId($id, $group);
  86.         return apc_delete($cache_id);
  87.     }
  88.  
  89.     /**
  90.      * Clean cache for a group given a mode.
  91.      *
  92.      * group mode        : cleans all cache in the group
  93.      * notgroup mode    : cleans all cache not in the group
  94.      *
  95.      * @access    public
  96.      * @param    string    $group    The cache data group
  97.      * @param    string    $mode    The mode for cleaning cache [group|notgroup]
  98.      * @return    boolean    True on success, false otherwise
  99.      * @since    1.5
  100.      */
  101.     function clean($group, $mode)
  102.     {
  103.         $return = true;
  104.         $folder    = md5($group.'-'.$this->_hash);
  105.         switch ($mode)
  106.         {
  107.             case 'notgroup':
  108.                 // Get list of cache entries by folder and delete those not in $folder
  109.                 break;
  110.             case 'group':
  111.             default:
  112.                 // Get list of cache entries by folder and delete those in $folder
  113.                 break;
  114.         }
  115.         return $return;
  116.     }
  117.  
  118.     /**
  119.      * Test to see if the cache storage is available.
  120.      *
  121.      * @static
  122.      * @access public
  123.      * @return boolean  True on success, false otherwise.
  124.      */
  125.     function test()
  126.     {
  127.         return extension_loaded('apc');
  128.     }
  129.  
  130.     /**
  131.      * Get a cache_id string from an id/group pair
  132.      *
  133.      * @access    private
  134.      * @param    string    $id        The cache data id
  135.      * @param    string    $group    The cache data group
  136.      * @return    string    The cache_id string
  137.      * @since    1.5
  138.      */
  139.     function _getCacheId($id, $group)
  140.     {
  141.         $folder    = md5($group.'-'.$this->_hash);
  142.         $name    = md5($id.'-'.$this->_hash);
  143.  
  144.         return 'cache_'.$folder.DS.$name;
  145.     }
  146. }
  147. ?>
Documentation generated on Mon, 05 Mar 2007 20:52:02 +0000 by phpDocumentor 1.3.1