Completed
Push — develop ( 0790da...7befb7 )
by Stuart
02:26
created

FilterObjectProperties::from()   A

Complexity

Conditions 3
Paths 2

Size

Total Lines 19
Code Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 3
eloc 10
c 1
b 0
f 1
nc 2
nop 2
dl 0
loc 19
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 InvalidArgumentException;
47
use ReflectionObject;
48
use ReflectionProperty;
49
50
class FilterObjectProperties
51
{
52
    /**
53
     * get an object's non-static properties
54
     *
55
     * @param  object $target
56
     *         the object to examine
57
     * @param  int $filter
58
     *         the kind of properties to look for
59
     *         default is to look for public properties only
60
     * @return array
61
     *         a (possibly empty) read-only list of the object's
62
     *         non-static properties
63
     * @throws InvalidArgumentException
64
     *         if $target is not an object
65
     */
66
    public static function from($target, $filter = ReflectionProperty::IS_PUBLIC)
67
    {
68
        // robustness!!
69
        if (!is_object($target)) {
70
            throw new InvalidArgumentException('$target is not an object, is a ' . get_printable_type($target));
71
        }
72
73
        // if we get here, then we want to do this
74
        $refObj = new ReflectionObject($target);
75
        $resultFilter = function(ReflectionProperty $refProp, &$finalResult) use($target) {
76
            if (!IsObjectProperty::check($refProp)) {
77
                return;
78
            }
79
80
            $refProp->setAccessible(true);
81
            $finalResult[$refProp->getName()] = $refProp->getValue($target);
82
        };
83
        return FilterProperties::from($refObj, $filter, $resultFilter);
84
    }
85
}
86