Completed
Push — develop ( 41fc7f...75e6fb )
by Stuart
06:18
created

list-functions.php ➔ traverse_array()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 1
eloc 2
c 1
b 0
f 1
nc 1
nop 3
dl 0
loc 4
rs 10
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/ListFunctions
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
use GanbaroDigital\MissingBits\ListTraversals\TraverseArray;
45
use GanbaroDigital\MissingBits\ListTraversals\TraverseList;
46
use GanbaroDigital\MissingBits\ListTraversals\TraverseObject;
47
48
 /**
49
  * traverse a list held in an array
50
  *
51
  * @param  array $list
52
  *         the list to walk
53
  * @param  string $listName
54
  *         what is the name of $list in the calling code?
55
  * @param  callable $callable
56
  *         what are we calling
57
  * @return void
58
  */
59
function traverse_array($list, $listName, callable $callable)
60
{
61
    return TraverseArray::using($list, $listName, $callable);
62
}
63
64
/**
65
 * traverse a list held in an array or a traversable object
66
 *
67
 * @param  array|object $list
68
 *         the list to walk
69
 * @param  string $listName
70
 *         what is the name of $list in the calling code?
71
 * @param  callable $callable
72
 *         what are we calling
73
 * @return void
74
 */
75
function traverse_list($list, $listName, callable $callable)
76
{
77
    return TraverseList::using($list, $listName, $callable);
78
}
79
80
/**
81
 * traverse a list held in an object
82
 *
83
 * @param  object $list
84
 *         the list to walk
85
 * @param  string $listName
86
 *         what is the name of $list in the calling code?
87
 * @param  callable $callable
88
 *         what are we calling
89
 * @return void
90
 */
91
function traverse_object($list, $listName, callable $callable)
92
{
93
    return TraverseObject::using($list, $listName, $callable);
94
}
95