README

DR Utility Classes

A library with everyday use classes and methods:

Arrays

• first - Get the first element of an array, exception otherwise.
• firstOrNull - Get the first element of an array, null otherwise.
• last - Get the last element of an array, exception otherwise.
• lastOrNull - Get the last element of an array, null otherwise.
• find - Find the first element in an array that matches a predicate, exception otherwise.
• findOrNull - Find the first element in an array that matches a predicate, null otherwise.
• flatten - Recursively flattens an array returning an array with all the elements.
• implode - Implode an iterable into a string. Supports iterable of boolean, int, float, string, null, Stringable and BackedEnum.
• contains - Test if the given value is contained within items. Supports EquatableInterface.
• diff - Get the difference between two arrays. Supports ComparableInterface.
• equals - Tests if two arrays have equal contents, ignoring order. Supports ComparableInterface.
• explode - Explode a string or null into an array, with exploding empty string to empty array.
• map - Similar to array_map but with support for iterable, and receive key as second argument in the callback.
• mapAssoc - Map an array to a new array using a callback, preserving keys.
• mapKeys - Map an array to a new keyed array using a callback,
• reindex - Reindex an array with new keys based on the result of the callback.
• groupBy - Group items by the given return value of the callback.
• renameKey - Rename the string key of an array element.
• remove - Remove an element from an array based on the callback. Supports EquatableInterface.
• removeKey - Remove an element from an array based on the key.
• removeKeys - Remove multiple elements from an array based on the keys.
• removeTypes - Filters an array by removing all values that match the provided types.
• removeNull - Filters an array by removing all null values.
• search - Find the key of an element in an array or false otherwise. Supports EquatableInterface.
• unique - Remove duplicate values from an array. Supports EquatableInterface.
• wrap - Wrap a value in an array, unless it is already an array.
• toJson - Converts an array into a json string.
• fromJson - Converts a json string into an array.
• fetchByPath - Fetch a value from a multi-dimensional array by the given path.
• assignByPath - Assign a value to a multi-dimensional array by the given path.

Assert

Fluent assertion methods, inspired by webmozart/assert:

• null
• notNull
• isArray
• isList
• inArray
• isCallable
• resource
• object
• scalar
• integer
• positiveInt
• negativeInt
• nonNegativeInt
• nonPositiveInt
• numeric
• float
• string
• classString
• startsWith
• notStartsWith
• endsWith
• notEndsWith
• boolean
• true
• false
• notFalse
• emptyArray
• nonEmptyArray
• nonEmptyString
• isInstanceOf
• greaterThan - Supports ComparableInterface.
• lessThan - Supports ComparableInterface.
• type
• fileExists
• file
• directory
• readable
• writable

Example

$value = Assert::notNull($this->repository->find(123));

Stringify

::value(mixed $value): string

Easily convert any value to a string representation.

true > 'true'
false > 'false'
null > 'null'
123 > '123'
1.23 > '1.23'
'abc' > 'abc'
'' > 'empty-string',
[] > 'empty-array'
[1, 2, 3] > 'array-list(3)'
['foo' => 'bar'] => 'keyed-array(1)'
StringableObject => 'value (StringableObject)'
stdClass => 'stdClass'
resource => 'resource (stream)'

Closures

• unfold

Turns a variable with a closure into the return type of that closure.
Can be called multiple times on the same variable, but will only execute the closure once.

    $service = fn() => new Service();
    Closures::unfold($service);
    $service instanceof Service // true

Installation

composer require digitalrevolution/utils

About us

At 123inkt (Part of Digital Revolution B.V.), every day more than 50 development professionals are working on improving our internal ERP and our several shops. Do you want to join us? We are looking for developers.