Completed
Push — master ( a0b3b9...8a68c3 )
by Andreas
04:01
created

FileList::rewind()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 4
ccs 3
cts 3
cp 1
rs 10
cc 1
eloc 2
nc 1
nop 0
crap 1
1
<?php
2
/**
3
 * Copyright (c)2014-2014 heiglandreas
4
 * 
5
 * Permission is hereby granted, free of charge, to any person obtaining a copy
6
 * of this software and associated documentation files (the "Software"), to deal
7
 * in the Software without restriction, including without limitation the rights
8
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
 * copies of the Software, and to permit persons to whom the Software is
10
 * furnished to do so, subject to the following conditions:
11
 *
12
 * The above copyright notice and this permission notice shall be included in
13
 * all copies or substantial portions of the Software.
14
 * 
15
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
 * LIBILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
 * THE SOFTWARE.
22
 *
23
 * @category 
24
 * @author    Andreas Heigl<[email protected]>
25
 * @copyright ©2014-2014 Andreas Heigl
26
 * @license   http://www.opesource.org/licenses/mit-license.php MIT-License
27
 * @version   0.0
28
 * @since     05.11.14
29
 * @link      https://github.com/heiglandreas/
30
 */
31
32
namespace Org_Heigl\FileFinder;
33
34
35
class FileList implements FileListInterface, \Countable
36
{
37
    protected $filelist = array();
38
39
    /**
40
     * Add an SPL-File-Info to the filelist
41
     *
42
     * @param \SplFileInfo $file
43
     *
44
     * @return void
45
     */
46 4
    public function add(\SplFileInfo $file)
47
    {
48 4
        $this->filelist[] = $file;
49 4
    }
50
51
    /**
52
     * Clear all entries from the filelist
53
     *
54
     * @return self
55
     */
56 3
    public function clear()
57
    {
58 3
        $this->filelist = array();
59 3
    }
60
61
    /**
62
     * Return the current element
63
     *
64
     * @link http://php.net/manual/en/iterator.current.php
65
     * @return mixed Can return any type.
66
     */
67 2
    public function current()
68
    {
69 2
        return current($this->filelist);
70
    }
71
72
    /**
73
     * Move forward to next element
74
     *
75
     * @link http://php.net/manual/en/iterator.next.php
76
     * @return void Any returned value is ignored.
77
     */
78 2
    public function next()
79
    {
80 2
        next($this->filelist);
81 2
    }
82
83
    /**
84
     * Return the key of the current element
85
     *
86
     * @link http://php.net/manual/en/iterator.key.php
87
     * @return mixed scalar on success, or null on failure.
88
     */
89 1
    public function key()
90
    {
91 1
        return key($this->filelist);
92
    }
93
94
    /**
95
     * Checks if current position is valid
96
     *
97
     * @link http://php.net/manual/en/iterator.valid.php
98
     * @return boolean The return value will be casted to boolean and then evaluated.
99
     *       Returns true on success or false on failure.
100
     */
101 1
    public function valid()
102
    {
103 1
        return false !== $this->current();
104
    }
105
106
    /**
107
     * Rewind the Iterator to the first element
108
     *
109
     * @link http://php.net/manual/en/iterator.rewind.php
110
     * @return void Any returned value is ignored.
111
     */
112 2
    public function rewind()
113
    {
114 2
        reset($this->filelist);
115 2
    }
116
117
    /**
118
     * Count elements of an object
119
     *
120
     * @link http://php.net/manual/en/countable.count.php
121
     * @return int The custom count as an integer.
122
     *       </p>
123
     *       <p>
124
     *       The return value is cast to an integer.
125
     */
126 2
    public function count()
127
    {
128 2
        return count($this->filelist);
129
    }
130
}
131