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