Completed
Push — 4.0 ( 1968f6...2cd8cb )
by David
02:57
created
src/Mouf/Database/TDBM/DbRow.php 2 patches
Indentation   +380 added lines, -380 removed lines patch added patch discarded remove patch
@@ -27,170 +27,170 @@  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
-            $row = $result->fetch(\PDO::FETCH_ASSOC);
173
-
174
-            $this->dbRow = [];
175
-            $types = $this->tdbmService->_getColumnTypesForTable($this->dbTableName);
176
-
177
-            foreach ($row as $key => $value) {
178
-                $this->dbRow[$key] = $types[$key]->convertToPHPValue($value, $connection->getDatabasePlatform());
179
-            }
180
-
181
-            $result->closeCursor();
182
-
183
-            $this->status = TDBMObjectStateEnum::STATE_LOADED;
184
-        }
185
-    }
186
-
187
-    public function get($var)
188
-    {
189
-        $this->_dbLoadIfNotLoaded();
190
-
191
-        // Let's first check if the key exist.
192
-        if (!isset($this->dbRow[$var])) {
193
-            /*
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
+			$row = $result->fetch(\PDO::FETCH_ASSOC);
173
+
174
+			$this->dbRow = [];
175
+			$types = $this->tdbmService->_getColumnTypesForTable($this->dbTableName);
176
+
177
+			foreach ($row as $key => $value) {
178
+				$this->dbRow[$key] = $types[$key]->convertToPHPValue($value, $connection->getDatabasePlatform());
179
+			}
180
+
181
+			$result->closeCursor();
182
+
183
+			$this->status = TDBMObjectStateEnum::STATE_LOADED;
184
+		}
185
+	}
186
+
187
+	public function get($var)
188
+	{
189
+		$this->_dbLoadIfNotLoaded();
190
+
191
+		// Let's first check if the key exist.
192
+		if (!isset($this->dbRow[$var])) {
193
+			/*
194 194
             // Unable to find column.... this is an error if the object has been retrieved from database.
195 195
             // If it's a new object, well, that may not be an error after all!
196 196
             // Let's check if the column does exist in the table
@@ -210,39 +210,39 @@  discard block
 block discarded – undo
210 210
             $str = "Could not find column \"$var\" in table \"$this->dbTableName\". Maybe you meant one of those columns: '".implode("', '",$result_array)."'";
211 211
 
212 212
             throw new TDBMException($str);*/
213
-            return;
214
-        }
215
-
216
-        $value = $this->dbRow[$var];
217
-        if ($value instanceof \DateTime) {
218
-            if (method_exists('DateTimeImmutable', 'createFromMutable')) { // PHP 5.6+ only
219
-                return \DateTimeImmutable::createFromMutable($value);
220
-            } else {
221
-                return new \DateTimeImmutable($value->format('c'));
222
-            }
223
-        }
224
-
225
-        return $this->dbRow[$var];
226
-    }
227
-
228
-    /**
229
-     * Returns true if a column is set, false otherwise.
230
-     *
231
-     * @param string $var
232
-     *
233
-     * @return bool
234
-     */
235
-    /*public function has($var) {
213
+			return;
214
+		}
215
+
216
+		$value = $this->dbRow[$var];
217
+		if ($value instanceof \DateTime) {
218
+			if (method_exists('DateTimeImmutable', 'createFromMutable')) { // PHP 5.6+ only
219
+				return \DateTimeImmutable::createFromMutable($value);
220
+			} else {
221
+				return new \DateTimeImmutable($value->format('c'));
222
+			}
223
+		}
224
+
225
+		return $this->dbRow[$var];
226
+	}
227
+
228
+	/**
229
+	 * Returns true if a column is set, false otherwise.
230
+	 *
231
+	 * @param string $var
232
+	 *
233
+	 * @return bool
234
+	 */
235
+	/*public function has($var) {
236 236
         $this->_dbLoadIfNotLoaded();
237 237
 
238 238
         return isset($this->dbRow[$var]);
239 239
     }*/
240 240
 
241
-    public function set($var, $value)
242
-    {
243
-        $this->_dbLoadIfNotLoaded();
241
+	public function set($var, $value)
242
+	{
243
+		$this->_dbLoadIfNotLoaded();
244 244
 
245
-        /*
245
+		/*
246 246
         // Ok, let's start by checking the column type
247 247
         $type = $this->db_connection->getColumnType($this->dbTableName, $var);
248 248
 
@@ -252,194 +252,194 @@  discard block
 block discarded – undo
252 252
         }
253 253
         */
254 254
 
255
-        /*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var]))
255
+		/*if ($var == $this->getPrimaryKey() && isset($this->dbRow[$var]))
256 256
             throw new TDBMException("Error! Changing primary key value is forbidden.");*/
257
-        $this->dbRow[$var] = $value;
258
-        if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
259
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
260
-            $this->tdbmService->_addToToSaveObjectList($this);
261
-        }
262
-    }
263
-
264
-    /**
265
-     * @param string             $foreignKeyName
266
-     * @param AbstractTDBMObject $bean
267
-     */
268
-    public function setRef($foreignKeyName, AbstractTDBMObject $bean = null)
269
-    {
270
-        $this->references[$foreignKeyName] = $bean;
271
-
272
-        if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
273
-            $this->status = TDBMObjectStateEnum::STATE_DIRTY;
274
-            $this->tdbmService->_addToToSaveObjectList($this);
275
-        }
276
-    }
277
-
278
-    /**
279
-     * @param string $foreignKeyName A unique name for this reference
280
-     *
281
-     * @return AbstractTDBMObject|null
282
-     */
283
-    public function getRef($foreignKeyName)
284
-    {
285
-        if (array_key_exists($foreignKeyName, $this->references)) {
286
-            return $this->references[$foreignKeyName];
287
-        } elseif ($this->status === TDBMObjectStateEnum::STATE_NEW) {
288
-            // If the object is new and has no property, then it has to be empty.
289
-            return;
290
-        } else {
291
-            $this->_dbLoadIfNotLoaded();
292
-
293
-            // Let's match the name of the columns to the primary key values
294
-            $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
295
-
296
-            $values = [];
297
-            foreach ($fk->getLocalColumns() as $column) {
298
-                $val = $this->dbRow[$column];
299
-                if ($val === null) {
300
-                    return;
301
-                }
302
-                $values[] = $val;
303
-            }
304
-
305
-            $filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values);
306
-
307
-            return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true);
308
-        }
309
-    }
310
-
311
-    /**
312
-     * Returns the name of the table this object comes from.
313
-     *
314
-     * @return string
315
-     */
316
-    public function _getDbTableName()
317
-    {
318
-        return $this->dbTableName;
319
-    }
320
-
321
-    /**
322
-     * Method used internally by TDBM. You should not use it directly.
323
-     * This method returns the status of the TDBMObject.
324
-     * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
325
-     * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
326
-     * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
327
-     * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
328
-     *
329
-     * @return string
330
-     */
331
-    public function _getStatus()
332
-    {
333
-        return $this->status;
334
-    }
335
-
336
-    /**
337
-     * Override the native php clone function for TDBMObjects.
338
-     */
339
-    public function __clone()
340
-    {
341
-        // Let's load the row (before we lose the ID!)
342
-        $this->_dbLoadIfNotLoaded();
343
-
344
-        //Let's set the status to detached
345
-        $this->status = TDBMObjectStateEnum::STATE_DETACHED;
346
-
347
-        $this->primaryKeys = [];
348
-
349
-        //Now unset the PK from the row
350
-        if ($this->tdbmService) {
351
-            $pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName);
352
-            foreach ($pk_array as $pk) {
353
-                $this->dbRow[$pk] = null;
354
-            }
355
-        }
356
-    }
357
-
358
-    /**
359
-     * Returns raw database row.
360
-     *
361
-     * @return array
362
-     */
363
-    public function _getDbRow()
364
-    {
365
-        // Let's merge $dbRow and $references
366
-        $dbRow = $this->dbRow;
367
-
368
-        foreach ($this->references as $foreignKeyName => $reference) {
369
-            // Let's match the name of the columns to the primary key values
370
-            $fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
371
-            $localColumns = $fk->getLocalColumns();
372
-
373
-            if ($reference !== null) {
374
-                $refDbRows = $reference->_getDbRows();
375
-                $firstRefDbRow = reset($refDbRows);
376
-                $pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
377
-                for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
378
-                    $dbRow[$localColumns[$i]] = $pkValues[$i];
379
-                }
380
-            } else {
381
-                for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
382
-                    $dbRow[$localColumns[$i]] = null;
383
-                }
384
-            }
385
-        }
386
-
387
-        return $dbRow;
388
-    }
389
-
390
-    /**
391
-     * Returns references array.
392
-     *
393
-     * @return AbstractTDBMObject[]
394
-     */
395
-    public function _getReferences()
396
-    {
397
-        return $this->references;
398
-    }
399
-
400
-    /**
401
-     * Returns the values of the primary key.
402
-     * This is set when the object is in "loaded" state.
403
-     *
404
-     * @return array
405
-     */
406
-    public function _getPrimaryKeys()
407
-    {
408
-        return $this->primaryKeys;
409
-    }
410
-
411
-    /**
412
-     * Sets the values of the primary key.
413
-     * This is set when the object is in "loaded" state.
414
-     *
415
-     * @param array $primaryKeys
416
-     */
417
-    public function _setPrimaryKeys(array $primaryKeys)
418
-    {
419
-        $this->primaryKeys = $primaryKeys;
420
-        foreach ($this->primaryKeys as $column => $value) {
421
-            $this->dbRow[$column] = $value;
422
-        }
423
-    }
424
-
425
-    /**
426
-     * Returns the TDBMObject this bean is associated to.
427
-     *
428
-     * @return AbstractTDBMObject
429
-     */
430
-    public function getTDBMObject()
431
-    {
432
-        return $this->object;
433
-    }
434
-
435
-    /**
436
-     * Sets the TDBMObject this bean is associated to.
437
-     * Only used when cloning.
438
-     *
439
-     * @param AbstractTDBMObject $object
440
-     */
441
-    public function setTDBMObject(AbstractTDBMObject $object)
442
-    {
443
-        $this->object = $object;
444
-    }
257
+		$this->dbRow[$var] = $value;
258
+		if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
259
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
260
+			$this->tdbmService->_addToToSaveObjectList($this);
261
+		}
262
+	}
263
+
264
+	/**
265
+	 * @param string             $foreignKeyName
266
+	 * @param AbstractTDBMObject $bean
267
+	 */
268
+	public function setRef($foreignKeyName, AbstractTDBMObject $bean = null)
269
+	{
270
+		$this->references[$foreignKeyName] = $bean;
271
+
272
+		if ($this->tdbmService !== null && $this->status === TDBMObjectStateEnum::STATE_LOADED) {
273
+			$this->status = TDBMObjectStateEnum::STATE_DIRTY;
274
+			$this->tdbmService->_addToToSaveObjectList($this);
275
+		}
276
+	}
277
+
278
+	/**
279
+	 * @param string $foreignKeyName A unique name for this reference
280
+	 *
281
+	 * @return AbstractTDBMObject|null
282
+	 */
283
+	public function getRef($foreignKeyName)
284
+	{
285
+		if (array_key_exists($foreignKeyName, $this->references)) {
286
+			return $this->references[$foreignKeyName];
287
+		} elseif ($this->status === TDBMObjectStateEnum::STATE_NEW) {
288
+			// If the object is new and has no property, then it has to be empty.
289
+			return;
290
+		} else {
291
+			$this->_dbLoadIfNotLoaded();
292
+
293
+			// Let's match the name of the columns to the primary key values
294
+			$fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
295
+
296
+			$values = [];
297
+			foreach ($fk->getLocalColumns() as $column) {
298
+				$val = $this->dbRow[$column];
299
+				if ($val === null) {
300
+					return;
301
+				}
302
+				$values[] = $val;
303
+			}
304
+
305
+			$filter = array_combine($this->tdbmService->getPrimaryKeyColumns($fk->getForeignTableName()), $values);
306
+
307
+			return $this->tdbmService->findObjectByPk($fk->getForeignTableName(), $filter, [], true);
308
+		}
309
+	}
310
+
311
+	/**
312
+	 * Returns the name of the table this object comes from.
313
+	 *
314
+	 * @return string
315
+	 */
316
+	public function _getDbTableName()
317
+	{
318
+		return $this->dbTableName;
319
+	}
320
+
321
+	/**
322
+	 * Method used internally by TDBM. You should not use it directly.
323
+	 * This method returns the status of the TDBMObject.
324
+	 * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED.
325
+	 * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject.
326
+	 * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet.
327
+	 * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory.
328
+	 *
329
+	 * @return string
330
+	 */
331
+	public function _getStatus()
332
+	{
333
+		return $this->status;
334
+	}
335
+
336
+	/**
337
+	 * Override the native php clone function for TDBMObjects.
338
+	 */
339
+	public function __clone()
340
+	{
341
+		// Let's load the row (before we lose the ID!)
342
+		$this->_dbLoadIfNotLoaded();
343
+
344
+		//Let's set the status to detached
345
+		$this->status = TDBMObjectStateEnum::STATE_DETACHED;
346
+
347
+		$this->primaryKeys = [];
348
+
349
+		//Now unset the PK from the row
350
+		if ($this->tdbmService) {
351
+			$pk_array = $this->tdbmService->getPrimaryKeyColumns($this->dbTableName);
352
+			foreach ($pk_array as $pk) {
353
+				$this->dbRow[$pk] = null;
354
+			}
355
+		}
356
+	}
357
+
358
+	/**
359
+	 * Returns raw database row.
360
+	 *
361
+	 * @return array
362
+	 */
363
+	public function _getDbRow()
364
+	{
365
+		// Let's merge $dbRow and $references
366
+		$dbRow = $this->dbRow;
367
+
368
+		foreach ($this->references as $foreignKeyName => $reference) {
369
+			// Let's match the name of the columns to the primary key values
370
+			$fk = $this->tdbmService->_getForeignKeyByName($this->dbTableName, $foreignKeyName);
371
+			$localColumns = $fk->getLocalColumns();
372
+
373
+			if ($reference !== null) {
374
+				$refDbRows = $reference->_getDbRows();
375
+				$firstRefDbRow = reset($refDbRows);
376
+				$pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
377
+				for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
378
+					$dbRow[$localColumns[$i]] = $pkValues[$i];
379
+				}
380
+			} else {
381
+				for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
382
+					$dbRow[$localColumns[$i]] = null;
383
+				}
384
+			}
385
+		}
386
+
387
+		return $dbRow;
388
+	}
389
+
390
+	/**
391
+	 * Returns references array.
392
+	 *
393
+	 * @return AbstractTDBMObject[]
394
+	 */
395
+	public function _getReferences()
396
+	{
397
+		return $this->references;
398
+	}
399
+
400
+	/**
401
+	 * Returns the values of the primary key.
402
+	 * This is set when the object is in "loaded" state.
403
+	 *
404
+	 * @return array
405
+	 */
406
+	public function _getPrimaryKeys()
407
+	{
408
+		return $this->primaryKeys;
409
+	}
410
+
411
+	/**
412
+	 * Sets the values of the primary key.
413
+	 * This is set when the object is in "loaded" state.
414
+	 *
415
+	 * @param array $primaryKeys
416
+	 */
417
+	public function _setPrimaryKeys(array $primaryKeys)
418
+	{
419
+		$this->primaryKeys = $primaryKeys;
420
+		foreach ($this->primaryKeys as $column => $value) {
421
+			$this->dbRow[$column] = $value;
422
+		}
423
+	}
424
+
425
+	/**
426
+	 * Returns the TDBMObject this bean is associated to.
427
+	 *
428
+	 * @return AbstractTDBMObject
429
+	 */
430
+	public function getTDBMObject()
431
+	{
432
+		return $this->object;
433
+	}
434
+
435
+	/**
436
+	 * Sets the TDBMObject this bean is associated to.
437
+	 * Only used when cloning.
438
+	 *
439
+	 * @param AbstractTDBMObject $object
440
+	 */
441
+	public function setTDBMObject(AbstractTDBMObject $object)
442
+	{
443
+		$this->object = $object;
444
+	}
445 445
 }
Please login to merge, or discard this patch.
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -374,11 +374,11 @@
 block discarded – undo
374 374
                 $refDbRows = $reference->_getDbRows();
375 375
                 $firstRefDbRow = reset($refDbRows);
376 376
                 $pkValues = array_values($firstRefDbRow->_getPrimaryKeys());
377
-                for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
377
+                for ($i = 0, $count = count($localColumns); $i<$count; ++$i) {
378 378
                     $dbRow[$localColumns[$i]] = $pkValues[$i];
379 379
                 }
380 380
             } else {
381
-                for ($i = 0, $count = count($localColumns); $i < $count; ++$i) {
381
+                for ($i = 0, $count = count($localColumns); $i<$count; ++$i) {
382 382
                     $dbRow[$localColumns[$i]] = null;
383 383
                 }
384 384
             }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/TDBMService.php 1 patch
Indentation   +1329 added lines, -1329 removed lines patch added patch discarded remove patch
@@ -41,213 +41,213 @@  discard block
 block discarded – undo
41 41
  */
42 42
 class TDBMService
43 43
 {
44
-    const MODE_CURSOR = 1;
45
-    const MODE_ARRAY = 2;
46
-
47
-    /**
48
-     * The database connection.
49
-     *
50
-     * @var Connection
51
-     */
52
-    private $connection;
53
-
54
-    /**
55
-     * @var SchemaAnalyzer
56
-     */
57
-    private $schemaAnalyzer;
58
-
59
-    /**
60
-     * @var MagicQuery
61
-     */
62
-    private $magicQuery;
63
-
64
-    /**
65
-     * @var TDBMSchemaAnalyzer
66
-     */
67
-    private $tdbmSchemaAnalyzer;
68
-
69
-    /**
70
-     * @var string
71
-     */
72
-    private $cachePrefix;
73
-
74
-    /**
75
-     * Cache of table of primary keys.
76
-     * Primary keys are stored by tables, as an array of column.
77
-     * For instance $primary_key['my_table'][0] will return the first column of the primary key of table 'my_table'.
78
-     *
79
-     * @var string[]
80
-     */
81
-    private $primaryKeysColumns;
82
-
83
-    /**
84
-     * Service storing objects in memory.
85
-     * Access is done by table name and then by primary key.
86
-     * If the primary key is split on several columns, access is done by an array of columns, serialized.
87
-     *
88
-     * @var StandardObjectStorage|WeakrefObjectStorage
89
-     */
90
-    private $objectStorage;
91
-
92
-    /**
93
-     * The fetch mode of the result sets returned by `getObjects`.
94
-     * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY or TDBMObjectArray::MODE_COMPATIBLE_ARRAY.
95
-     *
96
-     * In 'MODE_ARRAY' mode (default), the result is an array. Use this mode by default (unless the list returned is very big).
97
-     * In 'MODE_CURSOR' mode, the result is a Generator which is an iterable collection that can be scanned only once (only one "foreach") on it,
98
-     * and it cannot be accessed via key. Use this mode for large datasets processed by batch.
99
-     * In 'MODE_COMPATIBLE_ARRAY' mode, the result is an old TDBMObjectArray (used up to TDBM 3.2).
100
-     * You can access the array by key, or using foreach, several times.
101
-     *
102
-     * @var int
103
-     */
104
-    private $mode = self::MODE_ARRAY;
105
-
106
-    /**
107
-     * Table of new objects not yet inserted in database or objects modified that must be saved.
108
-     *
109
-     * @var \SplObjectStorage of DbRow objects
110
-     */
111
-    private $toSaveObjects;
112
-
113
-    /**
114
-     * The content of the cache variable.
115
-     *
116
-     * @var array<string, mixed>
117
-     */
118
-    private $cache;
119
-
120
-    /**
121
-     * Map associating a table name to a fully qualified Bean class name.
122
-     *
123
-     * @var array
124
-     */
125
-    private $tableToBeanMap = [];
126
-
127
-    /**
128
-     * @var \ReflectionClass[]
129
-     */
130
-    private $reflectionClassCache = array();
131
-
132
-    /**
133
-     * @param Connection     $connection     The DBAL DB connection to use
134
-     * @param Cache|null     $cache          A cache service to be used
135
-     * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
136
-     *                                       Will be automatically created if not passed.
137
-     */
138
-    public function __construct(Connection $connection, Cache $cache = null, SchemaAnalyzer $schemaAnalyzer = null)
139
-    {
140
-        if (extension_loaded('weakref')) {
141
-            $this->objectStorage = new WeakrefObjectStorage();
142
-        } else {
143
-            $this->objectStorage = new StandardObjectStorage();
144
-        }
145
-        $this->connection = $connection;
146
-        if ($cache !== null) {
147
-            $this->cache = $cache;
148
-        } else {
149
-            $this->cache = new VoidCache();
150
-        }
151
-        if ($schemaAnalyzer) {
152
-            $this->schemaAnalyzer = $schemaAnalyzer;
153
-        } else {
154
-            $this->schemaAnalyzer = new SchemaAnalyzer($this->connection->getSchemaManager(), $this->cache, $this->getConnectionUniqueId());
155
-        }
156
-
157
-        $this->magicQuery = new MagicQuery($this->connection, $this->cache, $this->schemaAnalyzer);
158
-
159
-        $this->tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($connection, $this->cache, $this->schemaAnalyzer);
160
-        $this->cachePrefix = $this->tdbmSchemaAnalyzer->getCachePrefix();
161
-
162
-        $this->toSaveObjects = new \SplObjectStorage();
163
-    }
164
-
165
-    /**
166
-     * Returns the object used to connect to the database.
167
-     *
168
-     * @return Connection
169
-     */
170
-    public function getConnection()
171
-    {
172
-        return $this->connection;
173
-    }
174
-
175
-    /**
176
-     * Creates a unique cache key for the current connection.
177
-     *
178
-     * @return string
179
-     */
180
-    private function getConnectionUniqueId()
181
-    {
182
-        return hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
183
-    }
184
-
185
-    /**
186
-     * Sets the default fetch mode of the result sets returned by `findObjects`.
187
-     * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY.
188
-     *
189
-     * In 'MODE_ARRAY' mode (default), the result is a ResultIterator object that behaves like an array. Use this mode by default (unless the list returned is very big).
190
-     * In 'MODE_CURSOR' mode, the result is a ResultIterator object. If you scan it many times (by calling several time a foreach loop), the query will be run
191
-     * several times. In cursor mode, you cannot access the result set by key. Use this mode for large datasets processed by batch.
192
-     *
193
-     * @param int $mode
194
-     *
195
-     * @return $this
196
-     *
197
-     * @throws TDBMException
198
-     */
199
-    public function setFetchMode($mode)
200
-    {
201
-        if ($mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
202
-            throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
203
-        }
204
-        $this->mode = $mode;
205
-
206
-        return $this;
207
-    }
208
-
209
-    /**
210
-     * Returns a TDBMObject associated from table "$table_name".
211
-     * If the $filters parameter is an int/string, the object returned will be the object whose primary key = $filters.
212
-     * $filters can also be a set of TDBM_Filters (see the findObjects method for more details).
213
-     *
214
-     * For instance, if there is a table 'users', with a primary key on column 'user_id' and a column 'user_name', then
215
-     * 			$user = $tdbmService->getObject('users',1);
216
-     * 			echo $user->name;
217
-     * will return the name of the user whose user_id is one.
218
-     *
219
-     * If a table has a primary key over several columns, you should pass to $id an array containing the the value of the various columns.
220
-     * For instance:
221
-     * 			$group = $tdbmService->getObject('groups',array(1,2));
222
-     *
223
-     * Note that TDBMObject performs caching for you. If you get twice the same object, the reference of the object you will get
224
-     * will be the same.
225
-     *
226
-     * For instance:
227
-     * 			$user1 = $tdbmService->getObject('users',1);
228
-     * 			$user2 = $tdbmService->getObject('users',1);
229
-     * 			$user1->name = 'John Doe';
230
-     * 			echo $user2->name;
231
-     * will return 'John Doe'.
232
-     *
233
-     * You can use filters instead of passing the primary key. For instance:
234
-     * 			$user = $tdbmService->getObject('users',new EqualFilter('users', 'login', 'jdoe'));
235
-     * This will return the user whose login is 'jdoe'.
236
-     * Please note that if 2 users have the jdoe login in database, the method will throw a TDBM_DuplicateRowException.
237
-     *
238
-     * Also, you can specify the return class for the object (provided the return class extends TDBMObject).
239
-     * For instance:
240
-     *  	$user = $tdbmService->getObject('users',1,'User');
241
-     * will return an object from the "User" class. The "User" class must extend the "TDBMObject" class.
242
-     * Please be sure not to override any method or any property unless you perfectly know what you are doing!
243
-     *
244
-     * @param string $table_name   The name of the table we retrieve an object from.
245
-     * @param mixed  $filters      If the filter is a string/integer, it will be considered as the id of the object (the value of the primary key). Otherwise, it can be a filter bag (see the filterbag parameter of the findObjects method for more details about filter bags)
246
-     * @param string $className    Optional: The name of the class to instanciate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
247
-     * @param bool   $lazy_loading If set to true, and if the primary key is passed in parameter of getObject, the object will not be queried in database. It will be queried when you first try to access a column. If at that time the object cannot be found in database, an exception will be thrown.
248
-     *
249
-     * @return TDBMObject
250
-     */
44
+	const MODE_CURSOR = 1;
45
+	const MODE_ARRAY = 2;
46
+
47
+	/**
48
+	 * The database connection.
49
+	 *
50
+	 * @var Connection
51
+	 */
52
+	private $connection;
53
+
54
+	/**
55
+	 * @var SchemaAnalyzer
56
+	 */
57
+	private $schemaAnalyzer;
58
+
59
+	/**
60
+	 * @var MagicQuery
61
+	 */
62
+	private $magicQuery;
63
+
64
+	/**
65
+	 * @var TDBMSchemaAnalyzer
66
+	 */
67
+	private $tdbmSchemaAnalyzer;
68
+
69
+	/**
70
+	 * @var string
71
+	 */
72
+	private $cachePrefix;
73
+
74
+	/**
75
+	 * Cache of table of primary keys.
76
+	 * Primary keys are stored by tables, as an array of column.
77
+	 * For instance $primary_key['my_table'][0] will return the first column of the primary key of table 'my_table'.
78
+	 *
79
+	 * @var string[]
80
+	 */
81
+	private $primaryKeysColumns;
82
+
83
+	/**
84
+	 * Service storing objects in memory.
85
+	 * Access is done by table name and then by primary key.
86
+	 * If the primary key is split on several columns, access is done by an array of columns, serialized.
87
+	 *
88
+	 * @var StandardObjectStorage|WeakrefObjectStorage
89
+	 */
90
+	private $objectStorage;
91
+
92
+	/**
93
+	 * The fetch mode of the result sets returned by `getObjects`.
94
+	 * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY or TDBMObjectArray::MODE_COMPATIBLE_ARRAY.
95
+	 *
96
+	 * In 'MODE_ARRAY' mode (default), the result is an array. Use this mode by default (unless the list returned is very big).
97
+	 * In 'MODE_CURSOR' mode, the result is a Generator which is an iterable collection that can be scanned only once (only one "foreach") on it,
98
+	 * and it cannot be accessed via key. Use this mode for large datasets processed by batch.
99
+	 * In 'MODE_COMPATIBLE_ARRAY' mode, the result is an old TDBMObjectArray (used up to TDBM 3.2).
100
+	 * You can access the array by key, or using foreach, several times.
101
+	 *
102
+	 * @var int
103
+	 */
104
+	private $mode = self::MODE_ARRAY;
105
+
106
+	/**
107
+	 * Table of new objects not yet inserted in database or objects modified that must be saved.
108
+	 *
109
+	 * @var \SplObjectStorage of DbRow objects
110
+	 */
111
+	private $toSaveObjects;
112
+
113
+	/**
114
+	 * The content of the cache variable.
115
+	 *
116
+	 * @var array<string, mixed>
117
+	 */
118
+	private $cache;
119
+
120
+	/**
121
+	 * Map associating a table name to a fully qualified Bean class name.
122
+	 *
123
+	 * @var array
124
+	 */
125
+	private $tableToBeanMap = [];
126
+
127
+	/**
128
+	 * @var \ReflectionClass[]
129
+	 */
130
+	private $reflectionClassCache = array();
131
+
132
+	/**
133
+	 * @param Connection     $connection     The DBAL DB connection to use
134
+	 * @param Cache|null     $cache          A cache service to be used
135
+	 * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
136
+	 *                                       Will be automatically created if not passed.
137
+	 */
138
+	public function __construct(Connection $connection, Cache $cache = null, SchemaAnalyzer $schemaAnalyzer = null)
139
+	{
140
+		if (extension_loaded('weakref')) {
141
+			$this->objectStorage = new WeakrefObjectStorage();
142
+		} else {
143
+			$this->objectStorage = new StandardObjectStorage();
144
+		}
145
+		$this->connection = $connection;
146
+		if ($cache !== null) {
147
+			$this->cache = $cache;
148
+		} else {
149
+			$this->cache = new VoidCache();
150
+		}
151
+		if ($schemaAnalyzer) {
152
+			$this->schemaAnalyzer = $schemaAnalyzer;
153
+		} else {
154
+			$this->schemaAnalyzer = new SchemaAnalyzer($this->connection->getSchemaManager(), $this->cache, $this->getConnectionUniqueId());
155
+		}
156
+
157
+		$this->magicQuery = new MagicQuery($this->connection, $this->cache, $this->schemaAnalyzer);
158
+
159
+		$this->tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($connection, $this->cache, $this->schemaAnalyzer);
160
+		$this->cachePrefix = $this->tdbmSchemaAnalyzer->getCachePrefix();
161
+
162
+		$this->toSaveObjects = new \SplObjectStorage();
163
+	}
164
+
165
+	/**
166
+	 * Returns the object used to connect to the database.
167
+	 *
168
+	 * @return Connection
169
+	 */
170
+	public function getConnection()
171
+	{
172
+		return $this->connection;
173
+	}
174
+
175
+	/**
176
+	 * Creates a unique cache key for the current connection.
177
+	 *
178
+	 * @return string
179
+	 */
180
+	private function getConnectionUniqueId()
181
+	{
182
+		return hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
183
+	}
184
+
185
+	/**
186
+	 * Sets the default fetch mode of the result sets returned by `findObjects`.
187
+	 * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY.
188
+	 *
189
+	 * In 'MODE_ARRAY' mode (default), the result is a ResultIterator object that behaves like an array. Use this mode by default (unless the list returned is very big).
190
+	 * In 'MODE_CURSOR' mode, the result is a ResultIterator object. If you scan it many times (by calling several time a foreach loop), the query will be run
191
+	 * several times. In cursor mode, you cannot access the result set by key. Use this mode for large datasets processed by batch.
192
+	 *
193
+	 * @param int $mode
194
+	 *
195
+	 * @return $this
196
+	 *
197
+	 * @throws TDBMException
198
+	 */
199
+	public function setFetchMode($mode)
200
+	{
201
+		if ($mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
202
+			throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
203
+		}
204
+		$this->mode = $mode;
205
+
206
+		return $this;
207
+	}
208
+
209
+	/**
210
+	 * Returns a TDBMObject associated from table "$table_name".
211
+	 * If the $filters parameter is an int/string, the object returned will be the object whose primary key = $filters.
212
+	 * $filters can also be a set of TDBM_Filters (see the findObjects method for more details).
213
+	 *
214
+	 * For instance, if there is a table 'users', with a primary key on column 'user_id' and a column 'user_name', then
215
+	 * 			$user = $tdbmService->getObject('users',1);
216
+	 * 			echo $user->name;
217
+	 * will return the name of the user whose user_id is one.
218
+	 *
219
+	 * If a table has a primary key over several columns, you should pass to $id an array containing the the value of the various columns.
220
+	 * For instance:
221
+	 * 			$group = $tdbmService->getObject('groups',array(1,2));
222
+	 *
223
+	 * Note that TDBMObject performs caching for you. If you get twice the same object, the reference of the object you will get
224
+	 * will be the same.
225
+	 *
226
+	 * For instance:
227
+	 * 			$user1 = $tdbmService->getObject('users',1);
228
+	 * 			$user2 = $tdbmService->getObject('users',1);
229
+	 * 			$user1->name = 'John Doe';
230
+	 * 			echo $user2->name;
231
+	 * will return 'John Doe'.
232
+	 *
233
+	 * You can use filters instead of passing the primary key. For instance:
234
+	 * 			$user = $tdbmService->getObject('users',new EqualFilter('users', 'login', 'jdoe'));
235
+	 * This will return the user whose login is 'jdoe'.
236
+	 * Please note that if 2 users have the jdoe login in database, the method will throw a TDBM_DuplicateRowException.
237
+	 *
238
+	 * Also, you can specify the return class for the object (provided the return class extends TDBMObject).
239
+	 * For instance:
240
+	 *  	$user = $tdbmService->getObject('users',1,'User');
241
+	 * will return an object from the "User" class. The "User" class must extend the "TDBMObject" class.
242
+	 * Please be sure not to override any method or any property unless you perfectly know what you are doing!
243
+	 *
244
+	 * @param string $table_name   The name of the table we retrieve an object from.
245
+	 * @param mixed  $filters      If the filter is a string/integer, it will be considered as the id of the object (the value of the primary key). Otherwise, it can be a filter bag (see the filterbag parameter of the findObjects method for more details about filter bags)
246
+	 * @param string $className    Optional: The name of the class to instanciate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
247
+	 * @param bool   $lazy_loading If set to true, and if the primary key is passed in parameter of getObject, the object will not be queried in database. It will be queried when you first try to access a column. If at that time the object cannot be found in database, an exception will be thrown.
248
+	 *
249
+	 * @return TDBMObject
250
+	 */
251 251
 /*	public function getObject($table_name, $filters, $className = null, $lazy_loading = false) {
252 252
 
253 253
         if (is_array($filters) || $filters instanceof FilterInterface) {
@@ -333,199 +333,199 @@  discard block
 block discarded – undo
333 333
         return $obj;
334 334
     }*/
335 335
 
336
-    /**
337
-     * Removes the given object from database.
338
-     * This cannot be called on an object that is not attached to this TDBMService
339
-     * (will throw a TDBMInvalidOperationException).
340
-     *
341
-     * @param AbstractTDBMObject $object the object to delete.
342
-     *
343
-     * @throws TDBMException
344
-     * @throws TDBMInvalidOperationException
345
-     */
346
-    public function delete(AbstractTDBMObject $object)
347
-    {
348
-        switch ($object->_getStatus()) {
349
-            case TDBMObjectStateEnum::STATE_DELETED:
350
-                // Nothing to do, object already deleted.
351
-                return;
352
-            case TDBMObjectStateEnum::STATE_DETACHED:
353
-                throw new TDBMInvalidOperationException('Cannot delete a detached object');
354
-            case TDBMObjectStateEnum::STATE_NEW:
355
-                $this->deleteManyToManyRelationships($object);
356
-                foreach ($object->_getDbRows() as $dbRow) {
357
-                    $this->removeFromToSaveObjectList($dbRow);
358
-                }
359
-                break;
360
-            case TDBMObjectStateEnum::STATE_DIRTY:
361
-                foreach ($object->_getDbRows() as $dbRow) {
362
-                    $this->removeFromToSaveObjectList($dbRow);
363
-                }
364
-                // And continue deleting...
365
-            case TDBMObjectStateEnum::STATE_NOT_LOADED:
366
-            case TDBMObjectStateEnum::STATE_LOADED:
367
-                $this->deleteManyToManyRelationships($object);
368
-                // Let's delete db rows, in reverse order.
369
-                foreach (array_reverse($object->_getDbRows()) as $dbRow) {
370
-                    $tableName = $dbRow->_getDbTableName();
371
-                    $primaryKeys = $dbRow->_getPrimaryKeys();
372
-                    $this->connection->delete($tableName, $primaryKeys);
373
-                    $this->objectStorage->remove($dbRow->_getDbTableName(), $this->getObjectHash($primaryKeys));
374
-                }
375
-                break;
376
-            // @codeCoverageIgnoreStart
377
-            default:
378
-                throw new TDBMInvalidOperationException('Unexpected status for bean');
379
-            // @codeCoverageIgnoreEnd
380
-        }
381
-
382
-        $object->_setStatus(TDBMObjectStateEnum::STATE_DELETED);
383
-    }
384
-
385
-    /**
386
-     * Removes all many to many relationships for this object.
387
-     *
388
-     * @param AbstractTDBMObject $object
389
-     */
390
-    private function deleteManyToManyRelationships(AbstractTDBMObject $object)
391
-    {
392
-        foreach ($object->_getDbRows() as $tableName => $dbRow) {
393
-            $pivotTables = $this->tdbmSchemaAnalyzer->getPivotTableLinkedToTable($tableName);
394
-            foreach ($pivotTables as $pivotTable) {
395
-                $remoteBeans = $object->_getRelationships($pivotTable);
396
-                foreach ($remoteBeans as $remoteBean) {
397
-                    $object->_removeRelationship($pivotTable, $remoteBean);
398
-                }
399
-            }
400
-        }
401
-        $this->persistManyToManyRelationships($object);
402
-    }
403
-
404
-    /**
405
-     * This function removes the given object from the database. It will also remove all objects relied to the one given
406
-     * by parameter before all.
407
-     *
408
-     * Notice: if the object has a multiple primary key, the function will not work.
409
-     *
410
-     * @param AbstractTDBMObject $objToDelete
411
-     */
412
-    public function deleteCascade(AbstractTDBMObject $objToDelete)
413
-    {
414
-        $this->deleteAllConstraintWithThisObject($objToDelete);
415
-        $this->delete($objToDelete);
416
-    }
417
-
418
-    /**
419
-     * This function is used only in TDBMService (private function)
420
-     * It will call deleteCascade function foreach object relied with a foreign key to the object given by parameter.
421
-     *
422
-     * @param AbstractTDBMObject $obj
423
-     */
424
-    private function deleteAllConstraintWithThisObject(AbstractTDBMObject $obj)
425
-    {
426
-        $dbRows = $obj->_getDbRows();
427
-        foreach ($dbRows as $dbRow) {
428
-            $tableName = $dbRow->_getDbTableName();
429
-            $pks = array_values($dbRow->_getPrimaryKeys());
430
-            if (!empty($pks)) {
431
-                $incomingFks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($tableName);
432
-
433
-                foreach ($incomingFks as $incomingFk) {
434
-                    $filter = array_combine($incomingFk->getLocalColumns(), $pks);
435
-
436
-                    $results = $this->findObjects($incomingFk->getLocalTableName(), $filter);
437
-
438
-                    foreach ($results as $bean) {
439
-                        $this->deleteCascade($bean);
440
-                    }
441
-                }
442
-            }
443
-        }
444
-    }
445
-
446
-    /**
447
-     * This function performs a save() of all the objects that have been modified.
448
-     */
449
-    public function completeSave()
450
-    {
451
-        foreach ($this->toSaveObjects as $dbRow) {
452
-            $this->save($dbRow->getTDBMObject());
453
-        }
454
-    }
455
-
456
-    /**
457
-     * Takes in input a filter_bag (which can be about anything from a string to an array of TDBMObjects... see above from documentation),
458
-     * and gives back a proper Filter object.
459
-     *
460
-     * @param mixed $filter_bag
461
-     * @param int   $counter
462
-     *
463
-     * @return array First item: filter string, second item: parameters.
464
-     *
465
-     * @throws TDBMException
466
-     */
467
-    public function buildFilterFromFilterBag($filter_bag, $counter = 1)
468
-    {
469
-        if ($filter_bag === null) {
470
-            return ['', []];
471
-        } elseif (is_string($filter_bag)) {
472
-            return [$filter_bag, []];
473
-        } elseif (is_array($filter_bag)) {
474
-            $sqlParts = [];
475
-            $parameters = [];
476
-            foreach ($filter_bag as $column => $value) {
477
-                if (is_int($column)) {
478
-                    list($subSqlPart, $subParameters) = $this->buildFilterFromFilterBag($value, $counter);
479
-                    $sqlParts[] = $subSqlPart;
480
-                    $parameters += $subParameters;
481
-                } else {
482
-                    $paramName = 'tdbmparam'.$counter;
483
-                    if (is_array($value)) {
484
-                        $sqlParts[] = $this->connection->quoteIdentifier($column).' IN :'.$paramName;
485
-                    } else {
486
-                        $sqlParts[] = $this->connection->quoteIdentifier($column).' = :'.$paramName;
487
-                    }
488
-                    $parameters[$paramName] = $value;
489
-                    ++$counter;
490
-                }
491
-            }
492
-
493
-            return [implode(' AND ', $sqlParts), $parameters];
494
-        } elseif ($filter_bag instanceof AbstractTDBMObject) {
495
-            $sqlParts = [];
496
-            $parameters = [];
497
-            $dbRows = $filter_bag->_getDbRows();
498
-            $dbRow = reset($dbRows);
499
-            $primaryKeys = $dbRow->_getPrimaryKeys();
500
-
501
-            foreach ($primaryKeys as $column => $value) {
502
-                $paramName = 'tdbmparam'.$counter;
503
-                $sqlParts[] = $this->connection->quoteIdentifier($dbRow->_getDbTableName()).'.'.$this->connection->quoteIdentifier($column).' = :'.$paramName;
504
-                $parameters[$paramName] = $value;
505
-                ++$counter;
506
-            }
507
-
508
-            return [implode(' AND ', $sqlParts), $parameters];
509
-        } elseif ($filter_bag instanceof \Iterator) {
510
-            return $this->buildFilterFromFilterBag(iterator_to_array($filter_bag), $counter);
511
-        } else {
512
-            throw new TDBMException('Error in filter. An object has been passed that is neither a SQL string, nor an array, nor a bean, nor null.');
513
-        }
514
-    }
515
-
516
-    /**
517
-     * @param string $table
518
-     *
519
-     * @return string[]
520
-     */
521
-    public function getPrimaryKeyColumns($table)
522
-    {
523
-        if (!isset($this->primaryKeysColumns[$table])) {
524
-            $this->primaryKeysColumns[$table] = $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getPrimaryKeyColumns();
525
-
526
-            // TODO TDBM4: See if we need to improve error reporting if table name does not exist.
527
-
528
-            /*$arr = array();
336
+	/**
337
+	 * Removes the given object from database.
338
+	 * This cannot be called on an object that is not attached to this TDBMService
339
+	 * (will throw a TDBMInvalidOperationException).
340
+	 *
341
+	 * @param AbstractTDBMObject $object the object to delete.
342
+	 *
343
+	 * @throws TDBMException
344
+	 * @throws TDBMInvalidOperationException
345
+	 */
346
+	public function delete(AbstractTDBMObject $object)
347
+	{
348
+		switch ($object->_getStatus()) {
349
+			case TDBMObjectStateEnum::STATE_DELETED:
350
+				// Nothing to do, object already deleted.
351
+				return;
352
+			case TDBMObjectStateEnum::STATE_DETACHED:
353
+				throw new TDBMInvalidOperationException('Cannot delete a detached object');
354
+			case TDBMObjectStateEnum::STATE_NEW:
355
+				$this->deleteManyToManyRelationships($object);
356
+				foreach ($object->_getDbRows() as $dbRow) {
357
+					$this->removeFromToSaveObjectList($dbRow);
358
+				}
359
+				break;
360
+			case TDBMObjectStateEnum::STATE_DIRTY:
361
+				foreach ($object->_getDbRows() as $dbRow) {
362
+					$this->removeFromToSaveObjectList($dbRow);
363
+				}
364
+				// And continue deleting...
365
+			case TDBMObjectStateEnum::STATE_NOT_LOADED:
366
+			case TDBMObjectStateEnum::STATE_LOADED:
367
+				$this->deleteManyToManyRelationships($object);
368
+				// Let's delete db rows, in reverse order.
369
+				foreach (array_reverse($object->_getDbRows()) as $dbRow) {
370
+					$tableName = $dbRow->_getDbTableName();
371
+					$primaryKeys = $dbRow->_getPrimaryKeys();
372
+					$this->connection->delete($tableName, $primaryKeys);
373
+					$this->objectStorage->remove($dbRow->_getDbTableName(), $this->getObjectHash($primaryKeys));
374
+				}
375
+				break;
376
+			// @codeCoverageIgnoreStart
377
+			default:
378
+				throw new TDBMInvalidOperationException('Unexpected status for bean');
379
+			// @codeCoverageIgnoreEnd
380
+		}
381
+
382
+		$object->_setStatus(TDBMObjectStateEnum::STATE_DELETED);
383
+	}
384
+
385
+	/**
386
+	 * Removes all many to many relationships for this object.
387
+	 *
388
+	 * @param AbstractTDBMObject $object
389
+	 */
390
+	private function deleteManyToManyRelationships(AbstractTDBMObject $object)
391
+	{
392
+		foreach ($object->_getDbRows() as $tableName => $dbRow) {
393
+			$pivotTables = $this->tdbmSchemaAnalyzer->getPivotTableLinkedToTable($tableName);
394
+			foreach ($pivotTables as $pivotTable) {
395
+				$remoteBeans = $object->_getRelationships($pivotTable);
396
+				foreach ($remoteBeans as $remoteBean) {
397
+					$object->_removeRelationship($pivotTable, $remoteBean);
398
+				}
399
+			}
400
+		}
401
+		$this->persistManyToManyRelationships($object);
402
+	}
403
+
404
+	/**
405
+	 * This function removes the given object from the database. It will also remove all objects relied to the one given
406
+	 * by parameter before all.
407
+	 *
408
+	 * Notice: if the object has a multiple primary key, the function will not work.
409
+	 *
410
+	 * @param AbstractTDBMObject $objToDelete
411
+	 */
412
+	public function deleteCascade(AbstractTDBMObject $objToDelete)
413
+	{
414
+		$this->deleteAllConstraintWithThisObject($objToDelete);
415
+		$this->delete($objToDelete);
416
+	}
417
+
418
+	/**
419
+	 * This function is used only in TDBMService (private function)
420
+	 * It will call deleteCascade function foreach object relied with a foreign key to the object given by parameter.
421
+	 *
422
+	 * @param AbstractTDBMObject $obj
423
+	 */
424
+	private function deleteAllConstraintWithThisObject(AbstractTDBMObject $obj)
425
+	{
426
+		$dbRows = $obj->_getDbRows();
427
+		foreach ($dbRows as $dbRow) {
428
+			$tableName = $dbRow->_getDbTableName();
429
+			$pks = array_values($dbRow->_getPrimaryKeys());
430
+			if (!empty($pks)) {
431
+				$incomingFks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($tableName);
432
+
433
+				foreach ($incomingFks as $incomingFk) {
434
+					$filter = array_combine($incomingFk->getLocalColumns(), $pks);
435
+
436
+					$results = $this->findObjects($incomingFk->getLocalTableName(), $filter);
437
+
438
+					foreach ($results as $bean) {
439
+						$this->deleteCascade($bean);
440
+					}
441
+				}
442
+			}
443
+		}
444
+	}
445
+
446
+	/**
447
+	 * This function performs a save() of all the objects that have been modified.
448
+	 */
449
+	public function completeSave()
450
+	{
451
+		foreach ($this->toSaveObjects as $dbRow) {
452
+			$this->save($dbRow->getTDBMObject());
453
+		}
454
+	}
455
+
456
+	/**
457
+	 * Takes in input a filter_bag (which can be about anything from a string to an array of TDBMObjects... see above from documentation),
458
+	 * and gives back a proper Filter object.
459
+	 *
460
+	 * @param mixed $filter_bag
461
+	 * @param int   $counter
462
+	 *
463
+	 * @return array First item: filter string, second item: parameters.
464
+	 *
465
+	 * @throws TDBMException
466
+	 */
467
+	public function buildFilterFromFilterBag($filter_bag, $counter = 1)
468
+	{
469
+		if ($filter_bag === null) {
470
+			return ['', []];
471
+		} elseif (is_string($filter_bag)) {
472
+			return [$filter_bag, []];
473
+		} elseif (is_array($filter_bag)) {
474
+			$sqlParts = [];
475
+			$parameters = [];
476
+			foreach ($filter_bag as $column => $value) {
477
+				if (is_int($column)) {
478
+					list($subSqlPart, $subParameters) = $this->buildFilterFromFilterBag($value, $counter);
479
+					$sqlParts[] = $subSqlPart;
480
+					$parameters += $subParameters;
481
+				} else {
482
+					$paramName = 'tdbmparam'.$counter;
483
+					if (is_array($value)) {
484
+						$sqlParts[] = $this->connection->quoteIdentifier($column).' IN :'.$paramName;
485
+					} else {
486
+						$sqlParts[] = $this->connection->quoteIdentifier($column).' = :'.$paramName;
487
+					}
488
+					$parameters[$paramName] = $value;
489
+					++$counter;
490
+				}
491
+			}
492
+
493
+			return [implode(' AND ', $sqlParts), $parameters];
494
+		} elseif ($filter_bag instanceof AbstractTDBMObject) {
495
+			$sqlParts = [];
496
+			$parameters = [];
497
+			$dbRows = $filter_bag->_getDbRows();
498
+			$dbRow = reset($dbRows);
499
+			$primaryKeys = $dbRow->_getPrimaryKeys();
500
+
501
+			foreach ($primaryKeys as $column => $value) {
502
+				$paramName = 'tdbmparam'.$counter;
503
+				$sqlParts[] = $this->connection->quoteIdentifier($dbRow->_getDbTableName()).'.'.$this->connection->quoteIdentifier($column).' = :'.$paramName;
504
+				$parameters[$paramName] = $value;
505
+				++$counter;
506
+			}
507
+
508
+			return [implode(' AND ', $sqlParts), $parameters];
509
+		} elseif ($filter_bag instanceof \Iterator) {
510
+			return $this->buildFilterFromFilterBag(iterator_to_array($filter_bag), $counter);
511
+		} else {
512
+			throw new TDBMException('Error in filter. An object has been passed that is neither a SQL string, nor an array, nor a bean, nor null.');
513
+		}
514
+	}
515
+
516
+	/**
517
+	 * @param string $table
518
+	 *
519
+	 * @return string[]
520
+	 */
521
+	public function getPrimaryKeyColumns($table)
522
+	{
523
+		if (!isset($this->primaryKeysColumns[$table])) {
524
+			$this->primaryKeysColumns[$table] = $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getPrimaryKeyColumns();
525
+
526
+			// TODO TDBM4: See if we need to improve error reporting if table name does not exist.
527
+
528
+			/*$arr = array();
529 529
             foreach ($this->connection->getPrimaryKey($table) as $col) {
530 530
                 $arr[] = $col->name;
531 531
             }
@@ -546,141 +546,141 @@  discard block
 block discarded – undo
546 546
                     throw new TDBMException($str);
547 547
                 }
548 548
             }*/
549
-        }
550
-
551
-        return $this->primaryKeysColumns[$table];
552
-    }
553
-
554
-    /**
555
-     * This is an internal function, you should not use it in your application.
556
-     * This is used internally by TDBM to add an object to the object cache.
557
-     *
558
-     * @param DbRow $dbRow
559
-     */
560
-    public function _addToCache(DbRow $dbRow)
561
-    {
562
-        $primaryKey = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
563
-        $hash = $this->getObjectHash($primaryKey);
564
-        $this->objectStorage->set($dbRow->_getDbTableName(), $hash, $dbRow);
565
-    }
566
-
567
-    /**
568
-     * This is an internal function, you should not use it in your application.
569
-     * This is used internally by TDBM to remove the object from the list of objects that have been
570
-     * created/updated but not saved yet.
571
-     *
572
-     * @param DbRow $myObject
573
-     */
574
-    private function removeFromToSaveObjectList(DbRow $myObject)
575
-    {
576
-        unset($this->toSaveObjects[$myObject]);
577
-    }
578
-
579
-    /**
580
-     * This is an internal function, you should not use it in your application.
581
-     * This is used internally by TDBM to add an object to the list of objects that have been
582
-     * created/updated but not saved yet.
583
-     *
584
-     * @param AbstractTDBMObject $myObject
585
-     */
586
-    public function _addToToSaveObjectList(DbRow $myObject)
587
-    {
588
-        $this->toSaveObjects[$myObject] = true;
589
-    }
590
-
591
-    /**
592
-     * Generates all the daos and beans.
593
-     *
594
-     * @param string $daoFactoryClassName The classe name of the DAO factory
595
-     * @param string $daonamespace        The namespace for the DAOs, without trailing \
596
-     * @param string $beannamespace       The Namespace for the beans, without trailing \
597
-     * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone.
598
-     * @param string $composerFile        If it's set, location of custom Composer file. Relative to project root.
599
-     *
600
-     * @return \string[] the list of tables
601
-     */
602
-    public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc, $composerFile = null)
603
-    {
604
-        // Purge cache before generating anything.
605
-        $this->cache->deleteAll();
606
-
607
-        $tdbmDaoGenerator = new TDBMDaoGenerator($this->schemaAnalyzer, $this->tdbmSchemaAnalyzer->getSchema(), $this->tdbmSchemaAnalyzer);
608
-        if (null !== $composerFile) {
609
-            $tdbmDaoGenerator->setComposerFile(__DIR__.'/../../../../../../../'.$composerFile);
610
-        }
611
-
612
-        return $tdbmDaoGenerator->generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc);
613
-    }
614
-
615
-    /**
616
-     * @param array<string, string> $tableToBeanMap
617
-     */
618
-    public function setTableToBeanMap(array $tableToBeanMap)
619
-    {
620
-        $this->tableToBeanMap = $tableToBeanMap;
621
-    }
622
-
623
-    /**
624
-     * Saves $object by INSERTing or UPDAT(E)ing it in the database.
625
-     *
626
-     * @param AbstractTDBMObject $object
627
-     *
628
-     * @throws TDBMException
629
-     */
630
-    public function save(AbstractTDBMObject $object)
631
-    {
632
-        $status = $object->_getStatus();
633
-
634
-        if ($status === null) {
635
-            throw new TDBMException(sprintf('Your bean for class %s has no status. It is likely that you overloaded the __construct method and forgot to call parent::__construct.', get_class($object)));
636
-        }
637
-
638
-        // Let's attach this object if it is in detached state.
639
-        if ($status === TDBMObjectStateEnum::STATE_DETACHED) {
640
-            $object->_attach($this);
641
-            $status = $object->_getStatus();
642
-        }
643
-
644
-        if ($status === TDBMObjectStateEnum::STATE_NEW) {
645
-            $dbRows = $object->_getDbRows();
646
-
647
-            $unindexedPrimaryKeys = array();
648
-
649
-            foreach ($dbRows as $dbRow) {
650
-                $tableName = $dbRow->_getDbTableName();
651
-
652
-                $schema = $this->tdbmSchemaAnalyzer->getSchema();
653
-                $tableDescriptor = $schema->getTable($tableName);
654
-
655
-                $primaryKeyColumns = $this->getPrimaryKeyColumns($tableName);
656
-
657
-                if (empty($unindexedPrimaryKeys)) {
658
-                    $primaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
659
-                } else {
660
-                    // First insert, the children must have the same primary key as the parent.
661
-                    $primaryKeys = $this->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $unindexedPrimaryKeys);
662
-                    $dbRow->_setPrimaryKeys($primaryKeys);
663
-                }
664
-
665
-                $references = $dbRow->_getReferences();
666
-
667
-                // Let's save all references in NEW or DETACHED state (we need their primary key)
668
-                foreach ($references as $fkName => $reference) {
669
-                    if ($reference !== null) {
670
-                        $refStatus = $reference->_getStatus();
671
-                        if ($refStatus === TDBMObjectStateEnum::STATE_NEW || $refStatus === TDBMObjectStateEnum::STATE_DETACHED) {
672
-                            $this->save($reference);
673
-                        }
674
-                    }
675
-                }
676
-
677
-                $dbRowData = $dbRow->_getDbRow();
678
-
679
-                // Let's see if the columns for primary key have been set before inserting.
680
-                // We assume that if one of the value of the PK has been set, the PK is set.
681
-                $isPkSet = !empty($primaryKeys);
682
-
683
-                /*if (!$isPkSet) {
549
+		}
550
+
551
+		return $this->primaryKeysColumns[$table];
552
+	}
553
+
554
+	/**
555
+	 * This is an internal function, you should not use it in your application.
556
+	 * This is used internally by TDBM to add an object to the object cache.
557
+	 *
558
+	 * @param DbRow $dbRow
559
+	 */
560
+	public function _addToCache(DbRow $dbRow)
561
+	{
562
+		$primaryKey = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
563
+		$hash = $this->getObjectHash($primaryKey);
564
+		$this->objectStorage->set($dbRow->_getDbTableName(), $hash, $dbRow);
565
+	}
566
+
567
+	/**
568
+	 * This is an internal function, you should not use it in your application.
569
+	 * This is used internally by TDBM to remove the object from the list of objects that have been
570
+	 * created/updated but not saved yet.
571
+	 *
572
+	 * @param DbRow $myObject
573
+	 */
574
+	private function removeFromToSaveObjectList(DbRow $myObject)
575
+	{
576
+		unset($this->toSaveObjects[$myObject]);
577
+	}
578
+
579
+	/**
580
+	 * This is an internal function, you should not use it in your application.
581
+	 * This is used internally by TDBM to add an object to the list of objects that have been
582
+	 * created/updated but not saved yet.
583
+	 *
584
+	 * @param AbstractTDBMObject $myObject
585
+	 */
586
+	public function _addToToSaveObjectList(DbRow $myObject)
587
+	{
588
+		$this->toSaveObjects[$myObject] = true;
589
+	}
590
+
591
+	/**
592
+	 * Generates all the daos and beans.
593
+	 *
594
+	 * @param string $daoFactoryClassName The classe name of the DAO factory
595
+	 * @param string $daonamespace        The namespace for the DAOs, without trailing \
596
+	 * @param string $beannamespace       The Namespace for the beans, without trailing \
597
+	 * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone.
598
+	 * @param string $composerFile        If it's set, location of custom Composer file. Relative to project root.
599
+	 *
600
+	 * @return \string[] the list of tables
601
+	 */
602
+	public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc, $composerFile = null)
603
+	{
604
+		// Purge cache before generating anything.
605
+		$this->cache->deleteAll();
606
+
607
+		$tdbmDaoGenerator = new TDBMDaoGenerator($this->schemaAnalyzer, $this->tdbmSchemaAnalyzer->getSchema(), $this->tdbmSchemaAnalyzer);
608
+		if (null !== $composerFile) {
609
+			$tdbmDaoGenerator->setComposerFile(__DIR__.'/../../../../../../../'.$composerFile);
610
+		}
611
+
612
+		return $tdbmDaoGenerator->generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc);
613
+	}
614
+
615
+	/**
616
+	 * @param array<string, string> $tableToBeanMap
617
+	 */
618
+	public function setTableToBeanMap(array $tableToBeanMap)
619
+	{
620
+		$this->tableToBeanMap = $tableToBeanMap;
621
+	}
622
+
623
+	/**
624
+	 * Saves $object by INSERTing or UPDAT(E)ing it in the database.
625
+	 *
626
+	 * @param AbstractTDBMObject $object
627
+	 *
628
+	 * @throws TDBMException
629
+	 */
630
+	public function save(AbstractTDBMObject $object)
631
+	{
632
+		$status = $object->_getStatus();
633
+
634
+		if ($status === null) {
635
+			throw new TDBMException(sprintf('Your bean for class %s has no status. It is likely that you overloaded the __construct method and forgot to call parent::__construct.', get_class($object)));
636
+		}
637
+
638
+		// Let's attach this object if it is in detached state.
639
+		if ($status === TDBMObjectStateEnum::STATE_DETACHED) {
640
+			$object->_attach($this);
641
+			$status = $object->_getStatus();
642
+		}
643
+
644
+		if ($status === TDBMObjectStateEnum::STATE_NEW) {
645
+			$dbRows = $object->_getDbRows();
646
+
647
+			$unindexedPrimaryKeys = array();
648
+
649
+			foreach ($dbRows as $dbRow) {
650
+				$tableName = $dbRow->_getDbTableName();
651
+
652
+				$schema = $this->tdbmSchemaAnalyzer->getSchema();
653
+				$tableDescriptor = $schema->getTable($tableName);
654
+
655
+				$primaryKeyColumns = $this->getPrimaryKeyColumns($tableName);
656
+
657
+				if (empty($unindexedPrimaryKeys)) {
658
+					$primaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
659
+				} else {
660
+					// First insert, the children must have the same primary key as the parent.
661
+					$primaryKeys = $this->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $unindexedPrimaryKeys);
662
+					$dbRow->_setPrimaryKeys($primaryKeys);
663
+				}
664
+
665
+				$references = $dbRow->_getReferences();
666
+
667
+				// Let's save all references in NEW or DETACHED state (we need their primary key)
668
+				foreach ($references as $fkName => $reference) {
669
+					if ($reference !== null) {
670
+						$refStatus = $reference->_getStatus();
671
+						if ($refStatus === TDBMObjectStateEnum::STATE_NEW || $refStatus === TDBMObjectStateEnum::STATE_DETACHED) {
672
+							$this->save($reference);
673
+						}
674
+					}
675
+				}
676
+
677
+				$dbRowData = $dbRow->_getDbRow();
678
+
679
+				// Let's see if the columns for primary key have been set before inserting.
680
+				// We assume that if one of the value of the PK has been set, the PK is set.
681
+				$isPkSet = !empty($primaryKeys);
682
+
683
+				/*if (!$isPkSet) {
684 684
                     // if there is no autoincrement and no pk set, let's go in error.
685 685
                     $isAutoIncrement = true;
686 686
 
@@ -698,25 +698,25 @@  discard block
 block discarded – undo
698 698
 
699 699
                 }*/
700 700
 
701
-                $types = [];
701
+				$types = [];
702 702
 
703
-                foreach ($dbRowData as $columnName => $value) {
704
-                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
705
-                    $types[] = $columnDescriptor->getType();
706
-                }
703
+				foreach ($dbRowData as $columnName => $value) {
704
+					$columnDescriptor = $tableDescriptor->getColumn($columnName);
705
+					$types[] = $columnDescriptor->getType();
706
+				}
707 707
 
708
-                $this->connection->insert($tableName, $dbRowData, $types);
708
+				$this->connection->insert($tableName, $dbRowData, $types);
709 709
 
710
-                if (!$isPkSet && count($primaryKeyColumns) == 1) {
711
-                    $id = $this->connection->lastInsertId();
712
-                    $primaryKeys[$primaryKeyColumns[0]] = $id;
713
-                }
710
+				if (!$isPkSet && count($primaryKeyColumns) == 1) {
711
+					$id = $this->connection->lastInsertId();
712
+					$primaryKeys[$primaryKeyColumns[0]] = $id;
713
+				}
714 714
 
715
-                // TODO: change this to some private magic accessor in future
716
-                $dbRow->_setPrimaryKeys($primaryKeys);
717
-                $unindexedPrimaryKeys = array_values($primaryKeys);
715
+				// TODO: change this to some private magic accessor in future
716
+				$dbRow->_setPrimaryKeys($primaryKeys);
717
+				$unindexedPrimaryKeys = array_values($primaryKeys);
718 718
 
719
-                /*
719
+				/*
720 720
                  * When attached, on "save", we check if the column updated is part of a primary key
721 721
                  * If this is part of a primary key, we call the _update_id method that updates the id in the list of known objects.
722 722
                  * This method should first verify that the id is not already used (and is not auto-incremented)
@@ -726,7 +726,7 @@  discard block
 block discarded – undo
726 726
                  *
727 727
                  */
728 728
 
729
-                /*try {
729
+				/*try {
730 730
                     $this->db_connection->exec($sql);
731 731
                 } catch (TDBMException $e) {
732 732
                     $this->db_onerror = true;
@@ -745,390 +745,390 @@  discard block
 block discarded – undo
745 745
                     }
746 746
                 }*/
747 747
 
748
-                // Let's remove this object from the $new_objects static table.
749
-                $this->removeFromToSaveObjectList($dbRow);
750
-
751
-                // TODO: change this behaviour to something more sensible performance-wise
752
-                // Maybe a setting to trigger this globally?
753
-                //$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
754
-                //$this->db_modified_state = false;
755
-                //$dbRow = array();
756
-
757
-                // Let's add this object to the list of objects in cache.
758
-                $this->_addToCache($dbRow);
759
-            }
760
-
761
-            $object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
762
-        } elseif ($status === TDBMObjectStateEnum::STATE_DIRTY) {
763
-            $dbRows = $object->_getDbRows();
764
-
765
-            foreach ($dbRows as $dbRow) {
766
-                $references = $dbRow->_getReferences();
767
-
768
-                // Let's save all references in NEW state (we need their primary key)
769
-                foreach ($references as $fkName => $reference) {
770
-                    if ($reference !== null && $reference->_getStatus() === TDBMObjectStateEnum::STATE_NEW) {
771
-                        $this->save($reference);
772
-                    }
773
-                }
774
-
775
-                // Let's first get the primary keys
776
-                $tableName = $dbRow->_getDbTableName();
777
-                $dbRowData = $dbRow->_getDbRow();
778
-
779
-                $schema = $this->tdbmSchemaAnalyzer->getSchema();
780
-                $tableDescriptor = $schema->getTable($tableName);
781
-
782
-                $primaryKeys = $dbRow->_getPrimaryKeys();
783
-
784
-                $types = [];
785
-
786
-                foreach ($dbRowData as $columnName => $value) {
787
-                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
788
-                    $types[] = $columnDescriptor->getType();
789
-                }
790
-                foreach ($primaryKeys as $columnName => $value) {
791
-                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
792
-                    $types[] = $columnDescriptor->getType();
793
-                }
794
-
795
-                $this->connection->update($tableName, $dbRowData, $primaryKeys, $types);
796
-
797
-                // Let's check if the primary key has been updated...
798
-                $needsUpdatePk = false;
799
-                foreach ($primaryKeys as $column => $value) {
800
-                    if (!isset($dbRowData[$column]) || $dbRowData[$column] != $value) {
801
-                        $needsUpdatePk = true;
802
-                        break;
803
-                    }
804
-                }
805
-                if ($needsUpdatePk) {
806
-                    $this->objectStorage->remove($tableName, $this->getObjectHash($primaryKeys));
807
-                    $newPrimaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
808
-                    $dbRow->_setPrimaryKeys($newPrimaryKeys);
809
-                    $this->objectStorage->set($tableName, $this->getObjectHash($primaryKeys), $dbRow);
810
-                }
811
-
812
-                // Let's remove this object from the list of objects to save.
813
-                $this->removeFromToSaveObjectList($dbRow);
814
-            }
815
-
816
-            $object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
817
-        } elseif ($status === TDBMObjectStateEnum::STATE_DELETED) {
818
-            throw new TDBMInvalidOperationException('This object has been deleted. It cannot be saved.');
819
-        }
820
-
821
-        // Finally, let's save all the many to many relationships to this bean.
822
-        $this->persistManyToManyRelationships($object);
823
-    }
824
-
825
-    private function persistManyToManyRelationships(AbstractTDBMObject $object)
826
-    {
827
-        foreach ($object->_getCachedRelationships() as $pivotTableName => $storage) {
828
-            $tableDescriptor = $this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName);
829
-            list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $object);
830
-
831
-            foreach ($storage as $remoteBean) {
832
-                /* @var $remoteBean AbstractTDBMObject */
833
-                $statusArr = $storage[$remoteBean];
834
-                $status = $statusArr['status'];
835
-                $reverse = $statusArr['reverse'];
836
-                if ($reverse) {
837
-                    continue;
838
-                }
839
-
840
-                if ($status === 'new') {
841
-                    $remoteBeanStatus = $remoteBean->_getStatus();
842
-                    if ($remoteBeanStatus === TDBMObjectStateEnum::STATE_NEW || $remoteBeanStatus === TDBMObjectStateEnum::STATE_DETACHED) {
843
-                        // Let's save remote bean if needed.
844
-                        $this->save($remoteBean);
845
-                    }
846
-
847
-                    $filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
848
-
849
-                    $types = [];
850
-
851
-                    foreach ($filters as $columnName => $value) {
852
-                        $columnDescriptor = $tableDescriptor->getColumn($columnName);
853
-                        $types[] = $columnDescriptor->getType();
854
-                    }
855
-
856
-                    $this->connection->insert($pivotTableName, $filters, $types);
857
-
858
-                    // Finally, let's mark relationships as saved.
859
-                    $statusArr['status'] = 'loaded';
860
-                    $storage[$remoteBean] = $statusArr;
861
-                    $remoteStorage = $remoteBean->_getCachedRelationships()[$pivotTableName];
862
-                    $remoteStatusArr = $remoteStorage[$object];
863
-                    $remoteStatusArr['status'] = 'loaded';
864
-                    $remoteStorage[$object] = $remoteStatusArr;
865
-                } elseif ($status === 'delete') {
866
-                    $filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
867
-
868
-                    $types = [];
869
-
870
-                    foreach ($filters as $columnName => $value) {
871
-                        $columnDescriptor = $tableDescriptor->getColumn($columnName);
872
-                        $types[] = $columnDescriptor->getType();
873
-                    }
874
-
875
-                    $this->connection->delete($pivotTableName, $filters, $types);
876
-
877
-                    // Finally, let's remove relationships completely from bean.
878
-                    $storage->detach($remoteBean);
879
-                    $remoteBean->_getCachedRelationships()[$pivotTableName]->detach($object);
880
-                }
881
-            }
882
-        }
883
-    }
884
-
885
-    private function getPivotFilters(AbstractTDBMObject $localBean, AbstractTDBMObject $remoteBean, ForeignKeyConstraint $localFk, ForeignKeyConstraint $remoteFk)
886
-    {
887
-        $localBeanPk = $this->getPrimaryKeyValues($localBean);
888
-        $remoteBeanPk = $this->getPrimaryKeyValues($remoteBean);
889
-        $localColumns = $localFk->getLocalColumns();
890
-        $remoteColumns = $remoteFk->getLocalColumns();
891
-
892
-        $localFilters = array_combine($localColumns, $localBeanPk);
893
-        $remoteFilters = array_combine($remoteColumns, $remoteBeanPk);
894
-
895
-        return array_merge($localFilters, $remoteFilters);
896
-    }
897
-
898
-    /**
899
-     * Returns the "values" of the primary key.
900
-     * This returns the primary key from the $primaryKey attribute, not the one stored in the columns.
901
-     *
902
-     * @param AbstractTDBMObject $bean
903
-     *
904
-     * @return array numerically indexed array of values.
905
-     */
906
-    private function getPrimaryKeyValues(AbstractTDBMObject $bean)
907
-    {
908
-        $dbRows = $bean->_getDbRows();
909
-        $dbRow = reset($dbRows);
910
-
911
-        return array_values($dbRow->_getPrimaryKeys());
912
-    }
913
-
914
-    /**
915
-     * Returns a unique hash used to store the object based on its primary key.
916
-     * If the array contains only one value, then the value is returned.
917
-     * Otherwise, a hash representing the array is returned.
918
-     *
919
-     * @param array $primaryKeys An array of columns => values forming the primary key
920
-     *
921
-     * @return string
922
-     */
923
-    public function getObjectHash(array $primaryKeys)
924
-    {
925
-        if (count($primaryKeys) === 1) {
926
-            return reset($primaryKeys);
927
-        } else {
928
-            ksort($primaryKeys);
929
-
930
-            return md5(json_encode($primaryKeys));
931
-        }
932
-    }
933
-
934
-    /**
935
-     * Returns an array of primary keys from the object.
936
-     * The primary keys are extracted from the object columns and not from the primary keys stored in the
937
-     * $primaryKeys variable of the object.
938
-     *
939
-     * @param DbRow $dbRow
940
-     *
941
-     * @return array Returns an array of column => value
942
-     */
943
-    public function getPrimaryKeysForObjectFromDbRow(DbRow $dbRow)
944
-    {
945
-        $table = $dbRow->_getDbTableName();
946
-        $dbRowData = $dbRow->_getDbRow();
947
-
948
-        return $this->_getPrimaryKeysFromObjectData($table, $dbRowData);
949
-    }
950
-
951
-    /**
952
-     * Returns an array of primary keys for the given row.
953
-     * The primary keys are extracted from the object columns.
954
-     *
955
-     * @param $table
956
-     * @param array $columns
957
-     *
958
-     * @return array
959
-     */
960
-    public function _getPrimaryKeysFromObjectData($table, array $columns)
961
-    {
962
-        $primaryKeyColumns = $this->getPrimaryKeyColumns($table);
963
-        $values = array();
964
-        foreach ($primaryKeyColumns as $column) {
965
-            if (isset($columns[$column])) {
966
-                $values[$column] = $columns[$column];
967
-            }
968
-        }
969
-
970
-        return $values;
971
-    }
972
-
973
-    /**
974
-     * Attaches $object to this TDBMService.
975
-     * The $object must be in DETACHED state and will pass in NEW state.
976
-     *
977
-     * @param AbstractTDBMObject $object
978
-     *
979
-     * @throws TDBMInvalidOperationException
980
-     */
981
-    public function attach(AbstractTDBMObject $object)
982
-    {
983
-        $object->_attach($this);
984
-    }
985
-
986
-    /**
987
-     * Returns an associative array (column => value) for the primary keys from the table name and an
988
-     * indexed array of primary key values.
989
-     *
990
-     * @param string $tableName
991
-     * @param array  $indexedPrimaryKeys
992
-     */
993
-    public function _getPrimaryKeysFromIndexedPrimaryKeys($tableName, array $indexedPrimaryKeys)
994
-    {
995
-        $primaryKeyColumns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getPrimaryKeyColumns();
996
-
997
-        if (count($primaryKeyColumns) !== count($indexedPrimaryKeys)) {
998
-            throw new TDBMException(sprintf('Wrong number of columns passed for primary key. Expected %s columns for table "%s",
748
+				// Let's remove this object from the $new_objects static table.
749
+				$this->removeFromToSaveObjectList($dbRow);
750
+
751
+				// TODO: change this behaviour to something more sensible performance-wise
752
+				// Maybe a setting to trigger this globally?
753
+				//$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
754
+				//$this->db_modified_state = false;
755
+				//$dbRow = array();
756
+
757
+				// Let's add this object to the list of objects in cache.
758
+				$this->_addToCache($dbRow);
759
+			}
760
+
761
+			$object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
762
+		} elseif ($status === TDBMObjectStateEnum::STATE_DIRTY) {
763
+			$dbRows = $object->_getDbRows();
764
+
765
+			foreach ($dbRows as $dbRow) {
766
+				$references = $dbRow->_getReferences();
767
+
768
+				// Let's save all references in NEW state (we need their primary key)
769
+				foreach ($references as $fkName => $reference) {
770
+					if ($reference !== null && $reference->_getStatus() === TDBMObjectStateEnum::STATE_NEW) {
771
+						$this->save($reference);
772
+					}
773
+				}
774
+
775
+				// Let's first get the primary keys
776
+				$tableName = $dbRow->_getDbTableName();
777
+				$dbRowData = $dbRow->_getDbRow();
778
+
779
+				$schema = $this->tdbmSchemaAnalyzer->getSchema();
780
+				$tableDescriptor = $schema->getTable($tableName);
781
+
782
+				$primaryKeys = $dbRow->_getPrimaryKeys();
783
+
784
+				$types = [];
785
+
786
+				foreach ($dbRowData as $columnName => $value) {
787
+					$columnDescriptor = $tableDescriptor->getColumn($columnName);
788
+					$types[] = $columnDescriptor->getType();
789
+				}
790
+				foreach ($primaryKeys as $columnName => $value) {
791
+					$columnDescriptor = $tableDescriptor->getColumn($columnName);
792
+					$types[] = $columnDescriptor->getType();
793
+				}
794
+
795
+				$this->connection->update($tableName, $dbRowData, $primaryKeys, $types);
796
+
797
+				// Let's check if the primary key has been updated...
798
+				$needsUpdatePk = false;
799
+				foreach ($primaryKeys as $column => $value) {
800
+					if (!isset($dbRowData[$column]) || $dbRowData[$column] != $value) {
801
+						$needsUpdatePk = true;
802
+						break;
803
+					}
804
+				}
805
+				if ($needsUpdatePk) {
806
+					$this->objectStorage->remove($tableName, $this->getObjectHash($primaryKeys));
807
+					$newPrimaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
808
+					$dbRow->_setPrimaryKeys($newPrimaryKeys);
809
+					$this->objectStorage->set($tableName, $this->getObjectHash($primaryKeys), $dbRow);
810
+				}
811
+
812
+				// Let's remove this object from the list of objects to save.
813
+				$this->removeFromToSaveObjectList($dbRow);
814
+			}
815
+
816
+			$object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
817
+		} elseif ($status === TDBMObjectStateEnum::STATE_DELETED) {
818
+			throw new TDBMInvalidOperationException('This object has been deleted. It cannot be saved.');
819
+		}
820
+
821
+		// Finally, let's save all the many to many relationships to this bean.
822
+		$this->persistManyToManyRelationships($object);
823
+	}
824
+
825
+	private function persistManyToManyRelationships(AbstractTDBMObject $object)
826
+	{
827
+		foreach ($object->_getCachedRelationships() as $pivotTableName => $storage) {
828
+			$tableDescriptor = $this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName);
829
+			list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $object);
830
+
831
+			foreach ($storage as $remoteBean) {
832
+				/* @var $remoteBean AbstractTDBMObject */
833
+				$statusArr = $storage[$remoteBean];
834
+				$status = $statusArr['status'];
835
+				$reverse = $statusArr['reverse'];
836
+				if ($reverse) {
837
+					continue;
838
+				}
839
+
840
+				if ($status === 'new') {
841
+					$remoteBeanStatus = $remoteBean->_getStatus();
842
+					if ($remoteBeanStatus === TDBMObjectStateEnum::STATE_NEW || $remoteBeanStatus === TDBMObjectStateEnum::STATE_DETACHED) {
843
+						// Let's save remote bean if needed.
844
+						$this->save($remoteBean);
845
+					}
846
+
847
+					$filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
848
+
849
+					$types = [];
850
+
851
+					foreach ($filters as $columnName => $value) {
852
+						$columnDescriptor = $tableDescriptor->getColumn($columnName);
853
+						$types[] = $columnDescriptor->getType();
854
+					}
855
+
856
+					$this->connection->insert($pivotTableName, $filters, $types);
857
+
858
+					// Finally, let's mark relationships as saved.
859
+					$statusArr['status'] = 'loaded';
860
+					$storage[$remoteBean] = $statusArr;
861
+					$remoteStorage = $remoteBean->_getCachedRelationships()[$pivotTableName];
862
+					$remoteStatusArr = $remoteStorage[$object];
863
+					$remoteStatusArr['status'] = 'loaded';
864
+					$remoteStorage[$object] = $remoteStatusArr;
865
+				} elseif ($status === 'delete') {
866
+					$filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
867
+
868
+					$types = [];
869
+
870
+					foreach ($filters as $columnName => $value) {
871
+						$columnDescriptor = $tableDescriptor->getColumn($columnName);
872
+						$types[] = $columnDescriptor->getType();
873
+					}
874
+
875
+					$this->connection->delete($pivotTableName, $filters, $types);
876
+
877
+					// Finally, let's remove relationships completely from bean.
878
+					$storage->detach($remoteBean);
879
+					$remoteBean->_getCachedRelationships()[$pivotTableName]->detach($object);
880
+				}
881
+			}
882
+		}
883
+	}
884
+
885
+	private function getPivotFilters(AbstractTDBMObject $localBean, AbstractTDBMObject $remoteBean, ForeignKeyConstraint $localFk, ForeignKeyConstraint $remoteFk)
886
+	{
887
+		$localBeanPk = $this->getPrimaryKeyValues($localBean);
888
+		$remoteBeanPk = $this->getPrimaryKeyValues($remoteBean);
889
+		$localColumns = $localFk->getLocalColumns();
890
+		$remoteColumns = $remoteFk->getLocalColumns();
891
+
892
+		$localFilters = array_combine($localColumns, $localBeanPk);
893
+		$remoteFilters = array_combine($remoteColumns, $remoteBeanPk);
894
+
895
+		return array_merge($localFilters, $remoteFilters);
896
+	}
897
+
898
+	/**
899
+	 * Returns the "values" of the primary key.
900
+	 * This returns the primary key from the $primaryKey attribute, not the one stored in the columns.
901
+	 *
902
+	 * @param AbstractTDBMObject $bean
903
+	 *
904
+	 * @return array numerically indexed array of values.
905
+	 */
906
+	private function getPrimaryKeyValues(AbstractTDBMObject $bean)
907
+	{
908
+		$dbRows = $bean->_getDbRows();
909
+		$dbRow = reset($dbRows);
910
+
911
+		return array_values($dbRow->_getPrimaryKeys());
912
+	}
913
+
914
+	/**
915
+	 * Returns a unique hash used to store the object based on its primary key.
916
+	 * If the array contains only one value, then the value is returned.
917
+	 * Otherwise, a hash representing the array is returned.
918
+	 *
919
+	 * @param array $primaryKeys An array of columns => values forming the primary key
920
+	 *
921
+	 * @return string
922
+	 */
923
+	public function getObjectHash(array $primaryKeys)
924
+	{
925
+		if (count($primaryKeys) === 1) {
926
+			return reset($primaryKeys);
927
+		} else {
928
+			ksort($primaryKeys);
929
+
930
+			return md5(json_encode($primaryKeys));
931
+		}
932
+	}
933
+
934
+	/**
935
+	 * Returns an array of primary keys from the object.
936
+	 * The primary keys are extracted from the object columns and not from the primary keys stored in the
937
+	 * $primaryKeys variable of the object.
938
+	 *
939
+	 * @param DbRow $dbRow
940
+	 *
941
+	 * @return array Returns an array of column => value
942
+	 */
943
+	public function getPrimaryKeysForObjectFromDbRow(DbRow $dbRow)
944
+	{
945
+		$table = $dbRow->_getDbTableName();
946
+		$dbRowData = $dbRow->_getDbRow();
947
+
948
+		return $this->_getPrimaryKeysFromObjectData($table, $dbRowData);
949
+	}
950
+
951
+	/**
952
+	 * Returns an array of primary keys for the given row.
953
+	 * The primary keys are extracted from the object columns.
954
+	 *
955
+	 * @param $table
956
+	 * @param array $columns
957
+	 *
958
+	 * @return array
959
+	 */
960
+	public function _getPrimaryKeysFromObjectData($table, array $columns)
961
+	{
962
+		$primaryKeyColumns = $this->getPrimaryKeyColumns($table);
963
+		$values = array();
964
+		foreach ($primaryKeyColumns as $column) {
965
+			if (isset($columns[$column])) {
966
+				$values[$column] = $columns[$column];
967
+			}
968
+		}
969
+
970
+		return $values;
971
+	}
972
+
973
+	/**
974
+	 * Attaches $object to this TDBMService.
975
+	 * The $object must be in DETACHED state and will pass in NEW state.
976
+	 *
977
+	 * @param AbstractTDBMObject $object
978
+	 *
979
+	 * @throws TDBMInvalidOperationException
980
+	 */
981
+	public function attach(AbstractTDBMObject $object)
982
+	{
983
+		$object->_attach($this);
984
+	}
985
+
986
+	/**
987
+	 * Returns an associative array (column => value) for the primary keys from the table name and an
988
+	 * indexed array of primary key values.
989
+	 *
990
+	 * @param string $tableName
991
+	 * @param array  $indexedPrimaryKeys
992
+	 */
993
+	public function _getPrimaryKeysFromIndexedPrimaryKeys($tableName, array $indexedPrimaryKeys)
994
+	{
995
+		$primaryKeyColumns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getPrimaryKeyColumns();
996
+
997
+		if (count($primaryKeyColumns) !== count($indexedPrimaryKeys)) {
998
+			throw new TDBMException(sprintf('Wrong number of columns passed for primary key. Expected %s columns for table "%s",
999 999
 			got %s instead.', count($primaryKeyColumns), $tableName, count($indexedPrimaryKeys)));
1000
-        }
1001
-
1002
-        return array_combine($primaryKeyColumns, $indexedPrimaryKeys);
1003
-    }
1004
-
1005
-    /**
1006
-     * Return the list of tables (from child to parent) joining the tables passed in parameter.
1007
-     * Tables must be in a single line of inheritance. The method will find missing tables.
1008
-     *
1009
-     * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1010
-     * we must be able to find all other tables.
1011
-     *
1012
-     * @param string[] $tables
1013
-     *
1014
-     * @return string[]
1015
-     */
1016
-    public function _getLinkBetweenInheritedTables(array $tables)
1017
-    {
1018
-        sort($tables);
1019
-
1020
-        return $this->fromCache($this->cachePrefix.'_linkbetweeninheritedtables_'.implode('__split__', $tables),
1021
-            function () use ($tables) {
1022
-                return $this->_getLinkBetweenInheritedTablesWithoutCache($tables);
1023
-            });
1024
-    }
1025
-
1026
-    /**
1027
-     * Return the list of tables (from child to parent) joining the tables passed in parameter.
1028
-     * Tables must be in a single line of inheritance. The method will find missing tables.
1029
-     *
1030
-     * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1031
-     * we must be able to find all other tables.
1032
-     *
1033
-     * @param string[] $tables
1034
-     *
1035
-     * @return string[]
1036
-     */
1037
-    private function _getLinkBetweenInheritedTablesWithoutCache(array $tables)
1038
-    {
1039
-        $schemaAnalyzer = $this->schemaAnalyzer;
1040
-
1041
-        foreach ($tables as $currentTable) {
1042
-            $allParents = [$currentTable];
1043
-            while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1044
-                $currentTable = $currentFk->getForeignTableName();
1045
-                $allParents[] = $currentTable;
1046
-            };
1047
-
1048
-            // Now, does the $allParents contain all the tables we want?
1049
-            $notFoundTables = array_diff($tables, $allParents);
1050
-            if (empty($notFoundTables)) {
1051
-                // We have a winner!
1052
-                return $allParents;
1053
-            }
1054
-        }
1055
-
1056
-        throw new TDBMException(sprintf('The tables (%s) cannot be linked by an inheritance relationship.', implode(', ', $tables)));
1057
-    }
1058
-
1059
-    /**
1060
-     * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1061
-     *
1062
-     * @param string $table
1063
-     *
1064
-     * @return string[]
1065
-     */
1066
-    public function _getRelatedTablesByInheritance($table)
1067
-    {
1068
-        return $this->fromCache($this->cachePrefix.'_relatedtables_'.$table, function () use ($table) {
1069
-            return $this->_getRelatedTablesByInheritanceWithoutCache($table);
1070
-        });
1071
-    }
1072
-
1073
-    /**
1074
-     * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1075
-     *
1076
-     * @param string $table
1077
-     *
1078
-     * @return string[]
1079
-     */
1080
-    private function _getRelatedTablesByInheritanceWithoutCache($table)
1081
-    {
1082
-        $schemaAnalyzer = $this->schemaAnalyzer;
1083
-
1084
-        // Let's scan the parent tables
1085
-        $currentTable = $table;
1086
-
1087
-        $parentTables = [];
1088
-
1089
-        // Get parent relationship
1090
-        while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1091
-            $currentTable = $currentFk->getForeignTableName();
1092
-            $parentTables[] = $currentTable;
1093
-        };
1094
-
1095
-        // Let's recurse in children
1096
-        $childrenTables = $this->exploreChildrenTablesRelationships($schemaAnalyzer, $table);
1097
-
1098
-        return array_merge(array_reverse($parentTables), $childrenTables);
1099
-    }
1100
-
1101
-    /**
1102
-     * Explore all the children and descendant of $table and returns ForeignKeyConstraints on those.
1103
-     *
1104
-     * @param string $table
1105
-     *
1106
-     * @return string[]
1107
-     */
1108
-    private function exploreChildrenTablesRelationships(SchemaAnalyzer $schemaAnalyzer, $table)
1109
-    {
1110
-        $tables = [$table];
1111
-        $keys = $schemaAnalyzer->getChildrenRelationships($table);
1112
-
1113
-        foreach ($keys as $key) {
1114
-            $tables = array_merge($tables, $this->exploreChildrenTablesRelationships($schemaAnalyzer, $key->getLocalTableName()));
1115
-        }
1116
-
1117
-        return $tables;
1118
-    }
1119
-
1120
-    /**
1121
-     * Casts a foreign key into SQL, assuming table name is used with no alias.
1122
-     * The returned value does contain only one table. For instance:.
1123
-     *
1124
-     * " LEFT JOIN table2 ON table1.id = table2.table1_id"
1125
-     *
1126
-     * @param ForeignKeyConstraint $fk
1127
-     * @param bool                 $leftTableIsLocal
1128
-     *
1129
-     * @return string
1130
-     */
1131
-    /*private function foreignKeyToSql(ForeignKeyConstraint $fk, $leftTableIsLocal) {
1000
+		}
1001
+
1002
+		return array_combine($primaryKeyColumns, $indexedPrimaryKeys);
1003
+	}
1004
+
1005
+	/**
1006
+	 * Return the list of tables (from child to parent) joining the tables passed in parameter.
1007
+	 * Tables must be in a single line of inheritance. The method will find missing tables.
1008
+	 *
1009
+	 * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1010
+	 * we must be able to find all other tables.
1011
+	 *
1012
+	 * @param string[] $tables
1013
+	 *
1014
+	 * @return string[]
1015
+	 */
1016
+	public function _getLinkBetweenInheritedTables(array $tables)
1017
+	{
1018
+		sort($tables);
1019
+
1020
+		return $this->fromCache($this->cachePrefix.'_linkbetweeninheritedtables_'.implode('__split__', $tables),
1021
+			function () use ($tables) {
1022
+				return $this->_getLinkBetweenInheritedTablesWithoutCache($tables);
1023
+			});
1024
+	}
1025
+
1026
+	/**
1027
+	 * Return the list of tables (from child to parent) joining the tables passed in parameter.
1028
+	 * Tables must be in a single line of inheritance. The method will find missing tables.
1029
+	 *
1030
+	 * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1031
+	 * we must be able to find all other tables.
1032
+	 *
1033
+	 * @param string[] $tables
1034
+	 *
1035
+	 * @return string[]
1036
+	 */
1037
+	private function _getLinkBetweenInheritedTablesWithoutCache(array $tables)
1038
+	{
1039
+		$schemaAnalyzer = $this->schemaAnalyzer;
1040
+
1041
+		foreach ($tables as $currentTable) {
1042
+			$allParents = [$currentTable];
1043
+			while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1044
+				$currentTable = $currentFk->getForeignTableName();
1045
+				$allParents[] = $currentTable;
1046
+			};
1047
+
1048
+			// Now, does the $allParents contain all the tables we want?
1049
+			$notFoundTables = array_diff($tables, $allParents);
1050
+			if (empty($notFoundTables)) {
1051
+				// We have a winner!
1052
+				return $allParents;
1053
+			}
1054
+		}
1055
+
1056
+		throw new TDBMException(sprintf('The tables (%s) cannot be linked by an inheritance relationship.', implode(', ', $tables)));
1057
+	}
1058
+
1059
+	/**
1060
+	 * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1061
+	 *
1062
+	 * @param string $table
1063
+	 *
1064
+	 * @return string[]
1065
+	 */
1066
+	public function _getRelatedTablesByInheritance($table)
1067
+	{
1068
+		return $this->fromCache($this->cachePrefix.'_relatedtables_'.$table, function () use ($table) {
1069
+			return $this->_getRelatedTablesByInheritanceWithoutCache($table);
1070
+		});
1071
+	}
1072
+
1073
+	/**
1074
+	 * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1075
+	 *
1076
+	 * @param string $table
1077
+	 *
1078
+	 * @return string[]
1079
+	 */
1080
+	private function _getRelatedTablesByInheritanceWithoutCache($table)
1081
+	{
1082
+		$schemaAnalyzer = $this->schemaAnalyzer;
1083
+
1084
+		// Let's scan the parent tables
1085
+		$currentTable = $table;
1086
+
1087
+		$parentTables = [];
1088
+
1089
+		// Get parent relationship
1090
+		while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1091
+			$currentTable = $currentFk->getForeignTableName();
1092
+			$parentTables[] = $currentTable;
1093
+		};
1094
+
1095
+		// Let's recurse in children
1096
+		$childrenTables = $this->exploreChildrenTablesRelationships($schemaAnalyzer, $table);
1097
+
1098
+		return array_merge(array_reverse($parentTables), $childrenTables);
1099
+	}
1100
+
1101
+	/**
1102
+	 * Explore all the children and descendant of $table and returns ForeignKeyConstraints on those.
1103
+	 *
1104
+	 * @param string $table
1105
+	 *
1106
+	 * @return string[]
1107
+	 */
1108
+	private function exploreChildrenTablesRelationships(SchemaAnalyzer $schemaAnalyzer, $table)
1109
+	{
1110
+		$tables = [$table];
1111
+		$keys = $schemaAnalyzer->getChildrenRelationships($table);
1112
+
1113
+		foreach ($keys as $key) {
1114
+			$tables = array_merge($tables, $this->exploreChildrenTablesRelationships($schemaAnalyzer, $key->getLocalTableName()));
1115
+		}
1116
+
1117
+		return $tables;
1118
+	}
1119
+
1120
+	/**
1121
+	 * Casts a foreign key into SQL, assuming table name is used with no alias.
1122
+	 * The returned value does contain only one table. For instance:.
1123
+	 *
1124
+	 * " LEFT JOIN table2 ON table1.id = table2.table1_id"
1125
+	 *
1126
+	 * @param ForeignKeyConstraint $fk
1127
+	 * @param bool                 $leftTableIsLocal
1128
+	 *
1129
+	 * @return string
1130
+	 */
1131
+	/*private function foreignKeyToSql(ForeignKeyConstraint $fk, $leftTableIsLocal) {
1132 1132
         $onClauses = [];
1133 1133
         $foreignTableName = $this->connection->quoteIdentifier($fk->getForeignTableName());
1134 1134
         $foreignColumns = $fk->getForeignColumns();
@@ -1154,400 +1154,400 @@  discard block
 block discarded – undo
1154 1154
         }
1155 1155
     }*/
1156 1156
 
1157
-    /**
1158
-     * Returns an identifier for the group of tables passed in parameter.
1159
-     *
1160
-     * @param string[] $relatedTables
1161
-     *
1162
-     * @return string
1163
-     */
1164
-    private function getTableGroupName(array $relatedTables)
1165
-    {
1166
-        sort($relatedTables);
1167
-
1168
-        return implode('_``_', $relatedTables);
1169
-    }
1170
-
1171
-    /**
1172
-     * Returns a `ResultIterator` object representing filtered records of "$mainTable" .
1173
-     *
1174
-     * The findObjects method should be the most used query method in TDBM if you want to query the database for objects.
1175
-     * (Note: if you want to query the database for an object by its primary key, use the findObjectByPk method).
1176
-     *
1177
-     * The findObjects method takes in parameter:
1178
-     * 	- mainTable: the kind of bean you want to retrieve. In TDBM, a bean matches a database row, so the
1179
-     * 			`$mainTable` parameter should be the name of an existing table in database.
1180
-     *  - filter: The filter is a filter bag. It is what you use to filter your request (the WHERE part in SQL).
1181
-     *          It can be a string (SQL Where clause), or even a bean or an associative array (key = column to filter, value = value to find)
1182
-     *  - parameters: The parameters used in the filter. If you pass a SQL string as a filter, be sure to avoid
1183
-     *          concatenating parameters in the string (this leads to SQL injection and also to poor caching performance).
1184
-     *          Instead, please consider passing parameters (see documentation for more details).
1185
-     *  - additionalTablesFetch: An array of SQL tables names. The beans related to those tables will be fetched along
1186
-     *          the main table. This is useful to avoid hitting the database with numerous subqueries.
1187
-     *  - mode: The fetch mode of the result. See `setFetchMode()` method for more details.
1188
-     *
1189
-     * The `findObjects` method will return a `ResultIterator`. A `ResultIterator` is an object that behaves as an array
1190
-     * (in ARRAY mode) at least. It can be iterated using a `foreach` loop.
1191
-     *
1192
-     * Finally, if filter_bag is null, the whole table is returned.
1193
-     *
1194
-     * @param string            $mainTable             The name of the table queried
1195
-     * @param string|array|null $filter                The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
1196
-     * @param array             $parameters
1197
-     * @param string|null       $orderString           The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column)
1198
-     * @param array             $additionalTablesFetch
1199
-     * @param int               $mode
1200
-     * @param string            $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
1201
-     *
1202
-     * @return ResultIterator An object representing an array of results.
1203
-     *
1204
-     * @throws TDBMException
1205
-     */
1206
-    public function findObjects($mainTable, $filter = null, array $parameters = array(), $orderString = null, array $additionalTablesFetch = array(), $mode = null, $className = null)
1207
-    {
1208
-        // $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
1209
-        if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
1210
-            throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
1211
-        }
1212
-
1213
-        list($filterString, $additionalParameters) = $this->buildFilterFromFilterBag($filter);
1214
-
1215
-        $parameters = array_merge($parameters, $additionalParameters);
1216
-
1217
-        // From the table name and the additional tables we want to fetch, let's build a list of all tables
1218
-        // that must be part of the select columns.
1219
-
1220
-        $tableGroups = [];
1221
-        $allFetchedTables = $this->_getRelatedTablesByInheritance($mainTable);
1222
-        $tableGroupName = $this->getTableGroupName($allFetchedTables);
1223
-        foreach ($allFetchedTables as $table) {
1224
-            $tableGroups[$table] = $tableGroupName;
1225
-        }
1226
-
1227
-        foreach ($additionalTablesFetch as $additionalTable) {
1228
-            $relatedTables = $this->_getRelatedTablesByInheritance($additionalTable);
1229
-            $tableGroupName = $this->getTableGroupName($relatedTables);
1230
-            foreach ($relatedTables as $table) {
1231
-                $tableGroups[$table] = $tableGroupName;
1232
-            }
1233
-            $allFetchedTables = array_merge($allFetchedTables, $relatedTables);
1234
-        }
1235
-
1236
-        // Let's remove any duplicate
1237
-        $allFetchedTables = array_flip(array_flip($allFetchedTables));
1238
-
1239
-        $columnsList = [];
1240
-        $columnDescList = [];
1241
-        $schema = $this->tdbmSchemaAnalyzer->getSchema();
1242
-
1243
-        // Now, let's build the column list
1244
-        foreach ($allFetchedTables as $table) {
1245
-            foreach ($schema->getTable($table)->getColumns() as $column) {
1246
-                $columnName = $column->getName();
1247
-                $columnDescList[] = [
1248
-                    'as' => $table.'____'.$columnName,
1249
-                    'table' => $table,
1250
-                    'column' => $columnName,
1251
-                    'type' => $column->getType(),
1252
-                    'tableGroup' => $tableGroups[$table],
1253
-                ];
1254
-                $columnsList[] = $this->connection->quoteIdentifier($table).'.'.$this->connection->quoteIdentifier($columnName).' as '.
1255
-                    $this->connection->quoteIdentifier($table.'____'.$columnName);
1256
-            }
1257
-        }
1258
-
1259
-        $sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$mainTable.')';
1260
-        $countSql = 'SELECT COUNT(1) FROM MAGICJOIN('.$mainTable.')';
1261
-
1262
-        if (!empty($filterString)) {
1263
-            $sql .= ' WHERE '.$filterString;
1264
-            $countSql .= ' WHERE '.$filterString;
1265
-        }
1266
-
1267
-        if (!empty($orderString)) {
1268
-            $sql .= ' ORDER BY '.$orderString;
1269
-            $countSql .= ' ORDER BY '.$orderString;
1270
-        }
1271
-
1272
-        if ($mode !== null && $mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
1273
-            throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
1274
-        }
1275
-
1276
-        $mode = $mode ?: $this->mode;
1277
-
1278
-        return new ResultIterator($sql, $countSql, $parameters, $columnDescList, $this->objectStorage, $className, $this, $this->magicQuery, $mode);
1279
-    }
1280
-
1281
-    /**
1282
-     * @param $table
1283
-     * @param array  $primaryKeys
1284
-     * @param array  $additionalTablesFetch
1285
-     * @param bool   $lazy                  Whether to perform lazy loading on this object or not.
1286
-     * @param string $className
1287
-     *
1288
-     * @return AbstractTDBMObject
1289
-     *
1290
-     * @throws TDBMException
1291
-     */
1292
-    public function findObjectByPk($table, array $primaryKeys, array $additionalTablesFetch = array(), $lazy = false, $className = null)
1293
-    {
1294
-        $primaryKeys = $this->_getPrimaryKeysFromObjectData($table, $primaryKeys);
1295
-        $hash = $this->getObjectHash($primaryKeys);
1296
-
1297
-        if ($this->objectStorage->has($table, $hash)) {
1298
-            $dbRow = $this->objectStorage->get($table, $hash);
1299
-            $bean = $dbRow->getTDBMObject();
1300
-            if ($className !== null && !is_a($bean, $className)) {
1301
-                throw new TDBMException("TDBM cannot create a bean of class '".$className."'. The requested object was already loaded and its class is '".get_class($bean)."'");
1302
-            }
1303
-
1304
-            return $bean;
1305
-        }
1306
-
1307
-        // Are we performing lazy fetching?
1308
-        if ($lazy === true) {
1309
-            // Can we perform lazy fetching?
1310
-            $tables = $this->_getRelatedTablesByInheritance($table);
1311
-            // Only allowed if no inheritance.
1312
-            if (count($tables) === 1) {
1313
-                if ($className === null) {
1314
-                    $className = isset($this->tableToBeanMap[$table]) ? $this->tableToBeanMap[$table] : 'Mouf\\Database\\TDBM\\TDBMObject';
1315
-                }
1316
-
1317
-                // Let's construct the bean
1318
-                if (!isset($this->reflectionClassCache[$className])) {
1319
-                    $this->reflectionClassCache[$className] = new \ReflectionClass($className);
1320
-                }
1321
-                // Let's bypass the constructor when creating the bean!
1322
-                $bean = $this->reflectionClassCache[$className]->newInstanceWithoutConstructor();
1323
-                /* @var $bean AbstractTDBMObject */
1324
-                $bean->_constructLazy($table, $primaryKeys, $this);
1325
-
1326
-                return $bean;
1327
-            }
1328
-        }
1329
-
1330
-        // Did not find the object in cache? Let's query it!
1331
-        return $this->findObjectOrFail($table, $primaryKeys, [], $additionalTablesFetch, $className);
1332
-    }
1333
-
1334
-    /**
1335
-     * Returns a unique bean (or null) according to the filters passed in parameter.
1336
-     *
1337
-     * @param string            $mainTable             The name of the table queried
1338
-     * @param string|array|null $filter                The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
1339
-     * @param array             $parameters
1340
-     * @param array             $additionalTablesFetch
1341
-     * @param string            $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
1342
-     *
1343
-     * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters.
1344
-     *
1345
-     * @throws TDBMException
1346
-     */
1347
-    public function findObject($mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null)
1348
-    {
1349
-        $objects = $this->findObjects($mainTable, $filter, $parameters, null, $additionalTablesFetch, self::MODE_ARRAY, $className);
1350
-        $page = $objects->take(0, 2);
1351
-        $count = $page->count();
1352
-        if ($count > 1) {
1353
-            throw new DuplicateRowException("Error while querying an object for table '$mainTable': More than 1 row have been returned, but we should have received at most one.");
1354
-        } elseif ($count === 0) {
1355
-            return;
1356
-        }
1357
-
1358
-        return $objects[0];
1359
-    }
1360
-
1361
-    /**
1362
-     * Returns a unique bean according to the filters passed in parameter.
1363
-     * Throws a NoBeanFoundException if no bean was found for the filter passed in parameter.
1364
-     *
1365
-     * @param string            $mainTable             The name of the table queried
1366
-     * @param string|array|null $filter                The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
1367
-     * @param array             $parameters
1368
-     * @param array             $additionalTablesFetch
1369
-     * @param string            $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
1370
-     *
1371
-     * @return AbstractTDBMObject The object we want
1372
-     *
1373
-     * @throws TDBMException
1374
-     */
1375
-    public function findObjectOrFail($mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null)
1376
-    {
1377
-        $bean = $this->findObject($mainTable, $filter, $parameters, $additionalTablesFetch, $className);
1378
-        if ($bean === null) {
1379
-            throw new NoBeanFoundException("No result found for query on table '".$mainTable."'");
1380
-        }
1381
-
1382
-        return $bean;
1383
-    }
1384
-
1385
-    /**
1386
-     * @param array $beanData An array of data: array<table, array<column, value>>
1387
-     *
1388
-     * @return array an array with first item = class name and second item = table name
1389
-     */
1390
-    public function _getClassNameFromBeanData(array $beanData)
1391
-    {
1392
-        if (count($beanData) === 1) {
1393
-            $tableName = array_keys($beanData)[0];
1394
-        } else {
1395
-            $tables = [];
1396
-            foreach ($beanData as $table => $row) {
1397
-                $primaryKeyColumns = $this->getPrimaryKeyColumns($table);
1398
-                $pkSet = false;
1399
-                foreach ($primaryKeyColumns as $columnName) {
1400
-                    if ($row[$columnName] !== null) {
1401
-                        $pkSet = true;
1402
-                        break;
1403
-                    }
1404
-                }
1405
-                if ($pkSet) {
1406
-                    $tables[] = $table;
1407
-                }
1408
-            }
1409
-
1410
-            // $tables contains the tables for this bean. Let's view the top most part of the hierarchy
1411
-            $allTables = $this->_getLinkBetweenInheritedTables($tables);
1412
-            $tableName = $allTables[0];
1413
-        }
1414
-
1415
-        // Only one table in this bean. Life is sweat, let's look at its type:
1416
-        if (isset($this->tableToBeanMap[$tableName])) {
1417
-            return [$this->tableToBeanMap[$tableName], $tableName];
1418
-        } else {
1419
-            return ['Mouf\\Database\\TDBM\\TDBMObject', $tableName];
1420
-        }
1421
-    }
1422
-
1423
-    /**
1424
-     * Returns an item from cache or computes it using $closure and puts it in cache.
1425
-     *
1426
-     * @param string   $key
1427
-     * @param callable $closure
1428
-     *
1429
-     * @return mixed
1430
-     */
1431
-    private function fromCache($key, callable $closure)
1432
-    {
1433
-        $item = $this->cache->fetch($key);
1434
-        if ($item === false) {
1435
-            $item = $closure();
1436
-            $this->cache->save($key, $item);
1437
-        }
1438
-
1439
-        return $item;
1440
-    }
1441
-
1442
-    /**
1443
-     * Returns the foreign key object.
1444
-     *
1445
-     * @param string $table
1446
-     * @param string $fkName
1447
-     *
1448
-     * @return ForeignKeyConstraint
1449
-     */
1450
-    public function _getForeignKeyByName($table, $fkName)
1451
-    {
1452
-        return $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getForeignKey($fkName);
1453
-    }
1454
-
1455
-    /**
1456
-     * @param $pivotTableName
1457
-     * @param AbstractTDBMObject $bean
1458
-     *
1459
-     * @return AbstractTDBMObject[]
1460
-     */
1461
-    public function _getRelatedBeans($pivotTableName, AbstractTDBMObject $bean)
1462
-    {
1463
-        list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $bean);
1464
-        /* @var $localFk ForeignKeyConstraint */
1465
-        /* @var $remoteFk ForeignKeyConstraint */
1466
-        $remoteTable = $remoteFk->getForeignTableName();
1467
-
1468
-        $primaryKeys = $this->getPrimaryKeyValues($bean);
1469
-        $columnNames = array_map(function ($name) use ($pivotTableName) { return $pivotTableName.'.'.$name; }, $localFk->getLocalColumns());
1470
-
1471
-        $filter = array_combine($columnNames, $primaryKeys);
1472
-
1473
-        return $this->findObjects($remoteTable, $filter);
1474
-    }
1475
-
1476
-    /**
1477
-     * @param $pivotTableName
1478
-     * @param AbstractTDBMObject $bean The LOCAL bean
1479
-     *
1480
-     * @return ForeignKeyConstraint[] First item: the LOCAL bean, second item: the REMOTE bean.
1481
-     *
1482
-     * @throws TDBMException
1483
-     */
1484
-    private function getPivotTableForeignKeys($pivotTableName, AbstractTDBMObject $bean)
1485
-    {
1486
-        $fks = array_values($this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName)->getForeignKeys());
1487
-        $table1 = $fks[0]->getForeignTableName();
1488
-        $table2 = $fks[1]->getForeignTableName();
1489
-
1490
-        $beanTables = array_map(function (DbRow $dbRow) { return $dbRow->_getDbTableName(); }, $bean->_getDbRows());
1491
-
1492
-        if (in_array($table1, $beanTables)) {
1493
-            return [$fks[0], $fks[1]];
1494
-        } elseif (in_array($table2, $beanTables)) {
1495
-            return [$fks[1], $fks[0]];
1496
-        } else {
1497
-            throw new TDBMException("Unexpected bean type in getPivotTableForeignKeys. Awaiting beans from table {$table1} and {$table2} for pivot table {$pivotTableName}");
1498
-        }
1499
-    }
1500
-
1501
-    /**
1502
-     * Returns a list of pivot tables linked to $bean.
1503
-     *
1504
-     * @param AbstractTDBMObject $bean
1505
-     *
1506
-     * @return string[]
1507
-     */
1508
-    public function _getPivotTablesLinkedToBean(AbstractTDBMObject $bean)
1509
-    {
1510
-        $junctionTables = [];
1511
-        $allJunctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
1512
-        foreach ($bean->_getDbRows() as $dbRow) {
1513
-            foreach ($allJunctionTables as $table) {
1514
-                // There are exactly 2 FKs since this is a pivot table.
1515
-                $fks = array_values($table->getForeignKeys());
1516
-
1517
-                if ($fks[0]->getForeignTableName() === $dbRow->_getDbTableName() || $fks[1]->getForeignTableName() === $dbRow->_getDbTableName()) {
1518
-                    $junctionTables[] = $table->getName();
1519
-                }
1520
-            }
1521
-        }
1522
-
1523
-        return $junctionTables;
1524
-    }
1525
-
1526
-    /**
1527
-     * Array of types for tables.
1528
-     * Key: table name
1529
-     * Value: array of types indexed by column.
1530
-     *
1531
-     * @var array[]
1532
-     */
1533
-    private $typesForTable = [];
1534
-
1535
-    /**
1536
-     * @internal
1537
-     *
1538
-     * @param string $tableName
1539
-     *
1540
-     * @return Type[]
1541
-     */
1542
-    public function _getColumnTypesForTable($tableName)
1543
-    {
1544
-        if (!isset($typesForTable[$tableName])) {
1545
-            $columns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getColumns();
1546
-            $typesForTable[$tableName] = array_map(function (Column $column) {
1547
-                return $column->getType();
1548
-            }, $columns);
1549
-        }
1550
-
1551
-        return $typesForTable[$tableName];
1552
-    }
1157
+	/**
1158
+	 * Returns an identifier for the group of tables passed in parameter.
1159
+	 *
1160
+	 * @param string[] $relatedTables
1161
+	 *
1162
+	 * @return string
1163
+	 */
1164
+	private function getTableGroupName(array $relatedTables)
1165
+	{
1166
+		sort($relatedTables);
1167
+
1168
+		return implode('_``_', $relatedTables);
1169
+	}
1170
+
1171
+	/**
1172
+	 * Returns a `ResultIterator` object representing filtered records of "$mainTable" .
1173
+	 *
1174
+	 * The findObjects method should be the most used query method in TDBM if you want to query the database for objects.
1175
+	 * (Note: if you want to query the database for an object by its primary key, use the findObjectByPk method).
1176
+	 *
1177
+	 * The findObjects method takes in parameter:
1178
+	 * 	- mainTable: the kind of bean you want to retrieve. In TDBM, a bean matches a database row, so the
1179
+	 * 			`$mainTable` parameter should be the name of an existing table in database.
1180
+	 *  - filter: The filter is a filter bag. It is what you use to filter your request (the WHERE part in SQL).
1181
+	 *          It can be a string (SQL Where clause), or even a bean or an associative array (key = column to filter, value = value to find)
1182
+	 *  - parameters: The parameters used in the filter. If you pass a SQL string as a filter, be sure to avoid
1183
+	 *          concatenating parameters in the string (this leads to SQL injection and also to poor caching performance).
1184
+	 *          Instead, please consider passing parameters (see documentation for more details).
1185
+	 *  - additionalTablesFetch: An array of SQL tables names. The beans related to those tables will be fetched along
1186
+	 *          the main table. This is useful to avoid hitting the database with numerous subqueries.
1187
+	 *  - mode: The fetch mode of the result. See `setFetchMode()` method for more details.
1188
+	 *
1189
+	 * The `findObjects` method will return a `ResultIterator`. A `ResultIterator` is an object that behaves as an array
1190
+	 * (in ARRAY mode) at least. It can be iterated using a `foreach` loop.
1191
+	 *
1192
+	 * Finally, if filter_bag is null, the whole table is returned.
1193
+	 *
1194
+	 * @param string            $mainTable             The name of the table queried
1195
+	 * @param string|array|null $filter                The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
1196
+	 * @param array             $parameters
1197
+	 * @param string|null       $orderString           The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column)
1198
+	 * @param array             $additionalTablesFetch
1199
+	 * @param int               $mode
1200
+	 * @param string            $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
1201
+	 *
1202
+	 * @return ResultIterator An object representing an array of results.
1203
+	 *
1204
+	 * @throws TDBMException
1205
+	 */
1206
+	public function findObjects($mainTable, $filter = null, array $parameters = array(), $orderString = null, array $additionalTablesFetch = array(), $mode = null, $className = null)
1207
+	{
1208
+		// $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
1209
+		if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
1210
+			throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
1211
+		}
1212
+
1213
+		list($filterString, $additionalParameters) = $this->buildFilterFromFilterBag($filter);
1214
+
1215
+		$parameters = array_merge($parameters, $additionalParameters);
1216
+
1217
+		// From the table name and the additional tables we want to fetch, let's build a list of all tables
1218
+		// that must be part of the select columns.
1219
+
1220
+		$tableGroups = [];
1221
+		$allFetchedTables = $this->_getRelatedTablesByInheritance($mainTable);
1222
+		$tableGroupName = $this->getTableGroupName($allFetchedTables);
1223
+		foreach ($allFetchedTables as $table) {
1224
+			$tableGroups[$table] = $tableGroupName;
1225
+		}
1226
+
1227
+		foreach ($additionalTablesFetch as $additionalTable) {
1228
+			$relatedTables = $this->_getRelatedTablesByInheritance($additionalTable);
1229
+			$tableGroupName = $this->getTableGroupName($relatedTables);
1230
+			foreach ($relatedTables as $table) {
1231
+				$tableGroups[$table] = $tableGroupName;
1232
+			}
1233
+			$allFetchedTables = array_merge($allFetchedTables, $relatedTables);
1234
+		}
1235
+
1236
+		// Let's remove any duplicate
1237
+		$allFetchedTables = array_flip(array_flip($allFetchedTables));
1238
+
1239
+		$columnsList = [];
1240
+		$columnDescList = [];
1241
+		$schema = $this->tdbmSchemaAnalyzer->getSchema();
1242
+
1243
+		// Now, let's build the column list
1244
+		foreach ($allFetchedTables as $table) {
1245
+			foreach ($schema->getTable($table)->getColumns() as $column) {
1246
+				$columnName = $column->getName();
1247
+				$columnDescList[] = [
1248
+					'as' => $table.'____'.$columnName,
1249
+					'table' => $table,
1250
+					'column' => $columnName,
1251
+					'type' => $column->getType(),
1252
+					'tableGroup' => $tableGroups[$table],
1253
+				];
1254
+				$columnsList[] = $this->connection->quoteIdentifier($table).'.'.$this->connection->quoteIdentifier($columnName).' as '.
1255
+					$this->connection->quoteIdentifier($table.'____'.$columnName);
1256
+			}
1257
+		}
1258
+
1259
+		$sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$mainTable.')';
1260
+		$countSql = 'SELECT COUNT(1) FROM MAGICJOIN('.$mainTable.')';
1261
+
1262
+		if (!empty($filterString)) {
1263
+			$sql .= ' WHERE '.$filterString;
1264
+			$countSql .= ' WHERE '.$filterString;
1265
+		}
1266
+
1267
+		if (!empty($orderString)) {
1268
+			$sql .= ' ORDER BY '.$orderString;
1269
+			$countSql .= ' ORDER BY '.$orderString;
1270
+		}
1271
+
1272
+		if ($mode !== null && $mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
1273
+			throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
1274
+		}
1275
+
1276
+		$mode = $mode ?: $this->mode;
1277
+
1278
+		return new ResultIterator($sql, $countSql, $parameters, $columnDescList, $this->objectStorage, $className, $this, $this->magicQuery, $mode);
1279
+	}
1280
+
1281
+	/**
1282
+	 * @param $table
1283
+	 * @param array  $primaryKeys
1284
+	 * @param array  $additionalTablesFetch
1285
+	 * @param bool   $lazy                  Whether to perform lazy loading on this object or not.
1286
+	 * @param string $className
1287
+	 *
1288
+	 * @return AbstractTDBMObject
1289
+	 *
1290
+	 * @throws TDBMException
1291
+	 */
1292
+	public function findObjectByPk($table, array $primaryKeys, array $additionalTablesFetch = array(), $lazy = false, $className = null)
1293
+	{
1294
+		$primaryKeys = $this->_getPrimaryKeysFromObjectData($table, $primaryKeys);
1295
+		$hash = $this->getObjectHash($primaryKeys);
1296
+
1297
+		if ($this->objectStorage->has($table, $hash)) {
1298
+			$dbRow = $this->objectStorage->get($table, $hash);
1299
+			$bean = $dbRow->getTDBMObject();
1300
+			if ($className !== null && !is_a($bean, $className)) {
1301
+				throw new TDBMException("TDBM cannot create a bean of class '".$className."'. The requested object was already loaded and its class is '".get_class($bean)."'");
1302
+			}
1303
+
1304
+			return $bean;
1305
+		}
1306
+
1307
+		// Are we performing lazy fetching?
1308
+		if ($lazy === true) {
1309
+			// Can we perform lazy fetching?
1310
+			$tables = $this->_getRelatedTablesByInheritance($table);
1311
+			// Only allowed if no inheritance.
1312
+			if (count($tables) === 1) {
1313
+				if ($className === null) {
1314
+					$className = isset($this->tableToBeanMap[$table]) ? $this->tableToBeanMap[$table] : 'Mouf\\Database\\TDBM\\TDBMObject';
1315
+				}
1316
+
1317
+				// Let's construct the bean
1318
+				if (!isset($this->reflectionClassCache[$className])) {
1319
+					$this->reflectionClassCache[$className] = new \ReflectionClass($className);
1320
+				}
1321
+				// Let's bypass the constructor when creating the bean!
1322
+				$bean = $this->reflectionClassCache[$className]->newInstanceWithoutConstructor();
1323
+				/* @var $bean AbstractTDBMObject */
1324
+				$bean->_constructLazy($table, $primaryKeys, $this);
1325
+
1326
+				return $bean;
1327
+			}
1328
+		}
1329
+
1330
+		// Did not find the object in cache? Let's query it!
1331
+		return $this->findObjectOrFail($table, $primaryKeys, [], $additionalTablesFetch, $className);
1332
+	}
1333
+
1334
+	/**
1335
+	 * Returns a unique bean (or null) according to the filters passed in parameter.
1336
+	 *
1337
+	 * @param string            $mainTable             The name of the table queried
1338
+	 * @param string|array|null $filter                The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
1339
+	 * @param array             $parameters
1340
+	 * @param array             $additionalTablesFetch
1341
+	 * @param string            $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
1342
+	 *
1343
+	 * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters.
1344
+	 *
1345
+	 * @throws TDBMException
1346
+	 */
1347
+	public function findObject($mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null)
1348
+	{
1349
+		$objects = $this->findObjects($mainTable, $filter, $parameters, null, $additionalTablesFetch, self::MODE_ARRAY, $className);
1350
+		$page = $objects->take(0, 2);
1351
+		$count = $page->count();
1352
+		if ($count > 1) {
1353
+			throw new DuplicateRowException("Error while querying an object for table '$mainTable': More than 1 row have been returned, but we should have received at most one.");
1354
+		} elseif ($count === 0) {
1355
+			return;
1356
+		}
1357
+
1358
+		return $objects[0];
1359
+	}
1360
+
1361
+	/**
1362
+	 * Returns a unique bean according to the filters passed in parameter.
1363
+	 * Throws a NoBeanFoundException if no bean was found for the filter passed in parameter.
1364
+	 *
1365
+	 * @param string            $mainTable             The name of the table queried
1366
+	 * @param string|array|null $filter                The SQL filters to apply to the query (the WHERE part). All columns must be prefixed by the table name (in the form: table.column)
1367
+	 * @param array             $parameters
1368
+	 * @param array             $additionalTablesFetch
1369
+	 * @param string            $className             Optional: The name of the class to instantiate. This class must extend the TDBMObject class. If none is specified, a TDBMObject instance will be returned.
1370
+	 *
1371
+	 * @return AbstractTDBMObject The object we want
1372
+	 *
1373
+	 * @throws TDBMException
1374
+	 */
1375
+	public function findObjectOrFail($mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null)
1376
+	{
1377
+		$bean = $this->findObject($mainTable, $filter, $parameters, $additionalTablesFetch, $className);
1378
+		if ($bean === null) {
1379
+			throw new NoBeanFoundException("No result found for query on table '".$mainTable."'");
1380
+		}
1381
+
1382
+		return $bean;
1383
+	}
1384
+
1385
+	/**
1386
+	 * @param array $beanData An array of data: array<table, array<column, value>>
1387
+	 *
1388
+	 * @return array an array with first item = class name and second item = table name
1389
+	 */
1390
+	public function _getClassNameFromBeanData(array $beanData)
1391
+	{
1392
+		if (count($beanData) === 1) {
1393
+			$tableName = array_keys($beanData)[0];
1394
+		} else {
1395
+			$tables = [];
1396
+			foreach ($beanData as $table => $row) {
1397
+				$primaryKeyColumns = $this->getPrimaryKeyColumns($table);
1398
+				$pkSet = false;
1399
+				foreach ($primaryKeyColumns as $columnName) {
1400
+					if ($row[$columnName] !== null) {
1401
+						$pkSet = true;
1402
+						break;
1403
+					}
1404
+				}
1405
+				if ($pkSet) {
1406
+					$tables[] = $table;
1407
+				}
1408
+			}
1409
+
1410
+			// $tables contains the tables for this bean. Let's view the top most part of the hierarchy
1411
+			$allTables = $this->_getLinkBetweenInheritedTables($tables);
1412
+			$tableName = $allTables[0];
1413
+		}
1414
+
1415
+		// Only one table in this bean. Life is sweat, let's look at its type:
1416
+		if (isset($this->tableToBeanMap[$tableName])) {
1417
+			return [$this->tableToBeanMap[$tableName], $tableName];
1418
+		} else {
1419
+			return ['Mouf\\Database\\TDBM\\TDBMObject', $tableName];
1420
+		}
1421
+	}
1422
+
1423
+	/**
1424
+	 * Returns an item from cache or computes it using $closure and puts it in cache.
1425
+	 *
1426
+	 * @param string   $key
1427
+	 * @param callable $closure
1428
+	 *
1429
+	 * @return mixed
1430
+	 */
1431
+	private function fromCache($key, callable $closure)
1432
+	{
1433
+		$item = $this->cache->fetch($key);
1434
+		if ($item === false) {
1435
+			$item = $closure();
1436
+			$this->cache->save($key, $item);
1437
+		}
1438
+
1439
+		return $item;
1440
+	}
1441
+
1442
+	/**
1443
+	 * Returns the foreign key object.
1444
+	 *
1445
+	 * @param string $table
1446
+	 * @param string $fkName
1447
+	 *
1448
+	 * @return ForeignKeyConstraint
1449
+	 */
1450
+	public function _getForeignKeyByName($table, $fkName)
1451
+	{
1452
+		return $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getForeignKey($fkName);
1453
+	}
1454
+
1455
+	/**
1456
+	 * @param $pivotTableName
1457
+	 * @param AbstractTDBMObject $bean
1458
+	 *
1459
+	 * @return AbstractTDBMObject[]
1460
+	 */
1461
+	public function _getRelatedBeans($pivotTableName, AbstractTDBMObject $bean)
1462
+	{
1463
+		list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $bean);
1464
+		/* @var $localFk ForeignKeyConstraint */
1465
+		/* @var $remoteFk ForeignKeyConstraint */
1466
+		$remoteTable = $remoteFk->getForeignTableName();
1467
+
1468
+		$primaryKeys = $this->getPrimaryKeyValues($bean);
1469
+		$columnNames = array_map(function ($name) use ($pivotTableName) { return $pivotTableName.'.'.$name; }, $localFk->getLocalColumns());
1470
+
1471
+		$filter = array_combine($columnNames, $primaryKeys);
1472
+
1473
+		return $this->findObjects($remoteTable, $filter);
1474
+	}
1475
+
1476
+	/**
1477
+	 * @param $pivotTableName
1478
+	 * @param AbstractTDBMObject $bean The LOCAL bean
1479
+	 *
1480
+	 * @return ForeignKeyConstraint[] First item: the LOCAL bean, second item: the REMOTE bean.
1481
+	 *
1482
+	 * @throws TDBMException
1483
+	 */
1484
+	private function getPivotTableForeignKeys($pivotTableName, AbstractTDBMObject $bean)
1485
+	{
1486
+		$fks = array_values($this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName)->getForeignKeys());
1487
+		$table1 = $fks[0]->getForeignTableName();
1488
+		$table2 = $fks[1]->getForeignTableName();
1489
+
1490
+		$beanTables = array_map(function (DbRow $dbRow) { return $dbRow->_getDbTableName(); }, $bean->_getDbRows());
1491
+
1492
+		if (in_array($table1, $beanTables)) {
1493
+			return [$fks[0], $fks[1]];
1494
+		} elseif (in_array($table2, $beanTables)) {
1495
+			return [$fks[1], $fks[0]];
1496
+		} else {
1497
+			throw new TDBMException("Unexpected bean type in getPivotTableForeignKeys. Awaiting beans from table {$table1} and {$table2} for pivot table {$pivotTableName}");
1498
+		}
1499
+	}
1500
+
1501
+	/**
1502
+	 * Returns a list of pivot tables linked to $bean.
1503
+	 *
1504
+	 * @param AbstractTDBMObject $bean
1505
+	 *
1506
+	 * @return string[]
1507
+	 */
1508
+	public function _getPivotTablesLinkedToBean(AbstractTDBMObject $bean)
1509
+	{
1510
+		$junctionTables = [];
1511
+		$allJunctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
1512
+		foreach ($bean->_getDbRows() as $dbRow) {
1513
+			foreach ($allJunctionTables as $table) {
1514
+				// There are exactly 2 FKs since this is a pivot table.
1515
+				$fks = array_values($table->getForeignKeys());
1516
+
1517
+				if ($fks[0]->getForeignTableName() === $dbRow->_getDbTableName() || $fks[1]->getForeignTableName() === $dbRow->_getDbTableName()) {
1518
+					$junctionTables[] = $table->getName();
1519
+				}
1520
+			}
1521
+		}
1522
+
1523
+		return $junctionTables;
1524
+	}
1525
+
1526
+	/**
1527
+	 * Array of types for tables.
1528
+	 * Key: table name
1529
+	 * Value: array of types indexed by column.
1530
+	 *
1531
+	 * @var array[]
1532
+	 */
1533
+	private $typesForTable = [];
1534
+
1535
+	/**
1536
+	 * @internal
1537
+	 *
1538
+	 * @param string $tableName
1539
+	 *
1540
+	 * @return Type[]
1541
+	 */
1542
+	public function _getColumnTypesForTable($tableName)
1543
+	{
1544
+		if (!isset($typesForTable[$tableName])) {
1545
+			$columns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getColumns();
1546
+			$typesForTable[$tableName] = array_map(function (Column $column) {
1547
+				return $column->getType();
1548
+			}, $columns);
1549
+		}
1550
+
1551
+		return $typesForTable[$tableName];
1552
+	}
1553 1553
 }
Please login to merge, or discard this patch.