adbario/php-dot-notation

PHP dot notation access to arrays

Maintainers

Details

github.com/adbario/php-dot-notation

Homepage

Source

Issues

Installs: 6 185 804

Dependents: 186

Suggesters: 1

Security: 0

Stars: 452

Watchers: 17

Forks: 50

Open Issues: 0

3.3.0 2023-02-24 20:27 UTC

Requires

Requires (Dev)

MIT a94ce4493d19ea430baa8d7d210a2c9bd7129fc2

  • Riku Särkinen <riku.woop@adbar.io>

ArrayAccessdotnotation

This package is auto-updated.

Last update: 2024-10-23 00:50:52 UTC

README

PHP Dot Notation

Tests Status Coverage Status Total Downloads Latest Stable Version License

About Dot

Dot provides an easy access to arrays of data with dot notation in a lightweight and fast way. Inspired by Laravel Collection.

Dot implements PHP's ArrayAccess interface and Dot object can also be used the same way as normal arrays with additional dot notation.

Examples

With Dot you can change this regular array syntax:

$array['info']['home']['address'] = 'Kings Square';

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

// Kings Square

to this (Dot object):

$dot->set('info.home.address', 'Kings Square');

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

or even this (ArrayAccess):

$dot['info.home.address'] = 'Kings Square';

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

Install

Install the latest version using Composer:

composer require adbario/php-dot-notation

Usage

Create a new Dot object:

$dot = new \Adbar\Dot;

// With existing array
$dot = new \Adbar\Dot($array);

// Or with auto parsing dot notation keys in existing array
$dot = new \Adbar\Dot($array, true);

// You can also set a custom delimiter instead of the default dot (.)
$dot = new \Adbar\Dot($array, false, "_");

You can also use a helper function to create the object:

$dot = dot();

// With existing array
$dot = dot($array);

// Or with auto parsing dot notation keys in existing array
$dot = dot($array, true);

// You can also set a custom delimiter instead of the default dot (.)
$dot = dot($array, true, "_");

All methods not returning a specific value returns the Dot object for chaining:

$dot = dot();

$dot->add('user.name', 'John')
    ->set('user.email', 'john@example.com')
    ->clear(); // returns empty Dot

Methods

Dot has the following methods:

add()

Sets a given key / value pair if the key doesn't exist already:

$dot->add('user.name', 'John');

// Equivalent vanilla PHP
if (!isset($array['user']['name'])) {
    $array['user']['name'] = 'John';
}

Multiple key / value pairs:

$dot->add([
    'user.name' => 'John',
    'page.title' => 'Home'
]);

all()

Returns all the stored items as an array:

$values = $dot->all();

clear()

Deletes the contents of a given key (sets an empty array):

$dot->clear('user.settings');

// Equivalent vanilla PHP
$array['user']['settings'] = [];

Multiple keys:

$dot->clear(['user.settings', 'app.config']);

All the stored items:

$dot->clear();

// Equivalent vanilla PHP
$array = [];

count()

Returns the number of items in a given key:

$dot->count('user.siblings');

Items in the root of Dot object:

$dot->count();

// Or use count() function as Dot implements Countable
count($dot);

delete()

Deletes the given key:

$dot->delete('user.name');

// ArrayAccess
unset($dot['user.name']);

// Equivalent vanilla PHP
unset($array['user']['name']);

Multiple keys:

$dot->delete([
    'user.name',
    'page.title'
]);

flatten()

Returns a flattened array with the keys delimited by a given character (default "."):

$flatten = $dot->flatten();

get()

Returns the value of a given key:

echo $dot->get('user.name');

// ArrayAccess
echo $dot['user.name'];

// Equivalent vanilla PHP < 7.0
echo isset($array['user']['name']) ? $array['user']['name'] : null;

// Equivalent vanilla PHP >= 7.0
echo $array['user']['name'] ?? null;

Returns a given default value, if the given key doesn't exist:

echo $dot->get('user.name', 'some default value');

has()

Checks if a given key exists (returns boolean true or false):

$dot->has('user.name');

