Accessing PHP Arrays via DOT notation is easy as:

DotArray::create(['config' => ['some.dotted.key' => 'value']])->get('config.{some.dotted.key}')

• via "composer require":

  composer require binary-cube/dot-array

• via composer (manually):

  If you're using Composer to manage dependencies, you can include the following in your composer.json file:

  {
      "require": {
          "binary-cube/dot-array": "1.*"
      }
  }

REMEMBER: YOU NEED TO KNOW YOUR DATA

DotArray::get() can return a new instance of DotArray in case the accessed path is an array or it will return the raw data value or the default given value

• instantiation:

  • new DotArray($array);
    DotArray::create($array);
    DotArray::createFromJson($jsonString);

• get:

  • // Because the key `sci-fi & fantasy` is array the returning value it will be a new instance of DotArray.
    $dot('books.{sci-fi & fantasy}');
    
    // Because the price is not an array, the result will be raw data, float in this case.
    $dot('books.{sci-fi & fantasy}.0.price');
    
    // Accessing the raw array.
    $dot('books.{sci-fi & fantasy}')->toArray();
    $dot->get('books.{sci-fi & fantasy}')->toArray();
    
    // Accessing the last leaf and getting the raw data.
    $dot('books.{sci-fi & fantasy}.0.name');
    $dot->get('books.{sci-fi & fantasy}.0.name');
    
    // Giving a default value in case the requested key is not found.
    $dot->get('key.not.exist', 'not-found-as-string');
    
    // Vanilla PHP.
    $dot('books.{sci-fi & fantasy}.0.name');
    $dot['books']['sci-fi & fantasy'][0]['name'];

• get :: more-complex:

  • // Using dotted key and accessing without getting confused.
    // Allowed tokens for keeping the names with dot(.) togethers are: '', "", [], (), {}
    $dot->get('config.{elastic-search}.\'v5.0\'.host')
    $dot->get('config.{elastic-search}."v5.0".host')
    $dot->get('config.{elastic-search}.[v5.0].host')
    $dot->get('config.{elastic-search}.(v5.0).host')
    $dot->get('config.{elastic-search}.{v5.0}.host')

• set:

  • $dot->set('books.{sci-fi & fantasy}.0.name', 'New Name');
    
    // Vanilla PHP.
    $dot['books.{sci-fi & fantasy}.0.name'] = 'New Name';
    $dot['books']['sci-fi & fantasy'][0]['name'] = 'New Name';

• clear (empty array <=> []):

  • $dot->clear('books.{sci-fi & fantasy}');
    $dot->clear('books.{sci-fi & fantasy}', null);
    $dot->clear('books.{sci-fi & fantasy}.0.name', null);
    
    // Multiple keys.
    $dot->clear([
      'books.{sci-fi & fantasy}',
      'books.{childre\'s books}'
    ]);
    
    // Vanilla PHP.
    $dot['books.{sci-fi & fantasy}'] = [];

• delete (unset(...)):

  • $dot->delete('books.{sci-fi & fantasy}');
    $dot->delete('books.{sci-fi & fantasy}.0.name');
    $dot->delete(['books.{sci-fi & fantasy}.0', 'books.{childre\'s books}.0']);

• find:

  • /*
        Find the first item in an array that passes the truth test, otherwise return false
        The signature of the callable must be: `function ($value, $key)`.
    */
    $book = $dot->get('books.{childre\'s books}')->find(function ($value, $key) {
       return $value['price'] > 0;
    });

• filter:

  • /*
        Use a callable function to filter through items.
        The signature of the callable must be: `function ($value, $key)`
    */
    $books = $dot->get('books.{childre\'s books}')->filter(function ($value, $key) {
        return $value['name'] === 'Harry Potter and the Order of the Phoenix';
    });
    
    $books->toArray();

• filterBy:

  • /*
        Allowed comparison operators:
            - [ =, ==, eq (equal) ]
            - [ ===, i (identical) ]
            - [ !=, ne (not equal) ]
            - [ !==, ni (not identical) ]
            - [ <, lt (less than) ]
            - [ >, gr (greater than) ]
            - [ <=, lte (less than or equal to) ]
            - [ =>, gte (greater than or equal to) ]
            - [ in, contains ]
            - [ not-in, not-contains ]
            - [ between ]
            - [ not-between ]
    */
    // Example 1.
    $books = $dot->get('books.{childre\'s books}')->filterBy('price', 'between', 5, 12);
    
    // Example 2.
    $books = $dot->get('books.{childre\'s books}')->filterBy('price', '>', 10);
    
    // Example 3.
    $books = $dot->get('books.{childre\'s books}')->filterBy('price', 'in', [8.5, 15.49]);

• where:

  • /*
        The signature of the `where` call can be:
            - where([property, comparisonOperator, ...value])
            - where(\Closure) :: The signature of the callable must be: `function ($value, $key)`
    
        Allowed comparison operators:
            - [ =, ==, eq (equal) ]
            - [ ===, i (identical) ]
            - [ !=, ne (not equal) ]
            - [ !==, ni (not identical) ]
            - [ <, lt (less than) ]
            - [ >, gr (greater than) ]
            - [ <=, lte (less than or equal to) ]
            - [ =>, gte (greater than or equal to) ]
            - [ in, contains ]
            - [ not-in, not-contains ]
            - [ between ]
            - [ not-between ]
    */
    
    // Example 1. (using the signature: [property, comparisonOperator, ...value])
    $books = $dot->get('books.{childre\'s books}')->where(['price', 'between', 5, 12]);
    
    // Example 2. (using the signature: [property, comparisonOperator, ...value])
    $books = $dot->get('books.{childre\'s books}')->where(['price', '>', 10]);
    
    // Example 3. (using the signature: [property, comparisonOperator, ...value])
    $books = $dot->get('books.{childre\'s books}')->where(['price', 'in', [8.5, 15.49]]);
    
    // Example 4. (using the signature: \Closure)
    $books = $dot->get('books.{childre\'s books}')->where(function ($value, $key) {
        return $value['name'] === 'Harry Potter and the Order of the Phoenix';
    });

$dummyArray = [
    'books' => [
        'sci-fi & fantasy' => 
            [
                [
                    'name'      => 'Chronicles of Narnia Box Set',
                    'price'     => 24.55,
                    'currency'  => '$',
                    'authors'   => 
                        [
                            [
                                'name' => 'C.S. Lewis'
                            ],
                        ],
                ],
                [
                    'name'      => 'A Game of Thrones / A Clash of Kings / A Storm of Swords / A Feast of Crows / A Dance with Dragons ',
                    'price'     => 37.97,
                    'currency'  => '$',
                    'authors'   => 
                        [
                            [
                                'name' => 'George R. R. Martin'
                            ],
                         ],
                ],
            ],
        
        'childre\'s books' => 
            [
                [
                    'name'      => 'Harry Potter and the Order of the Phoenix',
                    'price'     => 15.49,
                    'currency'  => '$',
                    'authors'   => 
                        [
                            [
                                'name' => 'J. K. Rowling'
                            ],
                        ],
                ],
                [
                    'name'      => 'Harry Potter and the Cursed Child',
                    'price'     => 8.5,
                    'currency'  => '$',
                    'authors'   => 
                        [
                            [
                                'name' => 'J. K. Rowling',
                            ],
                            [
                                'name' => 'Jack Thorne'
                            ],
                        ],
                ],
            ],
        
    ],
];

• Banciu N. Cristian Mihai

See also the list of contributors who participated in this project.

This project is licensed under the MIT License - see the LICENSE file for details