HasClassProperties::__construct() - Code Metrics - Inspection of "Fix: HasClassProperties throws TypeError now" - ganbarodigital/php-the-missing-bits - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( f80003...852d20 )

by Stuart

created 2017-06-10 19:04 UTC

HasClassProperties::__construct() A

↳ Parent: HasClassProperties

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

/**
 * Copyright (c) 2016-present Ganbaro Digital Ltd
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the names of the copyright holders nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Libraries
 * @package   MissingBits/ClassesAndObjects
 * @author    Stuart Herbert <[email protected]>
 * @copyright 2016-present Ganbaro Digital Ltd www.ganbarodigital.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://ganbarodigital.github.io/php-the-missing-bits
 */

namespace GanbaroDigital\MissingBits\ClassesAndObjects;

use GanbaroDigital\MissingBits\Checks\Check;
use GanbaroDigital\MissingBits\Checks\ListCheck;
use GanbaroDigital\MissingBits\Checks\ListCheckHelper;
use InvalidArgumentException;
use ReflectionClass;
use ReflectionProperty;
use TypeError;

/**
 * does a class have static properties?
 */
class HasClassProperties implements Check, ListCheck
{
    // save us having to implement it ourselves
    use ListCheckHelper;

    /**
     * which types of property do we want to check for?
     * @var int
     */
    protected $propTypes;

    /**
     * create a customised HasClassProperties checker, ready to use
     *
     * @param  int $propTypes
     *         the kind of properties to look for
     *         default is to look for public properties only
     * @return HasClassProperties

     *         a customised Check, ready to use
     */
    public function __construct($propTypes = ReflectionProperty::IS_PUBLIC)
    {
        $this->propTypes = $propTypes;
    }

    /**
     * create a customised HasClassProperties checker, ready to use
     *
     * @param  int $propTypes
     *         the kind of properties to look for
     *         default is to look for public properties only
     * @return HasClassProperties
     *         a customised Check, ready to use
     */
    public static function using($propTypes = ReflectionProperty::IS_PUBLIC)
    {
        return new static($propTypes);
    }

    /**
     * does a class have static properties?
     *
     * @param  string $target
     *         the class to examine
     * @return boolean
     *         TRUE if the class has static properties
     *         FALSE otherwise
     * @throws InvalidArgumentException
     *         if $target is not a valid class name
     */
    public function inspect($target)
    {
        return static::check($target, $this->propTypes);
    }

    /**
     * does a class have static properties?
     *
     * @param  string $target
     *         the class to examine
     * @param  int $propTypes
     *         the kind of properties to look for
     *         default is to look for public properties only
     * @return boolean
     *         TRUE if the class has static properties
     *         FALSE otherwise
     * @throws InvalidArgumentException
     *         if $target is not a valid class name
     */
    public static function check($target, $propTypes = ReflectionProperty::IS_PUBLIC)
    {
        // robustness!!
        if (!check_is_stringy($target)) {
            throw new TypeError('$target is not a string, is a ' . get_printable_type($target));
        }

        // make sure we have a valid class
        if (!class_exists($target) && !interface_exists($target)) {
            throw new InvalidArgumentException("class/interface '" . $target . "' not found");
        }

        // if we get here, then we want to do this
        $refObj = new ReflectionClass($target);
        $resultFilter = [IsClassProperty::class, 'check'];
        return HasFilteredProperties::check($refObj, $propTypes | ReflectionProperty::IS_STATIC, $resultFilter);
    }

    /**
     * does a list of classes have static properties?
     *
     * @param  mixed $list
     *         the list of classes to examine
     * @param  int $propTypes
     *         the kind of properties to look for
     *         default is to look for public properties only
     * @return boolean
     *         TRUE if the class has static properties
     *         FALSE otherwise
     * @throws InvalidArgumentException
     *         if $target is not a valid class name
     */
    public static function checkList($list, $propTypes = ReflectionProperty::IS_PUBLIC)
    {
        $check = new static($propTypes);
        return $check->inspectList($list);
    }
}


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 GanbaroDigital\MissingBits\Checks\ListCheck;
48			use GanbaroDigital\MissingBits\Checks\ListCheckHelper;
49			use InvalidArgumentException;
50			use ReflectionClass;
51			use ReflectionProperty;
52			use TypeError;
53
54			/**
55			* does a class have static properties?
56			*/
57			class HasClassProperties implements Check, ListCheck
58			{
59			// save us having to implement it ourselves
60			use ListCheckHelper;
61
62			/**
63			* which types of property do we want to check for?
64			* @var int
65			*/
66			protected $propTypes;
67
68			/**
69			* create a customised HasClassProperties checker, ready to use
70			*
71			* @param int $propTypes
72			* the kind of properties to look for
73			* default is to look for public properties only
74			* @return HasClassProperties
			0 ignored issues – show Comprehensibility Best Practice introduced 2017-06-10 19:06 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
75			* a customised Check, ready to use
76			*/
77			public function __construct($propTypes = ReflectionProperty::IS_PUBLIC)
78			{
79			$this->propTypes = $propTypes;
80			}
81
82			/**
83			* create a customised HasClassProperties checker, ready to use
84			*
85			* @param int $propTypes
86			* the kind of properties to look for
87			* default is to look for public properties only
88			* @return HasClassProperties
89			* a customised Check, ready to use
90			*/
91			public static function using($propTypes = ReflectionProperty::IS_PUBLIC)
92			{
93			return new static($propTypes);
94			}
95
96			/**
97			* does a class have static properties?
98			*
99			* @param string $target
100			* the class to examine
101			* @return boolean
102			* TRUE if the class has static properties
103			* FALSE otherwise
104			* @throws InvalidArgumentException
105			* if $target is not a valid class name
106			*/
107			public function inspect($target)
108			{
109			return static::check($target, $this->propTypes);
110			}
111
112			/**
113			* does a class have static properties?
114			*
115			* @param string $target
116			* the class to examine
117			* @param int $propTypes
118			* the kind of properties to look for
119			* default is to look for public properties only
120			* @return boolean
121			* TRUE if the class has static properties
122			* FALSE otherwise
123			* @throws InvalidArgumentException
124			* if $target is not a valid class name
125			*/
126			public static function check($target, $propTypes = ReflectionProperty::IS_PUBLIC)
127			{
128			// robustness!!
129			if (!check_is_stringy($target)) {
130			throw new TypeError('$target is not a string, is a ' . get_printable_type($target));
131			}
132
133			// make sure we have a valid class
134			if (!class_exists($target) && !interface_exists($target)) {
135			throw new InvalidArgumentException("class/interface '" . $target . "' not found");
136			}
137
138			// if we get here, then we want to do this
139			$refObj = new ReflectionClass($target);
140			$resultFilter = [IsClassProperty::class, 'check'];
141			return HasFilteredProperties::check($refObj, $propTypes \| ReflectionProperty::IS_STATIC, $resultFilter);
142			}
143
144			/**
145			* does a list of classes have static properties?
146			*
147			* @param mixed $list
148			* the list of classes to examine
149			* @param int $propTypes
150			* the kind of properties to look for
151			* default is to look for public properties only
152			* @return boolean
153			* TRUE if the class has static properties
154			* FALSE otherwise
155			* @throws InvalidArgumentException
156			* if $target is not a valid class name
157			*/
158			public static function checkList($list, $propTypes = ReflectionProperty::IS_PUBLIC)
159			{
160			$check = new static($propTypes);
161			return $check->inspectList($list);
162			}
163			}
164

ganbarodigital / php-the-missing-bits

Push — develop ( f80003...852d20 )

HasClassProperties::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like