Merge remote-tracking branch 'origin/master'

Author: minwork

docs/README.md

@@ -1,12 +1,26 @@
-# Documentation
+# Minwork Array
 
-### Welcome to the documentation page
+## Welcome to the documentation page
+
+Minwork Array library is focused on conviniently handling nested arrays as well as arrays of objects.
 
 {% hint style="info" %}
 Detailed documentation is always available through PHPDoc in your editor, so you can access it anytime.
 {% endhint %}
 
-We believe that the best way to learn some code is to see examples of using it. 
-That's why aside from detailed specification of each method we supply various examples of using it which will help in faster understanding it's purpose.  
+I believe that the best way to learn some code is to see it in action. That's why within this documentation, aside from detailed specification of each method you will find various examples of using it which will help in faster understanding it's purpose and applications.
+
+To quickly get started check out the links below or look at the full list of available methods in the left panel.
+
+{% page-ref page="common-methods/has.md" %}
+
+{% page-ref page="common-methods/get-getnestedelement.md" %}
+
+{% page-ref page="common-methods/set-setnestedelement.md" %}
+
+{% page-ref page="common-methods/remove.md" %}
+
+{% page-ref page="utility-methods/getfirstkey.md" %}
+
+{% page-ref page="utility-methods/getfirstvalue.md" %}
 
-To quickly get started check out [get](common-methods/get-getnestedelement.md), [set](common-methods/set-setnestedelement.md), [has](common-methods/has.md) and [remove](common-methods/remove.md) methods or look at the full list of available methods in the left panel\.

docs/SUMMARY.md

@@ -41,4 +41,8 @@
 * [random](utility-methods/random.md)
 * [shuffle](utility-methods/shuffle.md)
 * [nth](utility-methods/nth.md)
+* [getFirstKey](utility-methods/getfirstkey.md)
+* [getLastKey](utility-methods/getlastkey.md)
+* [getFirstValue](utility-methods/getfirstvalue.md)
+* [getLastValue](utility-methods/getlastvalue.md)
 

docs/manipulating-array/mapping.md

@@ -16,6 +16,15 @@ Applies a callback to the elements of given array. Arguments supplied to callbac
 For backward compatibility using `map(callable, array)` is still possible but is deprecated and will issue appropriate warning
 {% endhint %}
 
+#### Modes
+
+| Constant name | Description |
+| :--- | :--- |
+| MAP\_ARRAY\_KEY\_VALUE | Map array using callback in form of  `function($key, $value)` |
+| MAP\_ARRAY\_VALUE\_KEYS\_LIST | Map array using callback in form of  `function($value, $key1, $key2, ...)` |
+| MAP\_ARRAY\_KEYS\_ARRAY\_VALUE | Map array using callback in form of  `function(array $keys, $value)` |
+| MAP\_ARRAY\_VALUE\_KEY | Map array using callback in form of  `function($value, $key)` |
+
 #### Examples
 
 ```php
@@ -34,6 +43,10 @@ $array2 = [
 $mapKeyValue = function ($key, $value) {
     return "{$key} -> {$value}";
 };
+// Mind that $value is a first argument here
+$mapValueKey = function ($value, $key) {
+    return "{$key} -> {$value}";
+};
 $mapKeysValue = function ($keys, $value) {
     return implode('.', $keys) . " -> {$value}";
 };
@@ -44,6 +57,9 @@ $mapValueKeysList = function ($value, $key1, $key2) {
 // Equivalent to using MAP_ARRAY_KEY_VALUE as mode (3rd) argument
 Arr::map($array1, $mapKeyValue) -> ['0 -> a', '1 -> b', '2 -> c']
 
+// Resemble array_map function but with array supplied as first argument
+Arr::map($array1, $mapValueKey) -> ['0 -> a', '1 -> b', '2 -> c']
+
 // Map multidimensional array using keys array
 Arr::map($array2, $mapKeysValue, Arr::MAP_ARRAY_KEYS_ARRAY_VALUE) ->
 [

docs/utility-methods/getfirstkey.md

@@ -0,0 +1,24 @@
+# getFirstKey
+
+#### Definition
+
+```php
+Arr::getFirstKey(array $array): int|string|null
+```
+
+#### Description
+
+Get the first key of the given array without affecting the internal array pointer.
+
+Returns `null` if array is empty.
+
+#### Examples
+
+```php
+Arr::getFirstKey(['a' => 1, 'b' => 2, 'c' => 3]) -> 'a'
+
+Arr::getFirstKey([1, 2, 3]) -> 0
+
+Arr::getFirstKey([]) -> null
+```
+

docs/utility-methods/getfirstvalue.md

@@ -0,0 +1,24 @@
+# getFirstValue
+
+#### Definition
+
+```php
+Arr::getFirstValue(array $array): mixed|null
+```
+
+#### Description
+
+Get the first value of the given array without affecting the internal array pointer.
+
+Returns `null` if array is empty.
+
+#### Examples
+
+```php
+Arr::getFirstValue(['a' => 1, 'b' => 2, 'c' => 3]) -> 1
+
+Arr::getFirstValue([1, 2, 3, 4, 5]) -> 1
+
+Arr::getFirstValue([]) -> null
+```
+

docs/utility-methods/getlastkey.md

@@ -0,0 +1,24 @@
+# getLastKey
+
+#### Definition
+
+```php
+Arr::getLastKey(array $array): int|string|null
+```
+
+#### Description
+
+Get the last key of the given array without affecting the internal array pointer.
+
+Returns `null` if array is empty.
+
+#### Examples
+
+```php
+Arr::getLastKey(['a' => 1, 'b' => 2, 'c' => 3]) -> 'c'
+
+Arr::getLastKey([1, 2, 3]) -> 2
+
+Arr::getLastKey([]) -> null
+```
+

docs/utility-methods/getlastvalue.md

@@ -0,0 +1,24 @@
+# getLastValue
+
+#### Definition
+
+```php
+Arr::getLastValue(array $array): mixed|null
+```
+
+#### Description
+
+Get the last value of the given array without affecting the internal array pointer.
+
+Returns `null` if array is empty.
+
+#### Examples
+
+```php
+Arr::getLastValue(['a' => 1, 'b' => 2, 'c' => 3]) -> 3
+
+Arr::getLastValue([1, 2, 3, 4, 5]) -> 5
+
+Arr::getLastValue([]) -> null
+```
+