prowebcraft/dot

PHP dot notation array access

Dot - PHP dot notation array access

Based on adbario/php-dot-notation package, _(*1)

Easy access to multidimensional arrays with dot notation. With dot notation, your code is cleaner and handling deeper arrays is super easy., _(*2)

This class implements PHP's ArrayAccess class, so Dot object can also be used the same way as normal arrays with additional dot notation., _(*3)

With Dot you can change this:, _(*4)

echo $data['info']['home']['address'];

to this:, _(*5)

echo $data->get('info.home.address');

or even this:, _(*6)

echo $data['info.home.address'];

Installation

Via composer:, _(*7)

composer require prowebcraft/dot

Or just copy the class file Dot.php and handle namespace yourself., _(*8)

With Composer:

composer require prowebcraft/dot

Manual installation:

1. Download the latest release
2. Extract the files into your project
3. require_once '/path/to/dot/src/Dot.php';

Usage

This array will be used as a reference on this guide:, _(*9)

$array = [
    'user' => [
        'firstname' => 'John',
        'lastname'  => 'Smith'
    ],
    'info' => [
        'kids' => [
            0 => 'Laura',
            1 => 'Chris',
            2 => 'Little Johnny'
        ],
        'home' => [
            'address' => 'Rocky Road 3'
        ]
    ]
];

Create a Dot object

To start with an empty array, just create a new Dot object:, _(*10)

$data = new \Prowebcraft\Dot;

If you have an array already available, inject it to the Dot object:, _(*11)

$data = new \Prowebcraft\Dot($array);

Set an array after creating the Dot object:, _(*12)

$data->setArray($array);

Set an array as a reference, and all changes will be made directly to the original array:, _(*13)

$data->setReference($array);

Set a value

Set i.e. a phone number in the 'home' array:, _(*14)

$data->set('info.home.tel', '09-123-456-789');

// Array style
$data['info.home.tel'] = '09-123-456-789';

Set multiple values at once:, _(*15)

$data->set([
    'user.haircolor'    => 'blue',
    'info.home.address' => 'Private Lane 1'
]);

If the value already exists, Dot will override it with a new value., _(*16)

Get a value

echo $data->get('info.home.address');

// Default value if the path doesn't exist
echo $data->get('info.home.country', 'some default value');

// Array style
echo $data['info.home.address'];

Get all the stored values:, _(*17)

$values = $data->all();
``

Get a value from a path and remove it:

```php
$address = $data->pull('home.address');

Get all the stored values and remove them:, _(*18)

$values = $data->pull();

Add a value

$data->add('info.kids', 'Amy');

Multiple values at once:, _(*19)

$data->add('info.kids', [
    'Ben', 'Claire'
]);

Check if a value exists

if ($data->has('info.home.address')) {
    // Do something...
}

// Array style
if (isset($data['info.home.address'])) {
    // Do something...
}

Delete a value

$data->delete('info.home.address');

// Array style
unset($data['info.home.address']);

Multiple values at once:, _(*20)

$data->delete([
    'user.lastname', 'info.home.address'
]);

Clear values

Delete all the values from a path:, _(*21)

$data->clear('info.home');

Clear multiple paths at once:, _(*22)

$data->clear([
    'user', 'info.home'
]);

Clear all data:, _(*23)

$data->clear();

Sort the values

You can sort the values of a given path or all the stored values., _(*24)

Sort the values of a path:, _(*25)

$kids = $data->sort('info.kids');

// Sort recursively
$info = $data->sort('info');

Sort all the values, _(*26)

$sorted = $data->sort();

// Sort recursively
$sorted = $data->sort();

Magic methods

Magic methods can be used to handle single level data (without dot notation). These examples are not using the same data array as examples above., _(*27)

Set a value:, _(*28)

$data->name = 'John';

Get a value:, _(*29)

echo $data->name;

Check if a value exists:, _(*30)

if (isset($data->name)) {
    // Do something...
}

Delete a value:, _(*31)

unset($data->name);

License

MIT license, _(*32)