pklink/dotor

Easy access to array values using dot notation. Useful for handling configurations or something like that

Dotor

Dotor is a library for PHP 5.6 and higher to access an array by using dot notification. This can be useful for handling array configurations or something like that, _(*1)

Installation

Install Dotor with Composer, _(*2)

Create or update your composer.json, _(*3)

{
    "require": {
        "pklink/dotor": "2.*"
    }
}

And run Composer, _(*4)

php composer.phar install

Finally include Composers autoloader, _(*5)

include __DIR__ . '/vendor/autoload.php';

Usage

Using `Dotor is very simple. Create an instance with your (configurarion) array..., _(*6)

// config-sample.php
return [
    'name' => 'sample configuration',
    'database' => [
        'server'   => 'localhost',
        'username' => 'root',
        'password' => 'password',
        'database' => 'blah',
        'type'     => 'sqlite'
    ],
    'object' => new stdClass(),
    'false'      => false,
    'true'       => true,
    'zeroString' => '0',
    'zeroInt'    => 0,
    'oneString'  => '1',
    'oneInt'     => 1,
    'twoString'  => '2',
];

$loader = ArrayLoader::createFromFile('./config-sample.php');
$config = new Dotor($loader);

... and get the content by the get()-method., _(*7)

$config->get('name');
$config->get('database.server');

Default values

$config->get('asdasdas');         // returns null
$config->get('asdasdas', 'blah'); // returns 'blah'

Scalar values

$config->getScalar('object');           // returns ''
$config->getScalar('object', 'blah');   // returns 'blah'
$config->getScalar('not-existing');     // returns ''
$config->getScalar('not-existing', []); // throw InvalidArgumentException

Arrays

$config->getArray('database');      // returns the database array
$config->getArray('notexit');       // returns []
$config->getArray('notexit', [1]);  // returns [1]

Boolean

$config->getBoolean('database', false);   // returns false
$config->getBool('database', true);       // returns true
$config->getBoolean('zeroString', true);  // returns false
$config->getBoolean('zeroInt', true);     // returns false
$config->getBoolean('oneString', false);  // returns true
$config->getBoolean('oneInt', false);     // returns true

The getBoolean()-method and their alias getBool() handle the string '1' and the integer 1 as true. Otherwise this method returns the given $default or true., _(*8)

$config->getBoolean('oneString', false);   // returns true
$config->getBoolean('twoString', false);   // returns false
$config->getBoolean('twoString');          // returns true

Run tests

php composer.phar install --dev
php vendor/bin/phpunit tests/

or with code-coverage-report, _(*9)

php composer.phar install --dev
php vendor/bin/phpunit --coverage-html output tests/

License

This package is licensed under the BSD 2-Clause License. See the LICENSE file for details., _(*10)

Credits

This package is inspired by php-dotty, _(*11)