Completed
Push — develop ( b9756c...666e87 )
by Stuart
02:32
created

IsClassProperty::checkList()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 3
nc 1
nop 1
dl 0
loc 5
rs 9.4285
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/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\Check;
47
use ReflectionProperty;
48
use TypeError;
49
50
/**
51
 * is this property a class property?
52
 */
53
class IsClassProperty implements Check
54
{
55
    /**
56
     * is this property a class property?
57
     *
58
     * @param  ReflectionProperty $refProp
59
     *         the property to inspect
60
     * @return bool
61
     *         TRUE if $refProp is a class property
62
     *         FALSE otherwise
63
     */
64
    public static function check(ReflectionProperty $refProp)
65
    {
66
        if ($refProp->isStatic()) {
67
            return true;
68
        }
69
70
        return false;
71
    }
72
73
    /**
74
     * is this property a class property?
75
     *
76
     * NOTE: we cannot add a type-hint to $refProp below, as that will cause
77
     * a PHP Fatal Error
78
     *
79
     * @param  ReflectionProperty $refProp
80
     *         the property to inspect
81
     * @return bool
82
     *         TRUE if $refProp is a class property
83
     *         FALSE otherwise
84
     */
85
    public function inspect($refProp)
86
    {
87
        // robustness!
88
        if (! $refProp instanceof ReflectionProperty) {
89
            throw new TypeError('$refProp is not a ReflectionProperty, is a ' . get_printable_type($refProp));
90
        }
91
        return static::check($refProp);
92
    }
93
94
    /**
95
     * create a new IsClassProperty checker, ready to use
96
     *
97
     * we do not support any customisations
98
     *
99
     * @return IsClassProperty
100
     */
101
    public static function using()
102
    {
103
        return new static();
104
    }
105
}
106