README

About package

This package get data from an associative array.

Knowing the path to the data you need in the array, you can easily get it using ArrayParser, without having to iterate through the array yourself.

Содержание

1. Setup
2. Using
   1. ParserString
      1. Without collection
      2. With collection
   2. Parse object
   3. Examples of using
3. Additionally
   1. Unique values

Setup

To install the package, run on the command line:

composer install lupsor/array-parser

Using

To get the desired value, run: ArrayParser::parse($data, $parserString), where $date is an array from which you want to get the value, and $parserString is a link to the received data

ParserString

Without collection

Before you get the necessary data, you need to form a link to the data you need. Example:

three->one->one, where three, one and one - are the array key, and -> is the separator.

Based on this example, the ArrayParser will refer to the array element with the key three, there it will refer to the element with the key one and it will get the value of the element with the key one.

With collection

You can also get data from the collection by wrapping the required value in square brackets ([, ]). Example:

three->[one], where [one] - collection. The parser will iterate over all the values in the element with the key "three" and from each element of the array will get the value with the key "one".

The collection can be more complex, like [one->two]. You can learn more about this structure in example No. 2 and 3.

Parse object

The first argument ArrayParser::parse ($data) can be sent as an object, in which case the path must only point to functions that require no arguments.

Examples of using

Example 1 (without collection)

use Lupsor\ArrayParser\ArrayParser;

$data = [
    'one' => 'oneValue',
    'three' => [
        'one' => ['one' => 'threeOneOneValue',],
    ],
];
$parserString = 'three->one->one';

ArrayParser::parse($data, $parserString);

The result of running this example will be: threeOneOneValue

Example 2 (with collection)

use Lupsor\ArrayParser\ArrayParser;

$data = [
    'four' => [
        ['one' => 'fourOneValue',],
        ['one' => 'fourTwoValue',],
    ],
];
$parserString = 'four->[one]';

ArrayParser::parse($data, $parserString);

Result: fourOneValue, fourTwoValue

Example 3 (with collection)

use Lupsor\ArrayParser\ArrayParser;

$data = [
    'five' => [
        [
            'one' => [
                ['one' => 'fiveOneOneValue',],
                ['one' => 'fourOneTwoValue',],
            ],
        ],
        [
            'one' => [
                ['one' => 'fiveTwoOneValue',],
                ['one' => 'fourTwoTwoValue',],
                ['one' => 'fourTwoThreeValue',],
            ],
        ],
    ],
];
$parserString = 'five->[one->[one]]';

ArrayParser::parse($data, $parserString);

Result: fiveOneOneValue, fourOneTwoValue, fiveTwoOneValue, fourTwoTwoValue, fourTwoThreeValue

Additionally

Unique values

You can return only unique values by adding :unique at the end of ParserString. Example: five->[one->[one]]:unique