Merge remote-tracking branch 'origin/master'

Author: minwork

README.md

@@ -29,5 +29,5 @@
 
 ## Documentation
 
-[https://minwork.gitbook.io/array/](https://minwork.gitbook.io/array/documentation-1/overview)
+[https://minwork.gitbook.io/array/](https://minwork.gitbook.io/array/documentation/)
 

SUMMARY.md

@@ -1,12 +1,45 @@
 # Table of contents
 
 * [Minwork Array](README.md)
+* [Documentation](documentation.md)
 
-## Documentation
+## Common methods
 
-* [Overview](documentation-1/overview.md)
-* [Common methods](documentation-1/common.md)
-* [Validating array](documentation-1/validating-array.md)
-* [Manipulating array](documentation-1/manipulating-array.md)
-* [Utility methods](documentation-1/utility-methods.md)
+* [has](common-methods/has.md)
+* [get → getNestedElement](common-methods/get-getnestedelement.md)
+* [set → setNestedElement](common-methods/set-setnestedelement.md)
+* [remove](common-methods/remove.md)
+* [clone](common-methods/clone.md)
+* [getKeysArray](common-methods/getkeysarray.md)
+
+## Validating array
+
+* [check](validating-array/check.md)
+* [isEmpty](validating-array/isempty.md)
+* [isNested](validating-array/isnested.md)
+* [isArrayOfArrays](validating-array/isarrayofarrays.md)
+* [isAssoc](validating-array/isassoc.md)
+* [isUnique](validating-array/isunique.md)
+* [isNumeric](validating-array/isnumeric.md)
+* [hasKeys](validating-array/haskeys.md)
+
+## Manipulating array
+
+* [Mapping](manipulating-array/untitled.md)
+* [Filtering](manipulating-array/filtering.md)
+* [Grouping](manipulating-array/grouping.md)
+* [Sorting](manipulating-array/sorting.md)
+* [Computations](manipulating-array/computation.md)
+* [Flattening](manipulating-array/flattening.md)
+
+## Utility methods
+
+* [pack](utility-methods/pack.md)
+* [unpack](utility-methods/unpack.md)
+* [createMulti](utility-methods/untitled.md)
+* [forceArray](utility-methods/forcearray.md)
+* [getDepth](utility-methods/getdepth.md)
+* [random](utility-methods/random.md)
+* [shuffle](utility-methods/shuffle.md)
+* [nth](utility-methods/nth.md)
 

common-methods/clone.md

@@ -0,0 +1,41 @@
+# clone
+
+#### Definition
+
+```php
+Arr::clone(array $array): array
+```
+
+#### Description
+
+Copy array and clone every object inside it
+
+#### Examples
+
+```php
+$object = new class() {
+    public $counter = 1;
+
+    function __clone()
+    {
+        $this->counter = 2;
+    }
+};
+
+$array = [
+    'foo',
+    'bar',
+    $object,
+    'test',
+    'nested' => [
+        'object' => $object
+    ]
+];
+
+$cloned = Arr::clone($array);
+
+$cloned[0] -> 'foo'
+$cloned[2]->counter -> 2
+$cloned['nested']['object']->counter -> 2
+```
+

common-methods/get-getnestedelement.md

@@ -0,0 +1,32 @@
+# get → getNestedElement
+
+#### Definition
+
+```php
+Arr::getNestedElement(array|ArrayAccess $array, mixed $keys, mixed $default = null): mixed
+```
+
+#### Aliases
+
+```php
+get($array, $keys, $default = null) -> getNestedElement($array, $keys, $default)
+```
+
+#### Description
+
+Get nested array element using specified keys or return `$default` value if it does not exists.
+
+#### Examples
+
+```php
+$array = ['key1' => ['key2' => ['key3' => ['test']]]];
+
+Arr::getNestedElement($array, 'key1.key2.key3') -> ['test']
+
+Arr::getNestedElement($array, 'key1.key2.key3.0') -> 'test'
+
+Arr::getNestedElement($array, ['nonexistent', 'key'], 'default') -> 'default'
+
+Arr::getNestedElement($array, 'nonexistent.key.without.default') -> null
+```
+

common-methods/getkeysarray.md

@@ -0,0 +1,30 @@
+# getKeysArray
+
+#### Definition
+
+```php
+Arr::getKeysArray(mixed $keys): array
+```
+
+#### Description
+
+Transform variable into standardised array of keys.
+
+{% hint style="info" %}
+All `$keys` arguments in other methods are normalized using this method
+{% endhint %}
+
+#### Examples
+
+```php
+Arr::getKeysArray(0) -> [0]
+
+Arr::getKeysArray(null) -> []
+
+Arr::getKeysArray('key') -> ['key']
+
+Arr::getKeysArray('key1.0.key2.1') -> ['key1', '0', 'key2', '1']
+
+Arr::getKeysArray([null, 'key1', '', 'key2', 3.1415, 0]) -> ['key1', 'key2', 0]
+```
+

common-methods/has.md

@@ -0,0 +1,39 @@
+# has
+
+#### Definition
+
+```php
+Arr::has(array $array, $keys): bool
+```
+
+#### Description
+
+Check if specified \(nested\) key\(s\) exists in array
+
+#### Examples
+
+```php
+$array = [
+    'foo' => [
+        1,
+        'test' => [
+            'abc' => 2,
+            'def'
+        ],
+        [
+            'bar' => true
+        ],
+    ],
+];
+
+Arr::has($array, 'foo') -> true
+Arr::has($array, 'foo.0') -> true
+Arr::has($array, 'foo.test') -> true
+Arr::has($array, 'foo.test.abc') -> true
+Arr::has($array, ['foo', 1, 'bar']) -> true
+
+Arr::has($array, 'test') -> false
+Arr::has($array, []) -> false
+Arr::has($array, 'not.existing.key') -> false
+```
+

common-methods/remove.md

@@ -0,0 +1,78 @@
+# remove
+
+#### Definition
+
+```php
+Arr::remove(array $array, $keys): array
+```
+
+#### Description
+
+Remove element inside array at path specified by keys
+
+#### Examples
+
+```php
+$array = [
+    'foo' => [
+        1,
+        'test' => [
+            'abc' => 2,
+            'def'
+        ],
+        [
+            'bar' => true
+        ],
+    ],
+];
+
+Arr::remove($array, 'foo') -> []
+Arr::remove($array, '') -> $array
+Arr::remove($array, []) -> $array
+
+Arr::remove($array, 'foo.test.abc') ->
+[
+    'foo' => [
+        1,
+        'test' => [
+            // Removed
+            //'abc' => 2,
+            'def'
+        ],
+        [
+            'bar' => true
+        ],
+    ],
+]
+
+Arr::remove($array, 'foo.test') ->
+[
+    'foo' => [
+        1,
+        // Removed
+        /*'test' => [
+            'abc' => 2,
+            'def'
+        ],*/
+        [
+            'bar' => true
+        ],
+    ],
+]
+
+Arr::remove($array, ['foo', 1, 'bar']) ->
+[
+    'foo' => [
+        1,
+        'test' => [
+            'abc' => 2,
+            'def'
+        ],
+        [
+            // Removed
+            //'bar' => true
+        ],
+    ],
+]
+```
+

common-methods/set-setnestedelement.md

@@ -0,0 +1,41 @@
+# set → setNestedElement
+
+#### Definition
+
+```php
+Arr::setNestedElement(array $array, mixed $keys, mixed $value): array
+```
+
+#### Aliases
+
+```php
+set(array $array, $keys, $value) -> setNestedElement(array $array, $keys, $value)
+```
+
+#### Description
+
+Set array element specified by keys to the desired value \(create missing keys if necessary\).
+
+#### Examples
+
+```php
+$array = ['key1' => ['key2' => ['key3' => ['test']]]];
+
+Arr::setNestedElement([], 'key1.key2.key3', ['test']) -> $array
+
+$array = Arr::setNestedElement($array, 'key1.key2.key4', 'test2');
+$array['key1']['key2']['key4'] -> 'test2'
+
+// Create nested array element using automatic index
+Arr::setNestedElement($array, 'foo.[].foo', 'bar') -> 
+[
+    'foo' => [
+        [
+            'foo' => 'bar',
+        ],
+    ],
+]
+
+Arr::setNestedElement([], '[].[].[]', 'test') -> [ [ [ 'test' ] ] ]
+```
+