Merge branch 'issue3875'
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / DomainObject / AbstractDomainObject.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
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 *
17 * This script is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * This copyright notice MUST APPEAR in all copies of the script!
23 ***************************************************************/
24
25 /**
26 * A generic Domain Object.
27 *
28 * All Model domain objects need to inherit from either AbstractEntity or AbstractValueObject, as this provides important framework information.
29 *
30 * @package Extbase
31 * @subpackage DomainObject
32 * @version $ID:$
33 */
34 abstract class Tx_Extbase_DomainObject_AbstractDomainObject implements Tx_Extbase_DomainObject_DomainObjectInterface {
35
36 /**
37 * @var int The uid
38 */
39 protected $uid;
40
41 /**
42 * TRUE if the object is a clone
43 * @var boolean
44 */
45 private $isClone = FALSE;
46
47 /**
48 * The generic constructor. If you want to implement your own __constructor() method in your Domain Object you have to call
49 * $this->initializeObject() in the first line of your constructor.
50 *
51 * @var array
52 */
53 public function __construct() {
54 $this->initializeObject();
55 }
56
57 /**
58 * This is the magic __wakeup() method. It's invoked by the unserialize statement in the reconstitution process
59 * of the object. If you want to implement your own __wakeup() method in your Domain Object you have to call
60 * parent::__wakeup() first!
61 *
62 * @return void
63 */
64 public function __wakeup() {
65 $this->initializeObject();
66 }
67
68 /**
69 * A template method to initialize an object. This can be used to manipulate the object after
70 * reconstitution and before the clean state of it's properties is stored.
71 *
72 * @return void
73 */
74 protected function initializeObject() {
75 }
76
77 /**
78 * Getter for uid.
79 *
80 * @return int the uid or NULL if none set yet.
81 */
82 final public function getUid() {
83 return ($this->uid === NULL ? NULL : (int)$this->uid);
84 }
85
86 /**
87 * Reconstitutes a property. Only for internal use.
88 *
89 * @param string $propertyName
90 * @param string $value
91 * @return void
92 */
93 public function _setProperty($propertyName, $propertyValue) {
94 if ($this->_hasProperty($propertyName)) {
95 $this->$propertyName = $propertyValue;
96 return TRUE;
97 }
98 return FALSE;
99 }
100
101 /**
102 * Returns the property value of the given property name. Only for internal use.
103 *
104 * @return mixed The propertyValue
105 */
106 public function _getProperty($propertyName) {
107 return $this->$propertyName;
108 }
109
110 /**
111 * Returns a hash map of property names and property values. Only for internal use.
112 *
113 * @return array The properties
114 */
115 public function _getProperties() {
116 $properties = get_object_vars($this);
117 unset($properties['_cleanProperties']);
118 return $properties;
119 }
120
121 /**
122 * Returns the property value of the given property name. Only for internal use.
123 *
124 * @return boolean TRUE bool true if the property exists, FALSE if it doesn't exist or
125 * NULL in case of an error.
126 */
127 public function _hasProperty($propertyName) {
128 return property_exists($this, $propertyName);
129 }
130
131 /**
132 * Returns TRUE if the object is new (the uid was not set, yet). Only for internal use
133 *
134 * @return boolean
135 */
136 public function _isNew() {
137 return $this->uid === NULL;
138 }
139
140 /**
141 * Register an object's clean state, e.g. after it has been reconstituted
142 * from the database
143 *
144 * @return void
145 */
146 public function _memorizeCleanState() {
147 }
148
149 /**
150 * Returns TRUE if the properties were modified after reconstitution. However, value objects can be never updated.
151 *
152 * @return boolean
153 */
154 public function _isDirty() {
155 return FALSE;
156 }
157
158 /**
159 * Returns TRUE if the object has been clonesd, cloned, FALSE otherwise.
160 *
161 * @return boolean TRUE if the object has been cloned
162 */
163 public function _isClone() {
164 return $this->isClone;
165 }
166
167 /**
168 * Setter whether this Domain Object is a clone of another one.
169 * NEVER SET THIS PROPERTY DIRECTLY. We currently need it to make the
170 * _isDirty check inside AbstractEntity work, but it is just a work-
171 * around right now.
172 *
173 * @param boolean $clone
174 */
175 public function _setClone($clone) {
176 $this->isClone = (boolean)$clone;
177 }
178
179 /**
180 * Clone method. Sets the _isClone property.
181 *
182 * @return void
183 */
184 public function __clone() {
185 $this->isClone = TRUE;
186 }
187 }
188 ?>