Array of UDF Library

Functions38 public, 0 private

Performs a deep search in the provided array for the specified value. The matching is using the case insensitive "contains" operator. Returns an array of structs with information about the path for all elements with the specified value: { Key: string, Value: string, Path: string }
public	array	arrayContainsValue
Array to search through.
required	array	source
Simple value to search for.
required	string	value
Path to prepend in every path information.
	string	path
Copies the specified range in the provided array to a new array.
public	array	arrayCopyOfRange

required	array	source

required	numeric	startIndex

required	numeric	endIndex

	boolean	deepCopy	false
Compares the provided arrays with each other (case sensitive) and returns an array with elements not appearing in both arrays.
public	array	arrayDifference

required	array	array1

required	array	array2
Compares the provided arrays with each other (case insensitive) and returns an array with elements not appearing in both arrays.
public	array	arrayDifferenceNoCase

required	array	array1

required	array	array2
Returns the index of the first element matching the specified ID. The ID is retrieved using the public accessor getID(). Complex elements without the public accessor will be skipped. Numeric elements are also considered.
public	numeric	arrayFindByID
Array to search through.
required	array	source
ID to search for.
required	numeric	id
Returns the index of the first element matching the specified (simple) value. The matching is type insensitive.
public	numeric	arrayFindValue
Array to search through.
required	array	source
Simple value to search for.
required	string	value
Returns the first element of the provided array. May return NULL if the provided array is invalid or empty.
public	any	arrayFirst
Array to return the first element from.
required	any	source
Hashes all elements of the provided array. Returns the hash of all hashed elements combined.
public	string	arrayHash
Array to hash.
required	array	source
Algorithm to use for the hashing.
	string	algorithm	MD5
Encoding to use for the hashing.
	string	encoding	UTF-8
Returns the last element of the provided array. May return NULL if the provided array is invalid or empty.
public	any	arrayLast
Array to return the first element from.
required	any	source
Converts an array of objects to a struct using the public accessor for ID as key.
public	struct	arrayObjectToStruct

required	array	source
Appends the specified string to each simple value in the provided array. Returns a modified copy of the provided array.
public	array	arrayAppendInValues

required	array	target

required	string	append
Prepends the specified string to each simple value in the provided array. Returns a modified copy of the provided array.
public	array	arrayPrependInValues

required	array	target

required	string	prepend
Searches in the provided array using the specified regular expression and returns the index of the first occurrence.
public	numeric	arrayREfind

required	string	expression

required	array	source
Searches in the provided array using the specified regular expression and returns the index of the first occurrence.
public	numeric	arrayREfindNoCase

required	string	expression

required	array	source
Filters the provided array using the specified regular expression.
public	array	arrayREfilter

required	string	expression

required	array	source
Filters the provided array using the specified regular expression.
public	array	arrayREfilterNoCase

required	string	expression

required	array	source
Removes all common elements in the first array.
public	array	arrayRemoveAll
Array to remove the elements in.
required	array	array1
Array with elements to delete in the previous array.
required	array	array2

	struct	OPTIONS	{}

option	boolean	normalize	false
Attempts to remove the element with the specified ID in the provided array. Returns the array after removal.
public	array	arrayRemoveByID

required	array	source

required	any	id

	struct	OPTIONS	{}

option	boolean	byRef	true

public	array	arrayRemoveByIndex
Array to remove the indices from.
required	array	target
Array of indices to remove.
required	array	toRemove
Removes all duplicates in the provided array.
public	array	arrayRemoveDuplicates
The array to remove duplicates from.
required	array	source
Removes all duplicates in the provided array by using the specified selector.
public	array	arrayRemoveDuplicatesBySelector
The array to remove duplicates from.
required	array	source
The method call to evaluate, e.g.: getID()
required	string	selector
Removes all simple items in the provided array. Returns the array without simple items.
public	array	arrayRemoveSimpleItems

required	array	source

	struct	OPTIONS	{}

option	boolean	byRef	true
Removes all complex items in the provided array. Returns the array without complex items.
public	array	arrayRemoveComplexItems

required	array	source

	struct	OPTIONS	{}

option	boolean	byRef	true
Removes all empty values in the provided array. Strings containing only whitespaces, are considered empty.
public	array	arrayRemoveEmpty

required	array	target
Removes the specified simple value in the provided array. Ignores complex elements. This function is type insensitive.
public	array	arrayRemoveValue

required	array	array

required	string	value

	string	scope	ONE

public	array	arrayReplaceValue

required	array	source

required	string	find

required	string	replace
Reverses the order of items in the array.
public	array	arrayReverse

required	array	target
Shuffles the order of the items in the provided array.
public	array	arrayShuffle

required	array	target
Shrinks the provided array by removing entries based on the specified method.
public	array	arrayShrink

required	array	target

required	numeric	size

	"LAST", "RANDOM"	method	LAST
Sorts the provided array by the length of its values.
public	array	arraySortByLength
Array to sort by.
required	array	value
Type to sort by.
	"ASC", "DESC"	sortType	ASC
Sorts the provided array using the specified selector.
public	array	arraySortBySelector

required	array	source

required	string	selector

	string	order	ASC
Sorts the provided array using natural sort.
public	array	arraySortNatural

required	array	array

	"NUMERIC", "TEXT", "TEXTnoCASE"	sortType	TEXT

	"ASC", "DESC"	sortOrder	ASC
Transforms the provided array to a JavaScript compatible string.
public	string	arrayToJavaScript

required	array	array

	string	quote	'
Failsafe wrapper for the native [arrayToList] function.
public	string	arrayToList
Array to convert.
required	any	array
Delimiter used for the list.
	string	delimiter	,
Keep empty values.
	boolean	includeEmptyFields	false

	struct	OPTIONS	{}

option	string	prepend
character(s) to append in simple value elements
option	string	append
try to invoke toString() method on objects
option	boolean	toString	false
Trims all simple values in the provided array. Complex values are ignored.
public	array	arrayTrimValues
Array with the values to trim.
required	array	array
How to trim the values. SIMPLE: Remove leading and trailing whitespaces. EXTENDED: Remove leading, trailing and consecutive whitespaces.
	string	level	SIMPLE
Wraps each simple value in the provided array with the specified string. Returns a modified copy of the provided array.
public	array	arrayWrapValues

required	array	target

required	string	prefix
If omitted, prefix is used as postfix.
	string	postfix
Returns if the array consists of empty strings and only empty strings.
public	boolean	isArrayWithEmptyStrings
Array to inspect.
required	any	source
Retrieves all values of the specified column in the provided query. Returns an array with the fetched values.
public	array	valueArray
Query to extract the data from.
required	query	query
Name of the column to get values from.
required	string	column