resolveReferencePath()

Navigates to the parent container of the last key segment in a nested structure.

Parameters

$document : array<string, mixed>|object

The root document to navigate through (passed by reference).

$keys : array<int, string>

The exploded path as array segments (e.g. ['user', 'profile', 'name']).

$isArray : bool

If true, treat the structure as arrays; if false, as objects.

Tags

example

$doc = [];
$keys = ['user', 'name'];
$ref = &resolveReferencePath($doc, $keys, true);
$ref['name'] = 'John';
// $doc is now: ['user' => ['name' => 'John']]

$doc = new stdClass();
$keys = ['config', 'theme'];
$ref = &resolveReferencePath($doc, $keys, false);
$ref->theme = 'dark';
// $doc is now: (object)['config' => (object)['theme' => 'dark']]

Mixed structure support:

$doc = ['data' => (object)['name' => 'Alice']];
$keys = ['data', 'age'];
$ref = &resolveReferencePath($doc, $keys, true);
$ref->age = 30;
// $doc is now: ['data' => (object)['name' => 'Alice', 'age' => 30]]

Overwriting scalars:

$doc = ['user' => 'not_an_array'];
$keys = ['user', 'profile', 'name'];
$ref = &resolveReferencePath($doc, $keys, true);
$ref['name'] = 'Alice';
// $doc is now: ['user' => ['profile' => ['name' => 'Alice']]]

see

ensureArrayPath()

ensureObjectPath()

author

Marc Alcaraz (ekameleon)

since

1.0.0