\AdbarDot

__construct()

__construct(mixed  $items = array()) 

Create a new Dot instance

Parameters

add()

add(array|integer|string  $keys, mixed  $value = null) 

Set a given key / value pair or pairs if the key doesn't exist already

Parameters

all()

all() : array

Return all the stored items

Returns

clear()

clear(array|integer|string|null  $keys = null) 

Delete the contents of a given key or keys

Parameters

delete()

delete(array|integer|string  $keys) 

Delete the given key or keys

Parameters

flatten()

flatten(string  $delimiter = '.', array|null  $items = null, string  $prepend = '') : array

Flatten an array with the given character as a key delimiter

Parameters

Returns

get()

get(integer|string|null  $key = null, mixed  $default = null) : mixed

Return the value of a given key

Parameters

Returns

has()

has(array|integer|string  $keys) : boolean

Check if a given key or keys exists

Parameters

Returns

isEmpty()

isEmpty(array|integer|string|null  $keys = null) : boolean

Check if a given key or keys are empty

Parameters

Returns

merge()

merge(array|string|self  $key, array|self  $value = array()) 

Merge a given array or a Dot object with the given key or with the whole Dot object

Parameters

mergeRecursive()

mergeRecursive(array|string|self  $key, array|self  $value = array()) 

Recursively merge a given array or a Dot object with the given key or with the whole Dot object.

Duplicate keys are converted to arrays.

Parameters

mergeRecursiveDistinct()

mergeRecursiveDistinct(array|string|self  $key, array|self  $value = array()) 

Recursively merge a given array or a Dot object with the given key or with the whole Dot object.

Instead of converting duplicate keys to arrays, the value from given array will replace the value in Dot object.

Parameters

pull()

pull(integer|string|null  $key = null, mixed  $default = null) : mixed

Return the value of a given key and delete the key

Parameters

Returns

push()

push(mixed  $key, mixed  $value = null) 

Push a given value to the end of the array in a given key

Parameters

replace()

replace(array|string|self  $key, array|self  $value = array()) 

Replace all values or values within the given key with an array or Dot object

Parameters

set()

set(array|integer|string  $keys, mixed  $value = null) 

Set a given key / value pair or pairs

Parameters

setArray()

setArray(mixed  $items) 

Replace all items with a given array

Parameters

setReference()

setReference(array  $items) 

Replace all items with a given array as a reference

Parameters

toJson()

toJson(mixed  $key = null, integer  $options) : string

Return the value of a given key or all the values as JSON

Parameters

Returns

offsetExists()

offsetExists(integer|string  $key) : boolean

Check if a given key exists

Parameters

Returns

offsetGet()

offsetGet(integer|string  $key) : mixed

Return the value of a given key

Parameters

Returns

offsetSet()

offsetSet(integer|string|null  $key, mixed  $value) 

Set a given value to the given key

Parameters

offsetUnset()

offsetUnset(integer|string  $key) 

Delete the given key

Parameters

count()

count(integer|string|null  $key = null) : integer

Return the number of items in a given key

Parameters

Returns

getIterator()

getIterator() : \ArrayIterator

Get an iterator for the stored items

Returns

jsonSerialize()

jsonSerialize() : array

Return items for JSON serialization

Returns

exists()

exists(array  $array, integer|string  $key) : boolean

Checks if the given key exists in the provided array.

Parameters

Returns

getArrayItems()

getArrayItems(mixed  $items) : array

Return the given items as an array

Parameters

Returns

arrayMergeRecursiveDistinct()

arrayMergeRecursiveDistinct(array  $array1, array  $array2) : array

Merges two arrays recursively. In contrast to array_merge_recursive, duplicate keys are not converted to arrays but rather overwrite the value in the first array with the duplicate value in the second array.

Parameters

Returns