Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mschindler83/array-access
Library to ease array access handling
https://github.com/mschindler83/array-access
array array-helper array-manipulations php74
Last synced: about 1 month ago
JSON representation
Library to ease array access handling
- Host: GitHub
- URL: https://github.com/mschindler83/array-access
- Owner: mschindler83
- License: mit
- Created: 2020-02-15T10:40:50.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-28T10:03:20.000Z (over 3 years ago)
- Last Synced: 2024-09-29T20:23:20.399Z (about 2 months ago)
- Topics: array, array-helper, array-manipulations, php74
- Language: PHP
- Size: 36.1 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Array Access
[](https://travis-ci.org/mschindler83/array-access)
[](https://packagist.org/packages/mschindler83/array-access)
[](https://scrutinizer-ci.com/g/mschindler83/array-access/?branch=master)
[](https://scrutinizer-ci.com/g/mschindler83/array-access/?branch=master)
[](https://scrutinizer-ci.com/code-intelligence)
[](https://packagist.org/packages/mschindler83/array-access)
Library to ease array access handling.
Requires PHP >= 7.4
## Install
`composer require mschindler83/array-access`
## Features
- Savely access typed values from a given array
- Optional JSON schema validation
- Support for datetime parsing
- Define your own validation callback when retrieving values
- Create a new array in form of "dot annotations"
- Easily write values to a specific path of the array
## Usage Examples
### Creating access objects
#### Create access object from an array and access values
```
$array = [
'key1' => [
'key2' => [
'key3' => 'the-value'
],
],
];
$access = ArrayAccess::create($array);
try {
// Get the string value at the given path
$value = $access->string('key1', 'key2', 'key3');
// This will fail with an exception because we try to get an integer at the given path
$invalidValue = $access->int('key1', 'key2', 'key3');
} catch (ArrayAccessFailed $e) {
// handle errors
echo $e->getMessage();
}
```
#### Create an array from "dot annotation"
```
$access = ArrayAccess::newFromDotAnnotation(
SimpleDotAnnotation::create('key1.key2.2.key3', 'the-value-1'),
SimpleDotAnnotation::create('key1.key2.2.key4', 'the-value-2')
);
$plainArray = $access->data();
```
Plain array will contain:
```
Array
(
[key1] => Array
(
[key2] => Array
(
[2] => Array
(
[key3] => the-value-1
[key4] => the-value-2
)
)
)
)
```
### Array access with JSON schema validation
```
$data = [
'key1' => 'value1',
'key2' => true,
];
$access = ArrayAccess::createWithJsonSchemaValidation($data, \file_get_contents('json-schema.json'));
```
JSON schema:
```
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"key1": {
"type": "string",
"minLength": 3,
"maxLength": 64,
"pattern": "^[a-zA-Z0-9\\-]+(\\s[a-zA-Z0-9\\-]+)*$"
},
"key2": {
"type": "boolean"
}
},
"required": ["key1", "key2"],
"additionalProperties": false
}
```
If validation fails, an `ArrayAccessValidationFailed` exception will be thrown.
You can get an `ArrayAccess` object of validation errors by calling the method `errorMapping()` on the exception.
### Access values
```
$array = [
'root' => [
'string-value' => 'the-value',
'int-value' => 10,
'float-value' => 9.99,
'bool-value' => true,
'array-value' => [1, 2, 3],
'datetime-value' => '2020-01-01 12:00:00',
'object-value' => new \stdClass(),
'custom' => 'Choice 1',
],
];
// Create the access object
$access = ArrayAccess::create($array);
// This will return the string "the-value"
$access->string('root', 'string-value');
// This will return the integer "10"
$access->int('root', 'int-value');
// This will return the float "9.99"
$access->float('root', 'float-value');
// This will return the bool "true"
$access->bool('root', 'bool-value');
// This will return the array "[1, 2, 3]"
$access->array('root', 'array-value');
// This will return a new ArrayAccess object
$access->arrayAccess('root', 'array-value');
// This will return a \DateTimeImmutable object
$access->dateTimeImmutable('Y-m-d H:i:s', 'root', 'datetime-value');
// This will return a \DateTime object
$access->dateTime('Y-m-d H:i:s', 'root', 'datetime-value');
// This will return the \stdClass object
$access->objectOfType(\stdClass::class, 'root', 'object-value');
// This will return a mixed, depending on the array content, but only if the custom validation passes
// In this case it will return the string "Choice 1"
$access->callback(
function ($value) {
return in_array($value, ['Choice 1', 'Choice 2', 'Choice 3']);
},
'root', 'custom'
);
```
### Write to a path
```
$access = ArrayAccess::create([]);
$access->writeAtPath('the-value', 'at', 'some', 'path');
$theValue = $access->string('at', 'some', 'path');
```