quorum/dot-notation

Simple PHP Dot Notation Parser

v1.1.0 2025-04-12 22:50 UTC

This package is auto-updated.

Last update: 2025-04-16 15:00:10 UTC


README

Latest Stable Version Total Downloads License ci.yml

DotNotationParser is a simple parser that will parse foo.bar.baz into [ 'foo', 'bar', 'baz' ] and foo."bar.baz" into [ 'foo', 'bar.baz' ].

Requirements

  • php: >=7.1

Installing

Install the latest version with:

composer require 'quorum/dot-notation'

Documentation

Class: Quorum\DotNotation\DotNotationParser

Class DotPathParser

Parse strings like foo."bar.baz".quux into [ 'foo', 'bar.baz', 'quux' ]

Method: DotNotationParser->parse

function parse(string $path) : array

Parse a given dot notation path into it's parts

The path is expected to be a string of dot separated keys, where keys can be
quoted with double quotes. Backslashes are used to escape double quotes inside
quoted keys.

Examples
  • 'foo.bar.baz' => [ 'foo', 'bar', 'baz' ]
  • 'foo."bar.baz"' => [ 'foo', 'bar.baz' ]
  • 'foo."bar.baz".quux' => [ 'foo', 'bar.baz', 'quux' ]
  • 'foo."bar\"baz".quux' => [ 'foo', 'bar"baz', 'quux' ]

Throws: \Quorum\DotNotation\Exceptions\ParseException

Returns:
  • string[]