Completed
Push — develop ( 6ec5ed...eac156 )
by Stuart
05:24
created

IsIndexable::check()   A

Complexity

Conditions 3
Paths 2

Size

Total Lines 8
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 3
eloc 4
nc 2
nop 1
dl 0
loc 8
rs 9.4285
c 1
b 0
f 1
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/TypeChecks
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\TypeChecks;
45
46
use ArrayAccess;
47
use GanbaroDigital\MissingBits\Checks\Check;
48
49
/**
50
 * do we have something that we can use array index notation on?
51
 */
52
class IsIndexable implements Check
53
{
54
    /**
55
     * fluent-interface entry point
56
     *
57
     * we do not support any customisations
58
     *
59
     * @return IsIndexable
60
     */
61
    public static function using()
62
    {
63
        return new static();
64
    }
65
66
    /**
67
     * is $fieldOrVar something that can be used by PHP code that uses array
68
     * index notation?
69
     *
70
     * @param  mixed $fieldOrVar
71
     *         the item to examine
72
     * @return bool
73
     *         true if the item is compatible
74
     *         false otherwise
75
     */
76
    public static function check($fieldOrVar)
77
    {
78
        if (is_array($fieldOrVar) || $fieldOrVar instanceof ArrayAccess) {
79
            return true;
80
        }
81
82
        return false;
83
    }
84
85
    /**
86
     * is $fieldOrVar something that can be used by PHP code that uses array
87
     * index notation?
88
     *
89
     * @param  mixed $fieldOrVar
90
     *         the item to examine
91
     * @return bool
92
     *         true if the item is compatible
93
     *         false otherwise
94
     */
95
    public function inspect($fieldOrVar)
96
    {
97
        return static::check($fieldOrVar);
98
    }
99
}
100