configdoc/types.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <types>
   3   <type id="string" name="String"><div xmlns="http://www.w3.org/1999/xhtml">
   4     A <a
   5     href="http://docs.php.net/manual/en/language.types.string.php">sequence
   6     of characters</a>.
   7   </div></type>
   8   <type id="istring" name="Case-insensitive string"><div xmlns="http://www.w3.org/1999/xhtml">
   9     A series of case-insensitive characters.  Internally, upper-case
  10     ASCII characters will be converted to lower-case.
  11   </div></type>
  12   <type id="text" name="Text"><div xmlns="http://www.w3.org/1999/xhtml">
  13     A series of characters that may contain newlines.  Text tends to
  14     indicate human-oriented text, as opposed to a machine format.
  15   </div></type>
  16   <type id="itext" name="Case-insensitive text"><div xmlns="http://www.w3.org/1999/xhtml">
  17     A series of case-insensitive characters that may contain newlines.
  18   </div></type>
  19   <type id="int" name="Integer"><div xmlns="http://www.w3.org/1999/xhtml">
  20     An <a
  21       href="http://docs.php.net/manual/en/language.types.integer.php">
  22       integer</a>.  You are alternatively permitted to pass a string of
  23     digits instead, which will be cast to an integer using
  24     <code>(int)</code>.
  25   </div></type>
  26   <type id="float" name="Float"><div xmlns="http://www.w3.org/1999/xhtml">
  27     A <a href="http://docs.php.net/manual/en/language.types.float.php">
  28       floating point number</a>.  You are alternatively permitted to
  29     pass a numeric string (as defined by <code>is_numeric()</code>),
  30     which will be cast to a float using <code>(float)</code>.
  31   </div></type>
  32   <type id="bool" name="Boolean"><div xmlns="http://www.w3.org/1999/xhtml">
  33     A <a
  34       href="http://docs.php.net/manual/en/language.types.boolean.php">boolean</a>.
  35     You are alternatively permitted to pass an integer <code>0</code> or
  36     <code>1</code> (other integers are not permitted) or a string
  37     <code>"on"</code>, <code>"true"</code> or <code>"1"</code> for
  38     <code>true</code>, and <code>"off"</code>, <code>"false"</code> or
  39     <code>"0"</code> for <code>false</code>.
  40   </div></type>
  41   <type id="lookup" name="Lookup array"><div xmlns="http://www.w3.org/1999/xhtml">
  42     An array whose values are <code>true</code>, e.g. <code>array('key'
  43       => true, 'key2' => true)</code>.  You are alternatively permitted
  44     to pass an array list of the keys <code>array('key', 'key2')</code>
  45     or a comma-separated string of keys <code>"key, key2"</code>.  If
  46     you pass an array list of values, ensure that your values are
  47     strictly numerically indexed: <code>array('key1', 2 =>
  48       'key2')</code> will not do what you expect and emits a warning.
  49   </div></type>
  50   <type id="list" name="Array list"><div xmlns="http://www.w3.org/1999/xhtml">
  51     An array which has consecutive integer indexes, e.g.
  52     <code>array('val1', 'val2')</code>.  You are alternatively permitted
  53     to pass a comma-separated string of keys <code>"val1, val2"</code>.
  54     If your array is not in this form, <code>array_values</code> is run
  55     on the array and a warning is emitted.
  56   </div></type>
  57   <type id="hash" name="Associative array"><div xmlns="http://www.w3.org/1999/xhtml">
  58     An array which is a mapping of keys to values, e.g.
  59     <code>array('key1' => 'val1', 'key2' => 'val2')</code>.  You are
  60     alternatively permitted to pass a comma-separated string of
  61     key-colon-value strings, e.g. <code>"key1: val1, key2: val2"</code>.
  62   </div></type>
  63   <type id="mixed" name="Mixed"><div xmlns="http://www.w3.org/1999/xhtml">
  64     An arbitrary PHP value of any type.
  65   </div></type>
  66 </types>
  67
  68 <!-- vim: et sw=4 sts=4
  69 -->