DotNotationCollection.php

<?php

declare(strict_types=1);

namespace Peak\Collection;

use Peak\Blueprint\Collection\Dictionary;
use \RuntimeException;

use function array_key_exists;
use function array_shift;
use function count;
use function explode;
use function is_array;

class DotNotationCollection extends Collection implements Dictionary
{
    /**
     * @const string
     */
    const SEPARATOR = '.';

    /**
     * Return a path value
     * @param string $path
     * @param mixed $default
     * @return mixed
     */
    public function get(string $path, $default = null)
    {
        $array = $this->items;

        if (!empty($path)) {
            $keys = $this->explode($path);
            foreach ($keys as $key) {
                if (!is_array($array) || !array_key_exists($key, $array)) {
                    return $default;
                }
                $array = $array[$key];
            }
        }

        return $array;
    }

    /**
     * Add a path
     * @param string $path
     * @param mixed $value
     */
    public function set(string $path, $value): void
    {
        if (!empty($path)) {
            $at = & $this->items;
            $keys = $this->explode($path);

            while (count($keys) > 0) {
                if (count($keys) === 1) {
                    if (!is_array($at)) {
                        throw new RuntimeException('Can not set value at this path ['.$path.'] because is not array.');
                    }
                    $at[array_shift($keys)] = $value;
                } else {
                    $key = array_shift($keys);
                    if (!isset($at[$key])) {
                        $at[$key] = [];
                    }
                    $at =& $at[$key];
                }
            }
        } else {
            $this->items = [$value];
        }
    }

    /**
     * Merge a path with an array
     * @param string $path
     * @param array $values
     */
    public function add(string $path, array $values): void
    {
        $get = (array)$this->get($path);
        $this->set($path, $this->arrayMergeRecursiveDistinct($get, $values));
    }

    /**
     * Check if we have path
     * @param  string $path
     * @return bool
     */
    public function has(string $path): bool
    {
        $keys = $this->explode($path);
        $array = $this->items;
        foreach ($keys as $key) {
            if (!is_array($array) || !array_key_exists($key, $array)) {
                return false;
            }
            $array = $array[$key];
        }
        return true;
    }

    /**
     * Explode path string
     * @param string $path
     * @return mixed
     */
    protected function explode(string $path)
    {
        return explode(self::SEPARATOR, $path);
    }
}