[BUGFIX] FAL: Image Processing doesn't respect GFX "thumbnails_png"
[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 * Roles for folders
38 */
39 const ROLE_DEFAULT = 'default';
40 const ROLE_RECYCLER = 'recycler';
41 const ROLE_PROCESSING = 'processing';
42 const ROLE_TEMPORARY = 'temporary';
43 const ROLE_USERUPLOAD = 'userupload';
44
45 /**
46 * Returns a list of all subfolders
47 *
48 * @return Folder[]
49 */
50 public function getSubfolders();
51
52 /**
53 * Returns the object for a subfolder of the current folder, if it exists.
54 *
55 * @param string $name Name of the subfolder
56 * @return Folder
57 */
58 public function getSubfolder($name);
59
60 /**
61 * Checks if a folder exists in this folder.
62 *
63 * @param string $name
64 * @return boolean
65 */
66 public function hasFolder($name);
67
68 /**
69 * Checks if a file exists in this folder
70 *
71 * @param string $name
72 * @return boolean
73 */
74 public function hasFile($name);
75
76 /**
77 * Renames this folder.
78 *
79 * @param string $newName
80 * @return Folder
81 */
82 public function rename($newName);
83
84 /**
85 * Deletes this folder from its storage. This also means that this object becomes useless.
86 *
87 * @return boolean TRUE if deletion succeeded
88 */
89 public function delete();
90
91 }
92
93 ?>