[BUGFIX] Missing typehint in abstract FAL driver
[Packages/TYPO3.CMS.git] / t3lib / file / FolderInterface.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2012 Andreas Wolf <andreas.wolf@typo3.org>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29 * Interface for folders
30 *
31 * @author Andreas Wolf <andreas.wolf@typo3.org>
32 * @package TYPO3
33 * @subpackage t3lib
34 */
35 interface t3lib_file_FolderInterface extends t3lib_file_ResourceInterface {
36 /**
37 * Returns a list of all subfolders
38 *
39 * @return t3lib_file_Folder[]
40 */
41 public function getSubfolders();
42
43 /**
44 * Returns the object for a subfolder of the current folder, if it exists.
45 *
46 * @param string $name Name of the subfolder
47 * @return t3lib_file_Folder
48 */
49 public function getSubfolder($name);
50
51 /**
52 * Checks if a folder exists in this folder.
53 *
54 * @param string $name
55 * @return boolean
56 */
57 public function hasFolder($name);
58
59 /**
60 * Checks if a file exists in this folder
61 *
62 * @param string $name
63 * @return boolean
64 */
65 public function hasFile($name);
66
67 /**
68 * Renames this folder.
69 *
70 * @param string $newName
71 * @return t3lib_file_Folder
72 */
73 public function rename($newName);
74
75 /**
76 * Deletes this folder from its storage. This also means that this object becomes useless.
77 *
78 * @return boolean TRUE if deletion succeeded
79 */
80 public function delete();
81 }
82
83 ?>