[TASK] Add a set of interfaces for collection
[Packages/TYPO3.CMS.git] / t3lib / collection / interfaces / interface.t3lib_collection_nameable.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2011 Steffen Ritter <typo3steffen-ritter.net>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28
29 /**
30 * Marker interface for a collection class with title and description
31 *
32 * Collections might be used internally as well as being shown
33 * With the nameable interface a title and a description are added
34 * to an collection, allowing every collection implementing Nameable
35 * being display by the same logic.
36 *
37 * @author Steffen Ritter <typo3steffen-ritter.net>
38 * @package TYPO3
39 * @subpackage t3lib
40 */
41 interface t3lib_collection_Nameable {
42
43 /**
44 * Setter for the title
45 *
46 * @abstract
47 * @param string $title
48 * @return void
49 */
50 public function setTitle($title);
51
52 /**
53 * Setter for the description
54 *
55 * @abstract
56 * @param string $description
57 * @return void
58 */
59 public function setDescription($description);
60
61 /**
62 * Getter for the title
63 *
64 * @abstract
65 * @return string
66 */
67 public function getTitle();
68
69 /**
70 * Getter for the description
71 *
72 * @abstract
73 * @return void
74 */
75 public function getDescription();
76
77 }
78
79 ?>