ArrayHelper
in package
Table of Contents
Methods
- assertKeys() : array<string|int, mixed>
- The return is a 1-dim array as an alternative to set the variables, like: [$var1, $var2] = assertAllowedKeys($data, ['var1', 'var2']);
- convertMapInArray() : array<string|int, mixed>
- convertMapToString() : string
- convertToString() : string
- copySelectedKeysFromMap() : mixed
- mergeArrayUsingKey() : array<string|int, mixed>
- mergeKeysNotEmpty() : mixed
- onlyIntKeys() : array<string|int, mixed>
- onlyObject() : object
- onlyStringKeys() : array<string|int, mixed>
- onlyStringKeysMap() : array<string|int, mixed>
- Two dimensional array (2-dim, map or associative array) with only string keys
- parseStringInArray() : mixed
- transpose() : array<string|int, mixed>
Methods
assertKeys()
The return is a 1-dim array as an alternative to set the variables, like: [$var1, $var2] = assertAllowedKeys($data, ['var1', 'var2']);
public
static assertKeys(array<string|int, mixed> $array, array<string|int, mixed> $allowed_keys[, bool $allowed_empty = true ][, bool $must_have = true ]) : array<string|int, mixed>
If you want a 2-dim array, call this function to assert the keys but ignore the return, and use the original 'array' parameter
Parameters
- $array : array<string|int, mixed>
- $allowed_keys : array<string|int, mixed>
- $allowed_empty : bool = true
- $must_have : bool = true
Return values
array<string|int, mixed>convertMapInArray()
public
static convertMapInArray(array<string|int, mixed> $map, array<string|int, mixed> $sorted_keys) : array<string|int, mixed>
Parameters
- $map : array<string|int, mixed>
- $sorted_keys : array<string|int, mixed>
Return values
array<string|int, mixed>convertMapToString()
public
static convertMapToString(array<string|int, mixed> $array[, string $str_before_key = "" ][, string $str_after_key_before_value = ": " ][, string $str_after_value = ", " ][, bool $remove_last_str_after_value = true ]) : string
Parameters
- $array : array<string|int, mixed>
- $str_before_key : string = ""
- $str_after_key_before_value : string = ": "
- $str_after_value : string = ", "
- $remove_last_str_after_value : bool = true
Return values
stringconvertToString()
public
static convertToString(array<string|int, mixed> $array[, string $str_before_value = "" ][, string $str_after_value = "" ][, bool $remove_last_str_after_value = false ]) : string
Parameters
- $array : array<string|int, mixed>
- $str_before_value : string = ""
- $str_after_value : string = ""
- $remove_last_str_after_value : bool = false
Return values
stringcopySelectedKeysFromMap()
public
static copySelectedKeysFromMap(array<string|int, mixed> $a, array<string|int, mixed> $selected_keys) : mixed
Parameters
- $a : array<string|int, mixed>
- $selected_keys : array<string|int, mixed>
mergeArrayUsingKey()
public
static mergeArrayUsingKey(array<string|int, mixed> $array1, array<string|int, mixed> $array2, string $key) : array<string|int, mixed>
Parameters
- $array1 : array<string|int, mixed>
- $array2 : array<string|int, mixed>
- $key : string
Return values
array<string|int, mixed>mergeKeysNotEmpty()
public
static mergeKeysNotEmpty(array<string|int, mixed> $a1, array<string|int, mixed> $a2[, array<string|int, mixed> $keys_exceptions = [] ]) : mixed
Parameters
- $a1 : array<string|int, mixed>
- $a2 : array<string|int, mixed>
- $keys_exceptions : array<string|int, mixed> = []
onlyIntKeys()
public
static onlyIntKeys(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
Return values
array<string|int, mixed>onlyObject()
public
static onlyObject(array<string|int, mixed> $array) : object
Parameters
- $array : array<string|int, mixed>
Return values
objectonlyStringKeys()
public
static onlyStringKeys(array<string|int, mixed>|null $array) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>|null
Return values
array<string|int, mixed>onlyStringKeysMap()
Two dimensional array (2-dim, map or associative array) with only string keys
public
static onlyStringKeysMap(array<string|int, mixed>|null $map[, string|array<string|int, mixed> $field_key = "" ][, mixed $field_key_callback = null ]) : array<string|int, mixed>
Parameters
- $map : array<string|int, mixed>|null
- $field_key : string|array<string|int, mixed> = ""
- $field_key_callback : mixed = null
Return values
array<string|int, mixed>parseStringInArray()
public
static parseStringInArray(string $string, string $separator, array<string|int, mixed> $keys) : mixed
Parameters
- $string : string
- $separator : string
- $keys : array<string|int, mixed>
transpose()
public
static transpose(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>