framework/src/Config/Config.php at 5.1 · userfrosting/framework · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<?php

declare(strict_types=1);

/*
 * UserFrosting Framework (http://www.userfrosting.com)
 *
 * @link      https://github.com/userfrosting/framework
 * @copyright Copyright (c) 2013-2024 Alexander Weissman, Louis Charette, Jordan Mele
 * @license   https://github.com/userfrosting/framework/blob/master/LICENSE.md (MIT License)
 */

namespace UserFrosting\Config;

use UserFrosting\Support\Repository\Repository;

/**
 * Config Repository. Adds type specific getters.
 */
class Config extends Repository
{
    /**
     * Get the specified configuration value as bool.
     * Returns null if the key is not found, unless a default is provided, in
     * which case the return value is type safe (can't be null).
     *
     * @param string    $key
     * @param bool|null $default
     *
     * @return ($default is null ? bool|null : bool)
     */
    public function getBool(string $key, ?bool $default = null): ?bool
    {
        $value = $this->get($key, $default) ?? $default;

        if (!is_bool($value) && !is_null($value)) {
            throw new TypeException("Config key '$key' doesn't return bool.");
        }

        return $value;
    }

    /**
     * Get the specified configuration value as bool.
     * Returns null if the key is not found, unless a default is provided, in
     * which case the return value is type safe (can't be null).
     *
     * @param string      $key
     * @param string|null $default
     *
     * @return ($default is null ? string|null : string)
     */
    public function getString(string $key, ?string $default = null): ?string
    {
        $value = $this->get($key, $default) ?? $default;

        if (!is_string($value) && !is_null($value)) {
            throw new TypeException("Config key '$key' doesn't return string.");
        }

        return $value;
    }

    /**
     * Get the specified configuration value as bool.
     * Returns null if the key is not found, unless a default is provided, in
     * which case the return value is type safe (can't be null).
     *
     * @param string   $key
     * @param int|null $default
     *
     * @return ($default is null ? int|null : int)
     */
    public function getInt(string $key, ?int $default = null): ?int
    {
        $value = $this->get($key, $default) ?? $default;

        if (!is_int($value) && !is_null($value)) {
            throw new TypeException("Config key '$key' doesn't return int.");
        }

        return $value;
    }

    /**
     * Get the specified configuration value as bool.
     * Returns null if the key is not found, unless a default is provided, in
     * which case the return value is type safe (can't be null).
     *
     * @param string       $key
     * @param mixed[]|null $default
     *
     * @return ($default is null ? mixed[]|null : mixed[])
     */
    public function getArray(string $key, ?array $default = null): ?array
    {
        $value = $this->get($key, $default) ?? $default;

        if (!is_array($value) && !is_null($value)) {
            throw new TypeException("Config key '$key' doesn't return array.");
        }

        return $value;
    }
}