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\SplFileInfo.
41 *
42 * Enhance SplFileInfo implementation.
43 *
44 * @copyright  Copyright © 2007-2017 Hoa community
45 * @license    New BSD License
46 */
47class SplFileInfo extends \SplFileInfo
48{
49    /**
50     * Hash.
51     *
52     * @var string
53     */
54    protected $_hash         = null;
55
56    /**
57     * Relative path.
58     *
59     * @var string
60     */
61    protected $_relativePath = null;
62
63
64
65    /**
66     * Construct.
67     *
68     * @param   string  $filename        Filename.
69     * @param   string  $relativePath    Relative path.
70     */
71    public function __construct($filename, $relativePath = null)
72    {
73        parent::__construct($filename);
74
75        if (-1 !== $mtime = $this->getMTime()) {
76            $this->_hash = md5($this->getPathname() . $mtime);
77        }
78
79        $this->_relativePath = $relativePath;
80
81        return;
82    }
83
84    /**
85     * Get the hash.
86     *
87     * @return  string
88     */
89    public function getHash()
90    {
91        return $this->_hash;
92    }
93
94    /**
95     * Get the MTime.
96     *
97     * @return  int
98     */
99    public function getMTime()
100    {
101        try {
102            return parent::getMTime();
103        } catch (\RuntimeException $e) {
104            return -1;
105        }
106    }
107
108    /**
109     * Set relative path.
110     *
111     * @param   string  $relativePath    Relative path.
112     * @return  string
113     */
114    public function setRelativePath($relativePath)
115    {
116        $old                 = $this->_relativePath;
117        $this->_relativePath = $relativePath;
118
119        return $old;
120    }
121
122    /**
123     * Get relative path (if given).
124     *
125     * @return  string
126     */
127    public function getRelativePath()
128    {
129        return $this->_relativePath;
130    }
131
132    /**
133     * Get relative pathname (if possible).
134     *
135     * @return  string
136     */
137    public function getRelativePathname()
138    {
139        if (null === $relative = $this->getRelativePath()) {
140            return $this->getPathname();
141        }
142
143        return substr($this->getPathname(), strlen($relative));
144    }
145}
146