Completed
Push — develop ( 97bd6f...558873 )
by Stuart
02:42
created

IsDefinedObjectType::check()   A

Complexity

Conditions 4
Paths 3

Size

Total Lines 15
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 4
eloc 6
nc 3
nop 1
dl 0
loc 15
rs 9.2
c 1
b 0
f 1
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
use GanbaroDigital\MissingBits\Checks\ListCheck;
48
use GanbaroDigital\MissingBits\Checks\ListCheckHelper;
49
50
/**
51
 * do we have a valid type name for an object?
52
 */
53
class IsDefinedObjectType implements Check, ListCheck
54
{
55
    // saves us having to implement inspectList() ourselves
56
    use ListCheckHelper;
57
58
    /**
59
     * is $fieldOrVar a valid type for an object?
60
     *
61
     * @param mixed $fieldOrVar
62
     *        the name to check
63
     * @return bool
64
     *         TRUE if $fieldOrVar is a class or interface name
65
     *         FALSE otherwise
66
     */
67
    public static function check($fieldOrVar)
68
    {
69
        // this prevents PHP runtime errors
70
        if (!IsStringy::check($fieldOrVar)) {
71
            return false;
72
        }
73
74
        // general cases
75
        if (class_exists($fieldOrVar) || interface_exists($fieldOrVar)) {
76
            return true;
77
        }
78
79
        // if we get here, we have run out of ideas
80
        return false;
81
    }
82
83
    /**
84
     * is $fieldOrVar a valid type for an object?
85
     *
86
     * @param mixed $fieldOrVar
87
     *        the name to check
88
     * @return bool
89
     *         TRUE if $fieldOrVar is a class or interface name
90
     *         FALSE otherwise
91
     */
92
    public function inspect($fieldOrVar)
93
    {
94
        return static::check($fieldOrVar);
95
    }
96
97
    /**
98
     * is every entry in $list a valid type for an object?
99
     *
100
     * @param  mixed $list
101
     *         the list of items to be checked
102
     * @return bool
103
     *         TRUE if every item in $list is a a valid type for an object
104
     *         FALSE otherwise
105
     */
106
    public static function checkList($list)
107
    {
108
        $check = new static;
109
        return $check->inspectList($list);
110
    }
111
}
112