[TASK] Add a set of interfaces for collection
[Packages/TYPO3.CMS.git] / t3lib / collection / interfaces / interface.t3lib_collection_persistable.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 class being persistable
31 *
32 * Collections are containers-classes handling the storage
33 * of data values (f.e. strings, records, relations) in a
34 * common and generic way, while the class manages the storage
35 * in an appropiate way itself
36 *
37 * @author Steffen Ritter <typo3steffen-ritter.net>
38 * @package TYPO3
39 * @subpackage t3lib
40 */
41 interface t3lib_collection_Persistable {
42
43 /**
44 * Get the identifier of the collection
45 *
46 * For database stored collections, this will be a integer,
47 * session stored, registry stored or other collections might
48 * use a string as well
49 *
50 * @abstract
51 * @return int|string
52 */
53 public function getIdentifier();
54
55 /**
56 * Sets the identifier of the collection
57 *
58 * @abstract
59 * @param int|string $id
60 * @return void
61 */
62 public function setIdentifier($id);
63
64 /**
65 * Loads the collections with the given id from persistence
66 *
67 * For memory reasons, per default only f.e. title, database-table,
68 * identifier (what ever static data is defined) is loaded.
69 * Entries can be load on first access.
70 *
71 * @static
72 * @abstract
73 * @param int|string $id
74 * @param boolean $fillItems Populates the entries directly on load, might be bad for memory on large collections
75 * @return t3lib_collection_Collection
76 */
77 public static function load($id, $fillItems = FALSE);
78
79 /**
80 * Persists current collection state to underlying storage
81 *
82 * @abstract
83 * @return void
84 */
85 public function persist();
86
87 /**
88 * Populates the content-entries of the storage
89 *
90 * Queries the underlying storage for entries of the collection
91 * and adds them to the collection data.
92 *
93 * If the content entries of the storage had not been loaded on creation
94 * ($fillItems = false) this function is to be used for loading the contents
95 * afterwards.
96 *
97 * @abstract
98 * @return void
99 */
100 public function loadContents();
101 }
102
103 ?>