Completed
Push — develop ( 6ec5ed...eac156 )
by Stuart
05:24
created

IsLogical::using()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 2
nc 1
nop 0
dl 0
loc 4
rs 10
c 0
b 0
f 0
1
<?php
2
3
/**
4
 * Copyright (c) 2016-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   MissingBits/TypeChecks
38
 * @author    Stuart Herbert <[email protected]>
39
 * @copyright 2016-present Ganbaro Digital Ltd www.ganbarodigital.com
40
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
41
 * @link      http://ganbarodigital.github.io/php-the-missing-bits
42
 */
43
44
namespace GanbaroDigital\MissingBits\TypeChecks;
45
use GanbaroDigital\MissingBits\Checks\Check;
46
use GanbaroDigital\MissingBits\TypeInterfaces\Logical;
47
48
/**
49
 * do we have something that can be used as a boolean value?
50
 */
51
class IsLogical implements Check
52
{
53
    /**
54
     * fluent-interface entry point
55
     *
56
     * we do not support any customisations
57
     * @return IsLogical
58
     */
59
    public static function using()
60
    {
61
        return new static;
62
    }
63
64
    /**
65
     * do we have something that can be used as a boolean value?
66
     *
67
     * @param  mixed $fieldOrVar
68
     *         the item to be checked
69
     * @return bool
70
     *         TRUE if the item can be used as a boolean
71
     *         FALSE otherwise
72
     */
73
    public static function check($fieldOrVar)
74
    {
75
        // general case
76
        if (is_bool($fieldOrVar)) {
77
            return true;
78
        }
79
80
        // we also support objects that co-operate
81
        if (is_object($fieldOrVar) && $fieldOrVar instanceof Logical) {
82
            return true;
83
        }
84
85
        // if we get here, we have run out of ideas
86
        return false;
87
    }
88
89
    /**
90
     * do we have something that can be used as a boolean value?
91
     *
92
     * @param  mixed $fieldOrVar
93
     *         the item to be checked
94
     * @return bool
95
     *         TRUE if the item can be used as a boolean
96
     *         FALSE otherwise
97
     */
98
    public function inspect($fieldOrVar)
99
    {
100
        return static::check($fieldOrVar);
101
    }
102
}
103