GetStringDuckTypes::getStringDuckTypes() - Code Metrics - ganbarodigital/php-the-missing-bits - Measure and Improve Code Quality continuously with Scrutinizer

GetStringDuckTypes::getStringDuckTypes() A
last analyzed 2018-05-13 13:35 UTC

↳ Parent: GetStringDuckTypes

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) 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   MissingBits/Types
 * @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://ganbarodigital.github.io/php-the-missing-bits
 */

namespace GanbaroDigital\MissingBits\TypeInspectors;

use stdClass;

/**
 * get a full list of types that a string might satisfy
 */
class GetStringDuckTypes
{
    /**
     * get a full list of types that a string might satisfy
     *
     * @param  string $item
     *         the item to examine
     * @return string[]
     *         the list of type(s) that this item can be
     */
    public function getStringDuckTypes($item)

    {
        return self::from($item);
    }

    /**
     * get a full list of types that a string might satisfy
     *
     * @param  string $item
     *         the item to examine
     * @return string[]
     *         the list of type(s) that this item can be
     */
    public static function from($item)
    {
        // special case - we might have a coercable object
        if (is_object($item)) {
            return self::fromObject($item);
        }

        // robustness!
        if (!is_string($item)) {
            return [];
        }

        // our return list
        $retval = [];

        // special case - strings can be callables too
        if (is_callable($item)) {
            $retval['callable'] = 'callable';
        }

        // special cases
        //  - strings can be numbers too
        //  - strings can be class names too
        $retval = array_merge(
            $retval,
            self::detectClassNames($item),
            self::detectNumbers($item)
        );

        // all done
        $retval['string'] = 'string';
        return $retval;
    }

    /**
     * does this string contain any class or interface names?
     *
     * @param  string $item
     *         the item to examine
     * @return string[]
     */
    private static function detectClassNames($item)
    {
        $retval = [];

        // special case - is this a class name?
        if (class_exists($item)) {
            $retval = array_merge($retval, GetClassTypes::from($item), ['class' => 'class']);
        }
        else if (interface_exists($item)) {
            $retval = array_merge($retval, GetClassTypes::from($item), ['interface' => 'interface']);
        }

        // all done
        return $retval;
    }

    /**
     * will this string co-erce to any numeric types?
     *
     * @param  string $item
     *         the item to examine
     * @return string[]
     */
    private static function detectNumbers($item)
    {
        // what do we think this might be?
        $retval = GetNumericType::from($item);

        // special case - return an empty list if the string
        // isn't numeric at all
        if ($retval === null) {
            return [];
        }

        // if we get here, then $item will coerce to a PHP numeric type :)
        return [
            $retval => $retval,
            'numeric' => 'numeric',
        ];
    }

    private static function fromObject($item)
    {
        // does this object support being converted to a string?
        if (method_exists($item, '__toString')) {
            return [ 'string' => 'string' ];
        }

        // no, it does not
        return [];
    }
}


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 MissingBits/Types
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://ganbarodigital.github.io/php-the-missing-bits
42			*/
43
44			namespace GanbaroDigital\MissingBits\TypeInspectors;
45
46			use stdClass;
47
48			/**
49			* get a full list of types that a string might satisfy
50			*/
51			class GetStringDuckTypes
52			{
53			/**
54			* get a full list of types that a string might satisfy
55			*
56			* @param string $item
57			* the item to examine
58			* @return string[]
59			* the list of type(s) that this item can be
60			*/
61			public function getStringDuckTypes($item)
			0 ignored issues – show Coding Style Best Practice introduced 2017-09-17 14:55 UTC by Report Bug Copy Issue Report Please use `__construct()` instead of a PHP4-style constructor that is named after the class. Loading history...
62			{
63			return self::from($item);
64			}
65
66			/**
67			* get a full list of types that a string might satisfy
68			*
69			* @param string $item
70			* the item to examine
71			* @return string[]
72			* the list of type(s) that this item can be
73			*/
74			public static function from($item)
75			{
76			// special case - we might have a coercable object
77			if (is_object($item)) {
78			return self::fromObject($item);
79			}
80
81			// robustness!
82			if (!is_string($item)) {
83			return [];
84			}
85
86			// our return list
87			$retval = [];
88
89			// special case - strings can be callables too
90			if (is_callable($item)) {
91			$retval['callable'] = 'callable';
92			}
93
94			// special cases
95			// - strings can be numbers too
96			// - strings can be class names too
97			$retval = array_merge(
98			$retval,
99			self::detectClassNames($item),
100			self::detectNumbers($item)
101			);
102
103			// all done
104			$retval['string'] = 'string';
105			return $retval;
106			}
107
108			/**
109			* does this string contain any class or interface names?
110			*
111			* @param string $item
112			* the item to examine
113			* @return string[]
114			*/
115			private static function detectClassNames($item)
116			{
117			$retval = [];
118
119			// special case - is this a class name?
120			if (class_exists($item)) {
121			$retval = array_merge($retval, GetClassTypes::from($item), ['class' => 'class']);
122			}
123			else if (interface_exists($item)) {
124			$retval = array_merge($retval, GetClassTypes::from($item), ['interface' => 'interface']);
125			}
126
127			// all done
128			return $retval;
129			}
130
131			/**
132			* will this string co-erce to any numeric types?
133			*
134			* @param string $item
135			* the item to examine
136			* @return string[]
137			*/
138			private static function detectNumbers($item)
139			{
140			// what do we think this might be?
141			$retval = GetNumericType::from($item);
142
143			// special case - return an empty list if the string
144			// isn't numeric at all
145			if ($retval === null) {
146			return [];
147			}
148
149			// if we get here, then $item will coerce to a PHP numeric type :)
150			return [
151			$retval => $retval,
152			'numeric' => 'numeric',
153			];
154			}
155
156			private static function fromObject($item)
157			{
158			// does this object support being converted to a string?
159			if (method_exists($item, '__toString')) {
160			return [ 'string' => 'string' ];
161			}
162
163			// no, it does not
164			return [];
165			}
166			}
167

ganbarodigital / php-the-missing-bits

GetStringDuckTypes::getStringDuckTypes() A last analyzed 2018-05-13 13:35 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

GetStringDuckTypes::getStringDuckTypes() A
last analyzed 2018-05-13 13:35 UTC