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\Directory.
41 *
42 * Extending the SPL DirectoryIterator class.
43 *
44 * @copyright  Copyright © 2007-2017 Hoa community
45 * @license    New BSD License
46 */
47class Directory extends \DirectoryIterator
48{
49    /**
50     * SplFileInfo classname.
51     *
52     * @var string
53     */
54    protected $_splFileInfoClass = null;
55
56    /**
57     * Relative path.
58     *
59     * @var string
60     */
61    protected $_relativePath     = null;
62
63
64
65    /**
66     * Constructor.
67     * Please, see \DirectoryIterator::__construct() method.
68     * We add the $splFileInfoClass parameter.
69     *
70     * @param   string  $path                Path.
71     * @param   string  $splFileInfoClass    SplFileInfo classname.
72     */
73    public function __construct($path, $splFileInfoClass = null)
74    {
75        $this->_splFileInfoClass = $splFileInfoClass;
76        parent::__construct($path);
77        $this->setRelativePath($path);
78
79        return;
80    }
81
82    /**
83     * Current.
84     * Please, see \DirectoryIterator::current() method.
85     *
86     * @return  mixed
87     */
88    public function current()
89    {
90        $out = parent::current();
91
92        if (null !== $this->_splFileInfoClass &&
93            $out instanceof \SplFileInfo) {
94            $out->setInfoClass($this->_splFileInfoClass);
95            $out = $out->getFileInfo();
96
97            if ($out instanceof \Hoa\Iterator\SplFileInfo) {
98                $out->setRelativePath($this->getRelativePath());
99            }
100        }
101
102        return $out;
103    }
104
105    /**
106     * Set relative path.
107     *
108     * @param   string  $relativePath    Relative path.
109     * @return  string
110     */
111    protected function setRelativePath($path)
112    {
113        $old                 = $this->_relativePath;
114        $this->_relativePath = $path;
115
116        return $old;
117    }
118
119    /**
120     * Get relative path (if given).
121     *
122     * @return  string
123     */
124    public function getRelativePath()
125    {
126        return $this->_relativePath;
127    }
128}
129