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\Touchable.
41 *
42 * Interface for touchable input/output.
43 *
44 * @copyright  Copyright © 2007-2017 Hoa community
45 * @license    New BSD License
46 */
47interface Touchable extends Stream
48{
49    /**
50     * Overwrite file if already exists.
51     *
52     * @const bool
53     */
54    const OVERWRITE             = true;
55
56    /**
57     * Do not overwrite file if already exists.
58     *
59     * @const bool
60     */
61    const DO_NOT_OVERWRITE      = false;
62
63    /**
64     * Make directory if does not exist.
65     *
66     * @const bool
67     */
68    const MAKE_DIRECTORY        = true;
69
70    /**
71     * Do not make directory if does not exist.
72     *
73     * @const bool
74     */
75    const DO_NOT_MAKE_DIRECTORY = false;
76
77
78
79    /**
80     * Set access and modification time of file.
81     *
82     * @param   int     $time     Time. If equals to -1, time() should be used.
83     * @param   int     $atime    Access time. If equals to -1, $time should be
84     *                            used.
85     * @return  bool
86     */
87    public function touch($time = -1, $atime = -1);
88
89    /**
90     * Copy file.
91     * Return the destination file path if succeed, false otherwise.
92     *
93     * @param   string  $to       Destination path.
94     * @param   bool    $force    Force to copy if the file $to already exists.
95     *                            Use the self::*OVERWRITE constants.
96     * @return  bool
97     */
98    public function copy($to, $force = self::DO_NOT_OVERWRITE);
99
100    /**
101     * Move a file.
102     *
103     * @param   string  $name     New name.
104     * @param   bool    $force    Force to move if the file $name already
105     *                            exists.
106     *                            Use the self::*OVERWRITE constants.
107     * @param   bool    $mkdir    Force to make directory if does not exist.
108     *                            Use the self::*DIRECTORY constants.
109     * @return  bool
110     */
111    public function move(
112        $name,
113        $force = self::DO_NOT_OVERWRITE,
114        $mkdir = self::DO_NOT_MAKE_DIRECTORY
115    );
116
117    /**
118     * Delete a file.
119     *
120     * @return  bool
121     */
122    public function delete();
123
124    /**
125     * Change file group.
126     *
127     * @param   mixed   $group    Group name or number.
128     * @return  bool
129     */
130    public function changeGroup($group);
131
132    /**
133     * Change file mode.
134     *
135     * @param   int     $mode    Mode (in octal!).
136     * @return  bool
137     */
138    public function changeMode($mode);
139
140    /**
141     * Change file owner.
142     *
143     * @param   mixed   $user    User.
144     * @return  bool
145     */
146    public function changeOwner($user);
147
148    /**
149     * Change the current umask.
150     *
151     * @param   int     $umask    Umask (in octal!). If null, given the current
152     *                            umask value.
153     * @return  int
154     */
155    public static function umask($umask = null);
156}
157