home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Web Server / PHP.EXE / pear / Cache / Function.php < prev    next >
Encoding:
PHP Script  |  2001-03-04  |  3.4 KB  |  113 lines
  1. <?php
  2. /**
  3. * Function_Cache
  4. * 
  5. * Purpose:
  6. * 
  7. *   Caching the result and output of functions.
  8. * 
  9. * Example:
  10. * 
  11. *     require_once "Cache/Function.php";
  12. *
  13. *     $FUNCTION_CACHE_CONTAINER = "file";
  14. *     $FUNCTION_CACHE_CONTAINER_OPTIONS = array(
  15. *         "cache_dir" => "/tmp/",
  16. *         "filename_prefix" => "cache_");
  17. *
  18. *     function foo($string)
  19. *     {
  20. *         print $string . "<br>";
  21. *         for($i=1;$i<10000000;$i++){}
  22. *         return strrev($string);
  23. *     }
  24. * 
  25. *     print cached_function_call("foo", "test");
  26. * 
  27. * Note:
  28. * 
  29. *   You cannot cache every function. You should only cache 
  30. *   functions that only depend on their arguments and don't use
  31. *   global or static variables, don't rely on database queries or 
  32. *   files, and so on.
  33. * 
  34. * @author       Sebastian Bergmann <sb@sebastian-bergmann.de>
  35. * @module       Function_Cache
  36. * @modulegroup  Function_Cache
  37. * @package      Cache
  38. * @version      $Revision: 1.6 $
  39. * @access       public
  40. */
  41.  
  42. // +----------------------------------------------------------------------+
  43. // | PHP version 4.0                                                      |
  44. // +----------------------------------------------------------------------+
  45. // | Copyright (c) 1997, 1998, 1999, 2000, 2001 The PHP Group             |
  46. // +----------------------------------------------------------------------+
  47. // | This source file is subject to version 2.0 of the PHP license,       |
  48. // | that is bundled with this package in the file LICENSE, and is        |
  49. // | available at through the world-wide-web at                           |
  50. // | http://www.php.net/license/2_02.txt.                                 |
  51. // | If you did not receive a copy of the PHP license and are unable to   |
  52. // | obtain it through the world-wide-web, please send a note to          |
  53. // | license@php.net so we can mail you a copy immediately.               |
  54. // +----------------------------------------------------------------------+
  55. // | Authors: Sebastian Bergmann <sb@sebastian-bergmann.de>               |
  56. // +----------------------------------------------------------------------+
  57. //
  58. // $Id: Function.php,v 1.6 2001/03/03 19:17:20 uw Exp $
  59.  
  60. require_once 'Cache.php';
  61.  
  62. /**
  63. * Calls a cacheable function or method.
  64. *
  65. * @return mixed $result
  66. * @access public
  67. */
  68. function cached_function_call()
  69. {
  70.     global $FUNCTION_CACHE_CONTAINER, $FUNCTION_CACHE_CONTAINER_OPTIONS;
  71.     static $cache;
  72.  
  73.     // create Cache object, if needed
  74.     if (!is_object($cache))
  75.     {
  76.         $cache = new Cache($FUNCTION_CACHE_CONTAINER, $FUNCTION_CACHE_CONTAINER_OPTIONS);
  77.     }
  78.  
  79.     // get arguments
  80.     $arguments = func_get_args();
  81.  
  82.     // generate cache id
  83.     $id = md5(serialize($arguments));
  84.  
  85.     // query cache
  86.     $cached_object = $cache->get($id);
  87.  
  88.     // cache hit
  89.     if ($cached_object != NULL)
  90.     {
  91.         $output = $cached_object[0];
  92.         $result = $cached_object[1];
  93.     }
  94.  
  95.     // cache miss
  96.     else
  97.     {
  98.         $function_name = array_shift($arguments);
  99.  
  100.         // call function, save output and result
  101.         ob_start();
  102.         $result = call_user_func_array($function_name, $arguments);
  103.         $output = ob_get_contents();
  104.         ob_end_clean();
  105.  
  106.         // store output and result of function call in cache
  107.         $cache->save($id, array($output, $result));
  108.     }
  109.  
  110.     print $output;
  111.     return $result;
  112. }
  113. ?>