Extension:ArrayFunctions/Parser functions
ArrayFunctions provides the following parser functions.
Notes
edit- All keyword argument names are case-sensitive.
- All string arguments support the following escape sequences:
\s
for spaces\n
for newlines\\
for backslashes
- Parameters prefixed with a single asterisk (*) accept a variable number of positional arguments.
- Parameters prefixed with a double asterisk (**) accept a variable number of named arguments.
Functions
edit- Construct an array or value
Name | Description |
---|---|
#af_bool
|
Cast a string to a boolean. |
#af_float
|
Cast a string to a float. |
#af_int
|
Cast a string to an integer. |
#af_list
|
Create a new list from values. |
#af_object
|
Create a new object from values. |
#af_split
|
Split a string based on a delimiter. |
- Extract information from an array
Name | Description |
---|---|
#af_count
|
Count the number of values in an array. |
#af_exists
|
Check whether a key or index exists in an array. |
#af_get
|
Retrieve an element from an array by index. |
#af_isarray
|
Check if a value is an array. |
#af_print
|
Print an array for debug purposes. |
#af_search
|
Searches an array for a value. |
#af_show
|
Show a value in a human-readable format. |
- Create an array from an existing array
Name | Description |
---|---|
#af_difference
|
Compute the difference between arrays. |
#af_intersect
|
Compute the intersection of arrays. |
#af_keysort
|
Sort a list of objects based on the values of a key. |
#af_ksort
|
Sort an array by key. |
#af_merge
|
Compute the union of arrays. |
#af_push
|
Add a value to the end of a list. |
#af_set
|
Set a value at an index. |
#af_slice
|
Extract a slice from an array. |
#af_sort
|
Sort a list. |
#af_unique
|
Remove duplicates from an array. |
#af_unset
|
Remove a value from an array by index. |
- Iterate over an array
Name | Description |
---|---|
#af_foreach
|
Iterate over an array. |
#af_join
|
Recursively join the items of an array together with a separator. |
#af_map
|
Apply a callback to each element of a list. |
#af_reduce
|
Iteratively reduce the array to a single value using a callback. |
- Miscellaneous functions
Name | Description |
---|---|
#af_if
|
Select one of two alternatives based on a predicate. |
#af_stringmap
|
Apply a callback to each value in a delimited string. |
#af_template
|
Invoke a template with the values in an array. |
#af_trim
|
Trim characters at the start and end of a string. |
af_bool
editArrayFunctions version | ≥ 1.0 |
This parser function casts a string to a boolean. This is useful for creating an array containing a boolean.
Description
edit{{#af_bool: value }}
Parameters
edit- value : string or boolean
- The value to cast to a boolean.
Return values
editReturns the casted boolean.
Examples
editCreate an opaque representation of a boolean | {{#af_bool: yes }}, {{#af_bool: no }}, {{#af_bool: true }} |
boolean__^__1, boolean__^__0, boolean__^__1 |
Create an array containing a boolean | {{#af_print: {{#af_list: {{#af_bool: yes}} }} }} |
|
af_count
editArrayFunctions version | ≥ 1.0 |
This parser functions counts the number of values in an array.
Description
edit{{#af_count: array | recursive=recursive }}
Parameters
edit- array : array
- The array to count.
- recursive : boolean, default=false
- Whether to count items recursively. Note that elements containing a list are also counted (see examples below).
Return values
editThe number of items in the array.
Examples
editCount the number of items in a one-dimensional list | {{#af_print: {{#af_count: {{#af_list: a | b | c }} }} }} |
3 |
Count the number of items in a multi-dimensional list | {{#af_print: {{#af_count: {{#af_list: {{#af_list: a | b }} | {{#af_list: c | d }} }} }} }} |
2 |
Recursively count the number of items in a multi-dimensional list | {{#af_print: {{#af_count: {{#af_list: {{#af_list: a | b }} | {{#af_list: c | d }} }} | recursive=true }} }} |
6 |
af_difference
editArrayFunctions version | ≥ 1.5 |
This parser function computes the difference between arrays. This function preserves keys. Two values are considered equal if their string representation is the same (see array_diff on PHP.net).
Description
edit{{#af_difference: array | *arrays }}
Parameters
edit- array : array
- The first array.
- *arrays : array
- The other arrays.
Return values
editReturns an array containing all values from array
that are not present in any of the arrays in arrays
. The keys in array
are preserved.
Examples
editCompute the difference of three arrays | {{#af_print: {{#af_difference: {{#af_list: a | b | c }} | {{#af_list: a }} | {{#af_list: b}} }} }} |
|
af_exists
editArrayFunctions version | ≥ 1.0 |
This parser function checks whether the given key or index exists in the given array.
Description
edit{{#af_exists: array | key }}
Parameters
edit- array : array
- The array to check.
- key : string or int
- The key to check.
Return values
editReturns true if array
contains key
, false otherwise.
Examples
editCheck if a key exists | {{#af_print: {{#af_exists: {{#af_object: hello=world }} | hello }} }} |
true |
Check if an index exists | {{#af_print: {{#af_exists: {{#af_list: a | b | c }} | 2 }} }} |
true |
Check if a nested key exists | {{#af_print: {{#af_exists: {{#af_get: {{#af_list: a | {{#af_list: b | c }} }} | 1 }} | 2 }} }} |
false |
af_float
editArrayFunctions version | ≥ 1.0 |
This parser function casts a string to a float. This is useful for creating an array containing a float.
Description
edit{{#af_float: value }}
Parameters
edit- value : string or float
- The value to cast to a float.
Return values
editReturns the casted float.
Examples
editCreate an opaque representation of a float | {{#af_float: 1.298 }}, {{#af_float: 0 }} |
float__^__1.298, float__^__0 |
Create an array containing a float | {{#af_print: {{#af_list: {{#af_float: 1.298 }} }} }} |
|
af_foreach
editArrayFunctions version | ≥ 1.0 |
This parser function provides a way to iterate over arrays.
Description
edit{{#af_foreach: array | key_name | value_name | body | delimiter=delimiter }}
Parameters
edit- array : array
- The array over which to iterate.
- key_name : string, default=null
- The name to use for the key.
- value_name : string, default=null
- The name to use for the value.
- body : string
- The body to return for each iteration.
- delimiter : string, default=""
- The delimiter to put between results.
Return values
editReturns the resulting wikitext.
Examples
editIterate over a list | {{#af_foreach: {{#af_list: John | Steve | Harry }} | | name | Hello, {{{name}}}!<br/> }} |
Hello, John! Hello, Steve! Hello, Harry! |
Iterate over an object | {{#af_foreach: {{#af_object: Hello=John | Hi=Steve | Welcome=Harry }} | greeting | name | {{{greeting}}}, {{{name}}}!<br/> }} |
Hello, John! Hi, Steve! Welcome, Harry! |
Iterate over a list and add a delimiter | {{#af_foreach: {{#af_list: John | Steve | Harry }} | | name | Hello, {{{name}}}! | delimiter=<br/> }} |
Hello, John! Hello, Steve! Hello, Harry! |
af_get
editArrayFunctions version | ≥ 1.0 |
This parser function retrieves the element with the given index from the given array. If the index does not exist, the empty string is returned.
Description
edit{{#af_get: array | *indices }}
Parameters
edit- array : array
- The array in which to index.
- *indices : string
- The index. Multiple indices can be given to index nested arrays.
Return values
editReturns the indexed value, or the empty string if the index does not exist.
Examples
editGet a top-level element | {{#af_get: {{#af_list: a | b | c }} | 1 }} |
b |
Get a subarray | {{#af_print: {{#af_get: {{#af_list: a | {{#af_list: b | c }} }} | 1 }} }} |
|
Get a nested element | {{#af_get: {{#af_list: a | {{#af_object: hello=world }} }} | 1 | hello }} |
world |
af_if
editArrayFunctions version | ≥ 1.0 |
This parser function selects one of two alternatives based on the given predicate.
Description
edit{{#af_if: predicate | consequent | alternative }}
Parameters
edit- predicate : boolean
- The predicate.
- consequent : string
- The value to return if the predicate holds (i.e. is true).
- alternative : string, default=""
- The value to return if the predicate does not hold (i.e. is false).
Return values
editReturns the consequent if the predicate holds, or the alternative if it is given and the predicate does not hold.
Examples
editCheck if a value is an array | {{#af_if: {{#af_isarray: not an array }} | A beautiful array! | Not an array! }} |
Not an array! |
af_int
editArrayFunctions version | ≥ 1.0 |
This parser function casts a string to an integer. This is useful for creating an array containing an integer.
Description
edit{{#af_int: value }}
Parameters
edit- value : string or int
- The value to cast to an integer.
Return values
editReturns the casted integer.
Examples
editCreate an opaque representation of an integer | {{#af_int: 42 }}, {{#af_int: -12 }} |
integer__^__42, integer__^__-12 |
Create an array containing an integer | {{#af_print: {{#af_list: {{#af_int: -129}} }} }} |
|
af_intersect
editArrayFunctions version | ≥ 1.2 |
This parser function computes the intersection of arrays. This function preserves keys. Two values are considered equal if their string representation is the same (see array_intersect on PHP.net).
Description
edit{{#af_intersect: array | *arrays }}
Parameters
edit- array : array
- The first array.
- *arrays : array
- The other arrays.
Return values
editReturns the intersection of the given arrays.
Examples
editCompute the intersection of two identical arrays | {{#af_print: {{#af_intersect: {{#af_list: a | b | c }} | {{#af_list: a | b | c }} }} }} |
|
Compute the intersection of two partially overlapping arrays | {{#af_print: {{#af_intersect: {{#af_list: a | b | c }} | {{#af_list: c | d | e }} }} }} |
|
af_isarray
editArrayFunctions version | ≥ 1.0 |
This parser function checks if the given value is an array.
Description
edit{{#af_isarray: value }}
Parameters
edit- value : mixed
- The value to check.
Return values
editReturns true if value
is an array, false otherwise.
Examples
editCheck if an array is an array | {{#af_print: {{#af_isarray: {{#af_list: a | b | c }} }} }} |
true |
Check if a string is an array | {{#af_print: {{#af_isarray: Hello, World! }} }} |
false |
af_join
editArrayFunctions version | ≥ 1.0 |
This parser function recursively joins the items of an array together with a given separator.
Description
edit{{#af_join: array | glue }}
Parameters
edit- array : array
- The array to join.
- glue : string, default=""
- The string used to join each item.
Return values
editReturns the joined array.
Examples
editJoin a one-dimensional array | {{#af_join: {{#af_list: a | b | c }} }} |
abc |
Join a one-dimensional array using a separator | {{#af_join: {{#af_list: a | b | c }} | \s-\s }} |
a - b - c |
Join a multi-dimensional array using a separator | {{#af_join: {{#af_list: a | b | {{#af_list: c | d }} }} | \s-\s }} |
a - b - c - d |
af_keysort
editArrayFunctions version | ≥ 1.0 |
This parser function sorts a list of objects based on the values of the specified key. To sort an array by key, use #af_ksort.
Description
edit{{#af_keysort: array | key | descending=descending | caseinsensitive=caseinsensitive }}
Parameters
edit- array : array
- The array to sort.
- key : string
- The key of the values on which the sort should be based.
- descending : boolean, default=false
- Whether to sort in a descending order.
- caseinsensitive : boolean, default=false
- Whether to ignore case when sorting.
Return values
editReturns the sorted array.
Examples
editSort based on age | {{#af_print: {{#af_keysort: {{#af_list: {{#af_object: name=John | age=56 }} | {{#af_object: name=Harry | age=12 }} | {{#af_object: name=Bob | age=24 }} }} | age }} }} |
|
Sort based on age, in descending order | {{#af_print: {{#af_keysort: {{#af_list: {{#af_object: name=John | age=56 }} | {{#af_object: name=Harry | age=12 }} | {{#af_object: name=Bob | age=24 }} }} | age | descending=true }} }} |
|
af_ksort
editArrayFunctions version | ≥ 1.7 |
This parser function sorts an array by key.
Description
edit{{#af_ksort: array | descending=descending | caseinsensitive=caseinsensitive }}
Parameters
edit- array : array
- The array to sort.
- descending : boolean, default=false
- Whether to sort in a descending order.
- caseinsensitive : boolean, default=false
- Whether to ignore case when sorting.
Return values
editReturns the sorted array.
Examples
editSort by key | {{#af_print: {{#af_ksort: {{#af_object: c=banana | a=orange | b=apple }} |
|
af_list
editArrayFunctions version | ≥ 1.0 |
This parser function creates a new list from the given parameters.
Description
edit{{#af_list: *values }}
Parameters
edit- *values : mixed
- The values for the list.
Return values
editReturns the resulting list.
Examples
editCreate a simple one-dimensional list | {{#af_print: {{#af_list: a | b | c }} }} |
|
Create a multi-dimensional list | {{#af_print: {{#af_list: {{#af_list: a | b }} | {{#af_list: c | d }} }} }} |
|
Create a list of objects | {{#af_print: {{#af_list: {{#af_object: name=Harry | age=22 }} | {{#af_object: name=Bobby | age=29 }} }} }} |
|
af_map
editArrayFunctions version | ≥ 1.0 |
This parser function applies a callback to each element of a list.
Description
edit{{#af_map: array | value_name | callback }}
Parameters
edit- array : array
- The array to run through the callback.
- value_name : string
- The name to give to the value in the callback.
- callback : string
- The callback to apply to each element of the array.
Return values
editReturns the resulting mapped array.
Examples
editAppending a string to each element | {{#af_print: {{#af_map: {{#af_list: a | b | c }} | v | {{{v}}}-appended }} }} |
|
Altering list elements | {{#af_print: {{#af_map: {{#af_list: {{#af_list: a }} | {{#af_list: b }} }} | v | {{#af_push: {{{v}}} | c }} }} }} |
|
af_merge
editArrayFunctions version | ≥ 1.2 |
This parser function computes the union of arrays. It merges the elements of one or more arrays together so that the values of one are appended to the end of the previous one.
If the input arrays have the same string key, then the later value for that key will overwrite the previous one. If the arrays contain numeric keys, later values will be appended instead and the later keys will be renumbered.
Description
edit{{#af_merge: array | *arrays }}
Parameters
edit- array : array
- The first array.
- *arrays : array
- The other arrays.
Return values
editReturns the union of the given arrays.
Examples
editAppending a string to each element | {{#af_print: {{#af_merge: {{#af_list: a | b | c }} | {{#af_list: d | e | f }} }} }} |
|
af_object
editArrayFunctions version | ≥ 1.0 |
This parser function creates a new object from the given parameters.
Description
edit{{#af_object: **values }}
Parameters
edit- **values : mixed
- The values for the object.
Return values
editReturns the resulting object.
Examples
editCreate a simple one-dimensional object | {{#af_print: {{#af_object: a=b | b=c | c=d }} }} |
|
Create a multi-dimensional object | {{#af_print: {{#af_object: head={{#af_object: title=MediaWiki | meta={{#af_list: {{#af_object: charset=UTF-8 }} }} }} }} }} |
|
af_print
editArrayFunctions version | ≥ 1.0 |
This parser function prints the given value for debug purposes. Unlike #af_show, it does not parse the value, but does support printing lists and objects. This function should only be used for debug purposes. Consider using #af_show to display a value to the reader.
Description
edit{{#af_print: *values | end=end }}
Parameters
edit- *values : mixed
- The values to print.
- end : string, default=""
- The string to append to the end of each printed value.
Return values
editReturns the value in human-readable form.
Examples
editPrint a boolean | {{#af_print: {{#af_bool: yes }} }} |
true |
Print a list | {{#af_print: {{#af_list: a | b | c }} }} |
|
af_push
editArrayFunctions version | ≥ 1.0 |
This parser function adds the given value to the end of the list.
Description
edit{{#af_push: array | value }}
Parameters
edit- array : array
- The array to append the value to.
- value : mixed
- The value to add.
Return values
editReturns the array with the value appended.
Examples
editPush a value | {{#af_print: {{#af_push: {{#af_list: a | b }} | c }} }} |
|
af_reduce
editArrayFunctions version | ≥ 1.2 |
This parser function iteratively reduces the array to a single value using a callback. It iteratively applies callable
to the elements of the given array, so as to reduce the array to a single value. The callable is passed the value of the current iteration, as well as the result of the previous iteration.
Description
edit{{#af_reduce: array | carry_name | value_name | callable | initial }}
Parameters
edit- array : array
- The array to reduce.
- carry_name : string
- The name to use for the carry.
- value_name : string
- The name to use for the value.
- callable : string
- The callback to use for each iteration.
- initial : string, default=""
- The initial carry to use.
Return values
editReturns the resulting value.
Examples
editUsing reduction to concatenate values | {{#af_reduce: {{#af_list: a | b | c }} | c | i | {{{c}}}{{{i}}} }} |
abc |
Using reduction to reverse and then concatenate values | {{#af_reduce: {{#af_list: a | b | c }} | c | i | {{{i}}}{{{c}}} }} |
cba |
Using reduction to build an equation | {{#af_reduce: {{#af_list: 2 | 3 | 5 | 7 | 11 }} | c | i | {{{c}}} + {{{i}}} | 0 }} |
0 + 2 + 3 + 5 + 7 + 11 |
af_search
editArrayFunctions version | ≥ 1.3 |
This parser function searches the given array for the given value, and returns the first corresponding key if the value is found.
Description
edit{{#af_search: array | value }}
Parameters
edit- array : array
- The array to search in.
- value : mixed
- The value to search for.
Return values
editReturns the first corresponding key if the value is found, nothing otherwise.
Examples
editSearch for a value in an array | {{#af_print: {{#af_search: {{#af_list: a | b | c }} | b }} }} |
1 |
af_set
editArrayFunctions version | ≥ 1.0 |
This parser function sets the given value for the given index.
Description
edit{{#af_set: value | array | *indices }}
Parameters
edit- value : mixed
- The value to set the index to.
- array : array
- To array in which to set the index.
- *indices : string
- The index to set. Multiple indices can be given to index nested arrays.
Return values
editReturns the array with the given index set to the given value.
Examples
editReplace an existing value | {{#af_print: {{#af_set: d | {{#af_list: a | b | c }} | 2 }} }} |
|
Create a new index | {{#af_print: {{#af_set: far | {{#af_object: foo=bar }} | boo }} }} |
|
Create a new subarray | {{#af_print: {{#af_set: far | {{#af_object: foo=bar }} | boo | far }} }} |
|
af_show
editArrayFunctions version | ≥ 1.4 |
This parser function prints the given value in a human-readable format. Unlike #af_print, this parser function parses the value. It does not support showing lists or objects.
Description
edit{{#af_show: value }}
Parameters
edit- value : mixed
- The value to show.
Return values
editReturns the value in human-readable form.
Examples
editShow a value | {{#af_show: Hello World! }} |
Hello World! |
af_slice
editArrayFunctions version | ≥ 1.0 |
This parser function extracts a slice from the given array. Keys will be reset and reordered.
Description
edit{{#af_slice: array | offset | length }}
Parameters
edit- array : array
- The array to take a slice from.
- offset : integer
- The offset at which the slice starts. If non-negative, the slice will start at this given offset. If negative, the sequence will start that far from the end of the array.
- length : integer, optional
- The length of the slice. If the length is given and positive, then the slice will have that many elements in it. If the length is given and negative, then the slice will stop that many elements from the end of the array. If it is omitted, then the slice will have everything from offset up until the end of the array.
Return values
editThe slice.
Examples
editGet the first two elements | {{#af_print: {{#af_slice: {{#af_list: a | b | c }} | 0 | 2 }} }} |
|
Get the last element | {{#af_print: {{#af_slice: {{#af_list: a | b | c }} | -1 }} }} |
|
af_sort
editArrayFunctions version | ≥ 1.0 |
This parser function sorts the given list.
Description
edit{{#af_sort: array | descending=descending | caseinsensitive=caseinsensitive }}
Parameters
edit- array : array
- The array to sort.
- descending : boolean, default=false
- Whether to sort the list in descending order.
- caseinsensitive : boolean, default=false
- Whether to ignore case when sorting.
Return values
editReturns the sorted list.
Examples
editSort a list in ascending order | {{#af_print: {{#af_sort: {{#af_list: b | c | a }} }} }} |
|
Sort a list in descending order | {{#af_print: {{#af_sort: {{#af_list: b | c | a }} | descending=true }} }} |
|
af_split
editArrayFunctions version | ≥ 1.1 |
This parser function splits the given string based on a delimiter.
Description
edit{{#af_split: string | delimiter }}
Parameters
edit- string : string
- The string to split.
- delimiter : string, default=","
- The delimiter to use.
Return values
editReturns the resulting list.
Examples
editSplit a string based on commas | {{#af_print: {{#af_split: a, b, c }} }} |
|
Split a sentence into words | {{#af_print: {{#af_split: Lorem ipsum dolor et | \s }} }} |
|
af_stringmap
editArrayFunctions version | ≥ 1.6 |
This parser function applies a callback to each item of a delimited string, and returns the result as a delimited string, optionally with a different delimiter. This function is similar to Page Forms' #arraymap parser function.
Description
edit{{#af_stringmap: value | delimiter | value_name | callback | new_delimiter | conjunction }}
Parameters
edit- value : string
- The delimited string.
- delimiter : string
- The delimiter to split
value
on. If the empty string is given, "," is used. - value_name : string
- The name to give to the value in the callback.
- callback : string
- The callback to apply to each element of the array.
- new_delimiter : string, default=", "
- The new delimiter to insert in between the mapped items.
- conjunction : string, default=null
- The delimiter to place between the last two items. This allows you to create a more natural summation, such as "Alice, Bob and Eve". If no value is given, the value of
new_delimiter
is used.
Return values
editReturns the resulting delimited string.
Examples
editTurn each item into a link | {{#af_stringmap: William Shakespeare, Stephen King, Mark Twain | , | x | [[{{{x}}}]] }} |
William Shakespeare, Stephen King, Mark Twain |
Turn a comma-separated list into a human-readable list | {{#af_stringmap: William Shakespeare, Stephen King, Mark Twain | , | x | {{{x}}} | ,\s | and }} |
William Shakespeare, Stephen King and Mark Twain |
af_template
editArrayFunctions version | ≥ 1.0 |
This parser function will invoke the given template and pass the values in the given array as arguments.
Description
edit{{#af_template: name | data }}
Parameters
edit- name : string
- The name of the template to invoke. If no namespace is given, it is assumed the page is in the template namespace, otherwise the given namespace is used. The page must exist, must be includable and must be readable by the user, otherwise an error is given.
- data : array
- The data to pass to the parameters. Values with numeric indices are passed as positional arguments and values with string indices are passed as named arguments.
Return values
editThe expanded template.
Examples
editInvoking a template with a list | {{#af_template: Echo | {{#af_list: a | b }} }} |
{{Echo|a|b}} |
Invoking a template with an object | {{#af_template: Echo | {{#af_object: foo=bar | boo=far }} }} |
{{Echo|foo=bar|boo=far}} |
af_trim
editArrayFunctions version | ≥ 1.8 |
This parser function will trim the given character from the beginning and the end of the given string.
Description
edit{{#af_trim: string | characters }}
Parameters
edit- string : string
- The string that will be trimmed.
- characters : string
- The characters to trim.
Return values
editThe trimmed string.
Examples
editTrimming a string | {{#af_trim: !a! | ! }} |
a |
Trimming every string in a list | {{#af_print: {{#af_map: {{#af_list: !a! | !b! | !c! }} | v | {{#af_trim: {{{v}}} | ! }} }} }} |
|
af_unique
editArrayFunctions version | ≥ 1.0 |
This parser function removes duplicate values from the given array. This function does not reset keys.
Description
edit{{#af_unique: array }}
Parameters
edit- array : array
- The array from which to remove duplicates.
Return values
editReturns the array with duplicates removed.
Examples
editRemove duplicates from an array | {{#af_print: {{#af_unique: {{#af_list: a | a | b | c | b }} }} }} |
|
af_unset
editArrayFunctions version | ≥ 1.0 |
This parser function removes the value associated with the given index from the array and returns the result. Numeric keys are not reset after calling this function.
Description
edit{{#af_unset: array | *indices }}
Parameters
edit- array : array
- The array from which to remove the given key.
- *indices : string
- The index to remove. Multiple indices can be given to index nested arrays.
Return values
editReturns the array with the given index removed.
Examples
editRemove a top-level index | {{#af_print: {{#af_unset: {{#af_list: a | b | c }} | 2 }} }} |
|
Remove a top-level index, keys not reset | {{#af_print: {{#af_unset: {{#af_list: a | b | c }} | 1 }} }} |
|
Remove a nested index | {{#af_print: {{#af_unset: {{#af_object: foo={{#af_object: bar=quz | far=buz }} }} | foo | bar }} }} |
|