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\Stream\IStream;
38
39/**
40 * Interface \Hoa\Stream\IStream\Statable.
41 *
42 * Interface for statable input/output.
43 *
44 * @copyright  Copyright © 2007-2017 Hoa community
45 * @license    New BSD License
46 */
47interface Statable extends Stream
48{
49    /**
50     * Size is undefined.
51     *
52     * @const int
53     */
54    const SIZE_UNDEFINED = -1;
55
56    /**
57     * Get size.
58     *
59     * @return  int
60     */
61    public function getSize();
62
63    /**
64     * Get informations about a file.
65     *
66     * @return  array
67     */
68    public function getStatistic();
69
70    /**
71     * Get last access time of file.
72     *
73     * @return  int
74     */
75    public function getATime();
76
77    /**
78     * Get inode change time of file.
79     *
80     * @return  int
81     */
82    public function getCTime();
83
84    /**
85     * Get file modification time.
86     *
87     * @return  int
88     */
89    public function getMTime();
90
91    /**
92     * Get file group.
93     *
94     * @return  int
95     */
96    public function getGroup();
97
98    /**
99     * Get file owner.
100     *
101     * @return  int
102     */
103    public function getOwner();
104
105    /**
106     * Get file permissions.
107     *
108     * @return  int
109     */
110    public function getPermissions();
111
112    /**
113     * Check if the file is readable.
114     *
115     * @return  bool
116     */
117    public function isReadable();
118
119    /**
120     * Check if the file is writable.
121     *
122     * @return  bool
123     */
124    public function isWritable();
125
126    /**
127     * Check if the file is executable.
128     *
129     * @return  bool
130     */
131    public function isExecutable();
132
133    /**
134     * Clear file status cache.
135     *
136     * @return  void
137     */
138    public function clearStatisticCache();
139
140    /**
141     * Clear all files status cache.
142     *
143     * @return  void
144     */
145    public static function clearAllStatisticCaches();
146}
147