pointybeard / helpers-functions-arrays
A collection of helpful functions related to arrays and array manipulation
Installs: 2 457
Dependents: 2
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- php: >=5.6.6
Requires (Dev)
- block8/php-docblock-checker: ~1.10
- phpunit/phpunit: ^5
This package is auto-updated.
Last update: 2024-10-12 16:51:54 UTC
README
- Version: v1.0.1
- Date: May 11 2019
- Release notes
- GitHub repository
A collection of helpful functions related to arrays and array manipulation
Installation
This library is installed via Composer. To install, use composer require pointybeard/helpers-functions-arrays
or add "pointybeard/helpers-functions-arrays": "~1.0"
to your composer.json
file.
And run composer to update your dependencies:
$ curl -s http://getcomposer.org/installer | php
$ php composer.phar update
Requirements
There are no particuar requirements for this library other than PHP 5.6 or greater.
To include all the PHP Helpers packages on your project, use composer require pointybeard/helpers
or add "pointybeard/helpers": "~1.0"
to your composer file.
Usage
This library is a collection of helpful functions related to arrays and array manipulation. They are included by the vendor autoloader automatically. The functions have a namespace of pointybeard\Helpers\Functions\Arrays
The following functions are provided:
array_is_assoc(array $input) : bool
array_remove_empty(array $input, int $depth=null) : ?array
array_insert_at_index(array &$array, int $index, mixed ...$additions) : void
Example usage:
<?php include __DIR__ . '/vendor/autoload.php'; use pointybeard\Helpers\Functions\Arrays; var_dump(Arrays\array_is_assoc(['a' => 1, 'b' => 2])); // bool(true) var_dump(Arrays\array_is_assoc([4, 5, 6, 7])); // bool(false) $a = [1, 2, 3, 4]; Arrays\array_insert_at_index($a, 2, "apple", "banana", "orange"); print_r($a); // Array // ( // [0] => 1 // [1] => 2 // [2] => apple // [3] => banana // [4] => orange // [5] => 3 // [6] => 4 // ) $a = [1, 3, 'animal' => 'chicken', 1, 2, 3, 4]; Arrays\array_insert_at_index($a, 4, ['food' => 'cabbage']); print_r($a); // Note that array key 'food' is not preserved // Array // ( // [0] => 1 // [1] => 3 // [animal] => chicken // [2] => 1 // [3] => cabbage // [4] => 2 // [5] => 3 // [6] => 4 // ) print_r(Arrays\array_remove_empty([ 1, 2, 3, 4, '', ['a', 'b', 'c', '', 'e'] ])); // Array // ( // [0] => 1 // [1] => 2 // [2] => 3 // [3] => 4 // [5] => Array // ( // [0] => a // [1] => b // [2] => c // [4] => e // ) // ) print_r(Arrays\array_remove_empty([ "fruit" => [ "apple", "banana", "" ], "cars" => [], "ancestors" => [ "charlie" => "", "betty" => [ "children" => [ "pete", "sarah" => [ "children" => [ 1 => "heidi", 2 => "mary", 3 => "adam", 4 => "" ] ], "bob" => [ "children" => [] ] ] ] ] ], 3)); // Array // ( // [fruit] => Array // ( // [0] => apple // [1] => banana // ) // [ancestors] => Array // ( // [betty] => Array // ( // [children] => Array // ( // [0] => pete // [sarah] => Array // ( // [children] => Array // ( // [1] => heidi // [2] => mary // [3] => adam // ) // ) // [bob] => Array // ( // [children] => Array // ( // ) // ) // ) // ) // ) // ) var_dump(Arrays\array_remove_empty([ "", NULL, false ])); // array(0) {} try { print_r(Arrays\array_remove_empty([ "one", "two" ], "INVALID_DEPTH_VALUE")); } catch (\Exception $ex) { var_dump($ex->getMessage()); } // string(46) "depth must be NULL or a positive integer value"
Support
If you believe you have found a bug, please report it using the GitHub issue tracker, or better yet, fork the library and submit a pull request.
Contributing
We encourage you to contribute to this project. Please check out the Contributing documentation for guidelines about how to get involved.
License
"PHP Helpers: Array Functions" is released under the MIT License.