Utility to handle access to a data set by using access paths.
Install with Composer;
composer require phrity/util-accessor
Any set of data (including arrays, objects, and scalar values) can be access using a path.
use Phrity\Util\Accessor;
$subject = [
'string-val' => 'A string',
'assoc-array-val' => [
'string-val' => 'Another string',
],
'num-array-val' => [
'a',
],
'object-val' => (object)[
'string-val' => 'Yet another string',
],
];
$accessor = new Accessor();
$accessor->get($subject, 'string-val'); // => "A string"
$accessor->get($subject, 'assoc-array-val'); // => ['string-val' => "Another string"]
$accessor->get($subject, 'assoc-array-val/string-val'); // => "Another string"
$accessor->get($subject, 'num-array-val/0'); // => "a"
$accessor->get($subject, 'object-val/string-val'); // => "Yet another string"
$accessor->has($subject, 'assoc-array-val/string-val'); // => true
$accessor->has($subject, 'assoc-array-val/non-exising'); // => false
The get() method can also have default value specified, to be returned when path do not match the data set. If not specified, null will be returned in these cases.
use Phrity\Util\Accessor;
$subject = [
'string-val' => 'A string',
];
$accessor = new Accessor();
$accessor->get($subject, 'non-existing'); // => null
$accessor->get($subject, 'non-existing', 'My default'); // => "My default"
By default, path uses /
as separator. Optionally, separator can be set in constructor.
use Phrity\Util\Accessor;
$subject = [
'object-val' => (object)[
'string-val' => 'A string',
],
];
$accessor = new Accessor('.');
$accessor->get($subject, 'object-val.string-val'); // => "A string"
$accessor->has($subject, 'object-val.string-val'); // => true
If multiple data sets should be accessed using the same path, the PathAccessor can be used instead. The path is then specified on constructor, and then used on all calls to get() and has().
use Phrity\Util\PathAccessor;
$subject_1 = [
'object-val' => (object)[
'string-val' => 'A string',
],
];
$subject_2 = [
'object-val' => (object)[
'string-val' => 'Another string',
],
];
$accessor = new PathAccessor('object-val/string-val');
$accessor->get($subject_1); // => "A string"
$accessor->get($subject_2); // => "Another string"
If a data sets should be accessed using multiple paths, the DataAccessor can be used instead. The data is then specified on constructor, and then used on all calls to get() and has().
use Phrity\Util\DataAccessor;
$subject = [
'object-val' => (object)[
'string-val' => 'A string',
'int-val' => 23,
],
];
$accessor = new DataAccessor(subject);
$accessor->get('object-val/string-val'); // => "A string"
$accessor->get('object-val/int-val'); // => 23
Sure, no problem. Just use the AccessorTrait
in your class, and call the available worker methods.
The internal, recursive worker methods takes path as an array of path segments.
There is also a helper to extract array path from a string path.
use Phrity\Util\AccessorTrait;
class MyClass
{
use AccessorTrait;
public function doThings(): void
{
$my_data = ['array-val' => ['string-val' => 'A string']];
$exists = $this->accessorHas($my_data, ['array-val', 'string-val']);
$something = $this->accessorGet($my_data, ['array-val', 'string-val'], 'My default');
$my_path = $this->accessorParsePath('array-val#string-val', '#');
$exists = $this->accessorHas($my_data, $my_path);
$something = $this->accessorGet($my_data, $my_path, 'My default');
}
}
Version | PHP | |
---|---|---|
1.0 |
^7.4|^8.0 |
Initial version: get(), has() |