InvalidSettingsValue::getFailedKey()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
eloc 1
dl 0
loc 3
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 0
1
<?php
2
3
namespace LaravelPropertyBag\Exceptions;
4
5
use Exception;
6
7
class InvalidSettingsValue extends Exception
8
{
9
    /**
10
     * Failed key name.
11
     *
12
     * @var string
13
     */
14
    protected $failedKey;
15
16
    /**
17
     * Setting value is not definied in key's allowed values array.
18
     *
19
     * @param string $key
20
     *
21
     * @return static
22
     */
23
    public static function settingNotAllowed($key)
24
    {
25
        $exception = new static(
26
            "Given value is not a registered allowed value for {$key}."
27
        );
28
29
        return $exception->setFailedKey($key);
30
    }
31
32
    /**
33
     * Set failed key name.
34
     *
35
     * @param string $key
36
     *
37
     * @return static
38
     */
39
    public function setFailedKey($key)
40
    {
41
        $this->failedKey = $key;
42
43
        return $this;
44
    }
45
46
    /**
47
     * Return failed key name.
48
     *
49
     * @return string
50
     */
51
    public function getFailedKey()
52
    {
53
        return $this->failedKey;
54
    }
55
}
56