Arr Class

The arr class is a set of helper functions for working with arrays.

is_assoc($arr)

The is_assoc method checks if the array passed is an associative array or not.

Static Yes
Parameters
Param Default Description
$arr required The array to check.
Returns bool
Example 

$arr = array('foo', 'bar', 'baz', 'yay');
$result = Arr::is_assoc($arr);
// Result: false

$arr = array('foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz', 'yay' => 'yay');
$result = Arr::is_assoc($arr);
// Result: true

/*
 * Note that even if the '2' is defined as a string, PHP will store this internally
 * as an integer, and therefore this is NOT seen as an assoc array!
 */
$arr = array(0 => 'foo', 1 => 'bar', '2' => 'baz', 3 => 'yay');
$result = Arr::is_assoc($arr);
// Result: false!

to_assoc($arr)

The to_assoc method turns a non-associative array into an associative array if it has an even number of segments.

Static Yes
Parameters
Param Default Description
$arr required The array to convert.
Returns array|null
Throws BadMethodCallException when the number of values in the given array is uneven
Example 
$arr = array('foo', 'bar', 'baz', 'yay');
$array = Arr::to_assoc($arr);
/*
Result:
array(
    'foo' => 'bar',
    'baz' => 'yay',
)
*/

$arr = array('foo', 'bar', 'baz');
$array = Arr::to_assoc($arr);
/*
Result:
null
*/

assoc_to_keyval($assoc = null, $key_field = null, $val_field = null)

The assoc_to_keyval method turns a multi-dimensional array into a key=>val array.

Static Yes
Parameters
Param Default Description
$assoc required The array to transform.
$key_field required The associative array field to map as the key.
$val_field required The associative array field to map as the value.
Returns array
Throws InvalidArgumentException when the first argument isn't an array or doesn't implement the Iterator interface.
Example 
$people = array(
	array(
		"name" => "Jack",
		"age" => 21
	),
	array(
		"name" => "Jill",
		"age" => 23
	)
);

print_r( Arr::assoc_to_keyval($people, 'name', 'age') );

// Returns
Array
(
	["Jack"] => 21
	["Jill"] => 23
)

average($array = null)

The average method takes all values of an array and returns the average value.

Static Yes
Parameters
Param Default Description
$array required Array of values to average.
Returns array
Example 
echo Arr::average(array('1', 2, 4, '8')); // Outputs 3.75

flatten($array, $glue = ':', $reset = true)

The flatten method flattens a multi-dimensional array (both associative and indexed) down into a 1 dimensional array.

Static Yes
Parameters
Param Default Description
$array required The array to flatten.
$glue 
:
 The string used to glue the keys together with
$reset 
true
 Should we create a new array of values instead of merging them into the last array created by flatten?
Returns array
Example 
$indexed = array(
	array(
		"a"
	),
	array(
		"b"
	),
	array(
		"c"
	),
);

print_r( Arr::flatten($indexed, '_') );

// Returns
Array
(
	[0_0] => a
	[0_1] => b
	[0_2] => c
)

flatten_assoc($array, $glue = ':', $reset = true)

The flatten_assoc method flattens a multi-dimensional associative array down into a 1 dimensional associative array.

Static Yes
Parameters
Param Default Description
$array required The array to flatten.
$glue 
:
 The string used to glue the keys together with
$reset 
true
 Should we create a new array of values instead of merging them into the last array created by flatten_assoc?
Returns array
Example 
$people = array(
	array(
		"name" => "Jack",
		"age" => 21
	),
	array(
		"name" => "Jill",
		"age" => 23
	)
);

print_r( Arr::flatten_assoc($people) );

// Returns
Array
(
	[0:name] => Jack
	[0:age] => 21
	[1:name] => Jill
	[1:age] => 23
)

// Let's flatten another array on top
print_r( Arr::flatten_assoc( array( array( "name" => "Humpty", "age" => 11 ) ) ,":",false) );

// Returns
Array
(
	[0:name] => Humpty
	[0:age] => 11
	[1:name] => Jill
	[1:age] => 23
)

reverse_flatten($array, $glue = ':')

The reverse_flatten method unflattens a flattened multi-dimensional array (both associative and indexed) into its original form.

Static Yes
Parameters
Param Default Description
$array required The array to unflatten.
$glue 
:
 The string used to glue the keys together with
Returns array
Example 
$flattened = array(
	'0_name' => 'James',
	'0_age' => 24,
	'1_name' => 'John',
	'1_age' => 34,
);

print_r( Arr::reverse_flatten($flattened, '_') );

// Returns
Array
(
	[0] => Array
		(
			[name] => James
			[age] => 24
		)

	[1] => Array
		(
			[name] => John
			[age] => 34
		)
)

filter_prefixed($array, $prefix = 'prefix_', $remove_prefix = true)

