ArrayOK is a simple wrapper for nested, multi-dimensional arrays that makes it easy to do deep searching and index lookups.

ArrayOk is not intended to be used as a Collection wrapper

Public API:

$aok-> new ArrayOk(array $config_array);
$aok->get(string|array $keys = null) // uses key lookup to get nested values. If string, make sure to use dot notation.$aok->reverse($returnAsObject = false) // Reverses the order of the array, returns as new ArrayOk if param is true$aok->orderBy(string|array $input, $flipInput = true) // Reorders the contents by the given input. $flipInput determines if given input should be array_flip()'d$aok->orderByAndGetIntersection(string|array $input, $flipInput = true) // Reorders the contents by the given input and returns only the intersection$aok->intersect(array $input) // Get the intersection of the input array's values$aok->intersectKeys(array $input) // Get the intersection of the input array's keys$aok->prepend(mixed $value, string $key = null) // Prepend new value to beginning of array, with optional associatve key$aok->append(mixed $value, string $key = null) // Append new value to end of array, with optional associatve key$aok->remove(string $key) // Unsets the item from the array$aok->exists(string $key) // Checks one level deep to see if the item exists (TODO recursive checking)$aok->isEmpty(string $key = null) // Checks to see if object is empty. If key is provided, checks to see if that item is empty (TODO recurisve checking)$aok->isAok(any $object) // Validates another object to see if it's also an ArrayOk object$aok->itemIsAok(string|array $item) // Uses get() to deep seek an item, checks to see if it's also an ArrayOk object$aok->toArray() 

Examples:

// Given$config = [
'one' => [
'two' => [
'three' => 'four'
]
],
'Hello' => 'World!',
'Foo' => 'Bar'
];
// Wrap it$aok = newJlem\ArrayOk\ArrayOk($config); // Builds a nested object graph of ArrayOk objects for each child array in $config// Getting single values. All of these are valid.$aok->get('blah') // returns null (anything it doesn't find is always null)$aok->get('one') // returns an ArrayOk object since 'one' was an array$aok->get(['one']) // ... or use an array argument with object access$aok['one'] // ... or use array access$aok[['one']] // ... or use array argument with array access// Getting nested values. All of these are valid.$aok->get() // returns the full array & object graph$aok->toArray() // returns full object graph as a plain array$aok->get('one.two.three') // returns 'four' using dot notation with object access$aok->get(['one', 'two', 'three']) // ... or use an array argument with object access$aok['one.two.three'] // ... or use dot notation argument with array access$aok[['one', 'two', 'three']] // ... or use array argument with array access$aok['one']['two']['three'] // ... or use chained array access$aok->get('one')->get('two')->get('three') // ... or use chained object access$aok->get('one')['two']->get('three') // ... or mix it up$aok['one.two']->get(['three']) // ... mixing is A-Ok ;) just be careful about non-object returns (TODO: "safe mode" that returns null objects for safe chaining)// Mutating$aok->append('value') // adds a numerically indexed value to the end. (if value is array, it becomes an ArrayOk object)$aok[] = 'value'// array access equivalent$aok->append('value', 'optional_key') // adds a value with the optionally provided key to the end. (if value is array, it becomes an ArrayOk object)$aok['key'] = $value // array access equivalent$aok->prepend('value') // adds a numerically indexed value at the beginning. (if value is array, it becomes an ArrayOk object)$aok->prepend('value', 'optional_key') // adds a value with the optionally provided key to the beginning (if value is array, it becomes ArrayOk object)$aok->remove('Foo') // removes the 'Foo' element from the top level array (TODO: recursive / seek option)// Sorting$aok->orderBy(['Foo', 'Hello', 'one']) // explicitly changes the order of the array to match the given input array$aok->orderBy('Foo.Hello.one'); // ... or use dot notation to represent the order$aok->orderBy(['Foo' => 'f', 'Hello' => 'h', 'one' => 'o'], false) // Pass in "false" if you don't want the array keys and values flipped (e.g. if the array keys are already correct)// $aok->orderBy('Foo.Hello.one', false) // NOT RECOMMENDED. Passing in false with dot notation will keep the keys numerically indexed$aok->orderByAndGetIntersection(['Foo', 'one']) // Returns a new array containing only 'Foo' and 'one' values, in that order, leaving out 'Hello'$aok->orderByAndGetIntersection(['Foo' => 'f', 'one' => 'o'], false) // Use false to preserve array key/value positions (e.g. don't flip them)$aok->orderByAndGetIntersection('Foo.one') // ... dot notation allowed// Misc$aok->exists($key) // checks whether the given key is set in the top level array (TODO: recursive seeking / checking)