Completed
Push — develop ( d25f12...63ca9b )
by Stuart
02:47
created

IsClassProperty::check()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 8
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 2
eloc 4
c 1
b 0
f 1
nc 2
nop 1
dl 0
loc 8
rs 9.4285
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/ClassesAndObjects
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\ClassesAndObjects;
45
46
use GanbaroDigital\MissingBits\Checks\ListableCheck;
47
use GanbaroDigital\MissingBits\Checks\Check;
48
use GanbaroDigital\MissingBits\Checks\ListCheck;
49
use ReflectionProperty;
50
51
/**
52
 * is this property a class property?
53
 */
54
class IsClassProperty implements Check, ListCheck
55
{
56
    // saves us having to implement inspectList() ourselves
57
    use ListableCheck;
58
59
    /**
60
     * is this property a class property?
61
     *
62
     * @param  ReflectionProperty $refProp
63
     *         the property to inspect
64
     * @return bool
65
     *         TRUE if $refProp is a class property
66
     *         FALSE otherwise
67
     */
68
    public static function check(ReflectionProperty $refProp)
69
    {
70
        if ($refProp->isStatic()) {
71
            return true;
72
        }
73
74
        return false;
75
    }
76
77
    /**
78
     * is this property a class property?
79
     *
80
     * NOTE: we cannot add a type-hint to $refProp below, as that will cause
81
     * a PHP Fatal Error
82
     *
83
     * @param  ReflectionProperty $refProp
84
     *         the property to inspect
85
     * @return bool
86
     *         TRUE if $refProp is a class property
87
     *         FALSE otherwise
88
     */
89
    public function inspect($refProp)
90
    {
91
        return static::check($refProp);
92
    }
93
94
    /**
95
     * are all the properties in the list class properties?
96
     *
97
     * @param  mixed $list
98
     *         the list of properties to inspect
99
     * @return bool
100
     *         TRUE if all the entries in the list are class
101
     *         properties
102
     *         FALSE otherwise
103
     */
104
    public static function checkList($list)
105
    {
106
        $check = new static();
107
        return $check->inspectList($list);
108
    }
109
}
110