* Adding API annotations to classes
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / Manager.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 * The Extbase Persistence Manager
30 *
31 * @package Extbase
32 * @subpackage Persistence
33 * @version $Id: Manager.php 2293 2009-05-20 18:14:45Z robert $
34 * @api
35 */
36 class Tx_Extbase_Persistence_Manager implements Tx_Extbase_Persistence_ManagerInterface, t3lib_Singleton {
37
38 /**
39 * @var Tx_Extbase_Persistence_BackendInterface
40 */
41 protected $backend;
42
43 /**
44 * @var Tx_Extbase_Persistence_Session
45 */
46 protected $session;
47
48 /**
49 * @var Tx_Extbase_Object_ManagerInterface
50 */
51 protected $objectManager;
52
53 /**
54 * This is an array of registered repository class names.
55 *
56 * @var array
57 */
58 protected $repositoryClassNames = array();
59
60 /**
61 * Injects the Persistence Backend
62 *
63 * @param Tx_Extbase_Persistence_BackendInterface $backend The persistence backend
64 * @return void
65
66 */
67 public function injectBackend(Tx_Extbase_Persistence_BackendInterface $backend) {
68 $this->backend = $backend;
69 }
70
71 /**
72 *
73 * Injects the Persistence Session
74 *
75 * @param Tx_Extbase_Persistence_Session $session The persistence session
76 * @return void
77
78 */
79 public function injectSession(Tx_Extbase_Persistence_Session $session) {
80 $this->session = $session;
81 }
82
83 /**
84 * Injects the object manager
85 *
86 * @param Tx_Extbase_Object_ManagerInterface $objectManager
87 * @return void
88 */
89 public function injectObjectManager(Tx_Extbase_Object_ManagerInterface $objectManager) {
90 $this->objectManager = $objectManager;
91 }
92
93 /**
94 * Returns the current persistence session
95 *
96 * @return Tx_Extbase_Persistence_Session
97
98 */
99 public function getSession() {
100 return $this->session;
101 }
102
103 /**
104 * Returns the persistence backend
105 *
106 * @return Tx_Extbase_Persistence_BackendInterface
107 */
108 public function getBackend() {
109 return $this->backend;
110 }
111
112 /**
113 * Registers a repository
114 *
115 * @param string $className The class name of the repository to be reigistered
116 * @return void
117 */
118 public function registerRepositoryClassName($className) {
119 $this->repositoryClassNames[] = $className;
120 }
121
122 /**
123 * Returns all repository class names
124 *
125 * @return array An array holding the registered repository class names
126 */
127 public function getRepositoryClassNames() {
128 return $this->repositoryClassNames;
129 }
130
131 /**
132 * Commits new objects and changes to objects in the current persistence
133 * session into the backend
134 *
135 * @return void
136 * @api
137 */
138 public function persistAll() {
139 $aggregateRootObjects = new Tx_Extbase_Persistence_ObjectStorage();
140 $removedObjects = new Tx_Extbase_Persistence_ObjectStorage();
141
142 // fetch and inspect objects from all known repositories
143 $repositoryClassNames = $this->getRepositoryClassNames();
144 foreach ($repositoryClassNames as $repositoryClassName) {
145 $repository = $this->objectManager->getObject($repositoryClassName);
146 $aggregateRootObjects->addAll($repository->getAddedObjects());
147 $removedObjects->addAll($repository->getRemovedObjects());
148 }
149
150 $aggregateRootObjects->addAll($this->session->getReconstitutedObjects());
151
152 // hand in only aggregate roots, leaving handling of subobjects to
153 // the underlying storage layer
154 $this->backend->setAggregateRootObjects($aggregateRootObjects);
155 $this->backend->setDeletedObjects($removedObjects);
156 $this->backend->commit();
157
158 // this needs to unregister more than just those, as at least some of
159 // the subobjects are supposed to go away as well...
160 // OTOH those do no harm, changes to the unused ones should not happen,
161 // so all they do is eat some memory.
162 foreach($removedObjects as $removedObject) {
163 $this->session->unregisterReconstitutedObject($removedObject);
164 }
165 }
166
167 }
168 ?>