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

IsObjectOfType::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 1
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
46
use GanbaroDigital\MissingBits\Checks\Check;
47
48
/**
49
 * do we have something that is a specific type of object?
50
 */
51
class IsObjectOfType implements Check
52
{
53
    /**
54
     * what type of object are we looking for?
55
     * @var string
56
     */
57
    private $expectedType;
58
59
    /**
60
     * create a new check
61
     *
62
     * @param string $expectedType
63
     *        the class or interface that we want to check against
64
     */
65
    public function __construct($expectedType)
66
    {
67
        $this->expectedType = $expectedType;
68
    }
69
70
    /**
71
     * fluent-interface entry point
72
     *
73
     * @param  string $expectedType
74
     *         the class or interface that we want to check against
75
     * @return IsObjectOfType
76
     */
77
    public static function using($expectedType)
78
    {
79
        return new static($expectedType);
80
    }
81
82
    /**
83
     * do we have something that is a specific type of object?
84
     *
85
     * @param  mixed $fieldOrVar
86
     *         the item to be checked
87
     * @param  string $expectedType
88
     *         the class or interface that we want to check against
89
     * @return bool
90
     *         TRUE if the item is the requested type
91
     *         FALSE otherwise
92
     */
93
    public static function check($fieldOrVar, $expectedType)
94
    {
95
        // make sure we have an object
96
        if (!is_object($fieldOrVar)) {
97
            return false;
98
        }
99
100
        if ($fieldOrVar instanceof $expectedType) {
101
            return true;
102
        }
103
104
        return false;
105
    }
106
107
    /**
108
     * do we have something that is a specific type of object?
109
     *
110
     * @param  mixed $fieldOrVar
111
     *         the item to be checked
112
     * @return bool
113
     *         TRUE if the item is the requested type
114
     *         FALSE otherwise
115
     */
116
    public function inspect($fieldOrVar)
117
    {
118
        return static::check($fieldOrVar, $this->expectedType);
119
    }
120
}
121