Zymba Documentation
Array
Text
object @Array() {
clear(object $array): object {}
combine(object $keys, object $values): object {}
complementByKeys(object $array, ...$arrays): object {}
complementByValues(object $array, ...$arrays): object {}
concat(object $array, ...$arrays): object {}
contains(object $array, ...$arrays): bool {}
count(object $array): int {}
countDistinctValues(object $array): int {}
countUsedValues(object $array): object {}
countValue(object $array, mixed $value): int {}
createAssociative(object $keys, mixed $value): object {}
createIndex(int $length, mixed $value): object {}
createRange(number $from, number $to, number $step): object {}
equals(object $array1, object $array2): bool {}
equalsInOrder(object $array1, object $array2): bool {}
every(object $array, function $callback, ?object $bind): bool {}
filter(object $array, function $callback, ?object $bind): object {}
findKey(object $array, function $callback, ?object $bind): int {}
findValue(object $array, function $callback, ?object $bind): mixed {}
firstKey(object $array): int {}
firstValue(object $array): mixed {}
flip(object $array, ?string $key): object {}
forEach(object $array, function $callback, ?object $bind) {}
fromCSV(string $string, string $delimiter): object {}
getUniformType(object $array): string {}
hasAllKeys(object $array, object $keys): bool {}
hasAllValues(object $array, object $values): bool {}
hasAnyKeys(object $array, object $keys): bool {}
hasAnyValues(object $array, object $values): bool {}
hasKey(object $array, string $key): bool {}
hasSameKeys(object $array1, object $array2): bool {}
hasSameKeysInOrder(object $array1, object $array2): bool {}
hasSameValues(object $array1, object $array2): bool {}
hasValue(object $array, mixed $value): bool {}
head(object $array): object {}
insert(object $array, object $values, int $offset): object {}
intersectByKeys(object $array, ...$arrays): object {}
intersectByValues(object $array, ...$arrays): object {}
isEmpty(object $array): bool {}
isIndexed(object $array): bool {}
isMultidimensional(object $array): bool {}
joinKeys(object $array, string $delimiter): string {}
joinNonEmptyValues(object $array, string $delimiter, ?string $key): string {}
joinValues(object $array, string $delimiter, ?string $key): string {}
keyAt(object $array, int $offset): int {}
keyOf(object $array, mixed $value): int {}
lastKey(object $array): int {}
lastKeyOf(object $array, mixed $value): int {}
lastValue(object $array): mixed {}
linearize(object $array, string $key): object {}
listKeys(object $array): object {}
listValues(object $array, ?string $key): object {}
map(object $array, function $callback, ?object $bind): object {}
merge(object $array, ...$arrays): object {}
pad(object $array, int $length, mixed $padding): object {}
partition(object $array, int $length): object {}
pop(object $array): mixed {}
push(object $array, mixed $value): object {}
randomKey(object $array): int {}
randomValue(object $array): mixed {}
reduce(object $array, mixed $initial, function $callback, ?object $bind): mixed {}
reindex(object $array, int $initial): object {}
remove(object $array, ...$arrays): object {}
removeKey(object $array, string $key): object {}
removeKeys(object $array, object $keys): object {}
removeValue(object $array, mixed $value): object {}
removeValues(object $array, object $values): object {}
repeat(object $values, int $count): object {}
replace(object $array, ...$arrays): object {}
reverse(object $array): object {}
shift(object $array): mixed {}
shuffle(object $array): object {}
slice(object $array, int $offset, ?int $length): object {}
some(object $array, function $callback, ?object $bind): bool {}
sortAscByKeys(object $array): object {}
sortAscByValues(object $array, ?string $key): object {}
sortByKeys(object $array, function $callback, ?object $bind): object {}
sortByValues(object $array, function $callback, ?object $bind, ?string $key): object {}
sortDescByKeys(object $array): object {}
sortDescByValues(object $array, ?string $key): object {}
sortMultidimensional(object $array, object $callbacks, ?object $bind): object {}
sortNaturalAscByKeys(object $array): object {}
sortNaturalAscByValues(object $array, ?string $key): object {}
sortNaturalDescByKeys(object $array): object {}
sortNaturalDescByValues(object $array, ?string $key): object {}
splice(object $array, int $offset, ?int $length, object $replacement): object {}
tail(object $array): object {}
toCSV(object $array, string $delimiter, bool $enclosed): string {}
toLowerKeys(object $array): object {}
toLowerKeys(object $array): object {}
toUpperKeys(object $array): object {}
toUpperKeys(object $array): object {}
unionByKeys(object $array, ...$arrays): object {}
unionByValues(object $array, ...$arrays): object {}
unique(object $array, ?string $key): object {}
unshift(object $array, mixed $value): object {}
valueAt(object $array, string $key): mixed {}
}
Static array related prototypes and functions.
Functions
CODE
@Array.forEach(object $array, function $callback, ?object $bind): void
Parameters
| Name | Type | Value | Default |
|---|---|---|---|
| array | object | [] | |
| callback | function | null | |
| bind | ?object | null |
Inserts specific values into an array at a specific offset.
CODE
@Array.insert(object $array, object $values, int $offset): object
Parameters
| Name | Type | Value | Default |
|---|---|---|---|
| array | object | [] | |
| values | object | [value, ...] | [] |
| offset | int | 0 |
Returns
| Type | Value |
|---|---|
object | [(non-numeric-original-key: original-value) / original-value-if-numeric-key, ..., inserted-value, ..., (non-numeric-original-key: original-value) / original-value-if-numeric-key, ...] |
Joins the values of an array to form a string representation with each value separated by a specific delimiter, whereas empty string values are ignored.
CODE
@Array.joinNonEmptyValues(object $array, string $delimiter, ?string $key): string
Parameters
| Name | Type | Value | Default |
|---|---|---|---|
| array | object | [] | |
| delimiter | string | "" | |
| key | ?string | unidimensional |
Returns
| Type | Value |
|---|---|
string |
Merges an array with specific elements, whereas duplicate non-numeric keys are overwritten while elements with numeric keys are appended.
CODE
@Array.merge(object $array, variadic $arrays): object
Parameters
| Name | Type | Value | Default |
|---|---|---|---|
| array | object | [] | |
| arrays | variadic | [key: value, ...] | ... |
Returns
| Type | Value |
|---|---|
object | [original-key: (elements-value / original-value), ..., (supplemental-non-numeric-elements-key: elements-value) / elements-value-if-numeric-key, ...] |
Pads an array to a specific length by repeatedly filling it with a specific padding value.
CODE
@Array.pad(object $array, int $length, mixed $padding): object
Parameters
| Name | Type | Value | Default |
|---|---|---|---|
| array | object | [] | |
| length | int | 0 | |
| padding | mixed | null |
Returns
| Type | Value |
|---|---|
object | [(non-numeric-original-key: original-value) / original-value-if-numeric-key, ..., padding-value, ...] |
Repeatedly concatenates specific values to themselves and returns the aligned end-to-end array.
CODE
@Array.repeat(object $values, int $count): object
Parameters
| Name | Type | Value | Default |
|---|---|---|---|
| values | object | [value, ...] | [] |
| count | int | 1 |
Returns
| Type | Value |
|---|---|
object | [first-value, ..., last-value, first-value, ..., last-value, ...] |
Replaces specific elements of an array based on common keys.
CODE
@Array.replace(object $array, variadic $arrays): object
Parameters
| Name | Type | Value | Default |
|---|---|---|---|
| array | object | [] | |
| arrays | variadic | [key: value, ...] | ... |
Returns
| Type | Value |
|---|---|
object | [original-key: (elements-value / original-value), ..., supplemental-elements-key: elements-value, ...] |
Sorts an array by keys in a particular order determined by a specific comparison callback function.
CODE
@Array.sortByKeys(object $array, function $callback, ?object $bind): object
Parameters
| Name | Type | Value | Default |
|---|---|---|---|
| array | object | [] | |
| callback | function | null | |
| bind | ?object | null |
Returns
| Type | Value |
|---|---|
object | [reordered-key: original-value, ...] |
Sorts an array by values in a particular order determined by a specific comparison callback function.
CODE
@Array.sortByValues(object $array, function $callback, ?object $bind, ?string $key): object
Parameters
| Name | Type | Value | Default |
|---|---|---|---|
| array | object | [] | |
| callback | function | null | |
| bind | ?object | null | |
| key | ?string | unidimensional |
Returns
| Type | Value |
|---|---|
object | [original-key: reordered-value, ...] |
Extracts a specific portion of an array and replaces it with specific replacement values.
CODE
@Array.splice(object $array, int $offset, ?int $length, object $replacement): object
Parameters
| Name | Type | Value | Default |
|---|---|---|---|
| array | object | [] | |
| offset | int | 0 | |
| length | ?int | maximum length | |
| replacement | object | [value, ...] | [] |
Returns
| Type | Value |
|---|---|
object | [extracted-key: extracted-value, ...] |
CODE
@Array.unionByValues(object $array, variadic $arrays): object
Parameters
| Name | Type | Value | Default |
|---|---|---|---|
| array | object | [] | |
| arrays | variadic | [key: value, ...] | ... |
Returns
| Type | Value |
|---|---|
object | [original-key: (supplemental-elements-value / original-value), ..., (non-numeric-elements-key: supplemental-elements-value) / supplemental-elements-value-if-numeric-key, ...] |