README

PHP Common is a PHP library containing a set of common functionality.

To run tests use:

composer install -v

vendor/bin/phpunit

Find PHP Common on Packagist:

ArrayUtil

To use ArrayUtil you need to import it.

use Northern\Common\Util\ArrayUtil as Arr;

get

To get a value from an array use get:

$a = array(
   'foo' => 'bar'
);

$value = Arr::get( $a, 'foo' );

// $value == 'bar'

You can specify a default value in case the key you're trying to retrieve doesn't exists:

$value = Arr::get( $a, 'baz', NULL );

// $value == NULL

To get a nested value from an array you can specify a path:

$a = array(
   'foo' => array(
      'bar' => array(
         'baz' => 123
      )
   )
);

$value = Arr::get( $a, 'foo.bar.baz' );

// $value == 123

If required, you can use an alternate delimiter:

$value = Arr::getPath( $a, 'foo/bar/baz', NULL, '/' );

// $value == 123

set

To set a value or nested value use the set method:

$a = array();

Arr::set( $a, 'foo.bar.baz', 123 );

// $a = array( 'foo' => array( 'bar' => array( 'baz' => 123 ) ) );

If the key or path not already exist, it will be created.

insert

With insert you can create a new value at a path or key, however, the path will only be created if it does not yet exists.

$a = array();

Arr::set( $a, 'foo.bar.baz', 123 );

Arr::insert( $a, 'foo.bar.baz', 123 );

// The insert statement does nothing.

delete

It's also possible to delete a key or path:

Arr::delete( $a, 'foo.bar.baz' );

Or to delete multiple paths or keys at once:

Arr::delete( $a, array('fum', 'foo.bar.baz', 'foo.bar.bob') );

Or with an alternate delimiter:

Arr::delete( $a, array('fum', 'foo/bar/baz', 'foo/bar/bob'), '/' );

exists

To test if a key or path exists use:

$value = Arr::exists( $a, 'foo.bar.baz' );

// $value == TRUE

prefix

If you need to prefix all the values in an array, use the prefix method:

$a = array('1', '2', '3');

$values = Arr::prefix( $a, '$' );

// $values = array('$1', '$2', '$3');

postfix

If you need to postfix all the values in an array, use the postfix method:

$a = array('1', '2', '3');

$values = Arr::postfix( $a, '$' );

// $values = array('1$', '2$', '3$');

flatten

Sometimes you need to "flatten" an array, i.e. glueing the keys and values together with a symbol or character:

$a = array('param1' => '123', 'param2' => 'xyz');

$values = Arr::flatten( $a );

// $values = array('param1=123', 'param2=xyz');

Or use a different 'glue' character from the default '=':

$values = Arr::flatten( $a, '|' );

// $values = array( 'param1|123', 'param2|xyz' );

keys

Returns the keys of an array in the same way the array_keys function works, however, keys allows you to specifiy a prefix:

$a = array('param1' => '123', 'param2' => 'xyz');

$values = Arr::keys( $a, '&' );

// $values = array( '&param1', '&param2' )

values

Returns the values of an array in the same way the array_values function works, however, values allows you to specify a prefix:

$a = array('param1' => '123', 'param2' => 'xyz');

$values = Arr::values( $a, '&' );

// $values = array( '&123', '&xyz' )

contains

Tests if the values of one array exist in another. E.g:

$b = Arr::contains( array('A', 'B'), array('A', 'B', 'C') );

// $b = TRUE

The above tests if the values of the first array (needle) exist in the second array (haystack), which in the above example is true.

extract

Returns a value from an array and deletes the key in the array.

$a = array(
   'foo' => 'bar'
);

$value = Arr::extract( $a, 'foo' );

// $value == 'bar'
// $a = array()

The above example returns the value for foo from the array and deletes the foo key from the array.

northern / common

Maintainers

Details