htmlpurifier/configdoc/types.xml

<?xml version="1.0" encoding="UTF-8"?>
<types>
  <type id="string" name="String"><div xmlns="http://www.w3.org/1999/xhtml">
    A <a
    href="http://docs.php.net/manual/en/language.types.string.php">sequence
    of characters</a>.
  </div></type>
  <type id="istring" name="Case-insensitive string"><div xmlns="http://www.w3.org/1999/xhtml">
    A series of case-insensitive characters.  Internally, upper-case
    ASCII characters will be converted to lower-case.
  </div></type>
  <type id="text" name="Text"><div xmlns="http://www.w3.org/1999/xhtml">
    A series of characters that may contain newlines.  Text tends to
    indicate human-oriented text, as opposed to a machine format.
  </div></type>
  <type id="itext" name="Case-insensitive text"><div xmlns="http://www.w3.org/1999/xhtml">
    A series of case-insensitive characters that may contain newlines.
  </div></type>
  <type id="int" name="Integer"><div xmlns="http://www.w3.org/1999/xhtml">
    An <a
      href="http://docs.php.net/manual/en/language.types.integer.php">
      integer</a>.  You are alternatively permitted to pass a string of
    digits instead, which will be cast to an integer using
    <code>(int)</code>.
  </div></type>
  <type id="float" name="Float"><div xmlns="http://www.w3.org/1999/xhtml">
    A <a href="http://docs.php.net/manual/en/language.types.float.php">
      floating point number</a>.  You are alternatively permitted to
    pass a numeric string (as defined by <code>is_numeric()</code>),
    which will be cast to a float using <code>(float)</code>.
  </div></type>
  <type id="bool" name="Boolean"><div xmlns="http://www.w3.org/1999/xhtml">
    A <a
      href="http://docs.php.net/manual/en/language.types.boolean.php">boolean</a>.
    You are alternatively permitted to pass an integer <code>0</code> or
    <code>1</code> (other integers are not permitted) or a string
    <code>"on"</code>, <code>"true"</code> or <code>"1"</code> for
    <code>true</code>, and <code>"off"</code>, <code>"false"</code> or
    <code>"0"</code> for <code>false</code>.
  </div></type>
  <type id="lookup" name="Lookup array"><div xmlns="http://www.w3.org/1999/xhtml">
    An array whose values are <code>true</code>, e.g. <code>array('key'
      => true, 'key2' => true)</code>.  You are alternatively permitted
    to pass an array list of the keys <code>array('key', 'key2')</code>
    or a comma-separated string of keys <code>"key, key2"</code>.  If
    you pass an array list of values, ensure that your values are
    strictly numerically indexed: <code>array('key1', 2 =>
      'key2')</code> will not do what you expect and emits a warning.
  </div></type>
  <type id="list" name="Array list"><div xmlns="http://www.w3.org/1999/xhtml">
    An array which has consecutive integer indexes, e.g.
    <code>array('val1', 'val2')</code>.  You are alternatively permitted
    to pass a comma-separated string of keys <code>"val1, val2"</code>.
    If your array is not in this form, <code>array_values</code> is run
    on the array and a warning is emitted.
  </div></type>
  <type id="hash" name="Associative array"><div xmlns="http://www.w3.org/1999/xhtml">
    An array which is a mapping of keys to values, e.g.
    <code>array('key1' => 'val1', 'key2' => 'val2')</code>.  You are
    alternatively permitted to pass a comma-separated string of
    key-colon-value strings, e.g. <code>"key1: val1, key2: val2"</code>.
  </div></type>
  <type id="mixed" name="Mixed"><div xmlns="http://www.w3.org/1999/xhtml">
    An arbitrary PHP value of any type.
  </div></type>
</types>

<!-- vim: et sw=4 sts=4
-->