Completed
Push — develop ( 836b2b...a2682c )
by Stuart
02:35
created

IsArray::check()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 10
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 2
eloc 4
c 1
b 0
f 1
nc 2
nop 1
dl 0
loc 10
rs 9.4285
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 GanbaroDigital\MissingBits\Checks\Check;
47
48
/**
49
 * do we have something that is an array? It must be something that can be
50
 * used by any of PHP's array_xxx() functions
51
 */
52
class IsArray implements Check
53
{
54
    /**
55
     * do we have something that is an array?
56
     *
57
     * by array, we mean something that you can pass to any of PHP's
58
     * array_xxx() functions
59
     *
60
     * @param  mixed $fieldOrVar
61
     *         the item to be checked
62
     * @return bool
63
     *         TRUE if the item is an array
64
     *         FALSE otherwise
65
     */
66
    public static function check($fieldOrVar)
67
    {
68
        // general cases
69
        if (is_array($fieldOrVar)) {
70
            return true;
71
        }
72
73
        // if we get here, we have run out of ideas
74
        return false;
75
    }
76
77
    /**
78
     * do we have something that is an array?
79
     *
80
     * by array, we mean something that you can pass to any of PHP's
81
     * array_xxx() functions
82
     *
83
     * @param  mixed $fieldOrVar
84
     *         the item to be checked
85
     * @return bool
86
     *         TRUE if the item is an array
87
     *         FALSE otherwise
88
     */
89
    public function inspect($fieldOrVar)
90
    {
91
        return static::check($fieldOrVar);
92
    }
93
94
    /**
95
     * creates a new IsArray check, ready for use
96
     *
97
     * we do not support any customisations
98
     *
99
     * @return IsArray
100
     */
101
    public static function using()
102
    {
103
        return new static();
104
    }
105
}
106