Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/123inkt/utils
A library for small and convenient utility methods
https://github.com/123inkt/utils
array arrays assert assertions php utility
Last synced: about 1 month ago
JSON representation
A library for small and convenient utility methods
- Host: GitHub
- URL: https://github.com/123inkt/utils
- Owner: 123inkt
- License: mit
- Created: 2023-07-20T06:49:59.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-11T11:10:06.000Z (2 months ago)
- Last Synced: 2024-12-13T22:14:23.730Z (about 1 month ago)
- Topics: array, arrays, assert, assertions, php, utility
- Language: PHP
- Homepage:
- Size: 91.8 KB
- Stars: 1
- Watchers: 1
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://php.net/)
## 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.
- `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.
- `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.
## Assert
Fluent assertion methods, inspired by `webmozart/assert`:
- `null`
- `notNull`
- `isArray`
- `inArray`
- `isCallable`
- `resource`
- `object`
- `scalar`
- `integer`
- `numeric`
- `float`
- `string`
- `classString`
- `startsWith`
- `notStartsWith`
- `endsWith`
- `notEndsWith`
- `boolean`
- `true`
- `false`
- `notFalse`
- `nonEmptyArray`
- `nonEmptyString`
- `isInstanceOf`
- `type`
- `fileExists`
- `file`
- `directory`
- `readable`
- `writable`
### Example
```php
$value = Assert::notNull($this->repository->find(123));
```
## Stringify
### `::value(mixed $value): string`
Easily convert any value to a string representation.
```php
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)'
```
## Installation
```shell
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](https://www.werkenbij123inkt.nl/zoek-op-afdeling/it).