library/HTMLPurifier/DefinitionCacheFactory.php

   1 <?php
   2
   3 /**
   4  * Responsible for creating definition caches.
   5  */
   6 class HTMLPurifier_DefinitionCacheFactory
   7 {
   8
   9     protected $caches = array('Serializer' => array());
  10     protected $implementations = array();
  11     /**
  12      * @var HTMLPurifier_DefinitionCache_Decorator[]
  13      */
  14     protected $decorators = array();
  15
  16     /**
  17      * Initialize default decorators
  18      */
  19     public function setup()
  20     {
  21         $this->addDecorator('Cleanup');
  22     }
  23
  24     /**
  25      * Retrieves an instance of global definition cache factory.
  26      *
  27      * @return HTMLPurifier_DefinitionCacheFactory
  28      */
  29     public static function instance($prototype = null)
  30     {
  31         static $instance;
  32         if ($prototype !== null) {
  33             $instance = $prototype;
  34         } elseif ($instance === null || $prototype === true) {
  35             $instance = new HTMLPurifier_DefinitionCacheFactory();
  36             $instance->setup();
  37         }
  38         return $instance;
  39     }
  40
  41     /**
  42      * Registers a new definition cache object
  43      * @param string $short Short name of cache object, for reference
  44      * @param string $long Full class name of cache object, for construction
  45      */
  46     public function register($short, $long)
  47     {
  48         $this->implementations[$short] = $long;
  49     }
  50
  51     /**
  52      * Factory method that creates a cache object based on configuration
  53      *
  54      * @param string $name Name of definitions handled by cache
  55      * @param HTMLPurifier_Config $config Config instance
  56      */
  57     public function create($type, $config)
  58     {
  59         $method = $config->get('Cache.DefinitionImpl');
  60         if ($method === null) {
  61             return new HTMLPurifier_DefinitionCache_Null($type);
  62         }
  63         if (!empty($this->caches[$method][$type])) {
  64             return $this->caches[$method][$type];
  65         }
  66         if (
  67           isset($this->implementations[$method]) &&
  68           class_exists($class = $this->implementations[$method], false)
  69         ) {
  70             $cache = new $class($type);
  71         } else {
  72             if ($method != 'Serializer') {
  73                 trigger_error("Unrecognized DefinitionCache $method, using Serializer instead", E_USER_WARNING);
  74             }
  75             $cache = new HTMLPurifier_DefinitionCache_Serializer($type);
  76         }
  77         foreach ($this->decorators as $decorator) {
  78             $new_cache = $decorator->decorate($cache);
  79             // prevent infinite recursion in PHP 4
  80             unset($cache);
  81             $cache = $new_cache;
  82         }
  83         $this->caches[$method][$type] = $cache;
  84         return $this->caches[$method][$type];
  85     }
  86
  87     /**
  88      * Registers a decorator to add to all new cache objects
  89      * @param HTMLPurifier_DefinitionCache_Decorator|string $decorator An instance or the name of a decorator
  90      */
  91     public function addDecorator($decorator)
  92     {
  93         if (is_string($decorator)) {
  94             $class = "HTMLPurifier_DefinitionCache_Decorator_$decorator";
  95             $decorator = new $class;
  96         }
  97         $this->decorators[$decorator->name] = $decorator;
  98     }
  99
 100 }
 101
 102 // vim: et sw=4 sts=4