README

Perform get-operations on a string-notated subvalue of an object or array

Installation

composer require rikta/value-path

No config, no dependency-injection, nothing. Plug&Play!

Usage

Create a ValuePath-instance for a path, e.g. $path = new ValuePath('.contact.phone.0');
Invoke the instance on some data, e.g. $phone = $path($data);

Example

$data = [
    [
        'name' => 'John Doe',
        'contact' => [
            'phone' => [
                '+49301234567'
            ]
        ]
    ]
];

$path = new Rikta\ValuePath\ValuePath('.contact.phone.0');
$phone = $path($data);

\PHPUnit\Framework\assertEquals('+49301234567', $phone);

Notation

On top of the "usual" dot-notation for arrays this package also support objects.

The following notations are valid:

new Rikta\ValuePath\ValuePath('.something'); // = $value['something']
new Rikta\ValuePath\ValuePath('.0'); // = $value[0]
new Rikta\ValuePath\ValuePath('["something"]'); // = $value['something']
new Rikta\ValuePath\ValuePath('->something'); // = $value->something
new Rikta\ValuePath\ValuePath('->something("a", "b", 1)]'); // = $value->something("a", "b", 1)

// it's also possible to chain the notations to get some deeply nested data
new Rikta\ValuePath\ValuePath('.something["somethingElse"]->someOtherThing->sth("a", "b")]');

// ' and " are interchangeable
new Rikta\ValuePath\ValuePath(".something['somethingElse']->someOtherThing->sth('a', 'b', 1)]");

Set Data

It is planned to provide the feature to set data as well, but right now, while having multiple approaches, I don't have a satisfying concept for the chaining of methods. Properties and arrays are a no-brainer, but as soon as methods come into play the whole topic gets a bit more complicated

rikta / value-path

Maintainers

Details