slickframework / configuration

src/Driver/CommonDriverMethods.php

<?php

/**
 * This file is part of Configuration
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slick\Configuration\Driver;

use Slick\Configuration\ConfigurationInterface;
use Slick\Configuration\Exception\FileNotFoundException;

/**
 * Common Driver Methods Trait
 *
 * @package Slick\Configuration\Driver
 */
trait CommonDriverMethods
{

    /**
     * @var array<string, mixed>
     */
    protected array|int $data = [];

    /**
     * Checks if provided file exists
     *
     * @param string $file
     *
     * @throws FileNotFoundException if provided file does not exist
     */
    protected function checkFile(string $file): void
    {
        if (!is_file($file)) {
            throw new FileNotFoundException(
                "Configuration file $file could not be found."
            );
        }
    }

    /**
     * Returns the value store with provided key or the default value.
     *
     * @param string $key     The key used to store the value in configuration
     * @param mixed|null $default The default value if not found
     * @return mixed The stored value or the default value if key
     *  was not found.
     */
    public function get(string $key, mixed $default = null): mixed
    {
        $data = is_array($this->data) ? $this->data : [];
        return static::getValue($key, $default, $data);
    }

    /**
     * Set/Store the provided value with a given key.
     *
     * @param string $key The key used to store the value in configuration.
     * @param mixed $value The value to store under the provided key.
     *
     * @return ConfigurationInterface Self instance for method call chains.
     */
    public function set(string $key, mixed $value): ConfigurationInterface
    {
        static::setValue($key, $value, $this->data);

It seems like $this->data can also be of type integer; however, parameter $data of Slick\Configuration\Driver\CommonDriverMethods::setValue() does only seem to accept array, maybe add an additional type check?

        return $this;

The expression return $this returns the type Slick\Configuration\Driver\CommonDriverMethods which is incompatible with the type-hinted return Slick\Configuration\ConfigurationInterface.

    }

    /**
     * Recursive method to parse dot notation keys and retrieve the value
     *
     * @param string $key     The key/index to search
     * @param mixed  $default The value if key doesn't exist
     * @param array<string, mixed> $data    The data to search
     *
     * @return mixed The stored value or the default value if key
     *               or index don't exist
     */
    public static function getValue(string $key, mixed $default, array $data): mixed
    {
        $parts = explode('.', $key);
        $first = array_shift($parts);
        if (isset($data[$first])) {
            if (count($parts) > 0) {
                $newKey = implode('.', $parts);
                return static::getValue($newKey, $default, $data[$first]);
            }
            $default = $data[$first];
        }
        return $default;
    }
    /**
     * Recursive method to parse dot notation keys and set the value
     *
     * @param string $key   The key used to store the value in configuration.
     * @param mixed  $value The value to store under the provided key.
     * @param array<string, mixed> $data  The data to search
     */
    public static function setValue(string $key, mixed $value, array &$data): void
    {
        $parts = explode('.', $key);
        $first = array_shift($parts);
        if (count($parts) > 0) {
            $newKey = implode('.', $parts);
            $data[$first] = array_key_exists($first, $data) ? [$first => $data[$first]] : [];
            static::setValue($newKey, $value, $data[$first]);
            return;
        }
        $data[$first] = $value;
    }

    /**
     * @inheritdoc
     */
    public function asArray(): array
    {
        return is_array($this->data) ? $this->data : [];
    }
}