Source for file helper.php

Documentation is available at helper.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Platform
  4.  * @subpackage  Cache
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE
  8.  */
  9.  
  10. defined('JPATH_PLATFORM') or die;
  11.  
  12. /**
  13.  * Cache storage helper functions.
  14.  *
  15.  * @package     Joomla.Platform
  16.  * @subpackage  Cache
  17.  * @since       11.1
  18.  */
  19. class JCacheStorageHelper
  20. {
  21.     /**
  22.      * Cache data group
  23.      *
  24.      * @var    string 
  25.      * @since  11.1
  26.      */
  27.     public $group = '';
  28.  
  29.     /**
  30.      * Cached item size
  31.      *
  32.      * @var    string 
  33.      * @since  11.1
  34.      */
  35.     public $size = 0;
  36.  
  37.     /**
  38.      * Counter
  39.      *
  40.      * @var    integer 
  41.      * @since  11.1
  42.      */
  43.     public $count = 0;
  44.  
  45.     /**
  46.      * Constructor
  47.      *
  48.      * @param   string  $group  The cache data group
  49.      *
  50.      * @since   11.1
  51.      */
  52.     public function __construct($group)
  53.     {
  54.         $this->group = $group;
  55.     }
  56.  
  57.     /**
  58.      * Increase cache items count.
  59.      *
  60.      * @param   string  $size  Cached item size
  61.      *
  62.      * @return  void 
  63.      *
  64.      * @since   11.1
  65.      */
  66.     public function updateSize($size)
  67.     {
  68.         $this->size = number_format($this->size + $size, 2, '.', '');
  69.         $this->count++;
  70.     }
  71. }

Documentation generated on Tue, 19 Nov 2013 15:04:35 +0100 by phpDocumentor 1.4.3