Arikaim CMS

Arrays
in package

Array helpers

Table of Contents

Methods

arrayAppend()  : array<string|int, mixed>
Append values from append array to array
arrayColumns()  : array<string|int, mixed>
Filer array columns
arrayInsert()  : array<string|int, mixed>
Recursive insert array
convertToArray()  : array<string|int, mixed>
Convert object to array
getDefaultValue()  : mixed
Get default value
getValue()  : mixed
Get array value by key path
getValues()  : array<string|int, mixed>
Get array value
haveSubItems()  : bool
Return true if array have sub items
isAssociative()  : bool
Return true if array is associative
merge()  : array<string|int, mixed>
Merge arrays
numberFormat()  : array<string|int, mixed>
Format all numeric values in array
recursiveCount()  : int
Recursive array count
removeEmpty()  : array<string|int, mixed>
Remove empty values from array
setDefault()  : array<string|int, mixed>
Set default value if key not exist in array
setValue()  : array<string|int, mixed>
Set array value
sliceByKeys()  : array<string|int, mixed>
Slice array by keys
toArray()  : array<string|int, mixed>
Convert text to array
toPath()  : string
Convert array to path
toString()  : string
Convert array values to string
unique()  : array<string|int, mixed>
Return array with unique values
uniqueMultidimensional()  : array<string|int, mixed>
Unique multidimensional array

Methods

arrayAppend()

Append values from append array to array

public static arrayAppend(array<string|int, mixed> $array, array<string|int, mixed> $append) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
$append : array<string|int, mixed>
Return values
array<string|int, mixed>

arrayColumns()

Filer array columns

public static arrayColumns(array<string|int, mixed> $data, array<string|int, mixed> $keys) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$keys : array<string|int, mixed>
Return values
array<string|int, mixed>

arrayInsert()

Recursive insert array

public static arrayInsert(array<string|int, mixed> $array, array<string|int, mixed> $insert) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
$insert : array<string|int, mixed>
Return values
array<string|int, mixed>

convertToArray()

Convert object to array

public static convertToArray(object $object) : array<string|int, mixed>
Parameters
$object : object
Return values
array<string|int, mixed>

getDefaultValue()

Get default value

public static getDefaultValue(array<string|int, mixed> $array, string $key[, mixed $default = null ]) : mixed
Parameters
$array : array<string|int, mixed>
$key : string
$default : mixed = null

getValue()

Get array value by key path

public static getValue(array<string|int, mixed> $array, string|array<string|int, mixed> $path[, string $separator = '/' ]) : mixed
Parameters
$array : array<string|int, mixed>
$path : string|array<string|int, mixed>
$separator : string = '/'

getValues()

Get array value

public static getValues(array<string|int, mixed> $array, string $keySearch) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
$keySearch : string
Return values
array<string|int, mixed>

haveSubItems()

Return true if array have sub items

public static haveSubItems(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>
Return values
bool

isAssociative()

Return true if array is associative

public static isAssociative(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>
Return values
bool

merge()

Merge arrays

public static merge(array<string|int, mixed> $array1, array<string|int, mixed> $array2[, string $prevKey = '' ][, string $fullKey = '' ]) : array<string|int, mixed>
Parameters
$array1 : array<string|int, mixed>
$array2 : array<string|int, mixed>
$prevKey : string = ''
$fullKey : string = ''
Return values
array<string|int, mixed>

numberFormat()

Format all numeric values in array

public static numberFormat(array<string|int, mixed> $array[, int $decimals = 2 ][, string|null $decimalSeparator = '.' ][, string|null $thousandsSeparator = ' ' ]) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
$decimals : int = 2
$decimalSeparator : string|null = '.'
$thousandsSeparator : string|null = ' '
Return values
array<string|int, mixed>

recursiveCount()

Recursive array count

public static recursiveCount(mixed $array) : int
Parameters
$array : mixed
Return values
int

removeEmpty()

Remove empty values from array

public static removeEmpty(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
Return values
array<string|int, mixed>

setDefault()

Set default value if key not exist in array

public static setDefault(array<string|int, mixed> $array, string|int $key, mixed $value) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
$key : string|int
$value : mixed
Return values
array<string|int, mixed>

setValue()

Set array value

public static setValue(array<string|int, mixed> $array, string $path, mixed $value[, string $separator = '/' ]) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
$path : string
$value : mixed
$separator : string = '/'
Return values
array<string|int, mixed>

sliceByKeys()

Slice array by keys

public static sliceByKeys(array<string|int, mixed> $array[, array<string|int, mixed>|string|null $keys = null ]) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
$keys : array<string|int, mixed>|string|null = null
Return values
array<string|int, mixed>

toArray()

Convert text to array

public static toArray(string $text[, string|null $separator = null ]) : array<string|int, mixed>
Parameters
$text : string
$separator : string|null = null
Return values
array<string|int, mixed>

toPath()

Convert array to path

public static toPath(array<string|int, mixed> $array) : string
Parameters
$array : array<string|int, mixed>
Return values
string

toString()

Convert array values to string

public static toString(array<string|int, mixed> $array[, string|null $separator = null ]) : string
Parameters
$array : array<string|int, mixed>
$separator : string|null = null
Return values
string

unique()

Return array with unique values

public static unique(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
Return values
array<string|int, mixed>

uniqueMultidimensional()

Unique multidimensional array

public static uniqueMultidimensional(array<string|int, mixed> $array) : array<string|int, mixed>
Parameters
$array : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results