ea253976b54bb311885cf2ecbc7ae8903a9c2493
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / RepositoryInterface.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
6 * All rights reserved
7 *
8 * This class is a backport of the corresponding class of FLOW3.
9 * All credits go to the v5 team.
10 *
11 * This script is part of the TYPO3 project. The TYPO3 project is
12 * free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * The GNU General Public License can be found at
18 * http://www.gnu.org/copyleft/gpl.html.
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 * Contract for a repository
30 *
31 * @package Extbase
32 * @subpackage Persistence
33 * @version $ID:$
34 */
35 interface Tx_Extbase_Persistence_RepositoryInterface {
36
37 /**
38 * Adds an object to this repository.
39 *
40 * @param object $object The object to add
41 * @return void
42 * @api
43 */
44 public function add($object);
45
46 /**
47 * Removes an object from this repository.
48 *
49 * @param object $object The object to remove
50 * @return void
51 * @api
52 */
53 public function remove($object);
54
55 /**
56 * Returns all objects of this repository.
57 *
58 * @return array An array of objects, empty if no objects found
59 * @api
60 */
61 public function findAll();
62
63 /**
64 * Finds an object matching the given identifier.
65 *
66 * @param int $uid The identifier of the object to find
67 * @return object The matching object if found, otherwise NULL
68 * @api
69 */
70 public function findByUid($uid);
71
72 }
73 ?>