library/Zend/Cache/Frontend/Function.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Cache
  17  * @subpackage Zend_Cache_Frontend
  18  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  20  * @version    $Id: Function.php 16541 2009-07-07 06:59:03Z bkarwin $
  21  */
  22
  23
  24 /**
  25  * @see Zend_Cache_Core
  26  */
  27 require_once 'Zend/Cache/Core.php';
  28
  29
  30 /**
  31  * @package    Zend_Cache
  32  * @subpackage Zend_Cache_Frontend
  33  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  34  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  35  */
  36 class Zend_Cache_Frontend_Function extends Zend_Cache_Core
  37 {
  38     /**
  39      * This frontend specific options
  40      *
  41      * ====> (boolean) cache_by_default :
  42      * - if true, function calls will be cached by default
  43      *
  44      * ====> (array) cached_functions :
  45      * - an array of function names which will be cached (even if cache_by_default = false)
  46      *
  47      * ====> (array) non_cached_functions :
  48      * - an array of function names which won't be cached (even if cache_by_default = true)
  49      *
  50      * @var array options
  51      */
  52     protected $_specificOptions = array(
  53         'cache_by_default' => true,
  54         'cached_functions' => array(),
  55         'non_cached_functions' => array()
  56     );
  57
  58     /**
  59      * Constructor
  60      *
  61      * @param  array $options Associative array of options
  62      * @return void
  63      */
  64     public function __construct(array $options = array())
  65     {
  66         while (list($name, $value) = each($options)) {
  67             $this->setOption($name, $value);
  68         }
  69         $this->setOption('automatic_serialization', true);
  70     }
  71
  72     /**
  73      * Main method : call the specified function or get the result from cache
  74      *
  75      * @param  string $name             Function name
  76      * @param  array  $parameters       Function parameters
  77      * @param  array  $tags             Cache tags
  78      * @param  int    $specificLifetime If != false, set a specific lifetime for this cache record (null => infinite lifetime)
  79      * @param  int   $priority         integer between 0 (very low priority) and 10 (maximum priority) used by some particular backends
  80      * @return mixed Result
  81      */
  82     public function call($name, $parameters = array(), $tags = array(), $specificLifetime = false, $priority = 8)
  83     {
  84         $cacheBool1 = $this->_specificOptions['cache_by_default'];
  85         $cacheBool2 = in_array($name, $this->_specificOptions['cached_functions']);
  86         $cacheBool3 = in_array($name, $this->_specificOptions['non_cached_functions']);
  87         $cache = (($cacheBool1 || $cacheBool2) && (!$cacheBool3));
  88         if (!$cache) {
  89             // We do not have not cache
  90             return call_user_func_array($name, $parameters);
  91         }
  92         $id = $this->_makeId($name, $parameters);
  93         if ($this->test($id)) {
  94             // A cache is available
  95             $result = $this->load($id);
  96             $output = $result[0];
  97             $return = $result[1];
  98         } else {
  99             // A cache is not available
 100             ob_start();
 101             ob_implicit_flush(false);
 102             $return = call_user_func_array($name, $parameters);
 103             $output = ob_get_contents();
 104             ob_end_clean();
 105             $data = array($output, $return);
 106             $this->save($data, $id, $tags, $specificLifetime, $priority);
 107         }
 108         echo $output;
 109         return $return;
 110     }
 111
 112     /**
 113      * Make a cache id from the function name and parameters
 114      *
 115      * @param  string $name       Function name
 116      * @param  array  $parameters Function parameters
 117      * @throws Zend_Cache_Exception
 118      * @return string Cache id
 119      */
 120     private function _makeId($name, $parameters)
 121     {
 122         if (!is_string($name)) {
 123             Zend_Cache::throwException('Incorrect function name');
 124         }
 125         if (!is_array($parameters)) {
 126             Zend_Cache::throwException('parameters argument must be an array');
 127         }
 128         return md5($name . serialize($parameters));
 129     }
 130
 131 }