kodedphp / stdlib

ExtendedArguments.php

<?php declare(strict_types=1);

/*
 * This file is part of the Koded package.
 *
 * (c) Mihail Binev <mihail@kodeart.com>
 *
 * Please view the LICENSE distributed with this source code
 * for the full copyright and license information.
 */

namespace Koded\Stdlib;

use RecursiveArrayIterator;
use RecursiveIteratorIterator;
use function array_key_exists;
use function array_push;
use function array_slice;
use function explode;
use function is_array;
use function is_string;
use function join;
use function str_contains;

/**
 * Class ExtendedArguments
 *
 * - NULL key is not supported; also it doesn't make sense
 * - boolean is a wrong type for the key; do not use a boolean key (it's juggled into a string)
 *
 * Use string values for the keys and you'll be golden.
 *
 * @property array $data
 */

#[\AllowDynamicProperties]
class ExtendedArguments extends Arguments
{
    public function __construct(protected array $data = [])
    {
        $this->data = [];
        foreach ($data as $index => $value) {
            $this->set($index, $value);
        }
    }

    public function get(string $index, mixed $default = null): mixed
    {
        return $this->find($index, $default);
    }

    public function set(mixed $index, mixed $value): static
    {
        if (is_string($index) && false === str_contains($index, '.')) {
            return parent::set($index, $value);

The expression return parent::set($index, $value) returns the type Koded\Stdlib\Arguments which includes types incompatible with the type-hinted return Koded\Stdlib\ExtendedArguments.

        }
        $data =& $this->data;
        foreach (explode('.', (string)$index) as $i) {
            if (false === array_key_exists($i, $data) ||
                false === is_array($data[$i])
            ) {
                $data[$i] = [];
            }
            $data =& $data[$i];
        }
        $data = $value;
        return $this;
    }

    public function append(string $index, mixed $value): static
    {
        $partial = (array)$this->get($index);
        array_push($partial, $value);
        $this->set($index, $partial);
        return $this;
    }

    public function has(string $index): bool
    {
        if (false === str_contains($index, '.')) {
            return array_key_exists($index, $this->data);
        }
        $data =& $this->data;
        foreach (explode('.', $index) as $i) {
            if (false === is_array($data) ||
                false === array_key_exists($i, $data)
            ) {
                return false;
            }
            $data =& $data[$i];
        }
        return true;
    }

    public function delete(string $index): static
    {
        if (false === str_contains($index, '.')) {
            return parent::delete($index);

The expression return parent::delete($index) returns the type Koded\Stdlib\Arguments which includes types incompatible with the type-hinted return Koded\Stdlib\ExtendedArguments.

        }
        $data =& $this->data;
        foreach (explode('.', $index) as $i) {
            if (false === array_key_exists($i, $data) ||
                false === is_array($data[$i])
            ) {
                continue;
            }
            $data =& $data[$i];
        }
        if (isset($i)) {
            unset($data[$i]);
        }
        return $this;
    }

    public function extract(array $indexes): array
    {
        $found = [];
        foreach ($indexes as $index) {
            $found[$index] = $this->find($index);
        }
        return $found;
    }

    public function flatten(): static
    {
        $indexes = [];
        $flatten = [];
        $iterator = new RecursiveIteratorIterator(
            new RecursiveArrayIterator($this->data),
            RecursiveIteratorIterator::SELF_FIRST
        );
        foreach ($iterator as $index => $value) {
            $indexes[$iterator->getDepth()] = $index;
            if (false === is_array($value)) {
                $_ = join('.', array_slice($indexes, 0, $iterator->getDepth() + 1));
                $flatten[$_] = $value;
            }
        }
        return new static($flatten);
    }
}