The filter_prefixed method filters the array on a prefix. It returns an array where the key starts with the specified prefix.

Static Yes
Parameters
Param Default Description
$array required The array to filter.
$prefix 
prefix_
 The string used to filter on
$remove_prefix 
true
 Remove or keep the prefix in the array key?
Returns array
Example 
$arr = array(
	"user_name" => "John",
	"user_surname" => "Lastname",
	"project_name" => "Fuel",
	"project_type" => "Framework",
);

print_r( Arr::filter_prefixed($arr, "user_"));

// Returns
Array
(
	[name] => Frank
	[surname] => de Jonge
)

// Let's keep the prefix
print_r( Arr::filter_prefixed($arr, "project_", false);

// Returns
Array
(
	[project_name] => Fuel
	[project_type] => Framework
)

filter_keys($array, $keys, $remove = false)

The filter_keys method filters a given array to a set of keys. It returns an array that contains only the items whose keys are in the $keys array. Can also remove the specified $keys from an array.

Static Yes
Parameters
Param Default Description
$array required The array to filter.
$keys required Array of keys to filter the above array with.
$remove 
false
 If true, removes the $keys from the $array instead of fetching them.
Returns array
Example 
$arr = array(
	"user_name" => "John",
	"user_surname" => "Lastname",
	"project_name" => "Fuel",
	"project_type" => "Framework",
);

print_r( Arr::filter_keys($arr, array('project_name', 'user_name')));

// Returns
Array
(
	[project_name] => Fuel
	[user_name] => John
)

// Let's remove some keys
print_r(Arr::filter_keys($arr, array('user_name', 'user_surname'), true));

// Returns
Array
(
	[project_name] => Fuel
	[project_type] => Framework
)

get($array, $key, $default = false)

The get method returns the element of the given array using dot-notation, or a default if it is not set.

Static Yes
Parameters
Param Default Description
$array required The array to access
$key required The key requested in $array. If null is passed as key, the entire array is returned.
$default 
false
 The value to be returned if the requested key does not exist
Returns mixed. If you pass an array of keys, the return value will be an array with the result of all requested keys.
Example 
$person = array(
	"name" => "Jack",
	"age" => "21",
	"location" => array(
		"city" => "Pittsburgh",
		"state" => "PA",
		"country" => "US"
	)
);

echo Arr::get($person, "name", "Unknown Name");
// Returns "Jack"

echo Arr::get($person, "job", "Unknown job");
// Returns "Unknown job"

// This method can also dive into arrays by using a dot to separate between keys
echo Arr::get($person, "location.city", "Unknown City");
// Returns "Pittsburgh"

set(&$array, $key, $value = false)

The set method sets the element of the given array using dot-notation.
WARNING: The original array is edited by reference

Static Yes
Parameters
Param Default Description
$array required The array to access
$key required The key requested in $array. If no key is passed, or null is passed as key value, the array is unset. If you pass an array of key -> value pairs, all the values in the array will be set.
$value 
null
 The value to be set. Ignored if $key is an array.
Returns void
Example 
$person = array(
	"name" => "Jack",
	"age" => "21",
	"location" => array(
		"city" => "Pittsburgh",
		"state" => "PA",
		"country" => "US"
	)
);

Arr::set($person, "name", "John");
// $person['name'] is set to "John"

// This method can also dive into arrays by using a dot to separate between keys
Arr::set($person, "location.city", "Philadelphia");
// $person['location']['city'] is set to "Philadelphia"

// or set multiple values in one go
Arr::set($person, array("name" => "John", "location.city" => "Philadelphia"));

delete(&$array, $key)

The delete method the element of the given array using dot-notation.
WARNING: The original array is edited by reference, only boolean success is returned

Static Yes
Parameters
Param Default Description
$array required The array to access
$key required The key requested in $array. If no key is passed, or null is passed as key value, the array is unset.
Returns mixed, true if the key was deleted, false if the key didn't exist. If you pass an array of keys, the return value will be an array with the result of all requested deletes.
Example 
$person = array(
	"name" => "Jack",
	"age" => "21",
	"location" => array(
		"city" => "Pittsburgh",
		"state" => "PA",
		"country" => "US"
	)
);

$result = Arr::delete($person, "name");
// deleted $person['name'] from the array, returns true

// This method can also dive into arrays by using a dot to separate between keys
$result = Arr::delete($person, "location.city");
// deleted $person['location']['city'] from the array, returns true

// or delete multiple values in one go
$result = Arr::delete($person, array("name", "location.doesnotexist"));
// deleted $person['name'], returns array('name' => true, 'location.doesnotexist' => false)

insert(Array &$original, $value, $pos)

The insert method is mainly an array_splice alias with added error checking
WARNING: The original array is edited by reference, only boolean success is returned

Static Yes
Parameters
Param Default Description
$original required The array to use
$value required The value(s) to insert
$pos required The numeric position at which to insert, negative to count from the end backwards
Returns boolean
Example 
$people = array("Jack", "Jill");

// Add one value
Arr::insert($people, "Humpty", 0 );
print_r( $people );
// Returns
Array
(
	[0] => Humpty
	[1] => Jack
	[2] => Jill
)

// Add multiple values
Arr::insert($people, array("Hansel", "Gretel"), 1 );
print_r( $people );
// Returns
Array
(
	[0] => Humpty
	[1] => Hansel
	[2] => Gretel
	[3] => Jack
	[4] => Jill
)

// Add an array
Arr::insert($people, array( array("name" => "Wolf", "teeth" => "sharp" ) ), 0 );
print_r( $people );

// Returns
Array
(
	[0] => Array
		(
			[name] => Wolf
			[teeth] => sharp
		)

	[1] => Humpty
	[2] => Hansel
	[3] => Gretel
	[4] => Jack
	[5] => Jill
)

insert_before_key(Array &$original, $value, $key)

The insert_before_key method adds an element to an array before the key specified
WARNING: The original array is edited by reference, only boolean success is returned

Static Yes
Parameters
Param Default Description
$original required The array to use
$value required The value(s) to insert
$key required The key before which to insert
Returns boolean
Example 
$people = array("Jack", "Jill");

Arr::insert_before_key($people, "Humpty", 1 );
print_r( $people );

// Returns
Array
(
	[0] => Jack
	[1] => Humpty
	[2] => Jill
)

insert_after_key(Array &$original, $value, $key)

The insert_after_key method adds an element to an array after the key specified
WARNING: The original array is edited by reference, only boolean success is returned

Static Yes
Parameters
Param Default Description
$original required The array to use
$value required The value(s) to insert
$key required The key after which to insert
Returns boolean
Example 
$people = array("Jack", "Jill");

Arr::insert_after_key($people, "Humpty", 1 );
print_r( $people );

// Returns
Array
(
	[0] => Jack
	[1] => Jill
	[2] => Humpty
)

insert_after_value(Array &$original, $value, $search)

The insert_after_value method adds an element to an array after the value specified
WARNING: The original array is edited by reference, only boolean success is returned

Static Yes
Parameters
Param Default Description
$original required The array to use
$value required The value(s) to insert
$search required The value after which to insert
Returns boolean
Example 
$people = array("Jack", "Jill");

Arr::insert_after_value($people, "Humpty", "Jack" );
print_r( $people );

// Returns
Array
(
	[0] => Jack
	[1] => Humpty
	[2] => Jill
)

sort($array, $key, $order = 'asc', $sort_flags = SORT_REGULAR)

The sort method sorts a multi-dimensional array by its values.

Static Yes
Parameters
Param Default Description
$array required The array to sort
$key required The key requested to sort by in $array.
$order 
'asc'
 The order (asc or desc).
$sort_flags 
SORT_REGULAR
 The php sort type flags (http://php.net/manual/en/function.sort.php)
Returns mixed
Example 
$data = array(
	array(
		'info' => array(
			'pet' => array(
				'type' => 'dog'
			)
		),
	),
	array(
		'info' => array(
			'pet' => array(
				'type' => 'fish'
			)
		),
	),
	array(
		'info' => array(
			'pet' => array(
				'type' => 'cat'
			)
		),
	),
);

$data = Arr::sort($data, 'info.pet.type');
// Returns
array(
	array(
		'info' => array(
			'pet' => array(
				'type' => 'cat'
			)
		),
	),
	array(
		'info' => array(
			'pet' => array(
				'type' => 'dog'
			)
		),
	),
	array(
		'info' => array(
			'pet' => array(
				'type' => 'fish'
			)
		),
	),
);

in_array_recursive($needle, $haystack, $strict = false)

The in_array_recursive method checks wether a value is in an array recursively.

Static Yes
Parameters
Param Default Description
$needle required The value to search for
$haystack required The array to search in.
$strict 
false
 The wether to use == or ===.
Returns bool
Example 
$arr = array(
	'one' => 1,
	2,
	3,
	array(
		56
	),
	87
);

var_dump(Arr::in_array_recursive('56', $arr));
// is true

var_dump(Arr::in_array_recursive('87', $arr, true));
// is false

var_dump(Arr::in_array_recursive(87, $arr, true));
// is true

Procedural helpers

in_arrayi($needle, $haystack)

The in_arrayi function is a case-insensitive version of in_array.

Parameters
Param Type Default Description
$needle string required the value to search for
$haystrack array required the array to search in
Returns bool
Example 
$bool = in_arrayi('This', array('something','tHis'));
// Will result in $bool == true

$bool = in_arrayi('Thi', array('something','tHis'));
// Will result in $bool == false