Completed
Push — develop ( dcce5a...3de28d )
by Stuart
02:24
created

IsClassProperty::using()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

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