RequireLogical::checkMixed()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 1 Features 0
Metric Value
c 2
b 1
f 0
dl 0
loc 4
rs 10
cc 1
eloc 2
nc 1
nop 2
1
<?php
2
3
/**
4
 * Copyright (c) 2015-present Ganbaro Digital Ltd
5
 * All rights reserved.
6
 *
7
 * Redistribution and use in source and binary forms, with or without
8
 * modification, are permitted provided that the following conditions
9
 * are met:
10
 *
11
 *   * Redistributions of source code must retain the above copyright
12
 *     notice, this list of conditions and the following disclaimer.
13
 *
14
 *   * Redistributions in binary form must reproduce the above copyright
15
 *     notice, this list of conditions and the following disclaimer in
16
 *     the documentation and/or other materials provided with the
17
 *     distribution.
18
 *
19
 *   * Neither the names of the copyright holders nor the names of his
20
 *     contributors may be used to endorse or promote products derived
21
 *     from this software without specific prior written permission.
22
 *
23
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34
 * POSSIBILITY OF SUCH DAMAGE.
35
 *
36
 * @category  Libraries
37
 * @package   Reflection/Requirements
38
 * @author    Stuart Herbert <[email protected]>
39
 * @copyright 2015-present Ganbaro Digital Ltd www.ganbarodigital.com
40
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
41
 * @link      http://code.ganbarodigital.com/php-reflection
42
 */
43
44
namespace GanbaroDigital\Reflection\Requirements;
45
46
use GanbaroDigital\Reflection\Exceptions\E4xx_UnsupportedType;
47
use GanbaroDigital\Reflection\Checks\IsLogical;
48
use GanbaroDigital\Reflection\ValueBuilders\SimpleType;
49
50
class RequireLogical
51
{
52
    /**
53
     * throws exceptions if $item is not a data type that we can use as
54
     * a boolean
55
     *
56
     * @param  mixed $item
57
     *         the container to check
58
     * @param  string $exception
59
     *         the class to use when throwing an exception
60
     * @return void
61
     */
62
    public static function check($item, $exception = E4xx_UnsupportedType::class)
63
    {
64
        // make sure we have a stringy type
65
        if (!IsLogical::check($item)) {
66
            throw new $exception(SimpleType::from($item));
67
        }
68
    }
69
70
    /**
71
     * throws exceptions if $item is not a data type that we can use as
72
     * a boolean
73
     *
74
     * @deprecated since 2.10.0
75
     * @codeCoverageIgnore
76
     * @param  mixed $item
77
     *         the container to check
78
     * @param  string $exception
79
     *         the class to use when throwing an exception
80
     * @return void
81
     */
82
    public static function checkMixed($item, $exception = E4xx_UnsupportedType::class)
83
    {
84
        self::check($item, $exception);
85
    }
86
87
    /**
88
     * throws exceptions if $item is not a data type that we can use as
89
     * a boolean
90
     *
91
     * @param  mixed $item
92
     *         the container to check
93
     * @param  string $exception
94
     *         the class to use when throwing an exception
95
     * @return void
96
     */
97
    public function __invoke($item, $exception = E4xx_UnsupportedType::class)
98
    {
99
        self::check($item, $exception);
100
    }
101
}