IsTraversable::calculateResult() - Code Metrics - ganbarodigital/php-reflection - Measure and Improve Code Quality continuously with Scrutinizer

IsTraversable::calculateResult() A
last analyzed 2016-02-23 09:08 UTC

↳ Parent: IsTraversable

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	11
rs	9.4285
cc	3
eloc	6
nc	3
nop	1

<?php

/**
 * Copyright (c) 2015-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   Reflection/Checks
 * @author    Stuart Herbert <[email protected]>
 * @copyright 2015-present Ganbaro Digital Ltd www.ganbarodigital.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://code.ganbarodigital.com/php-reflection
 */

namespace GanbaroDigital\Reflection\Checks;

use stdClass;
use IteratorAggregate;
use Traversable;
use GanbaroDigital\DataContainers\Caches\StaticDataCache;
use GanbaroDigital\Reflection\ValueBuilders\AllMatchingTypesList;

class IsTraversable
{
    // speed repeated things up
    use StaticDataCache;

    /**
     * list of types that we consider to be traversable
     *
     * @var array
     */
    private static $acceptableTypes = [
        'Array'                  => true,
        stdClass::class          => true,
        Traversable::class       => true,
        IteratorAggregate::class => true,
    ];

    /**
     * is $item something that can be used in a foreach() loop?
     *
     * @param  mixed $item
     *         the item to examine
     * @return boolean
     *         true if the item can be used in a foreach() loop
     *         false otherwise
     */
    public static function check($item)
    {
        if (($retval = self::getCachedResult($item)) !== null) {
            return $retval;
        }

        $retval = self::calculateResult($item);

        self::setCachedResult($item, $retval);
        return $retval;
    }

    /**
     * is $item something that can be used in a foreach() loop?
     *
     * @param  mixed $item
     *         the item to examine
     * @return boolean
     *         true if the item can be used in a foreach() loop
     *         false otherwise
     */
    private static function calculateResult($item)
    {
        $itemTypes = AllMatchingTypesList::from($item);
        foreach ($itemTypes as $itemType) {
            if (isset(self::$acceptableTypes[$itemType])) {
                return true;
            }
        }

        return false;
    }

    /**
     * is $item something that can be used in a foreach() loop?
     *
     * @deprecated since 2.10.0
     * @codeCoverageIgnore
     * @param  mixed $item
     *         the item to examine
     * @return boolean
     *         true if the item can be used in a foreach() loop
     *         false otherwise
     */
    public static function checkMixed($item)
    {
        return self::check($item);
    }

    /**
     * is $item something that can be used in a foreach() loop?
     *
     * @param  mixed $item
     *         the item to examine
     * @return boolean
     *         true if the item can be used in a foreach() loop
     *         false otherwise
     */
    public function __invoke($item)
    {
        return self::check($item);
    }

    /**
     * have we seen this kind of item before?
     *
     * @param  mixed $item
     * @return boolean|null
     */
    private static function getCachedResult($item)
    {
        $cacheKey = self::getCacheKey($item);
        return self::getFromCache($cacheKey);
    }

    /**
     * remember the result in case there is a next time
     *
     * @param mixed $item
     * @param boolean $result
     * @return void
     */
    private static function setCachedResult($item, $result)
    {
        $cacheKey = self::getCacheKey($item);
        self::setInCache($cacheKey, $result);
    }

    /**
     * work out what lookup key to use for this item
     *
     * @param  mixed $item
     * @return string
     */
    private static function getCacheKey($item)
    {
        if (is_object($item)) {
            return get_class($item);
        }

        return gettype($item);
    }
}

1			<?php
2
3			/**
4			* Copyright (c) 2015-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 Reflection/Checks
38			* @author Stuart Herbert <[email protected]>
39			* @copyright 2015-present Ganbaro Digital Ltd www.ganbarodigital.com
40			* @license http://www.opensource.org/licenses/bsd-license.php BSD License
41			* @link http://code.ganbarodigital.com/php-reflection
42			*/
43
44			namespace GanbaroDigital\Reflection\Checks;
45
46			use stdClass;
47			use IteratorAggregate;
48			use Traversable;
49			use GanbaroDigital\DataContainers\Caches\StaticDataCache;
50			use GanbaroDigital\Reflection\ValueBuilders\AllMatchingTypesList;
51
52			class IsTraversable
53			{
54			// speed repeated things up
55			use StaticDataCache;
56
57			/**
58			* list of types that we consider to be traversable
59			*
60			* @var array
61			*/
62			private static $acceptableTypes = [
63			'Array' => true,
64			stdClass::class => true,
65			Traversable::class => true,
66			IteratorAggregate::class => true,
67			];
68
69			/**
70			* is $item something that can be used in a foreach() loop?
71			*
72			* @param mixed $item
73			* the item to examine
74			* @return boolean
75			* true if the item can be used in a foreach() loop
76			* false otherwise
77			*/
78			public static function check($item)
79			{
80			if (($retval = self::getCachedResult($item)) !== null) {
81			return $retval;
82			}
83
84			$retval = self::calculateResult($item);
85
86			self::setCachedResult($item, $retval);
87			return $retval;
88			}
89
90			/**
91			* is $item something that can be used in a foreach() loop?
92			*
93			* @param mixed $item
94			* the item to examine
95			* @return boolean
96			* true if the item can be used in a foreach() loop
97			* false otherwise
98			*/
99			private static function calculateResult($item)
100			{
101			$itemTypes = AllMatchingTypesList::from($item);
102			foreach ($itemTypes as $itemType) {
103			if (isset(self::$acceptableTypes[$itemType])) {
104			return true;
105			}
106			}
107
108			return false;
109			}
110
111			/**
112			* is $item something that can be used in a foreach() loop?
113			*
114			* @deprecated since 2.10.0
115			* @codeCoverageIgnore
116			* @param mixed $item
117			* the item to examine
118			* @return boolean
119			* true if the item can be used in a foreach() loop
120			* false otherwise
121			*/
122			public static function checkMixed($item)
123			{
124			return self::check($item);
125			}
126
127			/**
128			* is $item something that can be used in a foreach() loop?
129			*
130			* @param mixed $item
131			* the item to examine
132			* @return boolean
133			* true if the item can be used in a foreach() loop
134			* false otherwise
135			*/
136			public function __invoke($item)
137			{
138			return self::check($item);
139			}
140
141			/**
142			* have we seen this kind of item before?
143			*
144			* @param mixed $item
145			* @return boolean\|null
146			*/
147			private static function getCachedResult($item)
148			{
149			$cacheKey = self::getCacheKey($item);
150			return self::getFromCache($cacheKey);
151			}
152
153			/**
154			* remember the result in case there is a next time
155			*
156			* @param mixed $item
157			* @param boolean $result
158			* @return void
159			*/
160			private static function setCachedResult($item, $result)
161			{
162			$cacheKey = self::getCacheKey($item);
163			self::setInCache($cacheKey, $result);
164			}
165
166			/**
167			* work out what lookup key to use for this item
168			*
169			* @param mixed $item
170			* @return string
171			*/
172			private static function getCacheKey($item)
173			{
174			if (is_object($item)) {
175			return get_class($item);
176			}
177
178			return gettype($item);
179			}
180			}

ganbarodigital / php-reflection

IsTraversable::calculateResult() A last analyzed 2016-02-23 09:08 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

IsTraversable::calculateResult() A
last analyzed 2016-02-23 09:08 UTC