library arr

narrowspark/arr

A collection of utilities to manipulate arrays.

A PHP collection of utilities to manipulate arrays. Compatible with, PHP 7 and Php 7.1., _(*1)

, _(*2)

Master

, _(*3)

Develop

, _(*4)

• Installation
• Arr
  • Access methods
    • set
    • get
    • add
    • has
    • put
    • exists
    • update
    • forget
  • Enumerator
    • random
    • only
    • split
    • isAssoc
    • isIndexed
  • Transform
    • pop
    • swap
    • every
    • combine
    • collapse
    • divide
    • stripEmpty
    • unique
    • without
    • reindex
    • merger
    • extend
    • asHierarchy
    • groupBy
    • dot
    • flatten
    • expand
    • reset
    • extendDistinct
    • sortRecursive
    • zip
  • Traverse
    • map
    • filter
    • all
    • reject
    • where
    • first
    • last

Why?

Installation

Via Composer, _(*5)

``` bash $ composer require narrowspark/arr, <sub>(*6)</sub>

or

``` json
"require": {
    "narrowspark/arr": "~2.0"
}

Arr

All methods listed under "Arr"., <sub>(*7)</sub>

``` php use Narrowspark\Arr\Arr;, <sub>(*8)</sub>

// Returns a new array with the added key and value; // ['foo' => bar, 'arr' => 'narrowsaprk'] Arr::set(['foo' => bar], 'arr', 'narrowspark');, <sub>(*9)</sub>

#### set

Set an array item to a given value using "dot" notation. If no key is given to the method, the entire array will be replaced.
``` php
    $arr = Arr::set(['foo' => 'bar'], 'arr', 'narrowspark'); // ['foo' => 'bar', 'arr' => 'narrowspark']

get

Get an item from an array using "dot" notation. If key dont exist, you get a default value back., <sub>(*10)</sub>

``` php $arr = Arr::get(['foo' => 'bar'], 'foo', 'narrowspark'); // bar, <sub>(*11)</sub>

#### add

Add an element to the array at a specific location using the "dot" notation.

``` php
    $arr = Arr::add(['foo' => 'bar'], 'foo', 'narrowspark'); // ['foo' => ['bar', 'narrowspark']]

has

Check if an item exists in an array using "dot" notation., <sub>(*12)</sub>

``` php $arr = Arr::has(['foo' => 'bar'], 'foo'); // true, <sub>(*13)</sub>

#### update

Updates data at the given path.

``` php
    $increment = function ($value) {
        return $value + 1;
    };

    $arr = Arr::update(['foo' => 1], $increment); // ['foo' => 2]

forget

Remove one or many array items from a given array using "dot" notation., <sub>(*14)</sub>

``` php $arr = ['foo' => 'bar'], <sub>(*15)</sub>

Arr::forget($arr, 'foo');

$arr; // []

```, <sub>(*16)</sub>

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*17)</sub>

Testing

From the project directory, tests can be ran using phpunit, <sub>(*18)</sub>

Contributing

Please see CONTRIBUTING for details., <sub>(*19)</sub>

Credits

• Daniel Bannert
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*20)</sub>