https://github.com/narrowspark/arr

:shipit: A collection of utilities to manipulate arrays.
https://github.com/narrowspark/arr

array array-helper array-manipulations array-methods dot-notation manipulate-arrays multi-array php7

Last synced: 5 days ago
JSON representation

:shipit: A collection of utilities to manipulate arrays.

• Host: GitHub
• URL: https://github.com/narrowspark/arr
• Owner: narrowspark
• License: mit
• Archived: true
• Created: 2016-01-09T21:00:26.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-06-26T06:51:36.000Z (over 2 years ago)
• Last Synced: 2024-09-25T20:09:57.329Z (8 days ago)
• Topics: array, array-helper, array-manipulations, array-methods, dot-notation, manipulate-arrays, multi-array, php7
• Language: PHP
• Size: 102 KB
• Stars: 2
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        

A PHP collection of utilities to manipulate arrays. Compatible with, PHP 7 and Php 7.1.

[![Author](http://img.shields.io/badge/[email protected]?style=flat-square)](https://twitter.com/anolilab)

[![Latest Version on Packagist](https://img.shields.io/packagist/v/narrowspark/arr.svg?style=flat-square)](https://packagist.org/packages/narrowspark/arr)

[![Total Downloads](https://img.shields.io/packagist/dt/narrowspark/arr.svg?style=flat-square)](https://packagist.org/packages/narrowspark/arr)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)

## Master

[![Build Status](https://img.shields.io/travis/narrowspark/arr/master.svg?style=flat-square)](https://travis-ci.org/narrowspark/arr)

[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/narrowspark/arr/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/narrowspark/arr/code-structure)

[![Quality Score](https://img.shields.io/scrutinizer/g/narrowspark/arr/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/narrowspark/arr)

## Develop

[![Build Status](https://img.shields.io/travis/narrowspark/arr/develop.svg?style=flat-square)](https://travis-ci.org/narrowspark/arr)

[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/narrowspark/arr/develop.svg?style=flat-square)](https://scrutinizer-ci.com/g/narrowspark/arr/code-structure)

[![Quality Score](https://img.shields.io/scrutinizer/g/narrowspark/arr/develop.svg?style=flat-square)](https://scrutinizer-ci.com/g/narrowspark/arr)

* [Installation](#installation)

* [Arr](#arr)

    * [Access methods](#access)

        * [set](#set)

        * [get](#get)

        * [add](#add)

        * [has](#has)

        * [put](#put)

        * [exists](#exists)

        * [update](#update)

        * [forget](#forget)

    * [Enumerator](#enumerator)

        * [random](#random)

        * [only](only)

        * [split](#split)

        * [isAssoc](#isAssoc)

        * [isIndexed](#isIndexed)

    * [Transform](#transform)

        * [pop](#pop)

        * [swap](#swap)

        * [every](#every)

        * [combine](#combine)

        * [collapse](#collapse)

        * [divide](#divide)

        * [stripEmpty](#stripEmpty)

        * [unique](#unique)

        * [without](#without)

        * [reindex](#reindex)

        * [merger](#merge)

        * [extend](#extend)

        * [asHierarchy](#asHierarchy)

        * [groupBy](#groupBy)

        * [dot](#dot)

        * [flatten](#flatten)

        * [expand](#expand)

        * [reset](#reset)

        * [extendDistinct](#extendDistinct)

        * [sortRecursive](#sortRecursive)

        * [zip](#zip)

    * [Traverse](#traverse)

        * [map](#map)

        * [filter](#filter)

        * [all](#all)

        * [reject](#reject)

        * [where](#where)

        * [first](#first)

        * [last](#last)

## Why?

## Installation

Via Composer

``` bash

$ composer require narrowspark/arr

```

or

``` json

"require": {

    "narrowspark/arr": "~2.0"

}

```

## Arr

All methods listed under "Arr".

``` php

use Narrowspark\Arr\Arr;

// Returns a new array with the added key and value;

// ['foo' => bar, 'arr' => 'narrowsaprk']

Arr::set(['foo' => bar], 'arr', 'narrowspark');

```

#### 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.

``` php

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

```

#### 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.

``` php

    $arr = Arr::has(['foo' => 'bar'], 'foo'); // true

```

#### 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.

``` php

    $arr = ['foo' => 'bar']

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

    $arr; // []

```

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

From the project directory, tests can be ran using phpunit

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Credits

- [Daniel Bannert](https://github.com/prisis)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.