XTraverse.php
This bundle makes it dead easy to traverse through nested arrays/objects in PHP.
Installation
Via Composer
composer require phiil/xtraverse
File download
To use all the functions of this package simply download the src/ directory.
Getting started
Traversing paths
Paths are how you specify where you want to traverse to inside the nested object. Let's assume you want to get the title of the Block with ID 1 inside the 'blocks' array.
Our nested object:
$data = [
'blocks' => [
[
'id' => 1,
'title' => 'First block',
],
],
];
Now we specify which element we want:
use Phiil\XTraverse\Service\TraverseService;
$path = 'blocks[1].title';
$traverseService = new TraverseService();
$nodes = $traverseService->getNodes($path); // this function will split up the path by its steps (explode by '.')
Every step is delimited with a dot ('.').
If you want to query for an ID simply append it to the path with closed brackets.
Now let the traversing begin:
use Phiil\XTraverse\Service\TraverseService;
$traverseService = new TraverseService();
$title = $traverseService->traverseData($nodes, $data, false); // we want a non-array value - pass false or the service will throw an exception
echo $title;
The above will output the following: First block
Updating a nested value
Updating a value also works with paths:
use Phiil\XTraverse\Service\TraverseService;
// we want to update the title of the block we previously traversed to
$updatePath = 'blocks[1].title';
$traverseService = new TraverseService();
$data = $traverseService->update($data, $path, 'New title')->data;
Note: The update method returns an object with the properties path, data & insert. Getting the data property from the object straight away is almost always the best option.
Working with IDs
The traverse service can auto-increment IDs - meaning if you insert a nested object like:
use Phiil\XTraverse\Service\TraverseService;
$object = [
'id' => null,
'title' => 'Second block',
];
$traverseService = new TraverseService();
$data = $traverseService->update($object, 'blocks.$', $object)->data;
The object inside $data will now have the ID of 2 (First Block: ID 1).
Note: The path.$ can be used if you want to add a block to a non-associative (only numeric keys) array.
Running tests
To run tests run the following commands:
composer install --dev
./vendor/bin/phpunit tests/
Problems? Issues?
Just post them here on Github or contact me via email: [email protected]. Feel free to contribute!
2.7k Jan 8, 2023
31 Jun 25, 2021
5 Jun 13, 2022
5 Jul 13, 2022
69 Dec 3, 2022
135 Dec 22, 2022
519 Dec 31, 2022
4 Feb 7, 2022
1.7k Dec 24, 2022
406 Dec 30, 2022
120 Oct 10, 2022
7 Nov 14, 2022
22 Dec 1, 2022
174 Nov 26, 2022
74 Jul 20, 2022
14 May 23, 2022
22 Jan 2, 2023
4 Jun 27, 2022
0 Oct 7, 2022