[TASK] Update copyright year to 2013
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Resource / FolderInterface.php
1 <?php
2 namespace TYPO3\CMS\Core\Resource;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2012-2013 Andreas Wolf <andreas.wolf@typo3.org>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 * A copy is found in the textfile GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
20 *
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
29 /**
30 * Interface for folders
31 *
32 * @author Andreas Wolf <andreas.wolf@typo3.org>
33 */
34 interface FolderInterface extends ResourceInterface
35 {
36 /**
37 * Returns a list of all subfolders
38 *
39 * @return 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 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 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
84 ?>