Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.13 KB

readme.md

File metadata and controls

40 lines (31 loc) · 1.13 KB

Dot

A utility for traversing arrays using dot notation

Installation

$ composer require p810/dot

Example usage

<?php

p810\Dot\find('foo.bar', [
    'foo' => [
        'bar' => 'Hello world!'
    ]
]);
#=> string(12) "Hello world!"

API

p810\Dot\find(string $needle, array $haystack): mixed

Searches an array for a value based on a dot notated string of keys

Argument Type Default Description
$needle string n/a A dot separated list of keys
$haystack array n/a The array to traverse

💡 p810\Dot\search() is an alias for this function

p810\Dot\getKeysFromString(string $keys): array<int,string|int>

Returns a list of keys from a dot notated string

Argument Type Default Description
$keys string n/a A dot separated list of keys

License

This package is released under the MIT License.