[CLEANUP] Code cleanup in ext:core/Collection
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Collection / NameableCollectionInterface.php
1 <?php
2 namespace TYPO3\CMS\Core\Collection;
3
4 /**
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * Marker interface for a collection class with title and description
19 *
20 * Collections might be used internally as well as being shown
21 * With the nameable interface a title and a description are added
22 * to an collection, allowing every collection implementing Nameable
23 * being display by the same logic.
24 *
25 * @author Steffen Ritter <typo3steffen-ritter.net>
26 */
27 interface NameableCollectionInterface {
28
29 /**
30 * Setter for the title
31 *
32 * @param string $title
33 * @return void
34 */
35 public function setTitle($title);
36
37 /**
38 * Setter for the description
39 *
40 * @param string $description
41 * @return void
42 */
43 public function setDescription($description);
44
45 /**
46 * Getter for the title
47 *
48 * @return string
49 */
50 public function getTitle();
51
52 /**
53 * Getter for the description
54 *
55 * @return void
56 */
57 public function getDescription();
58
59 }