Skip to main content

Array lib

This guide provides documentation for the array class methods used in the AVRO framework.

is_assoc()​

Check if the given array is associative.

Parameters: array $arr

Usage Example:

$this->lib->array->is_assoc(...);
$this->lib->array->is_assoc([]); // False
$this->lib->array->is_assoc([0 => 'a', 1 => 'b']); // False
$this->lib->array->is_assoc(['a' => 1, 'b' => 2]); // True

array_key_rename()​

Rename key in an array.

Parameters: string $ext_key string $new_key array $arr

Usage Example:

$this->lib->array->array_key_rename(...);
$this->lib->array->array_key_rename('key1', 'key2', []); // False
$this->lib->array->array_key_rename('missing', 'new', ['a' => 1]); // False
$this->lib->array->array_key_rename('key1', 'key2', ['key1' => 'value']); // True

array_key_pos()​

Return the position of the key in the array.

Parameters: string $needle array $array

Usage Example:

$this->lib->array->array_key_pos(...);
$this->lib->array->array_key_pos('x', ['a' => 1, 'b' => 2]); // False
$this->lib->array->array_key_pos('b', ['a' => 1, 'b' => 2, 'c' => 3]); // True

is_elements_empty()​

Check if array elements are all empty.

Parameters: array $array

Usage Example:

$this->lib->array->is_elements_empty(...);
$this->lib->array->is_elements_empty([]); // True
$this->lib->array->is_elements_empty(['', null, 0]); // False
$this->lib->array->is_elements_empty(['', ' ', null]); // True

is_true_array()​

Check if a key exists and is an array in a given array.

Parameters: string $array_key array $array

Usage Example:

$this->lib->array->is_true_array(...);
$this->lib->array->is_true_array('data', []); // False
$this->lib->array->is_true_array('key', ['key' => 'value']); // False
$this->lib->array->is_true_array('key', ['key' => ['a' => 1]]); // True