1<?php
2
3/**
4 * Hoa
5 *
6 *
7 * @license
8 *
9 * New BSD License
10 *
11 * Copyright © 2007-2017, Hoa community. All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions are met:
15 *     * Redistributions of source code must retain the above copyright
16 *       notice, this list of conditions and the following disclaimer.
17 *     * Redistributions in binary form must reproduce the above copyright
18 *       notice, this list of conditions and the following disclaimer in the
19 *       documentation and/or other materials provided with the distribution.
20 *     * Neither the name of the Hoa nor the names of its contributors may be
21 *       used to endorse or promote products derived from this software without
22 *       specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
35 */
36
37namespace Hoa\Iterator;
38
39/**
40 * Class \Hoa\Iterator\FileSystem.
41 *
42 * Extending the SPL FileSystemIterator class.
43 *
44 * @copyright  Copyright © 2007-2017 Hoa community
45 * @license    New BSD License
46 */
47class FileSystem extends \FilesystemIterator
48{
49    /**
50     * SplFileInfo classname.
51     *
52     * @var string
53     */
54    protected $_splFileInfoClass = null;
55
56
57
58    /**
59     * Constructor.
60     * Please, see \FileSystemIterator::__construct() method.
61     * We add the $splFileInfoClass parameter.
62     *
63     * @param   string  $path                Path.
64     * @param   int     $flags               Flags.
65     * @param   string  $splFileInfoClass    SplFileInfo classname.
66     */
67    public function __construct($path, $flags = null, $splFileInfoClass = null)
68    {
69        $this->_splFileInfoClass = $splFileInfoClass;
70
71        if (null === $flags) {
72            parent::__construct($path);
73        } else {
74            parent::__construct($path, $flags);
75        }
76
77        return;
78    }
79
80    /**
81     * Current.
82     * Please, see \FileSystemIterator::current() method.
83     *
84     * @return  mixed
85     */
86    public function current()
87    {
88        $out = parent::current();
89
90        if (null !== $this->_splFileInfoClass &&
91            $out instanceof \SplFileInfo) {
92            $out->setInfoClass($this->_splFileInfoClass);
93            $out = $out->getFileInfo();
94        }
95
96        return $out;
97    }
98}
99