Extension:Arrays/Pre 2.0 Documentation

This page contains the documentation for Extension:Arrays (former ArrayExtension) for versions prior to version 2.0 (1.4 alpha to be exact). It also applies in case you are using version 2.0+ with active compatibility mode.

Differences compared to Arrays 2.0
The following breaking behavior changes were introduced with Arrays 2.0 (some already within 1.4 alpha). They are only active in case the compatibilty mode is not active, so they don't apply to the documentation on this page. You should aware of these if you want to upgrade to 2.0 without using compatibility mode.

Introduced in 1.4 alpha:
 * no longer returns an error text in case the array doesn't exist, just an empty string.
 * now uses n parameters instead of  as separator for n arrays to reset (with compatibility mode, both is supported but not both mixed together in one function call)
 * options removed, instead third parameter simply is the default value (without any  in front).
 * returns an empty string '' instead of ' ' in case nothing was found.
 * and  without all necessary parameters set will always create a new empty array.

Introduced in 2.0
 * will return its default also in case of existing index but empty value. This makes the function consistent with Variables  and HashTables.
 * ,  and   with only one array for the operation will make a copy of that array instead of creating no array at all (just like   behaved already).
 * Default separator for  now is the languages default separator instead of ' '.
 * will no longer expand the given wiki markup twice. Instead, it will escape special characters of array values before they will be inserted into the markup. This way it won't be possible anymore that array values can break the functions output.  defines which special characters should be escaped by which template/parser function.

In addition to these breaking changes, there are several other improvements in Arrays 2.0, see the RELEASE-NOTES for a full list.

Functions
This extension defines the following parser functions:

arraydefine
This function constructs an array (identified by 'key') using a list of 'values' separated by the 'delimiter'. The variable can be accessed by other functions later.

Syntax:

Notes:
 * values is a list of strings separated by delimiter
 * The resulting array is an array of strings.
 * The default delimiter is ',' if not specified, a delimiter can be (i) a string (the white-spaces surrounding delimiter will be trimmed) or (ii) a perl regular expression (for advanced user only), e.g. '/\s*,\s*/' (see preg_split)
 * Users can define an empty array (see example)
 * Users can specify options including unique, sort, and print (see example).

Examples:

arrayprint
This function prints the values of an array in customizable format.

Syntax:

Notes:
 * 'subject' accepts wiki links, templates and parser functions.
 * Within the 'subject, you don't have to escape pipe characters ' ', but you can since the whole will be parsed two times. Within the whole construct, the pattern will be searched an replaced with the current (un-escaped!) array value of each loop. Then the whole string will be parsed and put into an array of results which will be imploded with delimiter as separator. Finally, the whole result will be parsed a second time.
 * The second time parsing is due to historical reasons and is removed in Arrays 2.0 (without active compatibility mode)

Examples:

arrayindex
This function print the value of an array (identified by 'key') at position 'index'.

Syntax:

Notes:
 * Invalid index (non-number, out of bound) will result in printing an empty string.
 * The index is 0-based, i.e. the first element's index is 0.
 * Users can specify options on default value.

Examples:

arraysize
This function returns the size (number of elements) of an array. See: http://www.php.net/manual/en/function.count.php

In case the given array doesn't exist the output of the function will be a void string instead of a number. This allows to check whether the array exists.

Syntax:

Examples:

arraysearch
This function returns the index of the first occurrence of the 'value' in the array (identified by 'key') starting from the position identified by 'index' parameter, and returns '-1' when failed. when 'yes' and 'no' specified, print value of yes if found, and value of no otherwise. See: http://www.php.net/manual/en/function.array-search.php

Syntax:

Examples:

arraysearcharray
This function searches an array (identified by key) and creates a new array (identified by new_key) from the search with all the results. The search criteria value can be a string or a regular expression. If index is given the search will start there, limit can define the maximum search results. The parameter identified by transform can be used if value is a regular expression. It can transform the result of the matched entries into the new_key array like PHP preg_replace would do it.

Syntax:

Notes:
 * If value is a string the new_key array will only contain entries of exact this string.
 * Negative index values like  can be used to search the last n entries only.

Examples:

arrayslice
This function extracts a sub-array from an array (identified by 'key') into a new array (identified by 'new_key'). See: http://www.php.net/manual/en/function.array-slice.php

Syntax:

Notes:
 * Offset indicates starting point of slice, it can be (i) non-negative number (ii) negative number for backwards index (e.g. the last element of the array's offset is -1). offset is different from index (which must be non-negative number)
 * Length indicates how many element to extract. If it is omitted, then the sequence will have everything from offset up until the end of the array.
 * If offset is no less than array size, empty array will be returned, if offset if no greater than negative array size, a new array with all elements will be returned

Examples:

Alteration
Functions which alter an array directly instead of creating a new array.

arrayunique
This function converts an array (identified by 'key') into a set (no duplicated members, no empty element). see: http://www.php.net/manual/en/function.array-unique.php

Syntax:

Example:

arrayreset
This function free-up some or all defined arrays.

Syntax:

arraysort
This function sorts an array in the following order. Syntax:
 * (default) - no sort
 * - in descending order (see: http://www.php.net/manual/en/function.sort.php)
 * / - in ascending order (see:  http://www.php.net/manual/en/function.rsort.php)
 * - in random order (see: http://www.php.net/manual/en/function.array-rand.php)
 * - in reverse order (see: http://www.php.net/manual/en/function.array-reverse.php)

Note:
 * Each array element is being treated as a string, this means numbers might not be ordered as expected.

Examples:

Interaction Between Arrays
Functions which work with more than one array, creating one new array or overwriting an existing one as result.

arraymerge
This function merges values of two arrayes (identified by 'key1' and 'key2') into a new array (identified by 'new_key'). See: http://www.php.net/manual/en/function.array-merge.php Note: a wrong parameter will terminate this operation, and the array identified by 'new_key' will not be affected.

Syntax:

Note:
 * This merge is different from array_merge offered by PHP because it merges values instead of keys

Examples:

arrayunion
This function merges values of two arrayes (identified by 'key1' and 'key2') into a new array (identified by 'new_key') without duplicated values.

Syntax:

Notes:
 * This is a set operator, i.e., the returned array is a set without duplicated values.
 * Similar to arraymerge, this union operation works on values.

Example:

arraydiff
This function computes the (set theoretic) difference of two given arrays (identified by 'key1' and 'key2'), and the result array is identified by 'new_key'. The returned array (identified by 'key') is a set that contains elements in an array (identified by 'key1') but not in the other array (identified by 'key2'). See: http://www.php.net/manual/en/function.array-diff.php

Syntax:

Note:
 * This is a set operator, i.e. the returned array is a set without duplicated values.
 * This function can be used to test sub-class relation

Examples:

arrayintersect
This function computes the set theoretic intersection of two given arrays (identified by 'key1' and 'key2'), and the result array is identified by 'new_key'. See: http://www.php.net/manual/en/function.array-intersect.php

Syntax:

Note:
 * This is a set operator, i.e., the returned array is a set without duplicated values.

Example: