Completed
Push — 4.0 ( 984e8a...f02fa4 )
by David
08:59 queued 18s
created
src/Mouf/Database/TDBM/TDBMObject.php 1 patch
Indentation   +21 added lines, -21 removed lines patch added patch discarded remove patch
@@ -33,25 +33,25 @@
 block discarded – undo
33 33
  */
34 34
 class TDBMObject extends AbstractTDBMObject
35 35
 {
36
-    public function getProperty($var, $tableName = null)
37
-    {
38
-        return $this->get($var, $tableName);
39
-    }
40
-
41
-    public function setProperty($var, $value, $tableName = null)
42
-    {
43
-        $this->set($var, $value, $tableName);
44
-    }
45
-
46
-    /**
47
-     * Specify data which should be serialized to JSON
48
-     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
49
-     * @return mixed data which can be serialized by <b>json_encode</b>,
50
-     * which is a value of any type other than a resource.
51
-     * @since 5.4.0
52
-     */
53
-    public function jsonSerialize()
54
-    {
55
-        throw new TDBMException('Json serialization is only implemented for generated beans.');
56
-    }
36
+	public function getProperty($var, $tableName = null)
37
+	{
38
+		return $this->get($var, $tableName);
39
+	}
40
+
41
+	public function setProperty($var, $value, $tableName = null)
42
+	{
43
+		$this->set($var, $value, $tableName);
44
+	}
45
+
46
+	/**
47
+	 * Specify data which should be serialized to JSON
48
+	 * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
49
+	 * @return mixed data which can be serialized by <b>json_encode</b>,
50
+	 * which is a value of any type other than a resource.
51
+	 * @since 5.4.0
52
+	 */
53
+	public function jsonSerialize()
54
+	{
55
+		throw new TDBMException('Json serialization is only implemented for generated beans.');
56
+	}
57 57
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/DbRow.php 1 patch
Indentation   +343 added lines, -343 removed lines patch added patch discarded remove patch
@@ -27,163 +27,163 @@  discard block
 block discarded – undo
27 27
  */
28 28
 class DbRow
29 29
 {
30
-    /**
31
-     * The service this object is bound to.
32
-     *
33
-     * @var TDBMService
34
-     */
35
-    protected $tdbmService;
36
-
37
-    /**
38
-     * The object containing this db row.
39
-     *
40
-     * @var AbstractTDBMObject
41
-     */
42
-    private $object;
43
-
44
-    /**
45
-     * The name of the table the object if issued from.
46
-     *
47
-     * @var string
48
-     */
49
-    private $dbTableName;
50
-
51
-    /**
52
-     * The array of columns returned from database.
53
-     *
54
-     * @var array
55
-     */
56
-    private $dbRow = array();
57
-
58
-    /**
59
-     * @var AbstractTDBMObject[]
60
-     */
61
-    private $references = array();
62
-
63
-    /**
64
-     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
65
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
66
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
67
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
68
-     *
69
-     * @var string
70
-     */
71
-    private $status;
72
-
73
-    /**
74
-     * The values of the primary key.
75
-     * This is set when the object is in "loaded" state.
76
-     *
77
-     * @var array An array of column => value
78
-     */
79
-    private $primaryKeys;
80
-
81
-    /**
82
-     * You should never call the constructor directly. Instead, you should use the
83
-     * TDBMService class that will create TDBMObjects for you.
84
-     *
85
-     * Used with id!=false when we want to retrieve an existing object
86
-     * and id==false if we want a new object
87
-     *
88
-     * @param AbstractTDBMObject $object      The object containing this db row.
89
-     * @param string             $table_name
90
-     * @param array              $primaryKeys
91
-     * @param TDBMService        $tdbmService
92
-     *
93
-     * @throws TDBMException
94
-     * @throws TDBMInvalidOperationException
95
-     */
96
-    public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array())
97
-    {
98
-        $this->object = $object;
99
-        $this->dbTableName = $table_name;
100
-
101
-        $this->status = TDBMObjectStateEnum::STATE_DETACHED;
102
-
103
-        if ($tdbmService === null) {
104
-            if (!empty($primaryKeys)) {
105
-                throw new TDBMException('You cannot pass an id to the DbRow constructor without passing also a TDBMService.');
106
-            }
107
-        } else {
108
-            $this->tdbmService = $tdbmService;
109
-
110
-            if (!empty($primaryKeys)) {
111
-                $this->_setPrimaryKeys($primaryKeys);
112
-                if (!empty($dbRow)) {
113
-                    $this->dbRow = $dbRow;
114
-                    $this->status = TDBMObjectStateEnum::STATE_LOADED;
115
-                } else {
116
-                    $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
117
-                }
118
-                $tdbmService->_addToCache($this);
119
-            } else {
120
-                $this->status = TDBMObjectStateEnum::STATE_NEW;
121
-                $this->tdbmService->_addToToSaveObjectList($this);
122
-            }
123
-        }
124
-    }
125
-
126
-    public function _attach(TDBMService $tdbmService)
127
-    {
128
-        if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
129
-            throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
130
-        }
131
-        $this->tdbmService = $tdbmService;
132
-        $this->status = TDBMObjectStateEnum::STATE_NEW;
133
-        $this->tdbmService->_addToToSaveObjectList($this);
134
-    }
135
-
136
-    /**
137
-     * Sets the state of the TDBM Object
138
-     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
139
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
140
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
141
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
142
-     *
143
-     * @param string $state
144
-     */
145
-    public function _setStatus($state)
146
-    {
147
-        $this->status = $state;
148
-    }
149
-
150
-    /**
151
-     * This is an internal method. You should not call this method yourself. The TDBM library will do it for you.
152
-     * If the object is in state 'not loaded', this method performs a query in database to load the object.
153
-     *
154
-     * A TDBMException is thrown is no object can be retrieved (for instance, if the primary key specified
155
-     * cannot be found).
156
-     */
157
-    public function _dbLoadIfNotLoaded()
158
-    {
159
-        if ($this->status == TDBMObjectStateEnum::STATE_NOT_LOADED) {
160
-            $connection = $this->tdbmService->getConnection();
161
-
162
-            /// buildFilterFromFilterBag($filter_bag)
163
-            list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys);
164
-
165
-            $sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where;
166
-            $result = $connection->executeQuery($sql, $parameters);
167
-
168
-            if ($result->rowCount() === 0) {
169
-                throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \"\".");
170
-            }
171
-
172
-            $this->dbRow = $result->fetch(\PDO::FETCH_ASSOC);
173
-
174
-            $result->closeCursor();
175
-
176
-            $this->status = TDBMObjectStateEnum::STATE_LOADED;
177
-        }
178
-    }
179
-
180
-    public function get($var)
181
-    {
182
-        $this->_dbLoadIfNotLoaded();
183
-
184
-        // Let's first check if the key exist.
185
-        if (!isset($this->dbRow[$var])) {
186
-            /*
30
+	/**
31
+	 * The service this object is bound to.
32
+	 *
33
+	 * @var TDBMService
34
+	 */
35
+	protected $tdbmService;
36
+
37
+	/**
38
+	 * The object containing this db row.
39
+	 *
40
+	 * @var AbstractTDBMObject
41
+	 */
42
+	private $object;
43
+
44
+	/**
45
+	 * The name of the table the object if issued from.
46
+	 *
47
+	 * @var string
48
+	 */
49
+	private $dbTableName;
50
+
51
+	/**
52
+	 * The array of columns returned from database.
53
+	 *
54
+	 * @var array
55
+	 */
56
+	private $dbRow = array();
57
+
58
+	/**
59
+	 * @var AbstractTDBMObject[]
60
+	 */
61
+	private $references = array();
62
+
63
+	/**
64
+	 * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
65
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
66
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
67
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
68
+	 *
69
+	 * @var string
70
+	 */
71
+	private $status;
72
+
73
+	/**
74
+	 * The values of the primary key.
75
+	 * This is set when the object is in "loaded" state.
76
+	 *
77
+	 * @var array An array of column => value
78
+	 */
79
+	private $primaryKeys;
80
+
81
+	/**
82
+	 * You should never call the constructor directly. Instead, you should use the
83
+	 * TDBMService class that will create TDBMObjects for you.
84
+	 *
85
+	 * Used with id!=false when we want to retrieve an existing object
86
+	 * and id==false if we want a new object
87
+	 *
88
+	 * @param AbstractTDBMObject $object      The object containing this db row.
89
+	 * @param string             $table_name
90
+	 * @param array              $primaryKeys
91
+	 * @param TDBMService        $tdbmService
92
+	 *
93
+	 * @throws TDBMException
94
+	 * @throws TDBMInvalidOperationException
95
+	 */
96
+	public function __construct(AbstractTDBMObject $object, $table_name, array $primaryKeys = array(), TDBMService $tdbmService = null, array $dbRow = array())
97
+	{
98
+		$this->object = $object;
99
+		$this->dbTableName = $table_name;
100
+
101
+		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
102
+
103
+		if ($tdbmService === null) {
104
+			if (!empty($primaryKeys)) {
105
+				throw new TDBMException('You cannot pass an id to the DbRow constructor without passing also a TDBMService.');
106
+			}
107
+		} else {
108
+			$this->tdbmService = $tdbmService;
109
+
110
+			if (!empty($primaryKeys)) {
111
+				$this->_setPrimaryKeys($primaryKeys);
112
+				if (!empty($dbRow)) {
113
+					$this->dbRow = $dbRow;
114
+					$this->status = TDBMObjectStateEnum::STATE_LOADED;
115
+				} else {
116
+					$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
117
+				}
118
+				$tdbmService->_addToCache($this);
119
+			} else {
120
+				$this->status = TDBMObjectStateEnum::STATE_NEW;
121
+				$this->tdbmService->_addToToSaveObjectList($this);
122
+			}
123
+		}
124
+	}
125
+
126
+	public function _attach(TDBMService $tdbmService)
127
+	{
128
+		if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
129
+			throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
130
+		}
131
+		$this->tdbmService = $tdbmService;
132
+		$this->status = TDBMObjectStateEnum::STATE_NEW;
133
+		$this->tdbmService->_addToToSaveObjectList($this);
134
+	}
135
+
136
+	/**
137
+	 * Sets the state of the TDBM Object
138
+	 * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
139
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
140
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
141
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
142
+	 *
143
+	 * @param string $state
144
+	 */
145
+	public function _setStatus($state)
146
+	{
147
+		$this->status = $state;
148
+	}
149
+
150
+	/**
151
+	 * This is an internal method. You should not call this method yourself. The TDBM library will do it for you.
152
+	 * If the object is in state 'not loaded', this method performs a query in database to load the object.
153
+	 *
154
+	 * A TDBMException is thrown is no object can be retrieved (for instance, if the primary key specified
155
+	 * cannot be found).
156
+	 */
157
+	public function _dbLoadIfNotLoaded()
158
+	{
159
+		if ($this->status == TDBMObjectStateEnum::STATE_NOT_LOADED) {
160
+			$connection = $this->tdbmService->getConnection();
161
+
162
+			/// buildFilterFromFilterBag($filter_bag)
163
+			list($sql_where, $parameters) = $this->tdbmService->buildFilterFromFilterBag($this->primaryKeys);
164
+
165
+			$sql = 'SELECT * FROM '.$connection->quoteIdentifier($this->dbTableName).' WHERE '.$sql_where;
166
+			$result = $connection->executeQuery($sql, $parameters);
167
+
168
+			if ($result->rowCount() === 0) {
169
+				throw new TDBMException("Could not retrieve object from table \"$this->dbTableName\" using filter \"\".");
170
+			}
171
+
172
+			$this->dbRow = $result->fetch(\PDO::FETCH_ASSOC);
173
+
174
+			$result->closeCursor();
175
+
176
+			$this->status = TDBMObjectStateEnum::STATE_LOADED;
177
+		}
178
+	}
179
+
180
+	public function get($var)
181
+	{
182
+		$this->_dbLoadIfNotLoaded();
183
+
184
+		// Let's first check if the key exist.
185
+		if (!isset($this->dbRow[$var])) {
186
+			/*
187 187
             // Unable to find column.... this is an error if the object has been retrieved from database.
188 188
             // If it's a new object, well, that may not be an error after all!
189 189
             // Let's check if the column does exist in the table
@@ -203,30 +203,30 @@  discard block
 block discarded – undo
203 203
             $str = "Could not find column \"$var\" in table \"$this->dbTableName\". Maybe you meant one of those columns: '".implode("', '",$result_array)."'";
204 204
 
205 205
             throw new TDBMException($str);*/
206
-            return;
207
-        }
208
-
209
-        return $this->dbRow[$var];
210
-    }
211
-
212
-    /**
213
-     * Returns true if a column is set, false otherwise.
214
-     *
215
-     * @param string $var
216
-     *
217
-     * @return bool
218
-     */
219
-    /*public function has($var) {
206
+			return;
207
+		}
208
+
209
+		return $this->dbRow[$var];
210
+	}
211
+
212
+	/**
213
+	 * Returns true if a column is set, false otherwise.
214
+	 *
215
+	 * @param string $var
216
+	 *
217
+	 * @return bool
218
+	 */
219
+	/*public function has($var) {
220 220
         $this->_dbLoadIfNotLoaded();
221 221
 
222 222
         return isset($this->dbRow[$var]);
223 223
     }*/
224 224
 
225
-    public function set($var, $value)
226
-    {
227
-        $this->_dbLoadIfNotLoaded();
225
+	public function set($var, $value)
226
+	{
227
+		$this->_dbLoadIfNotLoaded();
228 228
 
229
-        /*
229
+		/*
230 230
         // Ok, let's start by checking the column type
231 231
         $type = $this->db_connection->getColumnType($this->dbTableName, $var);
232 232
 
@@ -236,173 +236,173 @@  discard block
 block discarded – undo
236 236
         }
237 237
         */
238 238
 
239
-        /*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var]))
239
+		/*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var]))
240 240
             throw new TDBMException("Error! Changing primary key value is forbidden.");*/
241
-        $this->dbRow[$var] = $value;
242
-        if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
243
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
244
-            $this->tdbmService->_addToToSaveObjectList($this);
245
-        }
246
-    }
247
-
248
-    /**
249
-     * @param string             $foreignKeyName
250
-     * @param AbstractTDBMObject $bean
251
-     */
252
-    public function setRef($foreignKeyName, AbstractTDBMObject $bean = null)
253
-    {
254
-        $this->references[$foreignKeyName] = $bean;
255
-
256
-        if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
257
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
258
-            $this->tdbmService->_addToToSaveObjectList($this);
259
-        }
260
-    }
261
-
262
-    /**
263
-     * @param string $foreignKeyName A unique name for this reference
264
-     *
265
-     * @return AbstractTDBMObject|null
266
-     */
267
-    public function getRef($foreignKeyName)
268
-    {
269
-        if (isset($this->references[$foreignKeyName])) {
270
-            return $this->references[$foreignKeyName];
271
-        } elseif ($this->status === TDBMObjectStateEnum::STATE_NEW) {
272
-            // If the object is new and has no property, then it has to be empty.
273
-            return;
274
-        } else {
275
-            $this->_dbLoadIfNotLoaded();
276
-
277
-            // Let's match the name of the columns to the primary key values
278
-            $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
279
-
280
-            $values = [];
281
-            foreach ($fk->getLocalColumns() as $column) {
282
-                $values[] = $this->dbRow[$column];
283
-            }
284
-
285
-            $filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values);
286
-
287
-            return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true);
288
-        }
289
-    }
290
-
291
-    /**
292
-     * Returns the name of the table this object comes from.
293
-     *
294
-     * @return string
295
-     */
296
-    public function _getDbTableName()
297
-    {
298
-        return $this->dbTableName;
299
-    }
300
-
301
-    /**
302
-     * Method used internally by TDBM. You should not use it directly.
303
-     * This method returns the status of the TDBMObject.
304
-     * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
305
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
306
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
307
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
308
-     *
309
-     * @return string
310
-     */
311
-    public function _getStatus()
312
-    {
313
-        return $this->status;
314
-    }
315
-
316
-    /**
317
-     * Override the native php clone function for TDBMObjects.
318
-     */
319
-    public function __clone()
320
-    {
321
-        // Let's load the row (before we lose the ID!)
322
-        $this->_dbLoadIfNotLoaded();
323
-
324
-        //Let's set the status to detached
325
-        $this->status = TDBMObjectStateEnum::STATE_DETACHED;
326
-
327
-        $this->primaryKeys = [];
328
-
329
-        //Now unset the PK from the row
330
-        if ($this->tdbmService) {
331
-            $pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName);
332
-            foreach ($pk_array as $pk) {
333
-                $this->dbRow[$pk] = null;
334
-            }
335
-        }
336
-    }
337
-
338
-    /**
339
-     * Returns raw database row.
340
-     *
341
-     * @return array
342
-     */
343
-    public function _getDbRow()
344
-    {
345
-        // Let's merge $dbRow and $references
346
-        $dbRow = $this->dbRow;
347
-
348
-        foreach ($this->references as $foreignKeyName => $reference) {
349
-            // Let's match the name of the columns to the primary key values
350
-            $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
351
-            $refDbRows = $reference->_getDbRows();
352
-            $firstRefDbRow = reset($refDbRows);
353
-            $pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
354
-            $localColumns = $fk->getLocalColumns();
355
-
356
-            for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
357
-                $dbRow[$localColumns[$i]] = $pkValues[$i];
358
-            }
359
-        }
360
-
361
-        return $dbRow;
362
-    }
363
-
364
-    /**
365
-     * Returns references array.
366
-     *
367
-     * @return AbstractTDBMObject[]
368
-     */
369
-    public function _getReferences()
370
-    {
371
-        return $this->references;
372
-    }
373
-
374
-    /**
375
-     * Returns the values of the primary key.
376
-     * This is set when the object is in "loaded" state.
377
-     *
378
-     * @return array
379
-     */
380
-    public function _getPrimaryKeys()
381
-    {
382
-        return $this->primaryKeys;
383
-    }
384
-
385
-    /**
386
-     * Sets the values of the primary key.
387
-     * This is set when the object is in "loaded" state.
388
-     *
389
-     * @param array $primaryKeys
390
-     */
391
-    public function _setPrimaryKeys(array $primaryKeys)
392
-    {
393
-        $this->primaryKeys = $primaryKeys;
394
-        foreach ($this->primaryKeys as $column => $value) {
395
-            $this->dbRow[$column] = $value;
396
-        }
397
-    }
398
-
399
-    /**
400
-     * Returns the TDBMObject this bean is associated to.
401
-     *
402
-     * @return AbstractTDBMObject
403
-     */
404
-    public function getTDBMObject()
405
-    {
406
-        return $this->object;
407
-    }
241
+		$this->dbRow[$var] = $value;
242
+		if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
243
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
244
+			$this->tdbmService->_addToToSaveObjectList($this);
245
+		}
246
+	}
247
+
248
+	/**
249
+	 * @param string             $foreignKeyName
250
+	 * @param AbstractTDBMObject $bean
251
+	 */
252
+	public function setRef($foreignKeyName, AbstractTDBMObject $bean = null)
253
+	{
254
+		$this->references[$foreignKeyName] = $bean;
255
+
256
+		if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
257
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
258
+			$this->tdbmService->_addToToSaveObjectList($this);
259
+		}
260
+	}
261
+
262
+	/**
263
+	 * @param string $foreignKeyName A unique name for this reference
264
+	 *
265
+	 * @return AbstractTDBMObject|null
266
+	 */
267
+	public function getRef($foreignKeyName)
268
+	{
269
+		if (isset($this->references[$foreignKeyName])) {
270
+			return $this->references[$foreignKeyName];
271
+		} elseif ($this->status === TDBMObjectStateEnum::STATE_NEW) {
272
+			// If the object is new and has no property, then it has to be empty.
273
+			return;
274
+		} else {
275
+			$this->_dbLoadIfNotLoaded();
276
+
277
+			// Let's match the name of the columns to the primary key values
278
+			$fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
279
+
280
+			$values = [];
281
+			foreach ($fk->getLocalColumns() as $column) {
282
+				$values[] = $this->dbRow[$column];
283
+			}
284
+
285
+			$filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values);
286
+
287
+			return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true);
288
+		}
289
+	}
290
+
291
+	/**
292
+	 * Returns the name of the table this object comes from.
293
+	 *
294
+	 * @return string
295
+	 */
296
+	public function _getDbTableName()
297
+	{
298
+		return $this->dbTableName;
299
+	}
300
+
301
+	/**
302
+	 * Method used internally by TDBM. You should not use it directly.
303
+	 * This method returns the status of the TDBMObject.
304
+	 * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
305
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
306
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
307
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
308
+	 *
309
+	 * @return string
310
+	 */
311
+	public function _getStatus()
312
+	{
313
+		return $this->status;
314
+	}
315
+
316
+	/**
317
+	 * Override the native php clone function for TDBMObjects.
318
+	 */
319
+	public function __clone()
320
+	{
321
+		// Let's load the row (before we lose the ID!)
322
+		$this->_dbLoadIfNotLoaded();
323
+
324
+		//Let's set the status to detached
325
+		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
326
+
327
+		$this->primaryKeys = [];
328
+
329
+		//Now unset the PK from the row
330
+		if ($this->tdbmService) {
331
+			$pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName);
332
+			foreach ($pk_array as $pk) {
333
+				$this->dbRow[$pk] = null;
334
+			}
335
+		}
336
+	}
337
+
338
+	/**
339
+	 * Returns raw database row.
340
+	 *
341
+	 * @return array
342
+	 */
343
+	public function _getDbRow()
344
+	{
345
+		// Let's merge $dbRow and $references
346
+		$dbRow = $this->dbRow;
347
+
348
+		foreach ($this->references as $foreignKeyName => $reference) {
349
+			// Let's match the name of the columns to the primary key values
350
+			$fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
351
+			$refDbRows = $reference->_getDbRows();
352
+			$firstRefDbRow = reset($refDbRows);
353
+			$pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
354
+			$localColumns = $fk->getLocalColumns();
355
+
356
+			for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
357
+				$dbRow[$localColumns[$i]] = $pkValues[$i];
358
+			}
359
+		}
360
+
361
+		return $dbRow;
362
+	}
363
+
364
+	/**
365
+	 * Returns references array.
366
+	 *
367
+	 * @return AbstractTDBMObject[]
368
+	 */
369
+	public function _getReferences()
370
+	{
371
+		return $this->references;
372
+	}
373
+
374
+	/**
375
+	 * Returns the values of the primary key.
376
+	 * This is set when the object is in "loaded" state.
377
+	 *
378
+	 * @return array
379
+	 */
380
+	public function _getPrimaryKeys()
381
+	{
382
+		return $this->primaryKeys;
383
+	}
384
+
385
+	/**
386
+	 * Sets the values of the primary key.
387
+	 * This is set when the object is in "loaded" state.
388
+	 *
389
+	 * @param array $primaryKeys
390
+	 */
391
+	public function _setPrimaryKeys(array $primaryKeys)
392
+	{
393
+		$this->primaryKeys = $primaryKeys;
394
+		foreach ($this->primaryKeys as $column => $value) {
395
+			$this->dbRow[$column] = $value;
396
+		}
397
+	}
398
+
399
+	/**
400
+	 * Returns the TDBMObject this bean is associated to.
401
+	 *
402
+	 * @return AbstractTDBMObject
403
+	 */
404
+	public function getTDBMObject()
405
+	{
406
+		return $this->object;
407
+	}
408 408
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/AbstractTDBMObject.php 1 patch
Indentation   +489 added lines, -489 removed lines patch added patch discarded remove patch
@@ -31,493 +31,493 @@
 block discarded – undo
31 31
  */
32 32
 abstract class AbstractTDBMObject implements JsonSerializable
33 33
 {
34
-    /**
35
-     * The service this object is bound to.
36
-     *
37
-     * @var TDBMService
38
-     */
39
-    protected $tdbmService;
40
-
41
-    /**
42
-     * An array of DbRow, indexed by table name.
43
-     *
44
-     * @var DbRow[]
45
-     */
46
-    protected $dbRows = array();
47
-
48
-    /**
49
-     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
50
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
51
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
52
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
53
-     *
54
-     * @var string
55
-     */
56
-    private $status;
57
-
58
-    /**
59
-     * Array storing beans related via many to many relationships (pivot tables).
60
-     *
61
-     * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage
62
-     */
63
-    private $relationships = [];
64
-
65
-    /**
66
-     * @var bool[] Key: pivot table name, value: whether a query was performed to load the data.
67
-     */
68
-    private $loadedRelationships = [];
69
-
70
-    /**
71
-     * Used with $primaryKeys when we want to retrieve an existing object
72
-     * and $primaryKeys=[] if we want a new object.
73
-     *
74
-     * @param string      $tableName
75
-     * @param array       $primaryKeys
76
-     * @param TDBMService $tdbmService
77
-     *
78
-     * @throws TDBMException
79
-     * @throws TDBMInvalidOperationException
80
-     */
81
-    public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null)
82
-    {
83
-        // FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation...
84
-        if (!empty($tableName)) {
85
-            $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
86
-        }
87
-
88
-        if ($tdbmService === null) {
89
-            $this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED);
90
-        } else {
91
-            $this->_attach($tdbmService);
92
-            if (!empty($primaryKeys)) {
93
-                $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
94
-            } else {
95
-                $this->_setStatus(TDBMObjectStateEnum::STATE_NEW);
96
-            }
97
-        }
98
-    }
99
-
100
-    /**
101
-     * Alternative constructor called when data is fetched from database via a SELECT.
102
-     *
103
-     * @param array       $beanData    array<table, array<column, value>>
104
-     * @param TDBMService $tdbmService
105
-     */
106
-    public function _constructFromData(array $beanData, TDBMService $tdbmService)
107
-    {
108
-        $this->tdbmService = $tdbmService;
109
-
110
-        foreach ($beanData as $table => $columns) {
111
-            $this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns);
112
-        }
113
-
114
-        $this->status = TDBMObjectStateEnum::STATE_LOADED;
115
-    }
116
-
117
-    /**
118
-     * Alternative constructor called when bean is lazily loaded.
119
-     *
120
-     * @param string      $tableName
121
-     * @param array       $primaryKeys
122
-     * @param TDBMService $tdbmService
123
-     */
124
-    public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService)
125
-    {
126
-        $this->tdbmService = $tdbmService;
127
-
128
-        $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
129
-
130
-        $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
131
-    }
132
-
133
-    public function _attach(TDBMService $tdbmService)
134
-    {
135
-        if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
136
-            throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
137
-        }
138
-        $this->tdbmService = $tdbmService;
139
-
140
-        // If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level)
141
-        $tableNames = array_keys($this->dbRows);
142
-        $tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames);
143
-        $tableNames = array_reverse($tableNames);
144
-
145
-        $newDbRows = [];
146
-
147
-        foreach ($tableNames as $table) {
148
-            if (!isset($this->dbRows[$table])) {
149
-                $this->registerTable($table);
150
-            }
151
-            $newDbRows[$table] = $this->dbRows[$table];
152
-        }
153
-        $this->dbRows = $newDbRows;
154
-
155
-        $this->status = TDBMObjectStateEnum::STATE_NEW;
156
-        foreach ($this->dbRows as $dbRow) {
157
-            $dbRow->_attach($tdbmService);
158
-        }
159
-    }
160
-
161
-    /**
162
-     * Sets the state of the TDBM Object
163
-     * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
164
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
165
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
166
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
167
-     *
168
-     * @param string $state
169
-     */
170
-    public function _setStatus($state)
171
-    {
172
-        $this->status = $state;
173
-
174
-        // TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself.
175
-        foreach ($this->dbRows as $dbRow) {
176
-            $dbRow->_setStatus($state);
177
-        }
178
-    }
179
-
180
-    protected function get($var, $tableName = null)
181
-    {
182
-        if ($tableName === null) {
183
-            if (count($this->dbRows) > 1) {
184
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
185
-            } elseif (count($this->dbRows) === 1) {
186
-                $tableName = array_keys($this->dbRows)[0];
187
-            }
188
-        }
189
-
190
-        if (!isset($this->dbRows[$tableName])) {
191
-            if (count($this->dbRows[$tableName] === 0)) {
192
-                throw new TDBMException('Object is not yet bound to any table.');
193
-            } else {
194
-                throw new TDBMException('Unknown table "'.$tableName.'"" in object.');
195
-            }
196
-        }
197
-
198
-        return $this->dbRows[$tableName]->get($var);
199
-    }
200
-
201
-    protected function set($var, $value, $tableName = null)
202
-    {
203
-        if ($tableName === null) {
204
-            if (count($this->dbRows) > 1) {
205
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
206
-            } elseif (count($this->dbRows) === 1) {
207
-                $tableName = array_keys($this->dbRows)[0];
208
-            } else {
209
-                throw new TDBMException('Please specify a table for this object.');
210
-            }
211
-        }
212
-
213
-        if (!isset($this->dbRows[$tableName])) {
214
-            $this->registerTable($tableName);
215
-        }
216
-
217
-        $this->dbRows[$tableName]->set($var, $value);
218
-        if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
219
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
220
-        }
221
-    }
222
-
223
-    /**
224
-     * @param string             $foreignKeyName
225
-     * @param AbstractTDBMObject $bean
226
-     */
227
-    protected function setRef($foreignKeyName, AbstractTDBMObject $bean, $tableName = null)
228
-    {
229
-        if ($tableName === null) {
230
-            if (count($this->dbRows) > 1) {
231
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
232
-            } elseif (count($this->dbRows) === 1) {
233
-                $tableName = array_keys($this->dbRows)[0];
234
-            } else {
235
-                throw new TDBMException('Please specify a table for this object.');
236
-            }
237
-        }
238
-
239
-        if (!isset($this->dbRows[$tableName])) {
240
-            $this->registerTable($tableName);
241
-        }
242
-
243
-        $this->dbRows[$tableName]->setRef($foreignKeyName, $bean);
244
-        if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
245
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
246
-        }
247
-    }
248
-
249
-    /**
250
-     * @param string $foreignKeyName A unique name for this reference
251
-     *
252
-     * @return AbstractTDBMObject|null
253
-     */
254
-    protected function getRef($foreignKeyName, $tableName = null)
255
-    {
256
-        if ($tableName === null) {
257
-            if (count($this->dbRows) > 1) {
258
-                throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
259
-            } elseif (count($this->dbRows) === 1) {
260
-                $tableName = array_keys($this->dbRows)[0];
261
-            }
262
-        }
263
-
264
-        if (!isset($this->dbRows[$tableName])) {
265
-            if (count($this->dbRows[$tableName] === 0)) {
266
-                throw new TDBMException('Object is not yet bound to any table.');
267
-            } else {
268
-                throw new TDBMException('Unknown table "'.$tableName.'"" in object.');
269
-            }
270
-        }
271
-
272
-        return $this->dbRows[$tableName]->getRef($foreignKeyName);
273
-    }
274
-
275
-    /**
276
-     * Adds a many to many relationship to this bean.
277
-     *
278
-     * @param string             $pivotTableName
279
-     * @param AbstractTDBMObject $remoteBean
280
-     */
281
-    protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
282
-    {
283
-        $this->setRelationship($pivotTableName, $remoteBean, 'new');
284
-    }
285
-
286
-    /**
287
-     * Returns true if there is a relationship to this bean.
288
-     *
289
-     * @param string             $pivotTableName
290
-     * @param AbstractTDBMObject $remoteBean
291
-     *
292
-     * @return bool
293
-     */
294
-    protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
295
-    {
296
-        $storage = $this->retrieveRelationshipsStorage($pivotTableName);
297
-
298
-        if ($storage->contains($remoteBean)) {
299
-            if ($storage[$remoteBean]['status'] !== 'delete') {
300
-                return true;
301
-            }
302
-        }
303
-
304
-        return false;
305
-    }
306
-
307
-    /**
308
-     * Internal TDBM method. Removes a many to many relationship from this bean.
309
-     *
310
-     * @param string             $pivotTableName
311
-     * @param AbstractTDBMObject $remoteBean
312
-     */
313
-    public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
314
-    {
315
-        if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') {
316
-            unset($this->relationships[$pivotTableName][$remoteBean]);
317
-            unset($remoteBean->relationships[$pivotTableName][$this]);
318
-        } else {
319
-            $this->setRelationship($pivotTableName, $remoteBean, 'delete');
320
-        }
321
-    }
322
-
323
-    /**
324
-     * Returns the list of objects linked to this bean via $pivotTableName.
325
-     *
326
-     * @param $pivotTableName
327
-     *
328
-     * @return \SplObjectStorage
329
-     */
330
-    private function retrieveRelationshipsStorage($pivotTableName)
331
-    {
332
-        $storage = $this->getRelationshipStorage($pivotTableName);
333
-        if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName]) {
334
-            return $storage;
335
-        }
336
-
337
-        $beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this);
338
-        $this->loadedRelationships[$pivotTableName] = true;
339
-
340
-        foreach ($beans as $bean) {
341
-            if (isset($storage[$bean])) {
342
-                $oldStatus = $storage[$bean]['status'];
343
-                if ($oldStatus === 'delete') {
344
-                    // Keep deleted things deleted
345
-                    continue;
346
-                }
347
-            }
348
-            $this->setRelationship($pivotTableName, $bean, 'loaded');
349
-        }
350
-
351
-        return $storage;
352
-    }
353
-
354
-    /**
355
-     * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName.
356
-     *
357
-     * @param $pivotTableName
358
-     *
359
-     * @return AbstractTDBMObject[]
360
-     */
361
-    public function _getRelationships($pivotTableName)
362
-    {
363
-        return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName));
364
-    }
365
-
366
-    private function relationshipStorageToArray(\SplObjectStorage $storage)
367
-    {
368
-        $beans = [];
369
-        foreach ($storage as $bean) {
370
-            $statusArr = $storage[$bean];
371
-            if ($statusArr['status'] !== 'delete') {
372
-                $beans[] = $bean;
373
-            }
374
-        }
375
-
376
-        return $beans;
377
-    }
378
-
379
-    /**
380
-     * Declares a relationship between.
381
-     *
382
-     * @param string             $pivotTableName
383
-     * @param AbstractTDBMObject $remoteBean
384
-     * @param string             $status
385
-     */
386
-    private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status)
387
-    {
388
-        $storage = $this->getRelationshipStorage($pivotTableName);
389
-        $storage->attach($remoteBean, ['status' => $status, 'reverse' => false]);
390
-        if ($this->status === TDBMObjectStateEnum::STATE_LOADED) {
391
-            $this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY);
392
-        }
393
-
394
-        $remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName);
395
-        $remoteStorage->attach($this, ['status' => $status, 'reverse' => true]);
396
-    }
397
-
398
-    /**
399
-     * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists).
400
-     *
401
-     * @param $pivotTableName
402
-     *
403
-     * @return \SplObjectStorage
404
-     */
405
-    private function getRelationshipStorage($pivotTableName)
406
-    {
407
-        if (isset($this->relationships[$pivotTableName])) {
408
-            $storage = $this->relationships[$pivotTableName];
409
-        } else {
410
-            $storage = new \SplObjectStorage();
411
-            $this->relationships[$pivotTableName] = $storage;
412
-        }
413
-
414
-        return $storage;
415
-    }
416
-
417
-    /**
418
-     * Reverts any changes made to the object and resumes it to its DB state.
419
-     * This can only be called on objects that come from database and that have not been deleted.
420
-     * Otherwise, this will throw an exception.
421
-     *
422
-     * @throws TDBMException
423
-     */
424
-    public function discardChanges()
425
-    {
426
-        if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) {
427
-            throw new TDBMException("You cannot call discardChanges() on an object that has been created with the 'new' keyword and that has not yet been saved.");
428
-        }
429
-
430
-        if ($this->status === TDBMObjectStateEnum::STATE_DELETED) {
431
-            throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.');
432
-        }
433
-
434
-        $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
435
-    }
436
-
437
-    /**
438
-     * Method used internally by TDBM. You should not use it directly.
439
-     * This method returns the status of the TDBMObject.
440
-     * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
441
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
442
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
443
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
444
-     *
445
-     * @return string
446
-     */
447
-    public function _getStatus()
448
-    {
449
-        return $this->status;
450
-    }
451
-
452
-    /**
453
-     * Override the native php clone function for TDBMObjects.
454
-     */
455
-    public function __clone()
456
-    {
457
-        // Let's clone the many to many relationships
458
-        if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) {
459
-            $pivotTableList = array_keys($this->relationships);
460
-        } else {
461
-            $pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this);
462
-        }
463
-
464
-        foreach ($pivotTableList as $pivotTable) {
465
-            $storage = $this->retrieveRelationshipsStorage($pivotTable);
466
-
467
-            // Let's duplicate the reverse side of the relationship
468
-            foreach ($storage as $remoteBean) {
469
-                $metadata = $storage[$remoteBean];
470
-
471
-                $remoteStorage = $remoteBean->getRelationshipStorage($pivotTable);
472
-                $remoteStorage->attach($this, ['status' => $metadata['status'], 'reverse' => !$metadata['reverse']]);
473
-            }
474
-        }
475
-
476
-        // Let's clone each row
477
-        foreach ($this->dbRows as $key => $dbRow) {
478
-            $this->dbRows[$key] = clone $dbRow;
479
-        }
480
-
481
-        // Let's set the status to new (to enter the save function)
482
-        $this->status = TDBMObjectStateEnum::STATE_DETACHED;
483
-    }
484
-
485
-    /**
486
-     * Returns raw database rows.
487
-     *
488
-     * @return DbRow[] Key: table name, Value: DbRow object
489
-     */
490
-    public function _getDbRows()
491
-    {
492
-        return $this->dbRows;
493
-    }
494
-
495
-    private function registerTable($tableName)
496
-    {
497
-        $dbRow = new DbRow($this, $tableName);
498
-
499
-        if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) {
500
-            // Let's get the primary key for the new table
501
-            $anotherDbRow = array_values($this->dbRows)[0];
502
-            /* @var $anotherDbRow DbRow */
503
-            $indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys());
504
-            $primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys);
505
-            $dbRow->_setPrimaryKeys($primaryKeys);
506
-        }
507
-
508
-        $dbRow->_setStatus($this->status);
509
-
510
-        $this->dbRows[$tableName] = $dbRow;
511
-        // TODO: look at status (if not new)=> get primary key from tdbmservice
512
-    }
513
-
514
-    /**
515
-     * Internal function: return the list of relationships.
516
-     *
517
-     * @return \SplObjectStorage[]
518
-     */
519
-    public function _getCachedRelationships()
520
-    {
521
-        return $this->relationships;
522
-    }
34
+	/**
35
+	 * The service this object is bound to.
36
+	 *
37
+	 * @var TDBMService
38
+	 */
39
+	protected $tdbmService;
40
+
41
+	/**
42
+	 * An array of DbRow, indexed by table name.
43
+	 *
44
+	 * @var DbRow[]
45
+	 */
46
+	protected $dbRows = array();
47
+
48
+	/**
49
+	 * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
50
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
51
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
52
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
53
+	 *
54
+	 * @var string
55
+	 */
56
+	private $status;
57
+
58
+	/**
59
+	 * Array storing beans related via many to many relationships (pivot tables).
60
+	 *
61
+	 * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage
62
+	 */
63
+	private $relationships = [];
64
+
65
+	/**
66
+	 * @var bool[] Key: pivot table name, value: whether a query was performed to load the data.
67
+	 */
68
+	private $loadedRelationships = [];
69
+
70
+	/**
71
+	 * Used with $primaryKeys when we want to retrieve an existing object
72
+	 * and $primaryKeys=[] if we want a new object.
73
+	 *
74
+	 * @param string      $tableName
75
+	 * @param array       $primaryKeys
76
+	 * @param TDBMService $tdbmService
77
+	 *
78
+	 * @throws TDBMException
79
+	 * @throws TDBMInvalidOperationException
80
+	 */
81
+	public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null)
82
+	{
83
+		// FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation...
84
+		if (!empty($tableName)) {
85
+			$this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
86
+		}
87
+
88
+		if ($tdbmService === null) {
89
+			$this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED);
90
+		} else {
91
+			$this->_attach($tdbmService);
92
+			if (!empty($primaryKeys)) {
93
+				$this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
94
+			} else {
95
+				$this->_setStatus(TDBMObjectStateEnum::STATE_NEW);
96
+			}
97
+		}
98
+	}
99
+
100
+	/**
101
+	 * Alternative constructor called when data is fetched from database via a SELECT.
102
+	 *
103
+	 * @param array       $beanData    array<table, array<column, value>>
104
+	 * @param TDBMService $tdbmService
105
+	 */
106
+	public function _constructFromData(array $beanData, TDBMService $tdbmService)
107
+	{
108
+		$this->tdbmService = $tdbmService;
109
+
110
+		foreach ($beanData as $table => $columns) {
111
+			$this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns);
112
+		}
113
+
114
+		$this->status = TDBMObjectStateEnum::STATE_LOADED;
115
+	}
116
+
117
+	/**
118
+	 * Alternative constructor called when bean is lazily loaded.
119
+	 *
120
+	 * @param string      $tableName
121
+	 * @param array       $primaryKeys
122
+	 * @param TDBMService $tdbmService
123
+	 */
124
+	public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService)
125
+	{
126
+		$this->tdbmService = $tdbmService;
127
+
128
+		$this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService);
129
+
130
+		$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
131
+	}
132
+
133
+	public function _attach(TDBMService $tdbmService)
134
+	{
135
+		if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) {
136
+			throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.');
137
+		}
138
+		$this->tdbmService = $tdbmService;
139
+
140
+		// If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level)
141
+		$tableNames = array_keys($this->dbRows);
142
+		$tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames);
143
+		$tableNames = array_reverse($tableNames);
144
+
145
+		$newDbRows = [];
146
+
147
+		foreach ($tableNames as $table) {
148
+			if (!isset($this->dbRows[$table])) {
149
+				$this->registerTable($table);
150
+			}
151
+			$newDbRows[$table] = $this->dbRows[$table];
152
+		}
153
+		$this->dbRows = $newDbRows;
154
+
155
+		$this->status = TDBMObjectStateEnum::STATE_NEW;
156
+		foreach ($this->dbRows as $dbRow) {
157
+			$dbRow->_attach($tdbmService);
158
+		}
159
+	}
160
+
161
+	/**
162
+	 * Sets the state of the TDBM Object
163
+	 * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
164
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
165
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
166
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
167
+	 *
168
+	 * @param string $state
169
+	 */
170
+	public function _setStatus($state)
171
+	{
172
+		$this->status = $state;
173
+
174
+		// TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself.
175
+		foreach ($this->dbRows as $dbRow) {
176
+			$dbRow->_setStatus($state);
177
+		}
178
+	}
179
+
180
+	protected function get($var, $tableName = null)
181
+	{
182
+		if ($tableName === null) {
183
+			if (count($this->dbRows) > 1) {
184
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
185
+			} elseif (count($this->dbRows) === 1) {
186
+				$tableName = array_keys($this->dbRows)[0];
187
+			}
188
+		}
189
+
190
+		if (!isset($this->dbRows[$tableName])) {
191
+			if (count($this->dbRows[$tableName] === 0)) {
192
+				throw new TDBMException('Object is not yet bound to any table.');
193
+			} else {
194
+				throw new TDBMException('Unknown table "'.$tableName.'"" in object.');
195
+			}
196
+		}
197
+
198
+		return $this->dbRows[$tableName]->get($var);
199
+	}
200
+
201
+	protected function set($var, $value, $tableName = null)
202
+	{
203
+		if ($tableName === null) {
204
+			if (count($this->dbRows) > 1) {
205
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
206
+			} elseif (count($this->dbRows) === 1) {
207
+				$tableName = array_keys($this->dbRows)[0];
208
+			} else {
209
+				throw new TDBMException('Please specify a table for this object.');
210
+			}
211
+		}
212
+
213
+		if (!isset($this->dbRows[$tableName])) {
214
+			$this->registerTable($tableName);
215
+		}
216
+
217
+		$this->dbRows[$tableName]->set($var, $value);
218
+		if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
219
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
220
+		}
221
+	}
222
+
223
+	/**
224
+	 * @param string             $foreignKeyName
225
+	 * @param AbstractTDBMObject $bean
226
+	 */
227
+	protected function setRef($foreignKeyName, AbstractTDBMObject $bean, $tableName = null)
228
+	{
229
+		if ($tableName === null) {
230
+			if (count($this->dbRows) > 1) {
231
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
232
+			} elseif (count($this->dbRows) === 1) {
233
+				$tableName = array_keys($this->dbRows)[0];
234
+			} else {
235
+				throw new TDBMException('Please specify a table for this object.');
236
+			}
237
+		}
238
+
239
+		if (!isset($this->dbRows[$tableName])) {
240
+			$this->registerTable($tableName);
241
+		}
242
+
243
+		$this->dbRows[$tableName]->setRef($foreignKeyName, $bean);
244
+		if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) {
245
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
246
+		}
247
+	}
248
+
249
+	/**
250
+	 * @param string $foreignKeyName A unique name for this reference
251
+	 *
252
+	 * @return AbstractTDBMObject|null
253
+	 */
254
+	protected function getRef($foreignKeyName, $tableName = null)
255
+	{
256
+		if ($tableName === null) {
257
+			if (count($this->dbRows) > 1) {
258
+				throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.');
259
+			} elseif (count($this->dbRows) === 1) {
260
+				$tableName = array_keys($this->dbRows)[0];
261
+			}
262
+		}
263
+
264
+		if (!isset($this->dbRows[$tableName])) {
265
+			if (count($this->dbRows[$tableName] === 0)) {
266
+				throw new TDBMException('Object is not yet bound to any table.');
267
+			} else {
268
+				throw new TDBMException('Unknown table "'.$tableName.'"" in object.');
269
+			}
270
+		}
271
+
272
+		return $this->dbRows[$tableName]->getRef($foreignKeyName);
273
+	}
274
+
275
+	/**
276
+	 * Adds a many to many relationship to this bean.
277
+	 *
278
+	 * @param string             $pivotTableName
279
+	 * @param AbstractTDBMObject $remoteBean
280
+	 */
281
+	protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
282
+	{
283
+		$this->setRelationship($pivotTableName, $remoteBean, 'new');
284
+	}
285
+
286
+	/**
287
+	 * Returns true if there is a relationship to this bean.
288
+	 *
289
+	 * @param string             $pivotTableName
290
+	 * @param AbstractTDBMObject $remoteBean
291
+	 *
292
+	 * @return bool
293
+	 */
294
+	protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
295
+	{
296
+		$storage = $this->retrieveRelationshipsStorage($pivotTableName);
297
+
298
+		if ($storage->contains($remoteBean)) {
299
+			if ($storage[$remoteBean]['status'] !== 'delete') {
300
+				return true;
301
+			}
302
+		}
303
+
304
+		return false;
305
+	}
306
+
307
+	/**
308
+	 * Internal TDBM method. Removes a many to many relationship from this bean.
309
+	 *
310
+	 * @param string             $pivotTableName
311
+	 * @param AbstractTDBMObject $remoteBean
312
+	 */
313
+	public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean)
314
+	{
315
+		if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') {
316
+			unset($this->relationships[$pivotTableName][$remoteBean]);
317
+			unset($remoteBean->relationships[$pivotTableName][$this]);
318
+		} else {
319
+			$this->setRelationship($pivotTableName, $remoteBean, 'delete');
320
+		}
321
+	}
322
+
323
+	/**
324
+	 * Returns the list of objects linked to this bean via $pivotTableName.
325
+	 *
326
+	 * @param $pivotTableName
327
+	 *
328
+	 * @return \SplObjectStorage
329
+	 */
330
+	private function retrieveRelationshipsStorage($pivotTableName)
331
+	{
332
+		$storage = $this->getRelationshipStorage($pivotTableName);
333
+		if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName]) {
334
+			return $storage;
335
+		}
336
+
337
+		$beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this);
338
+		$this->loadedRelationships[$pivotTableName] = true;
339
+
340
+		foreach ($beans as $bean) {
341
+			if (isset($storage[$bean])) {
342
+				$oldStatus = $storage[$bean]['status'];
343
+				if ($oldStatus === 'delete') {
344
+					// Keep deleted things deleted
345
+					continue;
346
+				}
347
+			}
348
+			$this->setRelationship($pivotTableName, $bean, 'loaded');
349
+		}
350
+
351
+		return $storage;
352
+	}
353
+
354
+	/**
355
+	 * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName.
356
+	 *
357
+	 * @param $pivotTableName
358
+	 *
359
+	 * @return AbstractTDBMObject[]
360
+	 */
361
+	public function _getRelationships($pivotTableName)
362
+	{
363
+		return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName));
364
+	}
365
+
366
+	private function relationshipStorageToArray(\SplObjectStorage $storage)
367
+	{
368
+		$beans = [];
369
+		foreach ($storage as $bean) {
370
+			$statusArr = $storage[$bean];
371
+			if ($statusArr['status'] !== 'delete') {
372
+				$beans[] = $bean;
373
+			}
374
+		}
375
+
376
+		return $beans;
377
+	}
378
+
379
+	/**
380
+	 * Declares a relationship between.
381
+	 *
382
+	 * @param string             $pivotTableName
383
+	 * @param AbstractTDBMObject $remoteBean
384
+	 * @param string             $status
385
+	 */
386
+	private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status)
387
+	{
388
+		$storage = $this->getRelationshipStorage($pivotTableName);
389
+		$storage->attach($remoteBean, ['status' => $status, 'reverse' => false]);
390
+		if ($this->status === TDBMObjectStateEnum::STATE_LOADED) {
391
+			$this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY);
392
+		}
393
+
394
+		$remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName);
395
+		$remoteStorage->attach($this, ['status' => $status, 'reverse' => true]);
396
+	}
397
+
398
+	/**
399
+	 * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists).
400
+	 *
401
+	 * @param $pivotTableName
402
+	 *
403
+	 * @return \SplObjectStorage
404
+	 */
405
+	private function getRelationshipStorage($pivotTableName)
406
+	{
407
+		if (isset($this->relationships[$pivotTableName])) {
408
+			$storage = $this->relationships[$pivotTableName];
409
+		} else {
410
+			$storage = new \SplObjectStorage();
411
+			$this->relationships[$pivotTableName] = $storage;
412
+		}
413
+
414
+		return $storage;
415
+	}
416
+
417
+	/**
418
+	 * Reverts any changes made to the object and resumes it to its DB state.
419
+	 * This can only be called on objects that come from database and that have not been deleted.
420
+	 * Otherwise, this will throw an exception.
421
+	 *
422
+	 * @throws TDBMException
423
+	 */
424
+	public function discardChanges()
425
+	{
426
+		if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) {
427
+			throw new TDBMException("You cannot call discardChanges() on an object that has been created with the 'new' keyword and that has not yet been saved.");
428
+		}
429
+
430
+		if ($this->status === TDBMObjectStateEnum::STATE_DELETED) {
431
+			throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.');
432
+		}
433
+
434
+		$this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED);
435
+	}
436
+
437
+	/**
438
+	 * Method used internally by TDBM. You should not use it directly.
439
+	 * This method returns the status of the TDBMObject.
440
+	 * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
441
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
442
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
443
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
444
+	 *
445
+	 * @return string
446
+	 */
447
+	public function _getStatus()
448
+	{
449
+		return $this->status;
450
+	}
451
+
452
+	/**
453
+	 * Override the native php clone function for TDBMObjects.
454
+	 */
455
+	public function __clone()
456
+	{
457
+		// Let's clone the many to many relationships
458
+		if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) {
459
+			$pivotTableList = array_keys($this->relationships);
460
+		} else {
461
+			$pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this);
462
+		}
463
+
464
+		foreach ($pivotTableList as $pivotTable) {
465
+			$storage = $this->retrieveRelationshipsStorage($pivotTable);
466
+
467
+			// Let's duplicate the reverse side of the relationship
468
+			foreach ($storage as $remoteBean) {
469
+				$metadata = $storage[$remoteBean];
470
+
471
+				$remoteStorage = $remoteBean->getRelationshipStorage($pivotTable);
472
+				$remoteStorage->attach($this, ['status' => $metadata['status'], 'reverse' => !$metadata['reverse']]);
473
+			}
474
+		}
475
+
476
+		// Let's clone each row
477
+		foreach ($this->dbRows as $key => $dbRow) {
478
+			$this->dbRows[$key] = clone $dbRow;
479
+		}
480
+
481
+		// Let's set the status to new (to enter the save function)
482
+		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
483
+	}
484
+
485
+	/**
486
+	 * Returns raw database rows.
487
+	 *
488
+	 * @return DbRow[] Key: table name, Value: DbRow object
489
+	 */
490
+	public function _getDbRows()
491
+	{
492
+		return $this->dbRows;
493
+	}
494
+
495
+	private function registerTable($tableName)
496
+	{
497
+		$dbRow = new DbRow($this, $tableName);
498
+
499
+		if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) {
500
+			// Let's get the primary key for the new table
501
+			$anotherDbRow = array_values($this->dbRows)[0];
502
+			/* @var $anotherDbRow DbRow */
503
+			$indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys());
504
+			$primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys);
505
+			$dbRow->_setPrimaryKeys($primaryKeys);
506
+		}
507
+
508
+		$dbRow->_setStatus($this->status);
509
+
510
+		$this->dbRows[$tableName] = $dbRow;
511
+		// TODO: look at status (if not new)=> get primary key from tdbmservice
512
+	}
513
+
514
+	/**
515
+	 * Internal function: return the list of relationships.
516
+	 *
517
+	 * @return \SplObjectStorage[]
518
+	 */
519
+	public function _getCachedRelationships()
520
+	{
521
+		return $this->relationships;
522
+	}
523 523
 }
Please login to merge, or discard this patch.