[TASK] Add a set of interfaces for collection
[Packages/TYPO3.CMS.git] / t3lib / collection / interfaces / interface.t3lib_collection_editable.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 * Interface for collection classes which es enabled to be modified
31 *
32 * @author Steffen Ritter <typo3steffen-ritter.net>
33 * @package TYPO3
34 * @subpackage t3lib
35 */
36 interface t3lib_collection_Editable {
37
38 /**
39 * Adds on entry to the collection
40 *
41 * @abstract
42 * @param mixed $data
43 * @return void
44 */
45 public function add($data);
46
47 /**
48 * Adds a set of entries to the collection
49 *
50 * @abstract
51 * @param t3lib_collection_Collection $other
52 * @return void
53 */
54 public function addAll(t3lib_collection_Collection $other);
55
56 /**
57 * Remove the given entry from collection
58 *
59 * Note: not the given "index"
60 *
61 * @abstract
62 * @param mixed $data
63 * @return void
64 */
65 public function remove($data);
66
67 /**
68 * Removes all entries from the collection
69 *
70 * collection will be empty afterwards
71 *
72 * @abstract
73 * @return void
74 */
75 public function removeAll();
76 }
77
78 ?>