GetStringTypes::getStringTypes()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 2
nc 1
nop 1
dl 0
loc 4
rs 10
c 0
b 0
f 0
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 GetStringTypes
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 getStringTypes($item)
0 ignored issues
show
Coding Style Best Practice introduced by
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 case - strings can be numbers too
95
        $retval = array_merge($retval, self::detectNumbers($item));
96
97
        // all done
98
        $retval['string'] = 'string';
99
        return $retval;
100
    }
101
102
    /**
103
     * will this string co-erce to any numeric types?
104
     *
105
     * @param  string $item
106
     *         the item to examine
107
     * @return string[]
108
     */
109
    private static function detectNumbers($item)
110
    {
111
        // what do we think this might be?
112
        $retval = GetNumericType::from($item);
113
114
        // special case - return an empty list if the string
115
        // isn't numeric at all
116
        if ($retval === null) {
117
            return [];
118
        }
119
120
        // if we get here, then $item will coerce to a PHP numeric type :)
121
        return [ $retval => $retval ];
122
    }
123
124
    private static function fromObject($item)
125
    {
126
        // does this object support being converted to a string?
127
        if (method_exists($item, '__toString')) {
128
            return [ 'string' => 'string' ];
129
        }
130
131
        // no, it does not
132
        return [];
133
    }
134
}
135