[BUGFIX] Fix several typos in php comments
[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 a collection, allowing every collection implementing Nameable
23 * being displayed by the same logic.
24 */
25 interface NameableCollectionInterface
26 {
27 /**
28 * Setter for the title
29 *
30 * @param string $title
31 */
32 public function setTitle($title);
33
34 /**
35 * Setter for the description
36 *
37 * @param string $description
38 */
39 public function setDescription($description);
40
41 /**
42 * Getter for the title
43 *
44 * @return string
45 */
46 public function getTitle();
47
48 /**
49 * Getter for the description
50 */
51 public function getDescription();
52 }