[TASK] Re-work/simplify copyright header in PHP files - Part 2
[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 * Marker interface for a collection class with title and description
18 *
19 * Collections might be used internally as well as being shown
20 * With the nameable interface a title and a description are added
21 * to an collection, allowing every collection implementing Nameable
22 * being display by the same logic.
23 *
24 * @author Steffen Ritter <typo3steffen-ritter.net>
25 */
26 interface NameableCollectionInterface
27 {
28 /**
29 * Setter for the title
30 *
31 * @param string $title
32 * @return void
33 */
34 public function setTitle($title);
35
36 /**
37 * Setter for the description
38 *
39 * @param string $description
40 * @return void
41 */
42 public function setDescription($description);
43
44 /**
45 * Getter for the title
46 *
47 * @return string
48 */
49 public function getTitle();
50
51 /**
52 * Getter for the description
53 *
54 * @return void
55 */
56 public function getDescription();
57
58 }