diff --git a/api.md b/api.md deleted file mode 100644 index 80f4e3ac..00000000 --- a/api.md +++ /dev/null @@ -1,31 +0,0 @@ - -Warning: PHP Startup: Unable to load dynamic library 'curl' (tried: /usr/local/Cellar/php@7.2/7.2.20/lib/php/20170718/curl (dlopen(/usr/local/Cellar/php@7.2/7.2.20/lib/php/20170718/curl, 9): image not found), /usr/local/Cellar/php@7.2/7.2.20/lib/php/20170718/curl.so (dlopen(/usr/local/Cellar/php@7.2/7.2.20/lib/php/20170718/curl.so, 9): image not found)) in Unknown on line 0 -## Table of contents - -- [\Flextype\Component\Arr\Arr](#class-flextypecomponentarrarr) - -
- -### Class: \Flextype\Component\Arr\Arr - -| Visibility | Function | -|:-----------|:---------| -| public static | average(array $array, int/\integer $decimals) : int/\Flextype\Component\Arr\double
Returns the average value of the current array. | -| public static | createFromJson(\string $json, \boolean $assoc=true, \integer $depth=512, int/\integer $options) : array
Create an new Array from JSON string. | -| public static | createFromString(\string $str, \string $delimiter=null, \string $regEx=null) : array
Create an new Array object via string. | -| public static | delete(array $array, \string $path) : mixed
Deletes an array value using "dot notation". | -| public static | dot(array $array, \string $prepend=`''`) : array
Flatten a multi-dimensional associative array with dots. | -| public static | first(array $array) : mixed The first element
Returns the first element of an array | -| public static | get(array $array, \string $path, mixed $default=null) : mixed
Returns value from array using "dot notation". If the key does not exist in the array, the default value will be returned instead. | -| public static | isAssoc(array $array) : bool
Returns TRUE if the array is associative and FALSE if not. | -| public static | keyExists(array $array, mixed $path) : bool
Checks if the given dot-notated key exists in the array. | -| public static | last(array $array) : mixed The last element
Returns the last element of an array | -| public static | overwrite(array $array1, array $array2) : array
Overwrites an array with values from input arrays. Keys that do not exist in the first array will not be added! | -| public static | random(array $array) : mixed
Returns a random value from an array. | -| public | reverse(array $array, \boolean $preserve_keys=false) : array
Return an array with elements in reverse order. Non-numeric keys are not affected by this setting and will always be preserved. | -| public static | set(array $array, \string $path, mixed $value) : void
Sets an array value using "dot notation". | -| public static | size(array $array, int/\integer $mode) : void
Counts all elements in an array. COUNT_RECURSIVE (or 1), count will recursively count the array. This is particularly useful for counting all the elements of a multidimensional array. count does not detect infinite recursion. | -| public static | sort(array $array, \string $field, \string $direction=`'ASC'`, \Flextype\Component\Arr\const $method) : array
Sorts a multi-dimensional array by a certain field path | -| public static | toJson(array $array, int/\integer $options, \integer $depth=512) : string The JSON string
Converts an array to a JSON string | -| public static | undot(array $array) : array
Expands a dot notation array into a full multi-dimensional array. | -