// ArrayAccess
isset($dot['user.name']);

Multiple keys:

$dot->has([
    'user.name',
    'page.title'
]);

isEmpty()

Checks if a given key is empty (returns boolean true or false):

$dot->isEmpty('user.name');

// ArrayAccess
empty($dot['user.name']);

// Equivalent vanilla PHP
empty($array['user']['name']);

Multiple keys:

$dot->isEmpty([
    'user.name',
    'page.title'
]);

Checks the whole Dot object:

$dot->isEmpty();

merge()

Merges a given array or another Dot object:

$dot->merge($array);

// Equivalent vanilla PHP
array_merge($originalArray, $array);

Merges a given array or another Dot object with the given key:

$dot->merge('user', $array);

// Equivalent vanilla PHP
array_merge($originalArray['user'], $array);

mergeRecursive()

Recursively merges a given array or another Dot object:

$dot->mergeRecursive($array);

// Equivalent vanilla PHP
array_merge_recursive($originalArray, $array);

Recursively merges a given array or another Dot object with the given key:

$dot->mergeRecursive('user', $array);

// Equivalent vanilla PHP
array_merge_recursive($originalArray['user'], $array);

mergeRecursiveDistinct()

Recursively merges a given array or another Dot object. Duplicate keys overwrite the value in the original array (unlike mergeRecursive(), where duplicate keys are transformed into arrays with multiple values):

$dot->mergeRecursiveDistinct($array);

Recursively merges a given array or another Dot object with the given key. Duplicate keys overwrite the value in the original array.

$dot->mergeRecursiveDistinct('user', $array);

pull()

Returns the value of a given key and deletes the key:

echo $dot->pull('user.name');

// Equivalent vanilla PHP < 7.0
echo isset($array['user']['name']) ? $array['user']['name'] : null;
unset($array['user']['name']);

// Equivalent vanilla PHP >= 7.0
echo $array['user']['name'] ?? null;
unset($array['user']['name']);

Returns a given default value, if the given key doesn't exist:

echo $dot->pull('user.name', 'some default value');

Returns all the stored items as an array and clears the Dot object:

$items = $dot->pull();

push()

Pushes a given value to the end of the array in a given key:

$dot->push('users', 'John');

// Equivalent vanilla PHP
$array['users'][] = 'John';

Pushes a given value to the end of the array:

$dot->push('John');

// Equivalent vanilla PHP
$array[] = 'John';

replace()

Replaces the values with values having the same keys in the given array or Dot object:

$dot->replace($array);

// Equivalent vanilla PHP
array_replace($originalArray, $array);

Replaces the values with values having the same keys in the given array or Dot object with the given key:

$dot->merge('user', $array);

// Equivalent vanilla PHP
array_replace($originalArray['user'], $array);

replace() is not recursive.

set()

Sets a given key / value pair:

$dot->set('user.name', 'John');

// ArrayAccess
$dot['user.name'] = 'John';

// Equivalent vanilla PHP
$array['user']['name'] = 'John';

Multiple key / value pairs:

$dot->set([
    'user.name' => 'John',
    'page.title'     => 'Home'
]);

setArray()

Replaces all items in Dot object with a given array:

$dot->setArray($array);

setReference()

Replaces all items in Dot object with a given array as a reference and all future changes to Dot will be made directly to the original array:

$dot->setReference($array);

toJson()

Returns the value of a given key as JSON:

echo $dot->toJson('user');

Returns all the stored items as JSON:

echo $dot->toJson();

Contributing

Pull Requests

  1. Fork the Dot repository
  2. Create a new branch for each feature or improvement
  3. Send a pull request from each feature branch to the 3.x branch

It is very important to separate new features or improvements into separate feature branches, and to send a pull request for each branch. This allows me to review and pull in new features or improvements individually.

Style Guide

All pull requests must adhere to the PSR-12 standard.

Unit Testing

All pull requests must be accompanied by passing unit tests and complete code coverage. Dot uses PHPUnit for testing.

Static Analysis

All pull requests must pass static analysis using PHPStan.

License

MIT license