Completed
Pull Request — master (#12)
by Timur
06:54
created

InvalidSettingsValue::getFailedKey()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
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("Given value is not a registered allowed value for {$key}.");
26
27
        return $exception->setFailedKey($key);
28
    }
29
30
    /**
31
     * Sets failed key name.
32
     *
33
     * @param string $key
34
     *
35
     * @return static
36
     */
37
    public function setFailedKey($key)
38
    {
39
        $this->failedKey = $key;
40
41
        return $this;
42
    }
43
44
    /**
45
     * Returns failed key name.
46
     *
47
     * @return string
48
     */
49
    public function getFailedKey()
50
    {
51
        return $this->failedKey;
52
    }
53
}
54