vendor/exercise/htmlpurifier-bundle/src/HTMLPurifierConfigFactory.php line 49

Open in your IDE?
  1. <?php
  3. namespace Exercise\HTMLPurifierBundle;
  5. class HTMLPurifierConfigFactory
  6. {
  7.     /**
  8.      * @param string                    $profile       The configuration name, also used as cache id
  9.      * @param array                     $configArray   The config array to set up
  10.      * @param \HTMLPurifier_Config|null $defaultConfig The default config that every config must inherit or null if
  11.      *                                                 default
  12.      * @param array                     $parents       An array of config arrays to inherit by preloading or null
  13.      * @param array                     $attributes    A nullable array of rules as arrays by tag name holding two
  14.      *                                                 string elements, the first for the attribute name and the second
  15.      *                                                 for the rule (i.e: Text, ID, ...)
  16.      *                                                 [ ['img' => ['src' => 'URI', 'data-type' => Text']] ]
  17.      * @param array                     $elements      An array of arrays by element to add or override, arrays must
  18.      *                                                 hold a type ("Inline, "Block", ...), a content type ("Empty",
  19.      *                                                 "Optional: #PCDATA", ...), an attributes set ("Core", "Common",
  20.      *                                                 ...), a fourth optional may define attributes rules as array, and
  21.      *                                                 a fifth to list forbidden attributes
  22.      * @param array                     $blankElements An array of tag names that should not have any attributes
  23.      */
  24.     public static function create(
  25.         string $profile,
  26.         array $configArray,
  27.         \HTMLPurifier_Config $defaultConfig = null,
  28.         array $parents = [],
  29.         array $attributes = [],
  30.         array $elements = [],
  31.         array $blankElements = []
  32.     ): \HTMLPurifier_Config {
  33.         if ($defaultConfig) {
  34.             $config = \HTMLPurifier_Config::inherit($defaultConfig);
  35.         } else {
  36.             $config = \HTMLPurifier_Config::createDefault();
  37.         }
  39.         foreach ($parents as $parent) {
  40.             $config->loadArray($parent);
  41.         }
  43.         $config->loadArray($configArray);
  45.         // Make the config unique
  46.         $config->set('HTML.DefinitionID', $profile);
  47.         $config->set('HTML.DefinitionRev', 1);
  49.         $def = $config->maybeGetRawHTMLDefinition();
  51.         // If the definition is not cached, build it
  52.         if ($def && ($attributes || $elements || $blankElements)) {
  53.             static::buildHTMLDefinition($def, $attributes, $elements, $blankElements);
  54.         }
  56.         return $config;
  57.     }
  59.     /**
  60.      * Builds a config definition from the given parameters.
  61.      *
  62.      * This build should never happen on runtime, since purifiers cache should
  63.      * be generated during warm up.
  64.      */
  65.     public static function buildHTMLDefinition(\HTMLPurifier_Definition $def, array $attributes, array $elements, array $blankElements): void
  66.     {
  67.         foreach ($attributes as $elementName => $rule) {
  68.             foreach ($rule as $attributeName => $definition) {
  69.                 /* @see \HTMLPurifier_AttrTypes */
  70.                 $def->addAttribute($elementName, $attributeName, $definition);
  71.             }
  72.         }
  74.         foreach ($elements as $elementName => $config) {
  75.             /* @see \HTMLPurifier_HTMLModule::addElement() */
  76.             $el = $def->addElement($elementName, $config[0], $config[1], $config[2], isset($config[3]) ? $config[3] : []);
  78.             if (isset($config[4])) {
  79.                 $el->excludes = array_fill_keys($config[4], true);
  80.             }
  81.         }
  83.         foreach ($blankElements as $blankElement) {
  84.             /* @see \HTMLPurifier_HTMLModule::addBlankElement() */
  85.             $def->addBlankElement($blankElement);
  86.         }
  87.     }
  88. }