Hyde\Facades\Config

Complexity

Total Complexity

9

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getFloat()	0	3	1
A	getString()	0	3	1
A	getInt()	0	3	1
A	getArray()	0	3	1
A	getBool()	0	3	1
A	getNullableString()	0	9	2
A	validated()	0	7	2

<?php

declare(strict_types=1);

namespace Hyde\Facades;

use TypeError;

/**
 * An extension of the Laravel Config facade with extra
 * accessors that ensure the types of the returned values.
 *
 * @see \Illuminate\Config\Repository
 * @see \Illuminate\Support\Facades\Config
 * @see \Hyde\Framework\Testing\Feature\TypedConfigFacadeTest
 */
class Config extends \Illuminate\Support\Facades\Config
{
    public static function getArray(string $key, array $default = null): array
    {
        return (array) self::validated(static::get($key, $default), 'array', $key);
    }

    public static function getString(string $key, string $default = null): string
    {
        return (string) self::validated(static::get($key, $default), 'string', $key);
    }

    public static function getInt(string $key, int $default = null): int
    {
        return (int) self::validated(static::get($key, $default), 'int', $key);
    }

    public static function getBool(string $key, bool $default = null): bool
    {
        return (bool) self::validated(static::get($key, $default), 'bool', $key);
    }

    public static function getFloat(string $key, float $default = null): float
    {
        return (float) self::validated(static::get($key, $default), 'float', $key);
    }

    /** @experimental */
    public static function getNullableString(string $key, string $default = null): ?string
    {
        $value = static::get($key, $default);

        if ($value === null) {
            return null;
        }

        return (string) self::validated($value, 'string', $key);
    }

    protected static function validated(mixed $value, string $type, string $key): mixed
    {
        if (! ("is_$type")($value)) {
            throw new TypeError(sprintf('%s(): Config value %s must be of type %s, %s given', __METHOD__, $key, $type, gettype($value)));
        }

        return $value;
    }
}