library/HTMLPurifier/ConfigDef/Directive.php

   1 <?php
   2
   3 /**
   4  * Structure object containing definition of a directive.
   5  * @note This structure does not contain default values
   6  */
   7 class HTMLPurifier_ConfigDef_Directive extends HTMLPurifier_ConfigDef
   8 {
   9
  10     public $class = 'directive';
  11
  12     public function __construct(
  13         $type = null,
  14         $description = null,
  15         $allow_null = null,
  16         $allowed = null,
  17         $aliases = null
  18     ) {
  19         if (       $type !== null)        $this->type = $type;
  20         if ($description !== null) $this->description = $description;
  21         if ( $allow_null !== null)  $this->allow_null = $allow_null;
  22         if (    $allowed !== null)     $this->allowed = $allowed;
  23         if (    $aliases !== null)     $this->aliases = $aliases;
  24     }
  25
  26     /**
  27      * Allowed type of the directive. Values are:
  28      *      - string
  29      *      - istring (case insensitive string)
  30      *      - int
  31      *      - float
  32      *      - bool
  33      *      - lookup (array of value => true)
  34      *      - list (regular numbered index array)
  35      *      - hash (array of key => value)
  36      *      - mixed (anything goes)
  37      */
  38     public $type = 'mixed';
  39
  40     /**
  41      * Plaintext description of the configuration entity is.
  42      */
  43     public $description = null;
  44
  45     /**
  46      * Is null allowed? Has no effect for mixed type.
  47      * @bool
  48      */
  49     public $allow_null = false;
  50
  51     /**
  52      * Lookup table of allowed values of the element, bool true if all allowed.
  53      */
  54     public $allowed = true;
  55
  56     /**
  57      * Hash of value aliases, i.e. values that are equivalent.
  58      */
  59     public $aliases = array();
  60
  61     /**
  62      * Advisory list of directive aliases, i.e. other directives that
  63      * redirect here
  64      */
  65     public $directiveAliases = array();
  66
  67 }
  68