Completed
Pull Request — 4.0 (#68)
by David
05:09
created
src/Mouf/Database/TDBM/TDBMService.php 1 patch
Indentation   +1327 added lines, -1327 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,139 +546,139 @@  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
-                    $refStatus = $reference->_getStatus();
670
-                    if ($refStatus === TDBMObjectStateEnum::STATE_NEW || $refStatus === TDBMObjectStateEnum::STATE_DETACHED) {
671
-                        $this->save($reference);
672
-                    }
673
-                }
674
-
675
-                $dbRowData = $dbRow->_getDbRow();
676
-
677
-                // Let's see if the columns for primary key have been set before inserting.
678
-                // We assume that if one of the value of the PK has been set, the PK is set.
679
-                $isPkSet = !empty($primaryKeys);
680
-
681
-                /*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
+					$refStatus = $reference->_getStatus();
670
+					if ($refStatus === TDBMObjectStateEnum::STATE_NEW || $refStatus === TDBMObjectStateEnum::STATE_DETACHED) {
671
+						$this->save($reference);
672
+					}
673
+				}
674
+
675
+				$dbRowData = $dbRow->_getDbRow();
676
+
677
+				// Let's see if the columns for primary key have been set before inserting.
678
+				// We assume that if one of the value of the PK has been set, the PK is set.
679
+				$isPkSet = !empty($primaryKeys);
680
+
681
+				/*if (!$isPkSet) {
682 682
                     // if there is no autoincrement and no pk set, let's go in error.
683 683
                     $isAutoIncrement = true;
684 684
 
@@ -696,25 +696,25 @@  discard block
 block discarded – undo
696 696
 
697 697
                 }*/
698 698
 
699
-                $types = [];
699
+				$types = [];
700 700
 
701
-                foreach ($dbRowData as $columnName => $value) {
702
-                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
703
-                    $types[] = $columnDescriptor->getType();
704
-                }
701
+				foreach ($dbRowData as $columnName => $value) {
702
+					$columnDescriptor = $tableDescriptor->getColumn($columnName);
703
+					$types[] = $columnDescriptor->getType();
704
+				}
705 705
 
706
-                $this->connection->insert($tableName, $dbRowData, $types);
706
+				$this->connection->insert($tableName, $dbRowData, $types);
707 707
 
708
-                if (!$isPkSet && count($primaryKeyColumns) == 1) {
709
-                    $id = $this->connection->lastInsertId();
710
-                    $primaryKeys[$primaryKeyColumns[0]] = $id;
711
-                }
708
+				if (!$isPkSet && count($primaryKeyColumns) == 1) {
709
+					$id = $this->connection->lastInsertId();
710
+					$primaryKeys[$primaryKeyColumns[0]] = $id;
711
+				}
712 712
 
713
-                // TODO: change this to some private magic accessor in future
714
-                $dbRow->_setPrimaryKeys($primaryKeys);
715
-                $unindexedPrimaryKeys = array_values($primaryKeys);
713
+				// TODO: change this to some private magic accessor in future
714
+				$dbRow->_setPrimaryKeys($primaryKeys);
715
+				$unindexedPrimaryKeys = array_values($primaryKeys);
716 716
 
717
-                /*
717
+				/*
718 718
                  * When attached, on "save", we check if the column updated is part of a primary key
719 719
                  * If this is part of a primary key, we call the _update_id method that updates the id in the list of known objects.
720 720
                  * This method should first verify that the id is not already used (and is not auto-incremented)
@@ -724,7 +724,7 @@  discard block
 block discarded – undo
724 724
                  *
725 725
                  */
726 726
 
727
-                /*try {
727
+				/*try {
728 728
                     $this->db_connection->exec($sql);
729 729
                 } catch (TDBMException $e) {
730 730
                     $this->db_onerror = true;
@@ -743,390 +743,390 @@  discard block
 block discarded – undo
743 743
                     }
744 744
                 }*/
745 745
 
746
-                // Let's remove this object from the $new_objects static table.
747
-                $this->removeFromToSaveObjectList($dbRow);
748
-
749
-                // TODO: change this behaviour to something more sensible performance-wise
750
-                // Maybe a setting to trigger this globally?
751
-                //$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
752
-                //$this->db_modified_state = false;
753
-                //$dbRow = array();
754
-
755
-                // Let's add this object to the list of objects in cache.
756
-                $this->_addToCache($dbRow);
757
-            }
758
-
759
-            $object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
760
-        } elseif ($status === TDBMObjectStateEnum::STATE_DIRTY) {
761
-            $dbRows = $object->_getDbRows();
762
-
763
-            foreach ($dbRows as $dbRow) {
764
-                $references = $dbRow->_getReferences();
765
-
766
-                // Let's save all references in NEW state (we need their primary key)
767
-                foreach ($references as $fkName => $reference) {
768
-                    if ($reference->_getStatus() === TDBMObjectStateEnum::STATE_NEW) {
769
-                        $this->save($reference);
770
-                    }
771
-                }
772
-
773
-                // Let's first get the primary keys
774
-                $tableName = $dbRow->_getDbTableName();
775
-                $dbRowData = $dbRow->_getDbRow();
776
-
777
-                $schema = $this->tdbmSchemaAnalyzer->getSchema();
778
-                $tableDescriptor = $schema->getTable($tableName);
779
-
780
-                $primaryKeys = $dbRow->_getPrimaryKeys();
781
-
782
-                $types = [];
783
-
784
-                foreach ($dbRowData as $columnName => $value) {
785
-                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
786
-                    $types[] = $columnDescriptor->getType();
787
-                }
788
-                foreach ($primaryKeys as $columnName => $value) {
789
-                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
790
-                    $types[] = $columnDescriptor->getType();
791
-                }
792
-
793
-                $this->connection->update($tableName, $dbRowData, $primaryKeys, $types);
794
-
795
-                // Let's check if the primary key has been updated...
796
-                $needsUpdatePk = false;
797
-                foreach ($primaryKeys as $column => $value) {
798
-                    if (!isset($dbRowData[$column]) || $dbRowData[$column] != $value) {
799
-                        $needsUpdatePk = true;
800
-                        break;
801
-                    }
802
-                }
803
-                if ($needsUpdatePk) {
804
-                    $this->objectStorage->remove($tableName, $this->getObjectHash($primaryKeys));
805
-                    $newPrimaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
806
-                    $dbRow->_setPrimaryKeys($newPrimaryKeys);
807
-                    $this->objectStorage->set($tableName, $this->getObjectHash($primaryKeys), $dbRow);
808
-                }
809
-
810
-                // Let's remove this object from the list of objects to save.
811
-                $this->removeFromToSaveObjectList($dbRow);
812
-            }
813
-
814
-            $object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
815
-        } elseif ($status === TDBMObjectStateEnum::STATE_DELETED) {
816
-            throw new TDBMInvalidOperationException('This object has been deleted. It cannot be saved.');
817
-        }
818
-
819
-        // Finally, let's save all the many to many relationships to this bean.
820
-        $this->persistManyToManyRelationships($object);
821
-    }
822
-
823
-    private function persistManyToManyRelationships(AbstractTDBMObject $object)
824
-    {
825
-        foreach ($object->_getCachedRelationships() as $pivotTableName => $storage) {
826
-            $tableDescriptor = $this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName);
827
-            list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $object);
828
-
829
-            foreach ($storage as $remoteBean) {
830
-                /* @var $remoteBean AbstractTDBMObject */
831
-                $statusArr = $storage[$remoteBean];
832
-                $status = $statusArr['status'];
833
-                $reverse = $statusArr['reverse'];
834
-                if ($reverse) {
835
-                    continue;
836
-                }
837
-
838
-                if ($status === 'new') {
839
-                    $remoteBeanStatus = $remoteBean->_getStatus();
840
-                    if ($remoteBeanStatus === TDBMObjectStateEnum::STATE_NEW || $remoteBeanStatus === TDBMObjectStateEnum::STATE_DETACHED) {
841
-                        // Let's save remote bean if needed.
842
-                        $this->save($remoteBean);
843
-                    }
844
-
845
-                    $filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
846
-
847
-                    $types = [];
848
-
849
-                    foreach ($filters as $columnName => $value) {
850
-                        $columnDescriptor = $tableDescriptor->getColumn($columnName);
851
-                        $types[] = $columnDescriptor->getType();
852
-                    }
853
-
854
-                    $this->connection->insert($pivotTableName, $filters, $types);
855
-
856
-                    // Finally, let's mark relationships as saved.
857
-                    $statusArr['status'] = 'loaded';
858
-                    $storage[$remoteBean] = $statusArr;
859
-                    $remoteStorage = $remoteBean->_getCachedRelationships()[$pivotTableName];
860
-                    $remoteStatusArr = $remoteStorage[$object];
861
-                    $remoteStatusArr['status'] = 'loaded';
862
-                    $remoteStorage[$object] = $remoteStatusArr;
863
-                } elseif ($status === 'delete') {
864
-                    $filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
865
-
866
-                    $types = [];
867
-
868
-                    foreach ($filters as $columnName => $value) {
869
-                        $columnDescriptor = $tableDescriptor->getColumn($columnName);
870
-                        $types[] = $columnDescriptor->getType();
871
-                    }
872
-
873
-                    $this->connection->delete($pivotTableName, $filters, $types);
874
-
875
-                    // Finally, let's remove relationships completely from bean.
876
-                    $storage->detach($remoteBean);
877
-                    $remoteBean->_getCachedRelationships()[$pivotTableName]->detach($object);
878
-                }
879
-            }
880
-        }
881
-    }
882
-
883
-    private function getPivotFilters(AbstractTDBMObject $localBean, AbstractTDBMObject $remoteBean, ForeignKeyConstraint $localFk, ForeignKeyConstraint $remoteFk)
884
-    {
885
-        $localBeanPk = $this->getPrimaryKeyValues($localBean);
886
-        $remoteBeanPk = $this->getPrimaryKeyValues($remoteBean);
887
-        $localColumns = $localFk->getLocalColumns();
888
-        $remoteColumns = $remoteFk->getLocalColumns();
889
-
890
-        $localFilters = array_combine($localColumns, $localBeanPk);
891
-        $remoteFilters = array_combine($remoteColumns, $remoteBeanPk);
892
-
893
-        return array_merge($localFilters, $remoteFilters);
894
-    }
895
-
896
-    /**
897
-     * Returns the "values" of the primary key.
898
-     * This returns the primary key from the $primaryKey attribute, not the one stored in the columns.
899
-     *
900
-     * @param AbstractTDBMObject $bean
901
-     *
902
-     * @return array numerically indexed array of values.
903
-     */
904
-    private function getPrimaryKeyValues(AbstractTDBMObject $bean)
905
-    {
906
-        $dbRows = $bean->_getDbRows();
907
-        $dbRow = reset($dbRows);
908
-
909
-        return array_values($dbRow->_getPrimaryKeys());
910
-    }
911
-
912
-    /**
913
-     * Returns a unique hash used to store the object based on its primary key.
914
-     * If the array contains only one value, then the value is returned.
915
-     * Otherwise, a hash representing the array is returned.
916
-     *
917
-     * @param array $primaryKeys An array of columns => values forming the primary key
918
-     *
919
-     * @return string
920
-     */
921
-    public function getObjectHash(array $primaryKeys)
922
-    {
923
-        if (count($primaryKeys) === 1) {
924
-            return reset($primaryKeys);
925
-        } else {
926
-            ksort($primaryKeys);
927
-
928
-            return md5(json_encode($primaryKeys));
929
-        }
930
-    }
931
-
932
-    /**
933
-     * Returns an array of primary keys from the object.
934
-     * The primary keys are extracted from the object columns and not from the primary keys stored in the
935
-     * $primaryKeys variable of the object.
936
-     *
937
-     * @param DbRow $dbRow
938
-     *
939
-     * @return array Returns an array of column => value
940
-     */
941
-    public function getPrimaryKeysForObjectFromDbRow(DbRow $dbRow)
942
-    {
943
-        $table = $dbRow->_getDbTableName();
944
-        $dbRowData = $dbRow->_getDbRow();
945
-
946
-        return $this->_getPrimaryKeysFromObjectData($table, $dbRowData);
947
-    }
948
-
949
-    /**
950
-     * Returns an array of primary keys for the given row.
951
-     * The primary keys are extracted from the object columns.
952
-     *
953
-     * @param $table
954
-     * @param array $columns
955
-     *
956
-     * @return array
957
-     */
958
-    public function _getPrimaryKeysFromObjectData($table, array $columns)
959
-    {
960
-        $primaryKeyColumns = $this->getPrimaryKeyColumns($table);
961
-        $values = array();
962
-        foreach ($primaryKeyColumns as $column) {
963
-            if (isset($columns[$column])) {
964
-                $values[$column] = $columns[$column];
965
-            }
966
-        }
967
-
968
-        return $values;
969
-    }
970
-
971
-    /**
972
-     * Attaches $object to this TDBMService.
973
-     * The $object must be in DETACHED state and will pass in NEW state.
974
-     *
975
-     * @param AbstractTDBMObject $object
976
-     *
977
-     * @throws TDBMInvalidOperationException
978
-     */
979
-    public function attach(AbstractTDBMObject $object)
980
-    {
981
-        $object->_attach($this);
982
-    }
983
-
984
-    /**
985
-     * Returns an associative array (column => value) for the primary keys from the table name and an
986
-     * indexed array of primary key values.
987
-     *
988
-     * @param string $tableName
989
-     * @param array  $indexedPrimaryKeys
990
-     */
991
-    public function _getPrimaryKeysFromIndexedPrimaryKeys($tableName, array $indexedPrimaryKeys)
992
-    {
993
-        $primaryKeyColumns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getPrimaryKeyColumns();
994
-
995
-        if (count($primaryKeyColumns) !== count($indexedPrimaryKeys)) {
996
-            throw new TDBMException(sprintf('Wrong number of columns passed for primary key. Expected %s columns for table "%s",
746
+				// Let's remove this object from the $new_objects static table.
747
+				$this->removeFromToSaveObjectList($dbRow);
748
+
749
+				// TODO: change this behaviour to something more sensible performance-wise
750
+				// Maybe a setting to trigger this globally?
751
+				//$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
752
+				//$this->db_modified_state = false;
753
+				//$dbRow = array();
754
+
755
+				// Let's add this object to the list of objects in cache.
756
+				$this->_addToCache($dbRow);
757
+			}
758
+
759
+			$object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
760
+		} elseif ($status === TDBMObjectStateEnum::STATE_DIRTY) {
761
+			$dbRows = $object->_getDbRows();
762
+
763
+			foreach ($dbRows as $dbRow) {
764
+				$references = $dbRow->_getReferences();
765
+
766
+				// Let's save all references in NEW state (we need their primary key)
767
+				foreach ($references as $fkName => $reference) {
768
+					if ($reference->_getStatus() === TDBMObjectStateEnum::STATE_NEW) {
769
+						$this->save($reference);
770
+					}
771
+				}
772
+
773
+				// Let's first get the primary keys
774
+				$tableName = $dbRow->_getDbTableName();
775
+				$dbRowData = $dbRow->_getDbRow();
776
+
777
+				$schema = $this->tdbmSchemaAnalyzer->getSchema();
778
+				$tableDescriptor = $schema->getTable($tableName);
779
+
780
+				$primaryKeys = $dbRow->_getPrimaryKeys();
781
+
782
+				$types = [];
783
+
784
+				foreach ($dbRowData as $columnName => $value) {
785
+					$columnDescriptor = $tableDescriptor->getColumn($columnName);
786
+					$types[] = $columnDescriptor->getType();
787
+				}
788
+				foreach ($primaryKeys as $columnName => $value) {
789
+					$columnDescriptor = $tableDescriptor->getColumn($columnName);
790
+					$types[] = $columnDescriptor->getType();
791
+				}
792
+
793
+				$this->connection->update($tableName, $dbRowData, $primaryKeys, $types);
794
+
795
+				// Let's check if the primary key has been updated...
796
+				$needsUpdatePk = false;
797
+				foreach ($primaryKeys as $column => $value) {
798
+					if (!isset($dbRowData[$column]) || $dbRowData[$column] != $value) {
799
+						$needsUpdatePk = true;
800
+						break;
801
+					}
802
+				}
803
+				if ($needsUpdatePk) {
804
+					$this->objectStorage->remove($tableName, $this->getObjectHash($primaryKeys));
805
+					$newPrimaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
806
+					$dbRow->_setPrimaryKeys($newPrimaryKeys);
807
+					$this->objectStorage->set($tableName, $this->getObjectHash($primaryKeys), $dbRow);
808
+				}
809
+
810
+				// Let's remove this object from the list of objects to save.
811
+				$this->removeFromToSaveObjectList($dbRow);
812
+			}
813
+
814
+			$object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
815
+		} elseif ($status === TDBMObjectStateEnum::STATE_DELETED) {
816
+			throw new TDBMInvalidOperationException('This object has been deleted. It cannot be saved.');
817
+		}
818
+
819
+		// Finally, let's save all the many to many relationships to this bean.
820
+		$this->persistManyToManyRelationships($object);
821
+	}
822
+
823
+	private function persistManyToManyRelationships(AbstractTDBMObject $object)
824
+	{
825
+		foreach ($object->_getCachedRelationships() as $pivotTableName => $storage) {
826
+			$tableDescriptor = $this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName);
827
+			list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $object);
828
+
829
+			foreach ($storage as $remoteBean) {
830
+				/* @var $remoteBean AbstractTDBMObject */
831
+				$statusArr = $storage[$remoteBean];
832
+				$status = $statusArr['status'];
833
+				$reverse = $statusArr['reverse'];
834
+				if ($reverse) {
835
+					continue;
836
+				}
837
+
838
+				if ($status === 'new') {
839
+					$remoteBeanStatus = $remoteBean->_getStatus();
840
+					if ($remoteBeanStatus === TDBMObjectStateEnum::STATE_NEW || $remoteBeanStatus === TDBMObjectStateEnum::STATE_DETACHED) {
841
+						// Let's save remote bean if needed.
842
+						$this->save($remoteBean);
843
+					}
844
+
845
+					$filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
846
+
847
+					$types = [];
848
+
849
+					foreach ($filters as $columnName => $value) {
850
+						$columnDescriptor = $tableDescriptor->getColumn($columnName);
851
+						$types[] = $columnDescriptor->getType();
852
+					}
853
+
854
+					$this->connection->insert($pivotTableName, $filters, $types);
855
+
856
+					// Finally, let's mark relationships as saved.
857
+					$statusArr['status'] = 'loaded';
858
+					$storage[$remoteBean] = $statusArr;
859
+					$remoteStorage = $remoteBean->_getCachedRelationships()[$pivotTableName];
860
+					$remoteStatusArr = $remoteStorage[$object];
861
+					$remoteStatusArr['status'] = 'loaded';
862
+					$remoteStorage[$object] = $remoteStatusArr;
863
+				} elseif ($status === 'delete') {
864
+					$filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
865
+
866
+					$types = [];
867
+
868
+					foreach ($filters as $columnName => $value) {
869
+						$columnDescriptor = $tableDescriptor->getColumn($columnName);
870
+						$types[] = $columnDescriptor->getType();
871
+					}
872
+
873
+					$this->connection->delete($pivotTableName, $filters, $types);
874
+
875
+					// Finally, let's remove relationships completely from bean.
876
+					$storage->detach($remoteBean);
877
+					$remoteBean->_getCachedRelationships()[$pivotTableName]->detach($object);
878
+				}
879
+			}
880
+		}
881
+	}
882
+
883
+	private function getPivotFilters(AbstractTDBMObject $localBean, AbstractTDBMObject $remoteBean, ForeignKeyConstraint $localFk, ForeignKeyConstraint $remoteFk)
884
+	{
885
+		$localBeanPk = $this->getPrimaryKeyValues($localBean);
886
+		$remoteBeanPk = $this->getPrimaryKeyValues($remoteBean);
887
+		$localColumns = $localFk->getLocalColumns();
888
+		$remoteColumns = $remoteFk->getLocalColumns();
889
+
890
+		$localFilters = array_combine($localColumns, $localBeanPk);
891
+		$remoteFilters = array_combine($remoteColumns, $remoteBeanPk);
892
+
893
+		return array_merge($localFilters, $remoteFilters);
894
+	}
895
+
896
+	/**
897
+	 * Returns the "values" of the primary key.
898
+	 * This returns the primary key from the $primaryKey attribute, not the one stored in the columns.
899
+	 *
900
+	 * @param AbstractTDBMObject $bean
901
+	 *
902
+	 * @return array numerically indexed array of values.
903
+	 */
904
+	private function getPrimaryKeyValues(AbstractTDBMObject $bean)
905
+	{
906
+		$dbRows = $bean->_getDbRows();
907
+		$dbRow = reset($dbRows);
908
+
909
+		return array_values($dbRow->_getPrimaryKeys());
910
+	}
911
+
912
+	/**
913
+	 * Returns a unique hash used to store the object based on its primary key.
914
+	 * If the array contains only one value, then the value is returned.
915
+	 * Otherwise, a hash representing the array is returned.
916
+	 *
917
+	 * @param array $primaryKeys An array of columns => values forming the primary key
918
+	 *
919
+	 * @return string
920
+	 */
921
+	public function getObjectHash(array $primaryKeys)
922
+	{
923
+		if (count($primaryKeys) === 1) {
924
+			return reset($primaryKeys);
925
+		} else {
926
+			ksort($primaryKeys);
927
+
928
+			return md5(json_encode($primaryKeys));
929
+		}
930
+	}
931
+
932
+	/**
933
+	 * Returns an array of primary keys from the object.
934
+	 * The primary keys are extracted from the object columns and not from the primary keys stored in the
935
+	 * $primaryKeys variable of the object.
936
+	 *
937
+	 * @param DbRow $dbRow
938
+	 *
939
+	 * @return array Returns an array of column => value
940
+	 */
941
+	public function getPrimaryKeysForObjectFromDbRow(DbRow $dbRow)
942
+	{
943
+		$table = $dbRow->_getDbTableName();
944
+		$dbRowData = $dbRow->_getDbRow();
945
+
946
+		return $this->_getPrimaryKeysFromObjectData($table, $dbRowData);
947
+	}
948
+
949
+	/**
950
+	 * Returns an array of primary keys for the given row.
951
+	 * The primary keys are extracted from the object columns.
952
+	 *
953
+	 * @param $table
954
+	 * @param array $columns
955
+	 *
956
+	 * @return array
957
+	 */
958
+	public function _getPrimaryKeysFromObjectData($table, array $columns)
959
+	{
960
+		$primaryKeyColumns = $this->getPrimaryKeyColumns($table);
961
+		$values = array();
962
+		foreach ($primaryKeyColumns as $column) {
963
+			if (isset($columns[$column])) {
964
+				$values[$column] = $columns[$column];
965
+			}
966
+		}
967
+
968
+		return $values;
969
+	}
970
+
971
+	/**
972
+	 * Attaches $object to this TDBMService.
973
+	 * The $object must be in DETACHED state and will pass in NEW state.
974
+	 *
975
+	 * @param AbstractTDBMObject $object
976
+	 *
977
+	 * @throws TDBMInvalidOperationException
978
+	 */
979
+	public function attach(AbstractTDBMObject $object)
980
+	{
981
+		$object->_attach($this);
982
+	}
983
+
984
+	/**
985
+	 * Returns an associative array (column => value) for the primary keys from the table name and an
986
+	 * indexed array of primary key values.
987
+	 *
988
+	 * @param string $tableName
989
+	 * @param array  $indexedPrimaryKeys
990
+	 */
991
+	public function _getPrimaryKeysFromIndexedPrimaryKeys($tableName, array $indexedPrimaryKeys)
992
+	{
993
+		$primaryKeyColumns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getPrimaryKeyColumns();
994
+
995
+		if (count($primaryKeyColumns) !== count($indexedPrimaryKeys)) {
996
+			throw new TDBMException(sprintf('Wrong number of columns passed for primary key. Expected %s columns for table "%s",
997 997
 			got %s instead.', count($primaryKeyColumns), $tableName, count($indexedPrimaryKeys)));
998
-        }
999
-
1000
-        return array_combine($primaryKeyColumns, $indexedPrimaryKeys);
1001
-    }
1002
-
1003
-    /**
1004
-     * Return the list of tables (from child to parent) joining the tables passed in parameter.
1005
-     * Tables must be in a single line of inheritance. The method will find missing tables.
1006
-     *
1007
-     * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1008
-     * we must be able to find all other tables.
1009
-     *
1010
-     * @param string[] $tables
1011
-     *
1012
-     * @return string[]
1013
-     */
1014
-    public function _getLinkBetweenInheritedTables(array $tables)
1015
-    {
1016
-        sort($tables);
1017
-
1018
-        return $this->fromCache($this->cachePrefix.'_linkbetweeninheritedtables_'.implode('__split__', $tables),
1019
-            function () use ($tables) {
1020
-                return $this->_getLinkBetweenInheritedTablesWithoutCache($tables);
1021
-            });
1022
-    }
1023
-
1024
-    /**
1025
-     * Return the list of tables (from child to parent) joining the tables passed in parameter.
1026
-     * Tables must be in a single line of inheritance. The method will find missing tables.
1027
-     *
1028
-     * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1029
-     * we must be able to find all other tables.
1030
-     *
1031
-     * @param string[] $tables
1032
-     *
1033
-     * @return string[]
1034
-     */
1035
-    private function _getLinkBetweenInheritedTablesWithoutCache(array $tables)
1036
-    {
1037
-        $schemaAnalyzer = $this->schemaAnalyzer;
1038
-
1039
-        foreach ($tables as $currentTable) {
1040
-            $allParents = [$currentTable];
1041
-            while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1042
-                $currentTable = $currentFk->getForeignTableName();
1043
-                $allParents[] = $currentTable;
1044
-            };
1045
-
1046
-            // Now, does the $allParents contain all the tables we want?
1047
-            $notFoundTables = array_diff($tables, $allParents);
1048
-            if (empty($notFoundTables)) {
1049
-                // We have a winner!
1050
-                return $allParents;
1051
-            }
1052
-        }
1053
-
1054
-        throw new TDBMException(sprintf('The tables (%s) cannot be linked by an inheritance relationship.', implode(', ', $tables)));
1055
-    }
1056
-
1057
-    /**
1058
-     * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1059
-     *
1060
-     * @param string $table
1061
-     *
1062
-     * @return string[]
1063
-     */
1064
-    public function _getRelatedTablesByInheritance($table)
1065
-    {
1066
-        return $this->fromCache($this->cachePrefix.'_relatedtables_'.$table, function () use ($table) {
1067
-            return $this->_getRelatedTablesByInheritanceWithoutCache($table);
1068
-        });
1069
-    }
1070
-
1071
-    /**
1072
-     * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1073
-     *
1074
-     * @param string $table
1075
-     *
1076
-     * @return string[]
1077
-     */
1078
-    private function _getRelatedTablesByInheritanceWithoutCache($table)
1079
-    {
1080
-        $schemaAnalyzer = $this->schemaAnalyzer;
1081
-
1082
-        // Let's scan the parent tables
1083
-        $currentTable = $table;
1084
-
1085
-        $parentTables = [];
1086
-
1087
-        // Get parent relationship
1088
-        while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1089
-            $currentTable = $currentFk->getForeignTableName();
1090
-            $parentTables[] = $currentTable;
1091
-        };
1092
-
1093
-        // Let's recurse in children
1094
-        $childrenTables = $this->exploreChildrenTablesRelationships($schemaAnalyzer, $table);
1095
-
1096
-        return array_merge(array_reverse($parentTables), $childrenTables);
1097
-    }
1098
-
1099
-    /**
1100
-     * Explore all the children and descendant of $table and returns ForeignKeyConstraints on those.
1101
-     *
1102
-     * @param string $table
1103
-     *
1104
-     * @return string[]
1105
-     */
1106
-    private function exploreChildrenTablesRelationships(SchemaAnalyzer $schemaAnalyzer, $table)
1107
-    {
1108
-        $tables = [$table];
1109
-        $keys = $schemaAnalyzer->getChildrenRelationships($table);
1110
-
1111
-        foreach ($keys as $key) {
1112
-            $tables = array_merge($tables, $this->exploreChildrenTablesRelationships($schemaAnalyzer, $key->getLocalTableName()));
1113
-        }
1114
-
1115
-        return $tables;
1116
-    }
1117
-
1118
-    /**
1119
-     * Casts a foreign key into SQL, assuming table name is used with no alias.
1120
-     * The returned value does contain only one table. For instance:.
1121
-     *
1122
-     * " LEFT JOIN table2 ON table1.id = table2.table1_id"
1123
-     *
1124
-     * @param ForeignKeyConstraint $fk
1125
-     * @param bool                 $leftTableIsLocal
1126
-     *
1127
-     * @return string
1128
-     */
1129
-    /*private function foreignKeyToSql(ForeignKeyConstraint $fk, $leftTableIsLocal) {
998
+		}
999
+
1000
+		return array_combine($primaryKeyColumns, $indexedPrimaryKeys);
1001
+	}
1002
+
1003
+	/**
1004
+	 * Return the list of tables (from child to parent) joining the tables passed in parameter.
1005
+	 * Tables must be in a single line of inheritance. The method will find missing tables.
1006
+	 *
1007
+	 * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1008
+	 * we must be able to find all other tables.
1009
+	 *
1010
+	 * @param string[] $tables
1011
+	 *
1012
+	 * @return string[]
1013
+	 */
1014
+	public function _getLinkBetweenInheritedTables(array $tables)
1015
+	{
1016
+		sort($tables);
1017
+
1018
+		return $this->fromCache($this->cachePrefix.'_linkbetweeninheritedtables_'.implode('__split__', $tables),
1019
+			function () use ($tables) {
1020
+				return $this->_getLinkBetweenInheritedTablesWithoutCache($tables);
1021
+			});
1022
+	}
1023
+
1024
+	/**
1025
+	 * Return the list of tables (from child to parent) joining the tables passed in parameter.
1026
+	 * Tables must be in a single line of inheritance. The method will find missing tables.
1027
+	 *
1028
+	 * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1029
+	 * we must be able to find all other tables.
1030
+	 *
1031
+	 * @param string[] $tables
1032
+	 *
1033
+	 * @return string[]
1034
+	 */
1035
+	private function _getLinkBetweenInheritedTablesWithoutCache(array $tables)
1036
+	{
1037
+		$schemaAnalyzer = $this->schemaAnalyzer;
1038
+
1039
+		foreach ($tables as $currentTable) {
1040
+			$allParents = [$currentTable];
1041
+			while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1042
+				$currentTable = $currentFk->getForeignTableName();
1043
+				$allParents[] = $currentTable;
1044
+			};
1045
+
1046
+			// Now, does the $allParents contain all the tables we want?
1047
+			$notFoundTables = array_diff($tables, $allParents);
1048
+			if (empty($notFoundTables)) {
1049
+				// We have a winner!
1050
+				return $allParents;
1051
+			}
1052
+		}
1053
+
1054
+		throw new TDBMException(sprintf('The tables (%s) cannot be linked by an inheritance relationship.', implode(', ', $tables)));
1055
+	}
1056
+
1057
+	/**
1058
+	 * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1059
+	 *
1060
+	 * @param string $table
1061
+	 *
1062
+	 * @return string[]
1063
+	 */
1064
+	public function _getRelatedTablesByInheritance($table)
1065
+	{
1066
+		return $this->fromCache($this->cachePrefix.'_relatedtables_'.$table, function () use ($table) {
1067
+			return $this->_getRelatedTablesByInheritanceWithoutCache($table);
1068
+		});
1069
+	}
1070
+
1071
+	/**
1072
+	 * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1073
+	 *
1074
+	 * @param string $table
1075
+	 *
1076
+	 * @return string[]
1077
+	 */
1078
+	private function _getRelatedTablesByInheritanceWithoutCache($table)
1079
+	{
1080
+		$schemaAnalyzer = $this->schemaAnalyzer;
1081
+
1082
+		// Let's scan the parent tables
1083
+		$currentTable = $table;
1084
+
1085
+		$parentTables = [];
1086
+
1087
+		// Get parent relationship
1088
+		while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1089
+			$currentTable = $currentFk->getForeignTableName();
1090
+			$parentTables[] = $currentTable;
1091
+		};
1092
+
1093
+		// Let's recurse in children
1094
+		$childrenTables = $this->exploreChildrenTablesRelationships($schemaAnalyzer, $table);
1095
+
1096
+		return array_merge(array_reverse($parentTables), $childrenTables);
1097
+	}
1098
+
1099
+	/**
1100
+	 * Explore all the children and descendant of $table and returns ForeignKeyConstraints on those.
1101
+	 *
1102
+	 * @param string $table
1103
+	 *
1104
+	 * @return string[]
1105
+	 */
1106
+	private function exploreChildrenTablesRelationships(SchemaAnalyzer $schemaAnalyzer, $table)
1107
+	{
1108
+		$tables = [$table];
1109
+		$keys = $schemaAnalyzer->getChildrenRelationships($table);
1110
+
1111
+		foreach ($keys as $key) {
1112
+			$tables = array_merge($tables, $this->exploreChildrenTablesRelationships($schemaAnalyzer, $key->getLocalTableName()));
1113
+		}
1114
+
1115
+		return $tables;
1116
+	}
1117
+
1118
+	/**
1119
+	 * Casts a foreign key into SQL, assuming table name is used with no alias.
1120
+	 * The returned value does contain only one table. For instance:.
1121
+	 *
1122
+	 * " LEFT JOIN table2 ON table1.id = table2.table1_id"
1123
+	 *
1124
+	 * @param ForeignKeyConstraint $fk
1125
+	 * @param bool                 $leftTableIsLocal
1126
+	 *
1127
+	 * @return string
1128
+	 */
1129
+	/*private function foreignKeyToSql(ForeignKeyConstraint $fk, $leftTableIsLocal) {
1130 1130
         $onClauses = [];
1131 1131
         $foreignTableName = $this->connection->quoteIdentifier($fk->getForeignTableName());
1132 1132
         $foreignColumns = $fk->getForeignColumns();
@@ -1152,400 +1152,400 @@  discard block
 block discarded – undo
1152 1152
         }
1153 1153
     }*/
1154 1154
 
1155
-    /**
1156
-     * Returns an identifier for the group of tables passed in parameter.
1157
-     *
1158
-     * @param string[] $relatedTables
1159
-     *
1160
-     * @return string
1161
-     */
1162
-    private function getTableGroupName(array $relatedTables)
1163
-    {
1164
-        sort($relatedTables);
1165
-
1166
-        return implode('_``_', $relatedTables);
1167
-    }
1168
-
1169
-    /**
1170
-     * Returns a `ResultIterator` object representing filtered records of "$mainTable" .
1171
-     *
1172
-     * The findObjects method should be the most used query method in TDBM if you want to query the database for objects.
1173
-     * (Note: if you want to query the database for an object by its primary key, use the findObjectByPk method).
1174
-     *
1175
-     * The findObjects method takes in parameter:
1176
-     * 	- mainTable: the kind of bean you want to retrieve. In TDBM, a bean matches a database row, so the
1177
-     * 			`$mainTable` parameter should be the name of an existing table in database.
1178
-     *  - filter: The filter is a filter bag. It is what you use to filter your request (the WHERE part in SQL).
1179
-     *          It can be a string (SQL Where clause), or even a bean or an associative array (key = column to filter, value = value to find)
1180
-     *  - parameters: The parameters used in the filter. If you pass a SQL string as a filter, be sure to avoid
1181
-     *          concatenating parameters in the string (this leads to SQL injection and also to poor caching performance).
1182
-     *          Instead, please consider passing parameters (see documentation for more details).
1183
-     *  - additionalTablesFetch: An array of SQL tables names. The beans related to those tables will be fetched along
1184
-     *          the main table. This is useful to avoid hitting the database with numerous subqueries.
1185
-     *  - mode: The fetch mode of the result. See `setFetchMode()` method for more details.
1186
-     *
1187
-     * The `findObjects` method will return a `ResultIterator`. A `ResultIterator` is an object that behaves as an array
1188
-     * (in ARRAY mode) at least. It can be iterated using a `foreach` loop.
1189
-     *
1190
-     * Finally, if filter_bag is null, the whole table is returned.
1191
-     *
1192
-     * @param string            $mainTable             The name of the table queried
1193
-     * @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)
1194
-     * @param array             $parameters
1195
-     * @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)
1196
-     * @param array             $additionalTablesFetch
1197
-     * @param int               $mode
1198
-     * @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.
1199
-     *
1200
-     * @return ResultIterator An object representing an array of results.
1201
-     *
1202
-     * @throws TDBMException
1203
-     */
1204
-    public function findObjects($mainTable, $filter = null, array $parameters = array(), $orderString = null, array $additionalTablesFetch = array(), $mode = null, $className = null)
1205
-    {
1206
-        // $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
1207
-        if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
1208
-            throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
1209
-        }
1210
-
1211
-        list($filterString, $additionalParameters) = $this->buildFilterFromFilterBag($filter);
1212
-
1213
-        $parameters = array_merge($parameters, $additionalParameters);
1214
-
1215
-        // From the table name and the additional tables we want to fetch, let's build a list of all tables
1216
-        // that must be part of the select columns.
1217
-
1218
-        $tableGroups = [];
1219
-        $allFetchedTables = $this->_getRelatedTablesByInheritance($mainTable);
1220
-        $tableGroupName = $this->getTableGroupName($allFetchedTables);
1221
-        foreach ($allFetchedTables as $table) {
1222
-            $tableGroups[$table] = $tableGroupName;
1223
-        }
1224
-
1225
-        foreach ($additionalTablesFetch as $additionalTable) {
1226
-            $relatedTables = $this->_getRelatedTablesByInheritance($additionalTable);
1227
-            $tableGroupName = $this->getTableGroupName($relatedTables);
1228
-            foreach ($relatedTables as $table) {
1229
-                $tableGroups[$table] = $tableGroupName;
1230
-            }
1231
-            $allFetchedTables = array_merge($allFetchedTables, $relatedTables);
1232
-        }
1233
-
1234
-        // Let's remove any duplicate
1235
-        $allFetchedTables = array_flip(array_flip($allFetchedTables));
1236
-
1237
-        $columnsList = [];
1238
-        $columnDescList = [];
1239
-        $schema = $this->tdbmSchemaAnalyzer->getSchema();
1240
-
1241
-        // Now, let's build the column list
1242
-        foreach ($allFetchedTables as $table) {
1243
-            foreach ($schema->getTable($table)->getColumns() as $column) {
1244
-                $columnName = $column->getName();
1245
-                $columnDescList[] = [
1246
-                    'as' => $table.'____'.$columnName,
1247
-                    'table' => $table,
1248
-                    'column' => $columnName,
1249
-                    'type' => $column->getType(),
1250
-                    'tableGroup' => $tableGroups[$table],
1251
-                ];
1252
-                $columnsList[] = $this->connection->quoteIdentifier($table).'.'.$this->connection->quoteIdentifier($columnName).' as '.
1253
-                    $this->connection->quoteIdentifier($table.'____'.$columnName);
1254
-            }
1255
-        }
1256
-
1257
-        $sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$mainTable.')';
1258
-        $countSql = 'SELECT COUNT(1) FROM MAGICJOIN('.$mainTable.')';
1259
-
1260
-        if (!empty($filterString)) {
1261
-            $sql .= ' WHERE '.$filterString;
1262
-            $countSql .= ' WHERE '.$filterString;
1263
-        }
1264
-
1265
-        if (!empty($orderString)) {
1266
-            $sql .= ' ORDER BY '.$orderString;
1267
-            $countSql .= ' ORDER BY '.$orderString;
1268
-        }
1269
-
1270
-        if ($mode !== null && $mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
1271
-            throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
1272
-        }
1273
-
1274
-        $mode = $mode ?: $this->mode;
1275
-
1276
-        return new ResultIterator($sql, $countSql, $parameters, $columnDescList, $this->objectStorage, $className, $this, $this->magicQuery, $mode);
1277
-    }
1278
-
1279
-    /**
1280
-     * @param $table
1281
-     * @param array  $primaryKeys
1282
-     * @param array  $additionalTablesFetch
1283
-     * @param bool   $lazy                  Whether to perform lazy loading on this object or not.
1284
-     * @param string $className
1285
-     *
1286
-     * @return AbstractTDBMObject
1287
-     *
1288
-     * @throws TDBMException
1289
-     */
1290
-    public function findObjectByPk($table, array $primaryKeys, array $additionalTablesFetch = array(), $lazy = false, $className = null)
1291
-    {
1292
-        $primaryKeys = $this->_getPrimaryKeysFromObjectData($table, $primaryKeys);
1293
-        $hash = $this->getObjectHash($primaryKeys);
1294
-
1295
-        if ($this->objectStorage->has($table, $hash)) {
1296
-            $dbRow = $this->objectStorage->get($table, $hash);
1297
-            $bean = $dbRow->getTDBMObject();
1298
-            if ($className !== null && !is_a($bean, $className)) {
1299
-                throw new TDBMException("TDBM cannot create a bean of class '".$className."'. The requested object was already loaded and its class is '".get_class($bean)."'");
1300
-            }
1301
-
1302
-            return $bean;
1303
-        }
1304
-
1305
-        // Are we performing lazy fetching?
1306
-        if ($lazy === true) {
1307
-            // Can we perform lazy fetching?
1308
-            $tables = $this->_getRelatedTablesByInheritance($table);
1309
-            // Only allowed if no inheritance.
1310
-            if (count($tables) === 1) {
1311
-                if ($className === null) {
1312
-                    $className = isset($this->tableToBeanMap[$table]) ? $this->tableToBeanMap[$table] : 'Mouf\\Database\\TDBM\\TDBMObject';
1313
-                }
1314
-
1315
-                // Let's construct the bean
1316
-                if (!isset($this->reflectionClassCache[$className])) {
1317
-                    $this->reflectionClassCache[$className] = new \ReflectionClass($className);
1318
-                }
1319
-                // Let's bypass the constructor when creating the bean!
1320
-                $bean = $this->reflectionClassCache[$className]->newInstanceWithoutConstructor();
1321
-                /* @var $bean AbstractTDBMObject */
1322
-                $bean->_constructLazy($table, $primaryKeys, $this);
1323
-
1324
-                return $bean;
1325
-            }
1326
-        }
1327
-
1328
-        // Did not find the object in cache? Let's query it!
1329
-        return $this->findObjectOrFail($table, $primaryKeys, [], $additionalTablesFetch, $className);
1330
-    }
1331
-
1332
-    /**
1333
-     * Returns a unique bean (or null) according to the filters passed in parameter.
1334
-     *
1335
-     * @param string            $mainTable             The name of the table queried
1336
-     * @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)
1337
-     * @param array             $parameters
1338
-     * @param array             $additionalTablesFetch
1339
-     * @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.
1340
-     *
1341
-     * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters.
1342
-     *
1343
-     * @throws TDBMException
1344
-     */
1345
-    public function findObject($mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null)
1346
-    {
1347
-        $objects = $this->findObjects($mainTable, $filter, $parameters, null, $additionalTablesFetch, self::MODE_ARRAY, $className);
1348
-        $page = $objects->take(0, 2);
1349
-        $count = $page->count();
1350
-        if ($count > 1) {
1351
-            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.");
1352
-        } elseif ($count === 0) {
1353
-            return;
1354
-        }
1355
-
1356
-        return $objects[0];
1357
-    }
1358
-
1359
-    /**
1360
-     * Returns a unique bean according to the filters passed in parameter.
1361
-     * Throws a NoBeanFoundException if no bean was found for the filter passed in parameter.
1362
-     *
1363
-     * @param string            $mainTable             The name of the table queried
1364
-     * @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)
1365
-     * @param array             $parameters
1366
-     * @param array             $additionalTablesFetch
1367
-     * @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.
1368
-     *
1369
-     * @return AbstractTDBMObject The object we want
1370
-     *
1371
-     * @throws TDBMException
1372
-     */
1373
-    public function findObjectOrFail($mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null)
1374
-    {
1375
-        $bean = $this->findObject($mainTable, $filter, $parameters, $additionalTablesFetch, $className);
1376
-        if ($bean === null) {
1377
-            throw new NoBeanFoundException("No result found for query on table '".$mainTable."'");
1378
-        }
1379
-
1380
-        return $bean;
1381
-    }
1382
-
1383
-    /**
1384
-     * @param array $beanData An array of data: array<table, array<column, value>>
1385
-     *
1386
-     * @return array an array with first item = class name and second item = table name
1387
-     */
1388
-    public function _getClassNameFromBeanData(array $beanData)
1389
-    {
1390
-        if (count($beanData) === 1) {
1391
-            $tableName = array_keys($beanData)[0];
1392
-        } else {
1393
-            $tables = [];
1394
-            foreach ($beanData as $table => $row) {
1395
-                $primaryKeyColumns = $this->getPrimaryKeyColumns($table);
1396
-                $pkSet = false;
1397
-                foreach ($primaryKeyColumns as $columnName) {
1398
-                    if ($row[$columnName] !== null) {
1399
-                        $pkSet = true;
1400
-                        break;
1401
-                    }
1402
-                }
1403
-                if ($pkSet) {
1404
-                    $tables[] = $table;
1405
-                }
1406
-            }
1407
-
1408
-            // $tables contains the tables for this bean. Let's view the top most part of the hierarchy
1409
-            $allTables = $this->_getLinkBetweenInheritedTables($tables);
1410
-            $tableName = $allTables[0];
1411
-        }
1412
-
1413
-        // Only one table in this bean. Life is sweat, let's look at its type:
1414
-        if (isset($this->tableToBeanMap[$tableName])) {
1415
-            return [$this->tableToBeanMap[$tableName], $tableName];
1416
-        } else {
1417
-            return ['Mouf\\Database\\TDBM\\TDBMObject', $tableName];
1418
-        }
1419
-    }
1420
-
1421
-    /**
1422
-     * Returns an item from cache or computes it using $closure and puts it in cache.
1423
-     *
1424
-     * @param string   $key
1425
-     * @param callable $closure
1426
-     *
1427
-     * @return mixed
1428
-     */
1429
-    private function fromCache($key, callable $closure)
1430
-    {
1431
-        $item = $this->cache->fetch($key);
1432
-        if ($item === false) {
1433
-            $item = $closure();
1434
-            $this->cache->save($key, $item);
1435
-        }
1436
-
1437
-        return $item;
1438
-    }
1439
-
1440
-    /**
1441
-     * Returns the foreign key object.
1442
-     *
1443
-     * @param string $table
1444
-     * @param string $fkName
1445
-     *
1446
-     * @return ForeignKeyConstraint
1447
-     */
1448
-    public function _getForeignKeyByName($table, $fkName)
1449
-    {
1450
-        return $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getForeignKey($fkName);
1451
-    }
1452
-
1453
-    /**
1454
-     * @param $pivotTableName
1455
-     * @param AbstractTDBMObject $bean
1456
-     *
1457
-     * @return AbstractTDBMObject[]
1458
-     */
1459
-    public function _getRelatedBeans($pivotTableName, AbstractTDBMObject $bean)
1460
-    {
1461
-        list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $bean);
1462
-        /* @var $localFk ForeignKeyConstraint */
1463
-        /* @var $remoteFk ForeignKeyConstraint */
1464
-        $remoteTable = $remoteFk->getForeignTableName();
1465
-
1466
-        $primaryKeys = $this->getPrimaryKeyValues($bean);
1467
-        $columnNames = array_map(function ($name) use ($pivotTableName) { return $pivotTableName.'.'.$name; }, $localFk->getLocalColumns());
1468
-
1469
-        $filter = array_combine($columnNames, $primaryKeys);
1470
-
1471
-        return $this->findObjects($remoteTable, $filter);
1472
-    }
1473
-
1474
-    /**
1475
-     * @param $pivotTableName
1476
-     * @param AbstractTDBMObject $bean The LOCAL bean
1477
-     *
1478
-     * @return ForeignKeyConstraint[] First item: the LOCAL bean, second item: the REMOTE bean.
1479
-     *
1480
-     * @throws TDBMException
1481
-     */
1482
-    private function getPivotTableForeignKeys($pivotTableName, AbstractTDBMObject $bean)
1483
-    {
1484
-        $fks = array_values($this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName)->getForeignKeys());
1485
-        $table1 = $fks[0]->getForeignTableName();
1486
-        $table2 = $fks[1]->getForeignTableName();
1487
-
1488
-        $beanTables = array_map(function (DbRow $dbRow) { return $dbRow->_getDbTableName(); }, $bean->_getDbRows());
1489
-
1490
-        if (in_array($table1, $beanTables)) {
1491
-            return [$fks[0], $fks[1]];
1492
-        } elseif (in_array($table2, $beanTables)) {
1493
-            return [$fks[1], $fks[0]];
1494
-        } else {
1495
-            throw new TDBMException("Unexpected bean type in getPivotTableForeignKeys. Awaiting beans from table {$table1} and {$table2} for pivot table {$pivotTableName}");
1496
-        }
1497
-    }
1498
-
1499
-    /**
1500
-     * Returns a list of pivot tables linked to $bean.
1501
-     *
1502
-     * @param AbstractTDBMObject $bean
1503
-     *
1504
-     * @return string[]
1505
-     */
1506
-    public function _getPivotTablesLinkedToBean(AbstractTDBMObject $bean)
1507
-    {
1508
-        $junctionTables = [];
1509
-        $allJunctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
1510
-        foreach ($bean->_getDbRows() as $dbRow) {
1511
-            foreach ($allJunctionTables as $table) {
1512
-                // There are exactly 2 FKs since this is a pivot table.
1513
-                $fks = array_values($table->getForeignKeys());
1514
-
1515
-                if ($fks[0]->getForeignTableName() === $dbRow->_getDbTableName() || $fks[1]->getForeignTableName() === $dbRow->_getDbTableName()) {
1516
-                    $junctionTables[] = $table->getName();
1517
-                }
1518
-            }
1519
-        }
1520
-
1521
-        return $junctionTables;
1522
-    }
1523
-
1524
-    /**
1525
-     * Array of types for tables.
1526
-     * Key: table name
1527
-     * Value: array of types indexed by column.
1528
-     *
1529
-     * @var array[]
1530
-     */
1531
-    private $typesForTable = [];
1532
-
1533
-    /**
1534
-     * @internal
1535
-     *
1536
-     * @param string $tableName
1537
-     *
1538
-     * @return Type[]
1539
-     */
1540
-    public function _getColumnTypesForTable($tableName)
1541
-    {
1542
-        if (!isset($typesForTable[$tableName])) {
1543
-            $columns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getColumns();
1544
-            $typesForTable[$tableName] = array_map(function (Column $column) {
1545
-                return $column->getType();
1546
-            }, $columns);
1547
-        }
1548
-
1549
-        return $typesForTable[$tableName];
1550
-    }
1155
+	/**
1156
+	 * Returns an identifier for the group of tables passed in parameter.
1157
+	 *
1158
+	 * @param string[] $relatedTables
1159
+	 *
1160
+	 * @return string
1161
+	 */
1162
+	private function getTableGroupName(array $relatedTables)
1163
+	{
1164
+		sort($relatedTables);
1165
+
1166
+		return implode('_``_', $relatedTables);
1167
+	}
1168
+
1169
+	/**
1170
+	 * Returns a `ResultIterator` object representing filtered records of "$mainTable" .
1171
+	 *
1172
+	 * The findObjects method should be the most used query method in TDBM if you want to query the database for objects.
1173
+	 * (Note: if you want to query the database for an object by its primary key, use the findObjectByPk method).
1174
+	 *
1175
+	 * The findObjects method takes in parameter:
1176
+	 * 	- mainTable: the kind of bean you want to retrieve. In TDBM, a bean matches a database row, so the
1177
+	 * 			`$mainTable` parameter should be the name of an existing table in database.
1178
+	 *  - filter: The filter is a filter bag. It is what you use to filter your request (the WHERE part in SQL).
1179
+	 *          It can be a string (SQL Where clause), or even a bean or an associative array (key = column to filter, value = value to find)
1180
+	 *  - parameters: The parameters used in the filter. If you pass a SQL string as a filter, be sure to avoid
1181
+	 *          concatenating parameters in the string (this leads to SQL injection and also to poor caching performance).
1182
+	 *          Instead, please consider passing parameters (see documentation for more details).
1183
+	 *  - additionalTablesFetch: An array of SQL tables names. The beans related to those tables will be fetched along
1184
+	 *          the main table. This is useful to avoid hitting the database with numerous subqueries.
1185
+	 *  - mode: The fetch mode of the result. See `setFetchMode()` method for more details.
1186
+	 *
1187
+	 * The `findObjects` method will return a `ResultIterator`. A `ResultIterator` is an object that behaves as an array
1188
+	 * (in ARRAY mode) at least. It can be iterated using a `foreach` loop.
1189
+	 *
1190
+	 * Finally, if filter_bag is null, the whole table is returned.
1191
+	 *
1192
+	 * @param string            $mainTable             The name of the table queried
1193
+	 * @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)
1194
+	 * @param array             $parameters
1195
+	 * @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)
1196
+	 * @param array             $additionalTablesFetch
1197
+	 * @param int               $mode
1198
+	 * @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.
1199
+	 *
1200
+	 * @return ResultIterator An object representing an array of results.
1201
+	 *
1202
+	 * @throws TDBMException
1203
+	 */
1204
+	public function findObjects($mainTable, $filter = null, array $parameters = array(), $orderString = null, array $additionalTablesFetch = array(), $mode = null, $className = null)
1205
+	{
1206
+		// $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
1207
+		if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
1208
+			throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
1209
+		}
1210
+
1211
+		list($filterString, $additionalParameters) = $this->buildFilterFromFilterBag($filter);
1212
+
1213
+		$parameters = array_merge($parameters, $additionalParameters);
1214
+
1215
+		// From the table name and the additional tables we want to fetch, let's build a list of all tables
1216
+		// that must be part of the select columns.
1217
+
1218
+		$tableGroups = [];
1219
+		$allFetchedTables = $this->_getRelatedTablesByInheritance($mainTable);
1220
+		$tableGroupName = $this->getTableGroupName($allFetchedTables);
1221
+		foreach ($allFetchedTables as $table) {
1222
+			$tableGroups[$table] = $tableGroupName;
1223
+		}
1224
+
1225
+		foreach ($additionalTablesFetch as $additionalTable) {
1226
+			$relatedTables = $this->_getRelatedTablesByInheritance($additionalTable);
1227
+			$tableGroupName = $this->getTableGroupName($relatedTables);
1228
+			foreach ($relatedTables as $table) {
1229
+				$tableGroups[$table] = $tableGroupName;
1230
+			}
1231
+			$allFetchedTables = array_merge($allFetchedTables, $relatedTables);
1232
+		}
1233
+
1234
+		// Let's remove any duplicate
1235
+		$allFetchedTables = array_flip(array_flip($allFetchedTables));
1236
+
1237
+		$columnsList = [];
1238
+		$columnDescList = [];
1239
+		$schema = $this->tdbmSchemaAnalyzer->getSchema();
1240
+
1241
+		// Now, let's build the column list
1242
+		foreach ($allFetchedTables as $table) {
1243
+			foreach ($schema->getTable($table)->getColumns() as $column) {
1244
+				$columnName = $column->getName();
1245
+				$columnDescList[] = [
1246
+					'as' => $table.'____'.$columnName,
1247
+					'table' => $table,
1248
+					'column' => $columnName,
1249
+					'type' => $column->getType(),
1250
+					'tableGroup' => $tableGroups[$table],
1251
+				];
1252
+				$columnsList[] = $this->connection->quoteIdentifier($table).'.'.$this->connection->quoteIdentifier($columnName).' as '.
1253
+					$this->connection->quoteIdentifier($table.'____'.$columnName);
1254
+			}
1255
+		}
1256
+
1257
+		$sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$mainTable.')';
1258
+		$countSql = 'SELECT COUNT(1) FROM MAGICJOIN('.$mainTable.')';
1259
+
1260
+		if (!empty($filterString)) {
1261
+			$sql .= ' WHERE '.$filterString;
1262
+			$countSql .= ' WHERE '.$filterString;
1263
+		}
1264
+
1265
+		if (!empty($orderString)) {
1266
+			$sql .= ' ORDER BY '.$orderString;
1267
+			$countSql .= ' ORDER BY '.$orderString;
1268
+		}
1269
+
1270
+		if ($mode !== null && $mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
1271
+			throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
1272
+		}
1273
+
1274
+		$mode = $mode ?: $this->mode;
1275
+
1276
+		return new ResultIterator($sql, $countSql, $parameters, $columnDescList, $this->objectStorage, $className, $this, $this->magicQuery, $mode);
1277
+	}
1278
+
1279
+	/**
1280
+	 * @param $table
1281
+	 * @param array  $primaryKeys
1282
+	 * @param array  $additionalTablesFetch
1283
+	 * @param bool   $lazy                  Whether to perform lazy loading on this object or not.
1284
+	 * @param string $className
1285
+	 *
1286
+	 * @return AbstractTDBMObject
1287
+	 *
1288
+	 * @throws TDBMException
1289
+	 */
1290
+	public function findObjectByPk($table, array $primaryKeys, array $additionalTablesFetch = array(), $lazy = false, $className = null)
1291
+	{
1292
+		$primaryKeys = $this->_getPrimaryKeysFromObjectData($table, $primaryKeys);
1293
+		$hash = $this->getObjectHash($primaryKeys);
1294
+
1295
+		if ($this->objectStorage->has($table, $hash)) {
1296
+			$dbRow = $this->objectStorage->get($table, $hash);
1297
+			$bean = $dbRow->getTDBMObject();
1298
+			if ($className !== null && !is_a($bean, $className)) {
1299
+				throw new TDBMException("TDBM cannot create a bean of class '".$className."'. The requested object was already loaded and its class is '".get_class($bean)."'");
1300
+			}
1301
+
1302
+			return $bean;
1303
+		}
1304
+
1305
+		// Are we performing lazy fetching?
1306
+		if ($lazy === true) {
1307
+			// Can we perform lazy fetching?
1308
+			$tables = $this->_getRelatedTablesByInheritance($table);
1309
+			// Only allowed if no inheritance.
1310
+			if (count($tables) === 1) {
1311
+				if ($className === null) {
1312
+					$className = isset($this->tableToBeanMap[$table]) ? $this->tableToBeanMap[$table] : 'Mouf\\Database\\TDBM\\TDBMObject';
1313
+				}
1314
+
1315
+				// Let's construct the bean
1316
+				if (!isset($this->reflectionClassCache[$className])) {
1317
+					$this->reflectionClassCache[$className] = new \ReflectionClass($className);
1318
+				}
1319
+				// Let's bypass the constructor when creating the bean!
1320
+				$bean = $this->reflectionClassCache[$className]->newInstanceWithoutConstructor();
1321
+				/* @var $bean AbstractTDBMObject */
1322
+				$bean->_constructLazy($table, $primaryKeys, $this);
1323
+
1324
+				return $bean;
1325
+			}
1326
+		}
1327
+
1328
+		// Did not find the object in cache? Let's query it!
1329
+		return $this->findObjectOrFail($table, $primaryKeys, [], $additionalTablesFetch, $className);
1330
+	}
1331
+
1332
+	/**
1333
+	 * Returns a unique bean (or null) according to the filters passed in parameter.
1334
+	 *
1335
+	 * @param string            $mainTable             The name of the table queried
1336
+	 * @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)
1337
+	 * @param array             $parameters
1338
+	 * @param array             $additionalTablesFetch
1339
+	 * @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.
1340
+	 *
1341
+	 * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters.
1342
+	 *
1343
+	 * @throws TDBMException
1344
+	 */
1345
+	public function findObject($mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null)
1346
+	{
1347
+		$objects = $this->findObjects($mainTable, $filter, $parameters, null, $additionalTablesFetch, self::MODE_ARRAY, $className);
1348
+		$page = $objects->take(0, 2);
1349
+		$count = $page->count();
1350
+		if ($count > 1) {
1351
+			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.");
1352
+		} elseif ($count === 0) {
1353
+			return;
1354
+		}
1355
+
1356
+		return $objects[0];
1357
+	}
1358
+
1359
+	/**
1360
+	 * Returns a unique bean according to the filters passed in parameter.
1361
+	 * Throws a NoBeanFoundException if no bean was found for the filter passed in parameter.
1362
+	 *
1363
+	 * @param string            $mainTable             The name of the table queried
1364
+	 * @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)
1365
+	 * @param array             $parameters
1366
+	 * @param array             $additionalTablesFetch
1367
+	 * @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.
1368
+	 *
1369
+	 * @return AbstractTDBMObject The object we want
1370
+	 *
1371
+	 * @throws TDBMException
1372
+	 */
1373
+	public function findObjectOrFail($mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), $className = null)
1374
+	{
1375
+		$bean = $this->findObject($mainTable, $filter, $parameters, $additionalTablesFetch, $className);
1376
+		if ($bean === null) {
1377
+			throw new NoBeanFoundException("No result found for query on table '".$mainTable."'");
1378
+		}
1379
+
1380
+		return $bean;
1381
+	}
1382
+
1383
+	/**
1384
+	 * @param array $beanData An array of data: array<table, array<column, value>>
1385
+	 *
1386
+	 * @return array an array with first item = class name and second item = table name
1387
+	 */
1388
+	public function _getClassNameFromBeanData(array $beanData)
1389
+	{
1390
+		if (count($beanData) === 1) {
1391
+			$tableName = array_keys($beanData)[0];
1392
+		} else {
1393
+			$tables = [];
1394
+			foreach ($beanData as $table => $row) {
1395
+				$primaryKeyColumns = $this->getPrimaryKeyColumns($table);
1396
+				$pkSet = false;
1397
+				foreach ($primaryKeyColumns as $columnName) {
1398
+					if ($row[$columnName] !== null) {
1399
+						$pkSet = true;
1400
+						break;
1401
+					}
1402
+				}
1403
+				if ($pkSet) {
1404
+					$tables[] = $table;
1405
+				}
1406
+			}
1407
+
1408
+			// $tables contains the tables for this bean. Let's view the top most part of the hierarchy
1409
+			$allTables = $this->_getLinkBetweenInheritedTables($tables);
1410
+			$tableName = $allTables[0];
1411
+		}
1412
+
1413
+		// Only one table in this bean. Life is sweat, let's look at its type:
1414
+		if (isset($this->tableToBeanMap[$tableName])) {
1415
+			return [$this->tableToBeanMap[$tableName], $tableName];
1416
+		} else {
1417
+			return ['Mouf\\Database\\TDBM\\TDBMObject', $tableName];
1418
+		}
1419
+	}
1420
+
1421
+	/**
1422
+	 * Returns an item from cache or computes it using $closure and puts it in cache.
1423
+	 *
1424
+	 * @param string   $key
1425
+	 * @param callable $closure
1426
+	 *
1427
+	 * @return mixed
1428
+	 */
1429
+	private function fromCache($key, callable $closure)
1430
+	{
1431
+		$item = $this->cache->fetch($key);
1432
+		if ($item === false) {
1433
+			$item = $closure();
1434
+			$this->cache->save($key, $item);
1435
+		}
1436
+
1437
+		return $item;
1438
+	}
1439
+
1440
+	/**
1441
+	 * Returns the foreign key object.
1442
+	 *
1443
+	 * @param string $table
1444
+	 * @param string $fkName
1445
+	 *
1446
+	 * @return ForeignKeyConstraint
1447
+	 */
1448
+	public function _getForeignKeyByName($table, $fkName)
1449
+	{
1450
+		return $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getForeignKey($fkName);
1451
+	}
1452
+
1453
+	/**
1454
+	 * @param $pivotTableName
1455
+	 * @param AbstractTDBMObject $bean
1456
+	 *
1457
+	 * @return AbstractTDBMObject[]
1458
+	 */
1459
+	public function _getRelatedBeans($pivotTableName, AbstractTDBMObject $bean)
1460
+	{
1461
+		list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $bean);
1462
+		/* @var $localFk ForeignKeyConstraint */
1463
+		/* @var $remoteFk ForeignKeyConstraint */
1464
+		$remoteTable = $remoteFk->getForeignTableName();
1465
+
1466
+		$primaryKeys = $this->getPrimaryKeyValues($bean);
1467
+		$columnNames = array_map(function ($name) use ($pivotTableName) { return $pivotTableName.'.'.$name; }, $localFk->getLocalColumns());
1468
+
1469
+		$filter = array_combine($columnNames, $primaryKeys);
1470
+
1471
+		return $this->findObjects($remoteTable, $filter);
1472
+	}
1473
+
1474
+	/**
1475
+	 * @param $pivotTableName
1476
+	 * @param AbstractTDBMObject $bean The LOCAL bean
1477
+	 *
1478
+	 * @return ForeignKeyConstraint[] First item: the LOCAL bean, second item: the REMOTE bean.
1479
+	 *
1480
+	 * @throws TDBMException
1481
+	 */
1482
+	private function getPivotTableForeignKeys($pivotTableName, AbstractTDBMObject $bean)
1483
+	{
1484
+		$fks = array_values($this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName)->getForeignKeys());
1485
+		$table1 = $fks[0]->getForeignTableName();
1486
+		$table2 = $fks[1]->getForeignTableName();
1487
+
1488
+		$beanTables = array_map(function (DbRow $dbRow) { return $dbRow->_getDbTableName(); }, $bean->_getDbRows());
1489
+
1490
+		if (in_array($table1, $beanTables)) {
1491
+			return [$fks[0], $fks[1]];
1492
+		} elseif (in_array($table2, $beanTables)) {
1493
+			return [$fks[1], $fks[0]];
1494
+		} else {
1495
+			throw new TDBMException("Unexpected bean type in getPivotTableForeignKeys. Awaiting beans from table {$table1} and {$table2} for pivot table {$pivotTableName}");
1496
+		}
1497
+	}
1498
+
1499
+	/**
1500
+	 * Returns a list of pivot tables linked to $bean.
1501
+	 *
1502
+	 * @param AbstractTDBMObject $bean
1503
+	 *
1504
+	 * @return string[]
1505
+	 */
1506
+	public function _getPivotTablesLinkedToBean(AbstractTDBMObject $bean)
1507
+	{
1508
+		$junctionTables = [];
1509
+		$allJunctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
1510
+		foreach ($bean->_getDbRows() as $dbRow) {
1511
+			foreach ($allJunctionTables as $table) {
1512
+				// There are exactly 2 FKs since this is a pivot table.
1513
+				$fks = array_values($table->getForeignKeys());
1514
+
1515
+				if ($fks[0]->getForeignTableName() === $dbRow->_getDbTableName() || $fks[1]->getForeignTableName() === $dbRow->_getDbTableName()) {
1516
+					$junctionTables[] = $table->getName();
1517
+				}
1518
+			}
1519
+		}
1520
+
1521
+		return $junctionTables;
1522
+	}
1523
+
1524
+	/**
1525
+	 * Array of types for tables.
1526
+	 * Key: table name
1527
+	 * Value: array of types indexed by column.
1528
+	 *
1529
+	 * @var array[]
1530
+	 */
1531
+	private $typesForTable = [];
1532
+
1533
+	/**
1534
+	 * @internal
1535
+	 *
1536
+	 * @param string $tableName
1537
+	 *
1538
+	 * @return Type[]
1539
+	 */
1540
+	public function _getColumnTypesForTable($tableName)
1541
+	{
1542
+		if (!isset($typesForTable[$tableName])) {
1543
+			$columns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getColumns();
1544
+			$typesForTable[$tableName] = array_map(function (Column $column) {
1545
+				return $column->getType();
1546
+			}, $columns);
1547
+		}
1548
+
1549
+		return $typesForTable[$tableName];
1550
+	}
1551 1551
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/Utils/TDBMDaoGenerator.php 1 patch
Indentation   +471 added lines, -471 removed lines patch added patch discarded remove patch
@@ -17,200 +17,200 @@  discard block
 block discarded – undo
17 17
  */
18 18
 class TDBMDaoGenerator
19 19
 {
20
-    /**
21
-     * @var SchemaAnalyzer
22
-     */
23
-    private $schemaAnalyzer;
24
-
25
-    /**
26
-     * @var Schema
27
-     */
28
-    private $schema;
29
-
30
-    /**
31
-     * The root directory of the project.
32
-     *
33
-     * @var string
34
-     */
35
-    private $rootPath;
36
-
37
-    /**
38
-     * Name of composer file.
39
-     *
40
-     * @var string
41
-     */
42
-    private $composerFile;
43
-
44
-    /**
45
-     * @var TDBMSchemaAnalyzer
46
-     */
47
-    private $tdbmSchemaAnalyzer;
48
-
49
-    /**
50
-     * Constructor.
51
-     *
52
-     * @param SchemaAnalyzer     $schemaAnalyzer
53
-     * @param Schema             $schema
54
-     * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer
55
-     */
56
-    public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
57
-    {
58
-        $this->schemaAnalyzer = $schemaAnalyzer;
59
-        $this->schema = $schema;
60
-        $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
61
-        $this->rootPath = __DIR__.'/../../../../../../../../';
62
-        $this->composerFile = 'composer.json';
63
-    }
64
-
65
-    /**
66
-     * Generates all the daos and beans.
67
-     *
68
-     * @param string $daoFactoryClassName The classe name of the DAO factory
69
-     * @param string $daonamespace        The namespace for the DAOs, without trailing \
70
-     * @param string $beannamespace       The Namespace for the beans, without trailing \
71
-     * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone.
72
-     *
73
-     * @return \string[] the list of tables
74
-     *
75
-     * @throws TDBMException
76
-     */
77
-    public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc)
78
-    {
79
-        $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.$this->composerFile);
80
-        // TODO: check that no class name ends with "Base". Otherwise, there will be name clash.
81
-
82
-        $tableList = $this->schema->getTables();
83
-
84
-        // Remove all beans and daos from junction tables
85
-        $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
86
-        $junctionTableNames = array_map(function (Table $table) {
87
-            return $table->getName();
88
-        }, $junctionTables);
89
-
90
-        $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) {
91
-            return !in_array($table->getName(), $junctionTableNames);
92
-        });
93
-
94
-        foreach ($tableList as $table) {
95
-            $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc);
96
-        }
97
-
98
-        $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper);
99
-
100
-        // Ok, let's return the list of all tables.
101
-        // These will be used by the calling script to create Mouf instances.
102
-
103
-        return array_map(function (Table $table) { return $table->getName(); }, $tableList);
104
-    }
105
-
106
-    /**
107
-     * Generates in one method call the daos and the beans for one table.
108
-     *
109
-     * @param Table           $table
110
-     * @param string          $daonamespace
111
-     * @param string          $beannamespace
112
-     * @param ClassNameMapper $classNameMapper
113
-     * @param bool            $storeInUtc
114
-     *
115
-     * @throws TDBMException
116
-     */
117
-    public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
118
-    {
119
-        $tableName = $table->getName();
120
-        $daoName = $this->getDaoNameFromTableName($tableName);
121
-        $beanName = $this->getBeanNameFromTableName($tableName);
122
-        $baseBeanName = $this->getBaseBeanNameFromTableName($tableName);
123
-        $baseDaoName = $this->getBaseDaoNameFromTableName($tableName);
124
-
125
-        $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer);
126
-        $this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc);
127
-        $this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper);
128
-    }
129
-
130
-    /**
131
-     * Returns the name of the bean class from the table name.
132
-     *
133
-     * @param $tableName
134
-     *
135
-     * @return string
136
-     */
137
-    public static function getBeanNameFromTableName($tableName)
138
-    {
139
-        return self::toSingular(self::toCamelCase($tableName)).'Bean';
140
-    }
141
-
142
-    /**
143
-     * Returns the name of the DAO class from the table name.
144
-     *
145
-     * @param $tableName
146
-     *
147
-     * @return string
148
-     */
149
-    public static function getDaoNameFromTableName($tableName)
150
-    {
151
-        return self::toSingular(self::toCamelCase($tableName)).'Dao';
152
-    }
153
-
154
-    /**
155
-     * Returns the name of the base bean class from the table name.
156
-     *
157
-     * @param $tableName
158
-     *
159
-     * @return string
160
-     */
161
-    public static function getBaseBeanNameFromTableName($tableName)
162
-    {
163
-        return self::toSingular(self::toCamelCase($tableName)).'BaseBean';
164
-    }
165
-
166
-    /**
167
-     * Returns the name of the base DAO class from the table name.
168
-     *
169
-     * @param $tableName
170
-     *
171
-     * @return string
172
-     */
173
-    public static function getBaseDaoNameFromTableName($tableName)
174
-    {
175
-        return self::toSingular(self::toCamelCase($tableName)).'BaseDao';
176
-    }
177
-
178
-    /**
179
-     * Writes the PHP bean file with all getters and setters from the table passed in parameter.
180
-     *
181
-     * @param BeanDescriptor  $beanDescriptor
182
-     * @param string          $className       The name of the class
183
-     * @param string          $baseClassName   The name of the base class which will be extended (name only, no directory)
184
-     * @param Table           $table           The table
185
-     * @param string          $beannamespace   The namespace of the bean
186
-     * @param ClassNameMapper $classNameMapper
187
-     *
188
-     * @throws TDBMException
189
-     */
190
-    public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
191
-    {
192
-        $str = $beanDescriptor->generatePhpCode($beannamespace);
193
-
194
-        $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\Generated\\'.$baseClassName);
195
-        if (empty($possibleBaseFileNames)) {
196
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.');
197
-        }
198
-        $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
199
-
200
-        $this->ensureDirectoryExist($possibleBaseFileName);
201
-        file_put_contents($possibleBaseFileName, $str);
202
-        @chmod($possibleBaseFileName, 0664);
203
-
204
-        $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className);
205
-        if (empty($possibleFileNames)) {
206
-            // @codeCoverageIgnoreStart
207
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.');
208
-            // @codeCoverageIgnoreEnd
209
-        }
210
-        $possibleFileName = $this->rootPath.$possibleFileNames[0];
211
-        if (!file_exists($possibleFileName)) {
212
-            $tableName = $table->getName();
213
-            $str = "<?php
20
+	/**
21
+	 * @var SchemaAnalyzer
22
+	 */
23
+	private $schemaAnalyzer;
24
+
25
+	/**
26
+	 * @var Schema
27
+	 */
28
+	private $schema;
29
+
30
+	/**
31
+	 * The root directory of the project.
32
+	 *
33
+	 * @var string
34
+	 */
35
+	private $rootPath;
36
+
37
+	/**
38
+	 * Name of composer file.
39
+	 *
40
+	 * @var string
41
+	 */
42
+	private $composerFile;
43
+
44
+	/**
45
+	 * @var TDBMSchemaAnalyzer
46
+	 */
47
+	private $tdbmSchemaAnalyzer;
48
+
49
+	/**
50
+	 * Constructor.
51
+	 *
52
+	 * @param SchemaAnalyzer     $schemaAnalyzer
53
+	 * @param Schema             $schema
54
+	 * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer
55
+	 */
56
+	public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
57
+	{
58
+		$this->schemaAnalyzer = $schemaAnalyzer;
59
+		$this->schema = $schema;
60
+		$this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
61
+		$this->rootPath = __DIR__.'/../../../../../../../../';
62
+		$this->composerFile = 'composer.json';
63
+	}
64
+
65
+	/**
66
+	 * Generates all the daos and beans.
67
+	 *
68
+	 * @param string $daoFactoryClassName The classe name of the DAO factory
69
+	 * @param string $daonamespace        The namespace for the DAOs, without trailing \
70
+	 * @param string $beannamespace       The Namespace for the beans, without trailing \
71
+	 * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone.
72
+	 *
73
+	 * @return \string[] the list of tables
74
+	 *
75
+	 * @throws TDBMException
76
+	 */
77
+	public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc)
78
+	{
79
+		$classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.$this->composerFile);
80
+		// TODO: check that no class name ends with "Base". Otherwise, there will be name clash.
81
+
82
+		$tableList = $this->schema->getTables();
83
+
84
+		// Remove all beans and daos from junction tables
85
+		$junctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
86
+		$junctionTableNames = array_map(function (Table $table) {
87
+			return $table->getName();
88
+		}, $junctionTables);
89
+
90
+		$tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) {
91
+			return !in_array($table->getName(), $junctionTableNames);
92
+		});
93
+
94
+		foreach ($tableList as $table) {
95
+			$this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc);
96
+		}
97
+
98
+		$this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper);
99
+
100
+		// Ok, let's return the list of all tables.
101
+		// These will be used by the calling script to create Mouf instances.
102
+
103
+		return array_map(function (Table $table) { return $table->getName(); }, $tableList);
104
+	}
105
+
106
+	/**
107
+	 * Generates in one method call the daos and the beans for one table.
108
+	 *
109
+	 * @param Table           $table
110
+	 * @param string          $daonamespace
111
+	 * @param string          $beannamespace
112
+	 * @param ClassNameMapper $classNameMapper
113
+	 * @param bool            $storeInUtc
114
+	 *
115
+	 * @throws TDBMException
116
+	 */
117
+	public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
118
+	{
119
+		$tableName = $table->getName();
120
+		$daoName = $this->getDaoNameFromTableName($tableName);
121
+		$beanName = $this->getBeanNameFromTableName($tableName);
122
+		$baseBeanName = $this->getBaseBeanNameFromTableName($tableName);
123
+		$baseDaoName = $this->getBaseDaoNameFromTableName($tableName);
124
+
125
+		$beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer);
126
+		$this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc);
127
+		$this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper);
128
+	}
129
+
130
+	/**
131
+	 * Returns the name of the bean class from the table name.
132
+	 *
133
+	 * @param $tableName
134
+	 *
135
+	 * @return string
136
+	 */
137
+	public static function getBeanNameFromTableName($tableName)
138
+	{
139
+		return self::toSingular(self::toCamelCase($tableName)).'Bean';
140
+	}
141
+
142
+	/**
143
+	 * Returns the name of the DAO class from the table name.
144
+	 *
145
+	 * @param $tableName
146
+	 *
147
+	 * @return string
148
+	 */
149
+	public static function getDaoNameFromTableName($tableName)
150
+	{
151
+		return self::toSingular(self::toCamelCase($tableName)).'Dao';
152
+	}
153
+
154
+	/**
155
+	 * Returns the name of the base bean class from the table name.
156
+	 *
157
+	 * @param $tableName
158
+	 *
159
+	 * @return string
160
+	 */
161
+	public static function getBaseBeanNameFromTableName($tableName)
162
+	{
163
+		return self::toSingular(self::toCamelCase($tableName)).'BaseBean';
164
+	}
165
+
166
+	/**
167
+	 * Returns the name of the base DAO class from the table name.
168
+	 *
169
+	 * @param $tableName
170
+	 *
171
+	 * @return string
172
+	 */
173
+	public static function getBaseDaoNameFromTableName($tableName)
174
+	{
175
+		return self::toSingular(self::toCamelCase($tableName)).'BaseDao';
176
+	}
177
+
178
+	/**
179
+	 * Writes the PHP bean file with all getters and setters from the table passed in parameter.
180
+	 *
181
+	 * @param BeanDescriptor  $beanDescriptor
182
+	 * @param string          $className       The name of the class
183
+	 * @param string          $baseClassName   The name of the base class which will be extended (name only, no directory)
184
+	 * @param Table           $table           The table
185
+	 * @param string          $beannamespace   The namespace of the bean
186
+	 * @param ClassNameMapper $classNameMapper
187
+	 *
188
+	 * @throws TDBMException
189
+	 */
190
+	public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc)
191
+	{
192
+		$str = $beanDescriptor->generatePhpCode($beannamespace);
193
+
194
+		$possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\Generated\\'.$baseClassName);
195
+		if (empty($possibleBaseFileNames)) {
196
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.');
197
+		}
198
+		$possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
199
+
200
+		$this->ensureDirectoryExist($possibleBaseFileName);
201
+		file_put_contents($possibleBaseFileName, $str);
202
+		@chmod($possibleBaseFileName, 0664);
203
+
204
+		$possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className);
205
+		if (empty($possibleFileNames)) {
206
+			// @codeCoverageIgnoreStart
207
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.');
208
+			// @codeCoverageIgnoreEnd
209
+		}
210
+		$possibleFileName = $this->rootPath.$possibleFileNames[0];
211
+		if (!file_exists($possibleFileName)) {
212
+			$tableName = $table->getName();
213
+			$str = "<?php
214 214
 /*
215 215
  * This file has been automatically generated by TDBM.
216 216
  * You can edit this file as it will not be overwritten.
@@ -227,76 +227,76 @@  discard block
 block discarded – undo
227 227
 {
228 228
 
229 229
 }";
230
-            $this->ensureDirectoryExist($possibleFileName);
231
-            file_put_contents($possibleFileName, $str);
232
-            @chmod($possibleFileName, 0664);
233
-        }
234
-    }
235
-
236
-    /**
237
-     * Tries to find a @defaultSort annotation in one of the columns.
238
-     *
239
-     * @param Table $table
240
-     *
241
-     * @return array First item: column name, Second item: column order (asc/desc)
242
-     */
243
-    private function getDefaultSortColumnFromAnnotation(Table $table)
244
-    {
245
-        $defaultSort = null;
246
-        $defaultSortDirection = null;
247
-        foreach ($table->getColumns() as $column) {
248
-            $comments = $column->getComment();
249
-            $matches = [];
250
-            if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) {
251
-                $defaultSort = $column->getName();
252
-                if (count($matches) === 3) {
253
-                    $defaultSortDirection = $matches[2];
254
-                } else {
255
-                    $defaultSortDirection = 'ASC';
256
-                }
257
-            }
258
-        }
259
-
260
-        return [$defaultSort, $defaultSortDirection];
261
-    }
262
-
263
-    /**
264
-     * Writes the PHP bean DAO with simple functions to create/get/save objects.
265
-     *
266
-     * @param BeanDescriptor  $beanDescriptor
267
-     * @param string          $className       The name of the class
268
-     * @param string          $baseClassName
269
-     * @param string          $beanClassName
270
-     * @param Table           $table
271
-     * @param string          $daonamespace
272
-     * @param string          $beannamespace
273
-     * @param ClassNameMapper $classNameMapper
274
-     *
275
-     * @throws TDBMException
276
-     */
277
-    public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper)
278
-    {
279
-        $tableName = $table->getName();
280
-        $primaryKeyColumns = $table->getPrimaryKeyColumns();
281
-
282
-        list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table);
283
-
284
-        // FIXME: lowercase tables with _ in the name should work!
285
-        $tableCamel = self::toSingular(self::toCamelCase($tableName));
286
-
287
-        $beanClassWithoutNameSpace = $beanClassName;
288
-        $beanClassName = $beannamespace.'\\'.$beanClassName;
289
-
290
-        list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace);
291
-
292
-        $usedBeans[] = $beanClassName;
293
-        // Let's suppress duplicates in used beans (if any)
294
-        $usedBeans = array_flip(array_flip($usedBeans));
295
-        $useStatements = array_map(function ($usedBean) {
296
-            return "use $usedBean;\n";
297
-        }, $usedBeans);
298
-
299
-        $str = "<?php
230
+			$this->ensureDirectoryExist($possibleFileName);
231
+			file_put_contents($possibleFileName, $str);
232
+			@chmod($possibleFileName, 0664);
233
+		}
234
+	}
235
+
236
+	/**
237
+	 * Tries to find a @defaultSort annotation in one of the columns.
238
+	 *
239
+	 * @param Table $table
240
+	 *
241
+	 * @return array First item: column name, Second item: column order (asc/desc)
242
+	 */
243
+	private function getDefaultSortColumnFromAnnotation(Table $table)
244
+	{
245
+		$defaultSort = null;
246
+		$defaultSortDirection = null;
247
+		foreach ($table->getColumns() as $column) {
248
+			$comments = $column->getComment();
249
+			$matches = [];
250
+			if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) {
251
+				$defaultSort = $column->getName();
252
+				if (count($matches) === 3) {
253
+					$defaultSortDirection = $matches[2];
254
+				} else {
255
+					$defaultSortDirection = 'ASC';
256
+				}
257
+			}
258
+		}
259
+
260
+		return [$defaultSort, $defaultSortDirection];
261
+	}
262
+
263
+	/**
264
+	 * Writes the PHP bean DAO with simple functions to create/get/save objects.
265
+	 *
266
+	 * @param BeanDescriptor  $beanDescriptor
267
+	 * @param string          $className       The name of the class
268
+	 * @param string          $baseClassName
269
+	 * @param string          $beanClassName
270
+	 * @param Table           $table
271
+	 * @param string          $daonamespace
272
+	 * @param string          $beannamespace
273
+	 * @param ClassNameMapper $classNameMapper
274
+	 *
275
+	 * @throws TDBMException
276
+	 */
277
+	public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper)
278
+	{
279
+		$tableName = $table->getName();
280
+		$primaryKeyColumns = $table->getPrimaryKeyColumns();
281
+
282
+		list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table);
283
+
284
+		// FIXME: lowercase tables with _ in the name should work!
285
+		$tableCamel = self::toSingular(self::toCamelCase($tableName));
286
+
287
+		$beanClassWithoutNameSpace = $beanClassName;
288
+		$beanClassName = $beannamespace.'\\'.$beanClassName;
289
+
290
+		list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace);
291
+
292
+		$usedBeans[] = $beanClassName;
293
+		// Let's suppress duplicates in used beans (if any)
294
+		$usedBeans = array_flip(array_flip($usedBeans));
295
+		$useStatements = array_map(function ($usedBean) {
296
+			return "use $usedBean;\n";
297
+		}, $usedBeans);
298
+
299
+		$str = "<?php
300 300
 
301 301
 /*
302 302
  * This file has been automatically generated by TDBM.
@@ -373,9 +373,9 @@  discard block
 block discarded – undo
373 373
     }
374 374
     ";
375 375
 
376
-        if (count($primaryKeyColumns) === 1) {
377
-            $primaryKeyColumn = $primaryKeyColumns[0];
378
-            $str .= "
376
+		if (count($primaryKeyColumns) === 1) {
377
+			$primaryKeyColumn = $primaryKeyColumns[0];
378
+			$str .= "
379 379
     /**
380 380
      * Get $beanClassWithoutNameSpace specified by its ID (its primary key)
381 381
      * If the primary key does not exist, an exception is thrown.
@@ -390,8 +390,8 @@  discard block
 block discarded – undo
390 390
         return \$this->tdbmService->findObjectByPk('$tableName', ['$primaryKeyColumn' => \$id], [], \$lazyLoading);
391 391
     }
392 392
     ";
393
-        }
394
-        $str .= "
393
+		}
394
+		$str .= "
395 395
     /**
396 396
      * Deletes the $beanClassWithoutNameSpace passed in parameter.
397 397
      *
@@ -449,33 +449,33 @@  discard block
 block discarded – undo
449 449
     }
450 450
 ";
451 451
 
452
-        $str .= $findByDaoCode;
453
-        $str .= '}
452
+		$str .= $findByDaoCode;
453
+		$str .= '}
454 454
 ';
455 455
 
456
-        $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\Generated\\'.$baseClassName);
457
-        if (empty($possibleBaseFileNames)) {
458
-            // @codeCoverageIgnoreStart
459
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.');
460
-            // @codeCoverageIgnoreEnd
461
-        }
462
-        $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
463
-
464
-        $this->ensureDirectoryExist($possibleBaseFileName);
465
-        file_put_contents($possibleBaseFileName, $str);
466
-        @chmod($possibleBaseFileName, 0664);
467
-
468
-        $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className);
469
-        if (empty($possibleFileNames)) {
470
-            // @codeCoverageIgnoreStart
471
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.');
472
-            // @codeCoverageIgnoreEnd
473
-        }
474
-        $possibleFileName = $this->rootPath.$possibleFileNames[0];
475
-
476
-        // Now, let's generate the "editable" class
477
-        if (!file_exists($possibleFileName)) {
478
-            $str = "<?php
456
+		$possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\Generated\\'.$baseClassName);
457
+		if (empty($possibleBaseFileNames)) {
458
+			// @codeCoverageIgnoreStart
459
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.');
460
+			// @codeCoverageIgnoreEnd
461
+		}
462
+		$possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0];
463
+
464
+		$this->ensureDirectoryExist($possibleBaseFileName);
465
+		file_put_contents($possibleBaseFileName, $str);
466
+		@chmod($possibleBaseFileName, 0664);
467
+
468
+		$possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className);
469
+		if (empty($possibleFileNames)) {
470
+			// @codeCoverageIgnoreStart
471
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.');
472
+			// @codeCoverageIgnoreEnd
473
+		}
474
+		$possibleFileName = $this->rootPath.$possibleFileNames[0];
475
+
476
+		// Now, let's generate the "editable" class
477
+		if (!file_exists($possibleFileName)) {
478
+			$str = "<?php
479 479
 
480 480
 /*
481 481
  * This file has been automatically generated by TDBM.
@@ -494,22 +494,22 @@  discard block
 block discarded – undo
494 494
 
495 495
 }
496 496
 ";
497
-            $this->ensureDirectoryExist($possibleFileName);
498
-            file_put_contents($possibleFileName, $str);
499
-            @chmod($possibleFileName, 0664);
500
-        }
501
-    }
502
-
503
-    /**
504
-     * Generates the factory bean.
505
-     *
506
-     * @param Table[] $tableList
507
-     */
508
-    private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper)
509
-    {
510
-        // For each table, let's write a property.
511
-
512
-        $str = "<?php
497
+			$this->ensureDirectoryExist($possibleFileName);
498
+			file_put_contents($possibleFileName, $str);
499
+			@chmod($possibleFileName, 0664);
500
+		}
501
+	}
502
+
503
+	/**
504
+	 * Generates the factory bean.
505
+	 *
506
+	 * @param Table[] $tableList
507
+	 */
508
+	private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper)
509
+	{
510
+		// For each table, let's write a property.
511
+
512
+		$str = "<?php
513 513
 
514 514
 /*
515 515
  * This file has been automatically generated by TDBM.
@@ -518,13 +518,13 @@  discard block
 block discarded – undo
518 518
 
519 519
 namespace {$daoNamespace}\\Generated;
520 520
 ";
521
-        foreach ($tableList as $table) {
522
-            $tableName = $table->getName();
523
-            $daoClassName = $this->getDaoNameFromTableName($tableName);
524
-            $str .= "use {$daoNamespace}\\".$daoClassName.";\n";
525
-        }
521
+		foreach ($tableList as $table) {
522
+			$tableName = $table->getName();
523
+			$daoClassName = $this->getDaoNameFromTableName($tableName);
524
+			$str .= "use {$daoNamespace}\\".$daoClassName.";\n";
525
+		}
526 526
 
527
-        $str .= "
527
+		$str .= "
528 528
 /**
529 529
  * The $daoFactoryClassName provides an easy access to all DAOs generated by TDBM.
530 530
  *
@@ -533,12 +533,12 @@  discard block
 block discarded – undo
533 533
 {
534 534
 ";
535 535
 
536
-        foreach ($tableList as $table) {
537
-            $tableName = $table->getName();
538
-            $daoClassName = $this->getDaoNameFromTableName($tableName);
539
-            $daoInstanceName = self::toVariableName($daoClassName);
536
+		foreach ($tableList as $table) {
537
+			$tableName = $table->getName();
538
+			$daoClassName = $this->getDaoNameFromTableName($tableName);
539
+			$daoInstanceName = self::toVariableName($daoClassName);
540 540
 
541
-            $str .= '    /**
541
+			$str .= '    /**
542 542
      * @var '.$daoClassName.'
543 543
      */
544 544
     private $'.$daoInstanceName.';
@@ -563,158 +563,158 @@  discard block
 block discarded – undo
563 563
     }
564 564
 
565 565
 ';
566
-        }
566
+		}
567 567
 
568
-        $str .= '
568
+		$str .= '
569 569
 }
570 570
 ';
571 571
 
572
-        $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\Generated\\'.$daoFactoryClassName);
573
-        if (empty($possibleFileNames)) {
574
-            throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.');
575
-        }
576
-        $possibleFileName = $this->rootPath.$possibleFileNames[0];
577
-
578
-        $this->ensureDirectoryExist($possibleFileName);
579
-        file_put_contents($possibleFileName, $str);
580
-        @chmod($possibleFileName, 0664);
581
-    }
582
-
583
-    /**
584
-     * Transforms a string to camelCase (except the first letter will be uppercase too).
585
-     * Underscores and spaces are removed and the first letter after the underscore is uppercased.
586
-     *
587
-     * @param $str string
588
-     *
589
-     * @return string
590
-     */
591
-    public static function toCamelCase($str)
592
-    {
593
-        $str = strtoupper(substr($str, 0, 1)).substr($str, 1);
594
-        while (true) {
595
-            if (strpos($str, '_') === false && strpos($str, ' ') === false) {
596
-                break;
597
-            }
598
-
599
-            $pos = strpos($str, '_');
600
-            if ($pos === false) {
601
-                $pos = strpos($str, ' ');
602
-            }
603
-            $before = substr($str, 0, $pos);
604
-            $after = substr($str, $pos + 1);
605
-            $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1);
606
-        }
607
-
608
-        return $str;
609
-    }
610
-
611
-    /**
612
-     * Tries to put string to the singular form (if it is plural).
613
-     * We assume the table names are in english.
614
-     *
615
-     * @param $str string
616
-     *
617
-     * @return string
618
-     */
619
-    public static function toSingular($str)
620
-    {
621
-        return Inflector::singularize($str);
622
-    }
623
-
624
-    /**
625
-     * Put the first letter of the string in lower case.
626
-     * Very useful to transform a class name into a variable name.
627
-     *
628
-     * @param $str string
629
-     *
630
-     * @return string
631
-     */
632
-    public static function toVariableName($str)
633
-    {
634
-        return strtolower(substr($str, 0, 1)).substr($str, 1);
635
-    }
636
-
637
-    /**
638
-     * Ensures the file passed in parameter can be written in its directory.
639
-     *
640
-     * @param string $fileName
641
-     *
642
-     * @throws TDBMException
643
-     */
644
-    private function ensureDirectoryExist($fileName)
645
-    {
646
-        $dirName = dirname($fileName);
647
-        if (!file_exists($dirName)) {
648
-            $old = umask(0);
649
-            $result = mkdir($dirName, 0775, true);
650
-            umask($old);
651
-            if ($result === false) {
652
-                throw new TDBMException("Unable to create directory: '".$dirName."'.");
653
-            }
654
-        }
655
-    }
656
-
657
-    /**
658
-     * Absolute path to composer json file.
659
-     *
660
-     * @param string $composerFile
661
-     */
662
-    public function setComposerFile($composerFile)
663
-    {
664
-        $this->rootPath = dirname($composerFile).'/';
665
-        $this->composerFile = basename($composerFile);
666
-    }
667
-
668
-    /**
669
-     * Transforms a DBAL type into a PHP type (for PHPDoc purpose).
670
-     *
671
-     * @param Type $type The DBAL type
672
-     *
673
-     * @return string The PHP type
674
-     */
675
-    public static function dbalTypeToPhpType(Type $type)
676
-    {
677
-        $map = [
678
-            Type::TARRAY => 'array',
679
-            Type::SIMPLE_ARRAY => 'array',
680
-            Type::JSON_ARRAY => 'array',
681
-            Type::BIGINT => 'string',
682
-            Type::BOOLEAN => 'bool',
683
-            Type::DATETIME => '\DateTimeInterface',
684
-            Type::DATETIMETZ => '\DateTimeInterface',
685
-            Type::DATE => '\DateTimeInterface',
686
-            Type::TIME => '\DateTimeInterface',
687
-            Type::DECIMAL => 'float',
688
-            Type::INTEGER => 'int',
689
-            Type::OBJECT => 'string',
690
-            Type::SMALLINT => 'int',
691
-            Type::STRING => 'string',
692
-            Type::TEXT => 'string',
693
-            Type::BINARY => 'string',
694
-            Type::BLOB => 'string',
695
-            Type::FLOAT => 'float',
696
-            Type::GUID => 'string',
697
-        ];
698
-
699
-        return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName();
700
-    }
701
-
702
-    /**
703
-     * @param string $beanNamespace
704
-     *
705
-     * @return \string[] Returns a map mapping table name to beans name
706
-     */
707
-    public function buildTableToBeanMap($beanNamespace)
708
-    {
709
-        $tableToBeanMap = [];
710
-
711
-        $tables = $this->schema->getTables();
712
-
713
-        foreach ($tables as $table) {
714
-            $tableName = $table->getName();
715
-            $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName);
716
-        }
717
-
718
-        return $tableToBeanMap;
719
-    }
572
+		$possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\Generated\\'.$daoFactoryClassName);
573
+		if (empty($possibleFileNames)) {
574
+			throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.');
575
+		}
576
+		$possibleFileName = $this->rootPath.$possibleFileNames[0];
577
+
578
+		$this->ensureDirectoryExist($possibleFileName);
579
+		file_put_contents($possibleFileName, $str);
580
+		@chmod($possibleFileName, 0664);
581
+	}
582
+
583
+	/**
584
+	 * Transforms a string to camelCase (except the first letter will be uppercase too).
585
+	 * Underscores and spaces are removed and the first letter after the underscore is uppercased.
586
+	 *
587
+	 * @param $str string
588
+	 *
589
+	 * @return string
590
+	 */
591
+	public static function toCamelCase($str)
592
+	{
593
+		$str = strtoupper(substr($str, 0, 1)).substr($str, 1);
594
+		while (true) {
595
+			if (strpos($str, '_') === false && strpos($str, ' ') === false) {
596
+				break;
597
+			}
598
+
599
+			$pos = strpos($str, '_');
600
+			if ($pos === false) {
601
+				$pos = strpos($str, ' ');
602
+			}
603
+			$before = substr($str, 0, $pos);
604
+			$after = substr($str, $pos + 1);
605
+			$str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1);
606
+		}
607
+
608
+		return $str;
609
+	}
610
+
611
+	/**
612
+	 * Tries to put string to the singular form (if it is plural).
613
+	 * We assume the table names are in english.
614
+	 *
615
+	 * @param $str string
616
+	 *
617
+	 * @return string
618
+	 */
619
+	public static function toSingular($str)
620
+	{
621
+		return Inflector::singularize($str);
622
+	}
623
+
624
+	/**
625
+	 * Put the first letter of the string in lower case.
626
+	 * Very useful to transform a class name into a variable name.
627
+	 *
628
+	 * @param $str string
629
+	 *
630
+	 * @return string
631
+	 */
632
+	public static function toVariableName($str)
633
+	{
634
+		return strtolower(substr($str, 0, 1)).substr($str, 1);
635
+	}
636
+
637
+	/**
638
+	 * Ensures the file passed in parameter can be written in its directory.
639
+	 *
640
+	 * @param string $fileName
641
+	 *
642
+	 * @throws TDBMException
643
+	 */
644
+	private function ensureDirectoryExist($fileName)
645
+	{
646
+		$dirName = dirname($fileName);
647
+		if (!file_exists($dirName)) {
648
+			$old = umask(0);
649
+			$result = mkdir($dirName, 0775, true);
650
+			umask($old);
651
+			if ($result === false) {
652
+				throw new TDBMException("Unable to create directory: '".$dirName."'.");
653
+			}
654
+		}
655
+	}
656
+
657
+	/**
658
+	 * Absolute path to composer json file.
659
+	 *
660
+	 * @param string $composerFile
661
+	 */
662
+	public function setComposerFile($composerFile)
663
+	{
664
+		$this->rootPath = dirname($composerFile).'/';
665
+		$this->composerFile = basename($composerFile);
666
+	}
667
+
668
+	/**
669
+	 * Transforms a DBAL type into a PHP type (for PHPDoc purpose).
670
+	 *
671
+	 * @param Type $type The DBAL type
672
+	 *
673
+	 * @return string The PHP type
674
+	 */
675
+	public static function dbalTypeToPhpType(Type $type)
676
+	{
677
+		$map = [
678
+			Type::TARRAY => 'array',
679
+			Type::SIMPLE_ARRAY => 'array',
680
+			Type::JSON_ARRAY => 'array',
681
+			Type::BIGINT => 'string',
682
+			Type::BOOLEAN => 'bool',
683
+			Type::DATETIME => '\DateTimeInterface',
684
+			Type::DATETIMETZ => '\DateTimeInterface',
685
+			Type::DATE => '\DateTimeInterface',
686
+			Type::TIME => '\DateTimeInterface',
687
+			Type::DECIMAL => 'float',
688
+			Type::INTEGER => 'int',
689
+			Type::OBJECT => 'string',
690
+			Type::SMALLINT => 'int',
691
+			Type::STRING => 'string',
692
+			Type::TEXT => 'string',
693
+			Type::BINARY => 'string',
694
+			Type::BLOB => 'string',
695
+			Type::FLOAT => 'float',
696
+			Type::GUID => 'string',
697
+		];
698
+
699
+		return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName();
700
+	}
701
+
702
+	/**
703
+	 * @param string $beanNamespace
704
+	 *
705
+	 * @return \string[] Returns a map mapping table name to beans name
706
+	 */
707
+	public function buildTableToBeanMap($beanNamespace)
708
+	{
709
+		$tableToBeanMap = [];
710
+
711
+		$tables = $this->schema->getTables();
712
+
713
+		foreach ($tables as $table) {
714
+			$tableName = $table->getName();
715
+			$tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName);
716
+		}
717
+
718
+		return $tableToBeanMap;
719
+	}
720 720
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/Utils/BeanDescriptor.php 1 patch
Indentation   +594 added lines, -594 removed lines patch added patch discarded remove patch
@@ -16,228 +16,228 @@  discard block
 block discarded – undo
16 16
  */
17 17
 class BeanDescriptor
18 18
 {
19
-    /**
20
-     * @var Table
21
-     */
22
-    private $table;
23
-
24
-    /**
25
-     * @var SchemaAnalyzer
26
-     */
27
-    private $schemaAnalyzer;
28
-
29
-    /**
30
-     * @var Schema
31
-     */
32
-    private $schema;
33
-
34
-    /**
35
-     * @var AbstractBeanPropertyDescriptor[]
36
-     */
37
-    private $beanPropertyDescriptors = [];
38
-
39
-    /**
40
-     * @var TDBMSchemaAnalyzer
41
-     */
42
-    private $tdbmSchemaAnalyzer;
43
-
44
-    public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
45
-    {
46
-        $this->table = $table;
47
-        $this->schemaAnalyzer = $schemaAnalyzer;
48
-        $this->schema = $schema;
49
-        $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
50
-        $this->initBeanPropertyDescriptors();
51
-    }
52
-
53
-    private function initBeanPropertyDescriptors()
54
-    {
55
-        $this->beanPropertyDescriptors = $this->getProperties($this->table);
56
-    }
57
-
58
-    /**
59
-     * Returns the foreign-key the column is part of, if any. null otherwise.
60
-     *
61
-     * @param Table  $table
62
-     * @param Column $column
63
-     *
64
-     * @return ForeignKeyConstraint|null
65
-     */
66
-    private function isPartOfForeignKey(Table $table, Column $column)
67
-    {
68
-        $localColumnName = $column->getName();
69
-        foreach ($table->getForeignKeys() as $foreignKey) {
70
-            foreach ($foreignKey->getColumns() as $columnName) {
71
-                if ($columnName === $localColumnName) {
72
-                    return $foreignKey;
73
-                }
74
-            }
75
-        }
76
-
77
-        return;
78
-    }
79
-
80
-    /**
81
-     * @return AbstractBeanPropertyDescriptor[]
82
-     */
83
-    public function getBeanPropertyDescriptors()
84
-    {
85
-        return $this->beanPropertyDescriptors;
86
-    }
87
-
88
-    /**
89
-     * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent.
90
-     *
91
-     * @return AbstractBeanPropertyDescriptor[]
92
-     */
93
-    public function getConstructorProperties()
94
-    {
95
-        $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
96
-           return $property->isCompulsory();
97
-        });
98
-
99
-        return $constructorProperties;
100
-    }
101
-
102
-    /**
103
-     * Returns the list of columns that have default values for a given table.
104
-     *
105
-     * @return AbstractBeanPropertyDescriptor[]
106
-     */
107
-    public function getPropertiesWithDefault()
108
-    {
109
-        $properties = $this->getPropertiesForTable($this->table);
110
-        $defaultProperties = array_filter($properties, function (AbstractBeanPropertyDescriptor $property) {
111
-            return $property->hasDefault();
112
-        });
113
-
114
-        return $defaultProperties;
115
-    }
116
-
117
-    /**
118
-     * Returns the list of properties exposed as getters and setters in this class.
119
-     *
120
-     * @return AbstractBeanPropertyDescriptor[]
121
-     */
122
-    public function getExposedProperties()
123
-    {
124
-        $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
125
-            return $property->getTable()->getName() == $this->table->getName();
126
-        });
127
-
128
-        return $exposedProperties;
129
-    }
130
-
131
-    /**
132
-     * Returns the list of properties for this table (including parent tables).
133
-     *
134
-     * @param Table $table
135
-     *
136
-     * @return AbstractBeanPropertyDescriptor[]
137
-     */
138
-    private function getProperties(Table $table)
139
-    {
140
-        $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
141
-        if ($parentRelationship) {
142
-            $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName());
143
-            $properties = $this->getProperties($parentTable);
144
-            // we merge properties by overriding property names.
145
-            $localProperties = $this->getPropertiesForTable($table);
146
-            foreach ($localProperties as $name => $property) {
147
-                // We do not override properties if this is a primary key!
148
-                if ($property->isPrimaryKey()) {
149
-                    continue;
150
-                }
151
-                $properties[$name] = $property;
152
-            }
153
-        } else {
154
-            $properties = $this->getPropertiesForTable($table);
155
-        }
156
-
157
-        return $properties;
158
-    }
159
-
160
-    /**
161
-     * Returns the list of properties for this table (ignoring parent tables).
162
-     *
163
-     * @param Table $table
164
-     *
165
-     * @return AbstractBeanPropertyDescriptor[]
166
-     */
167
-    private function getPropertiesForTable(Table $table)
168
-    {
169
-        $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
170
-        if ($parentRelationship) {
171
-            $ignoreColumns = $parentRelationship->getLocalColumns();
172
-        } else {
173
-            $ignoreColumns = [];
174
-        }
175
-
176
-        $beanPropertyDescriptors = [];
177
-
178
-        foreach ($table->getColumns() as $column) {
179
-            if (array_search($column->getName(), $ignoreColumns) !== false) {
180
-                continue;
181
-            }
182
-
183
-            $fk = $this->isPartOfForeignKey($table, $column);
184
-            if ($fk !== null) {
185
-                // Check that previously added descriptors are not added on same FK (can happen with multi key FK).
186
-                foreach ($beanPropertyDescriptors as $beanDescriptor) {
187
-                    if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) {
188
-                        continue 2;
189
-                    }
190
-                }
191
-                // Check that this property is not an inheritance relationship
192
-                $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
193
-                if ($parentRelationship === $fk) {
194
-                    continue;
195
-                }
196
-
197
-                $beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer);
198
-            } else {
199
-                $beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column);
200
-            }
201
-        }
202
-
203
-        // Now, let's get the name of all properties and let's check there is no duplicate.
204
-        /** @var $names AbstractBeanPropertyDescriptor[] */
205
-        $names = [];
206
-        foreach ($beanPropertyDescriptors as $beanDescriptor) {
207
-            $name = $beanDescriptor->getUpperCamelCaseName();
208
-            if (isset($names[$name])) {
209
-                $names[$name]->useAlternativeName();
210
-                $beanDescriptor->useAlternativeName();
211
-            } else {
212
-                $names[$name] = $beanDescriptor;
213
-            }
214
-        }
215
-
216
-        // Final check (throw exceptions if problem arises)
217
-        $names = [];
218
-        foreach ($beanPropertyDescriptors as $beanDescriptor) {
219
-            $name = $beanDescriptor->getUpperCamelCaseName();
220
-            if (isset($names[$name])) {
221
-                throw new TDBMException('Unsolvable name conflict while generating method name');
222
-            } else {
223
-                $names[$name] = $beanDescriptor;
224
-            }
225
-        }
226
-
227
-        // Last step, let's rebuild the list with a map:
228
-        $beanPropertyDescriptorsMap = [];
229
-        foreach ($beanPropertyDescriptors as $beanDescriptor) {
230
-            $beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor;
231
-        }
232
-
233
-        return $beanPropertyDescriptorsMap;
234
-    }
235
-
236
-    public function generateBeanConstructor()
237
-    {
238
-        $constructorProperties = $this->getConstructorProperties();
239
-
240
-        $constructorCode = '    /**
19
+	/**
20
+	 * @var Table
21
+	 */
22
+	private $table;
23
+
24
+	/**
25
+	 * @var SchemaAnalyzer
26
+	 */
27
+	private $schemaAnalyzer;
28
+
29
+	/**
30
+	 * @var Schema
31
+	 */
32
+	private $schema;
33
+
34
+	/**
35
+	 * @var AbstractBeanPropertyDescriptor[]
36
+	 */
37
+	private $beanPropertyDescriptors = [];
38
+
39
+	/**
40
+	 * @var TDBMSchemaAnalyzer
41
+	 */
42
+	private $tdbmSchemaAnalyzer;
43
+
44
+	public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer)
45
+	{
46
+		$this->table = $table;
47
+		$this->schemaAnalyzer = $schemaAnalyzer;
48
+		$this->schema = $schema;
49
+		$this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer;
50
+		$this->initBeanPropertyDescriptors();
51
+	}
52
+
53
+	private function initBeanPropertyDescriptors()
54
+	{
55
+		$this->beanPropertyDescriptors = $this->getProperties($this->table);
56
+	}
57
+
58
+	/**
59
+	 * Returns the foreign-key the column is part of, if any. null otherwise.
60
+	 *
61
+	 * @param Table  $table
62
+	 * @param Column $column
63
+	 *
64
+	 * @return ForeignKeyConstraint|null
65
+	 */
66
+	private function isPartOfForeignKey(Table $table, Column $column)
67
+	{
68
+		$localColumnName = $column->getName();
69
+		foreach ($table->getForeignKeys() as $foreignKey) {
70
+			foreach ($foreignKey->getColumns() as $columnName) {
71
+				if ($columnName === $localColumnName) {
72
+					return $foreignKey;
73
+				}
74
+			}
75
+		}
76
+
77
+		return;
78
+	}
79
+
80
+	/**
81
+	 * @return AbstractBeanPropertyDescriptor[]
82
+	 */
83
+	public function getBeanPropertyDescriptors()
84
+	{
85
+		return $this->beanPropertyDescriptors;
86
+	}
87
+
88
+	/**
89
+	 * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent.
90
+	 *
91
+	 * @return AbstractBeanPropertyDescriptor[]
92
+	 */
93
+	public function getConstructorProperties()
94
+	{
95
+		$constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
96
+		   return $property->isCompulsory();
97
+		});
98
+
99
+		return $constructorProperties;
100
+	}
101
+
102
+	/**
103
+	 * Returns the list of columns that have default values for a given table.
104
+	 *
105
+	 * @return AbstractBeanPropertyDescriptor[]
106
+	 */
107
+	public function getPropertiesWithDefault()
108
+	{
109
+		$properties = $this->getPropertiesForTable($this->table);
110
+		$defaultProperties = array_filter($properties, function (AbstractBeanPropertyDescriptor $property) {
111
+			return $property->hasDefault();
112
+		});
113
+
114
+		return $defaultProperties;
115
+	}
116
+
117
+	/**
118
+	 * Returns the list of properties exposed as getters and setters in this class.
119
+	 *
120
+	 * @return AbstractBeanPropertyDescriptor[]
121
+	 */
122
+	public function getExposedProperties()
123
+	{
124
+		$exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) {
125
+			return $property->getTable()->getName() == $this->table->getName();
126
+		});
127
+
128
+		return $exposedProperties;
129
+	}
130
+
131
+	/**
132
+	 * Returns the list of properties for this table (including parent tables).
133
+	 *
134
+	 * @param Table $table
135
+	 *
136
+	 * @return AbstractBeanPropertyDescriptor[]
137
+	 */
138
+	private function getProperties(Table $table)
139
+	{
140
+		$parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
141
+		if ($parentRelationship) {
142
+			$parentTable = $this->schema->getTable($parentRelationship->getForeignTableName());
143
+			$properties = $this->getProperties($parentTable);
144
+			// we merge properties by overriding property names.
145
+			$localProperties = $this->getPropertiesForTable($table);
146
+			foreach ($localProperties as $name => $property) {
147
+				// We do not override properties if this is a primary key!
148
+				if ($property->isPrimaryKey()) {
149
+					continue;
150
+				}
151
+				$properties[$name] = $property;
152
+			}
153
+		} else {
154
+			$properties = $this->getPropertiesForTable($table);
155
+		}
156
+
157
+		return $properties;
158
+	}
159
+
160
+	/**
161
+	 * Returns the list of properties for this table (ignoring parent tables).
162
+	 *
163
+	 * @param Table $table
164
+	 *
165
+	 * @return AbstractBeanPropertyDescriptor[]
166
+	 */
167
+	private function getPropertiesForTable(Table $table)
168
+	{
169
+		$parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
170
+		if ($parentRelationship) {
171
+			$ignoreColumns = $parentRelationship->getLocalColumns();
172
+		} else {
173
+			$ignoreColumns = [];
174
+		}
175
+
176
+		$beanPropertyDescriptors = [];
177
+
178
+		foreach ($table->getColumns() as $column) {
179
+			if (array_search($column->getName(), $ignoreColumns) !== false) {
180
+				continue;
181
+			}
182
+
183
+			$fk = $this->isPartOfForeignKey($table, $column);
184
+			if ($fk !== null) {
185
+				// Check that previously added descriptors are not added on same FK (can happen with multi key FK).
186
+				foreach ($beanPropertyDescriptors as $beanDescriptor) {
187
+					if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) {
188
+						continue 2;
189
+					}
190
+				}
191
+				// Check that this property is not an inheritance relationship
192
+				$parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName());
193
+				if ($parentRelationship === $fk) {
194
+					continue;
195
+				}
196
+
197
+				$beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer);
198
+			} else {
199
+				$beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column);
200
+			}
201
+		}
202
+
203
+		// Now, let's get the name of all properties and let's check there is no duplicate.
204
+		/** @var $names AbstractBeanPropertyDescriptor[] */
205
+		$names = [];
206
+		foreach ($beanPropertyDescriptors as $beanDescriptor) {
207
+			$name = $beanDescriptor->getUpperCamelCaseName();
208
+			if (isset($names[$name])) {
209
+				$names[$name]->useAlternativeName();
210
+				$beanDescriptor->useAlternativeName();
211
+			} else {
212
+				$names[$name] = $beanDescriptor;
213
+			}
214
+		}
215
+
216
+		// Final check (throw exceptions if problem arises)
217
+		$names = [];
218
+		foreach ($beanPropertyDescriptors as $beanDescriptor) {
219
+			$name = $beanDescriptor->getUpperCamelCaseName();
220
+			if (isset($names[$name])) {
221
+				throw new TDBMException('Unsolvable name conflict while generating method name');
222
+			} else {
223
+				$names[$name] = $beanDescriptor;
224
+			}
225
+		}
226
+
227
+		// Last step, let's rebuild the list with a map:
228
+		$beanPropertyDescriptorsMap = [];
229
+		foreach ($beanPropertyDescriptors as $beanDescriptor) {
230
+			$beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor;
231
+		}
232
+
233
+		return $beanPropertyDescriptorsMap;
234
+	}
235
+
236
+	public function generateBeanConstructor()
237
+	{
238
+		$constructorProperties = $this->getConstructorProperties();
239
+
240
+		$constructorCode = '    /**
241 241
      * The constructor takes all compulsory arguments.
242 242
      *
243 243
 %s
@@ -247,70 +247,70 @@  discard block
 block discarded – undo
247 247
 %s    }
248 248
     ';
249 249
 
250
-        $paramAnnotations = [];
251
-        $arguments = [];
252
-        $assigns = [];
253
-        $parentConstructorArguments = [];
254
-
255
-        foreach ($constructorProperties as $property) {
256
-            $className = $property->getClassName();
257
-            if ($className) {
258
-                $arguments[] = $className.' '.$property->getVariableName();
259
-            } else {
260
-                $arguments[] = $property->getVariableName();
261
-            }
262
-            $paramAnnotations[] = $property->getParamAnnotation();
263
-            if ($property->getTable()->getName() === $this->table->getName()) {
264
-                $assigns[] = $property->getConstructorAssignCode();
265
-            } else {
266
-                $parentConstructorArguments[] = $property->getVariableName();
267
-            }
268
-        }
269
-
270
-        $parentConstructorCode = sprintf("        parent::__construct(%s);\n", implode(', ', $parentConstructorArguments));
271
-
272
-        $defaultAssigns = [];
273
-        foreach ($this->getPropertiesWithDefault() as $property) {
274
-            $defaultAssigns[] = $property->assignToDefaultCode();
275
-        }
276
-
277
-        return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstructorCode, implode("\n", $assigns), implode("\n", $defaultAssigns));
278
-    }
279
-
280
-    public function generateDirectForeignKeysCode()
281
-    {
282
-        $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
283
-
284
-        $fksByTable = [];
285
-
286
-        foreach ($fks as $fk) {
287
-            $fksByTable[$fk->getLocalTableName()][] = $fk;
288
-        }
289
-
290
-        /* @var $fksByMethodName ForeignKeyConstraint[] */
291
-        $fksByMethodName = [];
292
-
293
-        foreach ($fksByTable as $tableName => $fksForTable) {
294
-            if (count($fksForTable) > 1) {
295
-                foreach ($fksForTable as $fk) {
296
-                    $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By';
297
-
298
-                    $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns());
299
-
300
-                    $methodName .= implode('And', $camelizedColumns);
301
-
302
-                    $fksByMethodName[$methodName] = $fk;
303
-                }
304
-            } else {
305
-                $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName());
306
-                $fksByMethodName[$methodName] = $fksForTable[0];
307
-            }
308
-        }
309
-
310
-        $code = '';
311
-
312
-        foreach ($fksByMethodName as $methodName => $fk) {
313
-            $getterCode = '    /**
250
+		$paramAnnotations = [];
251
+		$arguments = [];
252
+		$assigns = [];
253
+		$parentConstructorArguments = [];
254
+
255
+		foreach ($constructorProperties as $property) {
256
+			$className = $property->getClassName();
257
+			if ($className) {
258
+				$arguments[] = $className.' '.$property->getVariableName();
259
+			} else {
260
+				$arguments[] = $property->getVariableName();
261
+			}
262
+			$paramAnnotations[] = $property->getParamAnnotation();
263
+			if ($property->getTable()->getName() === $this->table->getName()) {
264
+				$assigns[] = $property->getConstructorAssignCode();
265
+			} else {
266
+				$parentConstructorArguments[] = $property->getVariableName();
267
+			}
268
+		}
269
+
270
+		$parentConstructorCode = sprintf("        parent::__construct(%s);\n", implode(', ', $parentConstructorArguments));
271
+
272
+		$defaultAssigns = [];
273
+		foreach ($this->getPropertiesWithDefault() as $property) {
274
+			$defaultAssigns[] = $property->assignToDefaultCode();
275
+		}
276
+
277
+		return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstructorCode, implode("\n", $assigns), implode("\n", $defaultAssigns));
278
+	}
279
+
280
+	public function generateDirectForeignKeysCode()
281
+	{
282
+		$fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName());
283
+
284
+		$fksByTable = [];
285
+
286
+		foreach ($fks as $fk) {
287
+			$fksByTable[$fk->getLocalTableName()][] = $fk;
288
+		}
289
+
290
+		/* @var $fksByMethodName ForeignKeyConstraint[] */
291
+		$fksByMethodName = [];
292
+
293
+		foreach ($fksByTable as $tableName => $fksForTable) {
294
+			if (count($fksForTable) > 1) {
295
+				foreach ($fksForTable as $fk) {
296
+					$methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By';
297
+
298
+					$camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns());
299
+
300
+					$methodName .= implode('And', $camelizedColumns);
301
+
302
+					$fksByMethodName[$methodName] = $fk;
303
+				}
304
+			} else {
305
+				$methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName());
306
+				$fksByMethodName[$methodName] = $fksForTable[0];
307
+			}
308
+		}
309
+
310
+		$code = '';
311
+
312
+		foreach ($fksByMethodName as $methodName => $fk) {
313
+			$getterCode = '    /**
314 314
      * Returns the list of %s pointing to this bean via the %s column.
315 315
      *
316 316
      * @return %s[]|ResultIterator
@@ -322,111 +322,111 @@  discard block
 block discarded – undo
322 322
 
323 323
 ';
324 324
 
325
-            list($sql, $parametersCode) = $this->getFilters($fk);
326
-
327
-            $beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName());
328
-            $code .= sprintf($getterCode,
329
-                $beanClass,
330
-                implode(', ', $fk->getColumns()),
331
-                $beanClass,
332
-                $methodName,
333
-                var_export($fk->getLocalTableName(), true),
334
-                $sql,
335
-                $parametersCode
336
-            );
337
-        }
338
-
339
-        return $code;
340
-    }
341
-
342
-    private function getFilters(ForeignKeyConstraint $fk)
343
-    {
344
-        $sqlParts = [];
345
-        $counter = 0;
346
-        $parameters = [];
347
-
348
-        $pkColumns = $this->table->getPrimaryKeyColumns();
349
-
350
-        foreach ($fk->getLocalColumns() as $columnName) {
351
-            $paramName = 'tdbmparam'.$counter;
352
-            $sqlParts[] = $fk->getLocalTableName().'.'.$columnName.' = :'.$paramName;
353
-
354
-            $pkColumn = $pkColumns[$counter];
355
-            $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($paramName, true), var_export($pkColumn, true), var_export($this->table->getName(), true));
356
-            ++$counter;
357
-        }
358
-        $sql = "'".implode(' AND ', $sqlParts)."'";
359
-        $parametersCode = '[ '.implode(', ', $parameters).' ]';
360
-
361
-        return [$sql, $parametersCode];
362
-    }
363
-
364
-    /**
365
-     * Generate code section about pivot tables.
366
-     *
367
-     * @return string
368
-     */
369
-    public function generatePivotTableCode()
370
-    {
371
-        $finalDescs = $this->getPivotTableDescriptors();
372
-
373
-        $code = '';
374
-
375
-        foreach ($finalDescs as $desc) {
376
-            $code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']);
377
-        }
378
-
379
-        return $code;
380
-    }
381
-
382
-    private function getPivotTableDescriptors()
383
-    {
384
-        $descs = [];
385
-        foreach ($this->schemaAnalyzer->detectJunctionTables(true) as $table) {
386
-            // There are exactly 2 FKs since this is a pivot table.
387
-            $fks = array_values($table->getForeignKeys());
388
-
389
-            if ($fks[0]->getForeignTableName() === $this->table->getName()) {
390
-                $localFK = $fks[0];
391
-                $remoteFK = $fks[1];
392
-            } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) {
393
-                $localFK = $fks[1];
394
-                $remoteFK = $fks[0];
395
-            } else {
396
-                continue;
397
-            }
398
-
399
-            $descs[$remoteFK->getForeignTableName()][] = [
400
-                'table' => $table,
401
-                'localFK' => $localFK,
402
-                'remoteFK' => $remoteFK,
403
-            ];
404
-        }
405
-
406
-        $finalDescs = [];
407
-        foreach ($descs as $descArray) {
408
-            if (count($descArray) > 1) {
409
-                foreach ($descArray as $desc) {
410
-                    $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName());
411
-                    $finalDescs[] = $desc;
412
-                }
413
-            } else {
414
-                $desc = $descArray[0];
415
-                $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName());
416
-                $finalDescs[] = $desc;
417
-            }
418
-        }
419
-
420
-        return $finalDescs;
421
-    }
422
-
423
-    public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK)
424
-    {
425
-        $singularName = TDBMDaoGenerator::toSingular($name);
426
-        $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
427
-        $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
428
-
429
-        $str = '    /**
325
+			list($sql, $parametersCode) = $this->getFilters($fk);
326
+
327
+			$beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName());
328
+			$code .= sprintf($getterCode,
329
+				$beanClass,
330
+				implode(', ', $fk->getColumns()),
331
+				$beanClass,
332
+				$methodName,
333
+				var_export($fk->getLocalTableName(), true),
334
+				$sql,
335
+				$parametersCode
336
+			);
337
+		}
338
+
339
+		return $code;
340
+	}
341
+
342
+	private function getFilters(ForeignKeyConstraint $fk)
343
+	{
344
+		$sqlParts = [];
345
+		$counter = 0;
346
+		$parameters = [];
347
+
348
+		$pkColumns = $this->table->getPrimaryKeyColumns();
349
+
350
+		foreach ($fk->getLocalColumns() as $columnName) {
351
+			$paramName = 'tdbmparam'.$counter;
352
+			$sqlParts[] = $fk->getLocalTableName().'.'.$columnName.' = :'.$paramName;
353
+
354
+			$pkColumn = $pkColumns[$counter];
355
+			$parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($paramName, true), var_export($pkColumn, true), var_export($this->table->getName(), true));
356
+			++$counter;
357
+		}
358
+		$sql = "'".implode(' AND ', $sqlParts)."'";
359
+		$parametersCode = '[ '.implode(', ', $parameters).' ]';
360
+
361
+		return [$sql, $parametersCode];
362
+	}
363
+
364
+	/**
365
+	 * Generate code section about pivot tables.
366
+	 *
367
+	 * @return string
368
+	 */
369
+	public function generatePivotTableCode()
370
+	{
371
+		$finalDescs = $this->getPivotTableDescriptors();
372
+
373
+		$code = '';
374
+
375
+		foreach ($finalDescs as $desc) {
376
+			$code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']);
377
+		}
378
+
379
+		return $code;
380
+	}
381
+
382
+	private function getPivotTableDescriptors()
383
+	{
384
+		$descs = [];
385
+		foreach ($this->schemaAnalyzer->detectJunctionTables(true) as $table) {
386
+			// There are exactly 2 FKs since this is a pivot table.
387
+			$fks = array_values($table->getForeignKeys());
388
+
389
+			if ($fks[0]->getForeignTableName() === $this->table->getName()) {
390
+				$localFK = $fks[0];
391
+				$remoteFK = $fks[1];
392
+			} elseif ($fks[1]->getForeignTableName() === $this->table->getName()) {
393
+				$localFK = $fks[1];
394
+				$remoteFK = $fks[0];
395
+			} else {
396
+				continue;
397
+			}
398
+
399
+			$descs[$remoteFK->getForeignTableName()][] = [
400
+				'table' => $table,
401
+				'localFK' => $localFK,
402
+				'remoteFK' => $remoteFK,
403
+			];
404
+		}
405
+
406
+		$finalDescs = [];
407
+		foreach ($descs as $descArray) {
408
+			if (count($descArray) > 1) {
409
+				foreach ($descArray as $desc) {
410
+					$desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName());
411
+					$finalDescs[] = $desc;
412
+				}
413
+			} else {
414
+				$desc = $descArray[0];
415
+				$desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName());
416
+				$finalDescs[] = $desc;
417
+			}
418
+		}
419
+
420
+		return $finalDescs;
421
+	}
422
+
423
+	public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK)
424
+	{
425
+		$singularName = TDBMDaoGenerator::toSingular($name);
426
+		$remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
427
+		$variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
428
+
429
+		$str = '    /**
430 430
      * Returns the list of %s associated to this bean via the %s pivot table.
431 431
      *
432 432
      * @return %s[]
@@ -436,9 +436,9 @@  discard block
 block discarded – undo
436 436
     }
437 437
 ';
438 438
 
439
-        $getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true));
439
+		$getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true));
440 440
 
441
-        $str = '    /**
441
+		$str = '    /**
442 442
      * Adds a relationship with %s associated to this bean via the %s pivot table.
443 443
      *
444 444
      * @param %s %s
@@ -448,9 +448,9 @@  discard block
 block discarded – undo
448 448
     }
449 449
 ';
450 450
 
451
-        $adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
451
+		$adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
452 452
 
453
-        $str = '    /**
453
+		$str = '    /**
454 454
      * Deletes the relationship with %s associated to this bean via the %s pivot table.
455 455
      *
456 456
      * @param %s %s
@@ -460,9 +460,9 @@  discard block
 block discarded – undo
460 460
     }
461 461
 ';
462 462
 
463
-        $removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
463
+		$removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
464 464
 
465
-        $str = '    /**
465
+		$str = '    /**
466 466
      * Returns whether this bean is associated with %s via the %s pivot table.
467 467
      *
468 468
      * @param %s %s
@@ -473,24 +473,24 @@  discard block
 block discarded – undo
473 473
     }
474 474
 ';
475 475
 
476
-        $hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
476
+		$hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName);
477 477
 
478
-        $code = $getterCode.$adderCode.$removerCode.$hasCode;
478
+		$code = $getterCode.$adderCode.$removerCode.$hasCode;
479 479
 
480
-        return $code;
481
-    }
480
+		return $code;
481
+	}
482 482
 
483
-    public function generateJsonSerialize()
484
-    {
485
-        $tableName = $this->table->getName();
486
-        $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
487
-        if ($parentFk !== null) {
488
-            $initializer = '$array = parent::jsonSerialize();';
489
-        } else {
490
-            $initializer = '$array = [];';
491
-        }
483
+	public function generateJsonSerialize()
484
+	{
485
+		$tableName = $this->table->getName();
486
+		$parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
487
+		if ($parentFk !== null) {
488
+			$initializer = '$array = parent::jsonSerialize();';
489
+		} else {
490
+			$initializer = '$array = [];';
491
+		}
492 492
 
493
-        $str = '
493
+		$str = '
494 494
     /**
495 495
      * Serializes the object for JSON encoding
496 496
      *
@@ -506,89 +506,89 @@  discard block
 block discarded – undo
506 506
     }
507 507
 ';
508 508
 
509
-        $propertiesCode = '';
510
-        foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) {
511
-            $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode();
512
-        }
509
+		$propertiesCode = '';
510
+		foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) {
511
+			$propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode();
512
+		}
513 513
 
514
-        // Many to many relationships:
514
+		// Many to many relationships:
515 515
 
516
-        $descs = $this->getPivotTableDescriptors();
516
+		$descs = $this->getPivotTableDescriptors();
517 517
 
518
-        $many2manyCode = '';
518
+		$many2manyCode = '';
519 519
 
520
-        foreach ($descs as $desc) {
521
-            $remoteFK = $desc['remoteFK'];
522
-            $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
523
-            $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
520
+		foreach ($descs as $desc) {
521
+			$remoteFK = $desc['remoteFK'];
522
+			$remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName());
523
+			$variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName);
524 524
 
525
-            $many2manyCode .= '        if (!$stopRecursion) {
525
+			$many2manyCode .= '        if (!$stopRecursion) {
526 526
             $array[\''.lcfirst($desc['name']).'\'] = array_map(function('.$remoteBeanName.' '.$variableName.') {
527 527
                 return '.$variableName.'->jsonSerialize(true);
528 528
             }, $this->get'.$desc['name'].'());
529 529
         }
530 530
         ';
531
-        }
532
-
533
-        return sprintf($str, $initializer, $propertiesCode, $many2manyCode);
534
-    }
535
-
536
-    /**
537
-     * Returns as an array the class we need to extend from and the list of use statements.
538
-     *
539
-     * @return array
540
-     */
541
-    private function generateExtendsAndUseStatements(ForeignKeyConstraint $parentFk = null)
542
-    {
543
-        $classes = [];
544
-        if ($parentFk !== null) {
545
-            $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
546
-            $classes[] = $extends;
547
-        }
548
-
549
-        foreach ($this->getBeanPropertyDescriptors() as $beanPropertyDescriptor) {
550
-            $className = $beanPropertyDescriptor->getClassName();
551
-            if (null !== $className) {
552
-                $classes[] = $beanPropertyDescriptor->getClassName();
553
-            }
554
-        }
555
-
556
-        foreach ($this->getPivotTableDescriptors() as $descriptor) {
557
-            /* @var $fk ForeignKeyConstraint */
558
-            $fk = $descriptor['remoteFK'];
559
-            $classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getForeignTableName());
560
-        }
561
-
562
-        $classes = array_flip(array_flip($classes));
563
-
564
-        return $classes;
565
-    }
566
-
567
-    /**
568
-     * Writes the PHP bean file with all getters and setters from the table passed in parameter.
569
-     *
570
-     * @param string $beannamespace The namespace of the bean
571
-     */
572
-    public function generatePhpCode($beannamespace)
573
-    {
574
-        $tableName = $this->table->getName();
575
-        $baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($tableName);
576
-        $className = TDBMDaoGenerator::getBeanNameFromTableName($tableName);
577
-        $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
578
-
579
-        $classes = $this->generateExtendsAndUseStatements($parentFk);
580
-
581
-        $uses = array_map(function ($className) use ($beannamespace) { return 'use '.$beannamespace.'\\'.$className.";\n"; }, $classes);
582
-        $use = implode('', $uses);
583
-
584
-        if ($parentFk !== null) {
585
-            $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
586
-        } else {
587
-            $extends = 'AbstractTDBMObject';
588
-            $use .= "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n";
589
-        }
590
-
591
-        $str = "<?php
531
+		}
532
+
533
+		return sprintf($str, $initializer, $propertiesCode, $many2manyCode);
534
+	}
535
+
536
+	/**
537
+	 * Returns as an array the class we need to extend from and the list of use statements.
538
+	 *
539
+	 * @return array
540
+	 */
541
+	private function generateExtendsAndUseStatements(ForeignKeyConstraint $parentFk = null)
542
+	{
543
+		$classes = [];
544
+		if ($parentFk !== null) {
545
+			$extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
546
+			$classes[] = $extends;
547
+		}
548
+
549
+		foreach ($this->getBeanPropertyDescriptors() as $beanPropertyDescriptor) {
550
+			$className = $beanPropertyDescriptor->getClassName();
551
+			if (null !== $className) {
552
+				$classes[] = $beanPropertyDescriptor->getClassName();
553
+			}
554
+		}
555
+
556
+		foreach ($this->getPivotTableDescriptors() as $descriptor) {
557
+			/* @var $fk ForeignKeyConstraint */
558
+			$fk = $descriptor['remoteFK'];
559
+			$classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getForeignTableName());
560
+		}
561
+
562
+		$classes = array_flip(array_flip($classes));
563
+
564
+		return $classes;
565
+	}
566
+
567
+	/**
568
+	 * Writes the PHP bean file with all getters and setters from the table passed in parameter.
569
+	 *
570
+	 * @param string $beannamespace The namespace of the bean
571
+	 */
572
+	public function generatePhpCode($beannamespace)
573
+	{
574
+		$tableName = $this->table->getName();
575
+		$baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($tableName);
576
+		$className = TDBMDaoGenerator::getBeanNameFromTableName($tableName);
577
+		$parentFk = $this->schemaAnalyzer->getParentRelationship($tableName);
578
+
579
+		$classes = $this->generateExtendsAndUseStatements($parentFk);
580
+
581
+		$uses = array_map(function ($className) use ($beannamespace) { return 'use '.$beannamespace.'\\'.$className.";\n"; }, $classes);
582
+		$use = implode('', $uses);
583
+
584
+		if ($parentFk !== null) {
585
+			$extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName());
586
+		} else {
587
+			$extends = 'AbstractTDBMObject';
588
+			$use .= "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n";
589
+		}
590
+
591
+		$str = "<?php
592 592
 namespace {$beannamespace}\\Generated;
593 593
 
594 594
 use Mouf\\Database\\TDBM\\ResultIterator;
@@ -606,122 +606,122 @@  discard block
 block discarded – undo
606 606
 {
607 607
 ";
608 608
 
609
-        $str .= $this->generateBeanConstructor();
609
+		$str .= $this->generateBeanConstructor();
610 610
 
611
-        foreach ($this->getExposedProperties() as $property) {
612
-            $str .= $property->getGetterSetterCode();
613
-        }
611
+		foreach ($this->getExposedProperties() as $property) {
612
+			$str .= $property->getGetterSetterCode();
613
+		}
614 614
 
615
-        $str .= $this->generateDirectForeignKeysCode();
616
-        $str .= $this->generatePivotTableCode();
617
-        $str .= $this->generateJsonSerialize();
615
+		$str .= $this->generateDirectForeignKeysCode();
616
+		$str .= $this->generatePivotTableCode();
617
+		$str .= $this->generateJsonSerialize();
618 618
 
619
-        $str .= '}
619
+		$str .= '}
620 620
 ';
621 621
 
622
-        return $str;
623
-    }
624
-
625
-    /**
626
-     * @param string $beanNamespace
627
-     * @param string $beanClassName
628
-     *
629
-     * @return array first element: list of used beans, second item: PHP code as a string
630
-     */
631
-    public function generateFindByDaoCode($beanNamespace, $beanClassName)
632
-    {
633
-        $code = '';
634
-        $usedBeans = [];
635
-        foreach ($this->table->getIndexes() as $index) {
636
-            if (!$index->isPrimary()) {
637
-                list($usedBeansForIndex, $codeForIndex) = $this->generateFindByDaoCodeForIndex($index, $beanNamespace, $beanClassName);
638
-                $code .= $codeForIndex;
639
-                $usedBeans = array_merge($usedBeans, $usedBeansForIndex);
640
-            }
641
-        }
642
-
643
-        return [$usedBeans, $code];
644
-    }
645
-
646
-    /**
647
-     * @param Index  $index
648
-     * @param string $beanNamespace
649
-     * @param string $beanClassName
650
-     *
651
-     * @return array first element: list of used beans, second item: PHP code as a string
652
-     */
653
-    private function generateFindByDaoCodeForIndex(Index $index, $beanNamespace, $beanClassName)
654
-    {
655
-        $columns = $index->getColumns();
656
-        $usedBeans = [];
657
-
658
-        /*
622
+		return $str;
623
+	}
624
+
625
+	/**
626
+	 * @param string $beanNamespace
627
+	 * @param string $beanClassName
628
+	 *
629
+	 * @return array first element: list of used beans, second item: PHP code as a string
630
+	 */
631
+	public function generateFindByDaoCode($beanNamespace, $beanClassName)
632
+	{
633
+		$code = '';
634
+		$usedBeans = [];
635
+		foreach ($this->table->getIndexes() as $index) {
636
+			if (!$index->isPrimary()) {
637
+				list($usedBeansForIndex, $codeForIndex) = $this->generateFindByDaoCodeForIndex($index, $beanNamespace, $beanClassName);
638
+				$code .= $codeForIndex;
639
+				$usedBeans = array_merge($usedBeans, $usedBeansForIndex);
640
+			}
641
+		}
642
+
643
+		return [$usedBeans, $code];
644
+	}
645
+
646
+	/**
647
+	 * @param Index  $index
648
+	 * @param string $beanNamespace
649
+	 * @param string $beanClassName
650
+	 *
651
+	 * @return array first element: list of used beans, second item: PHP code as a string
652
+	 */
653
+	private function generateFindByDaoCodeForIndex(Index $index, $beanNamespace, $beanClassName)
654
+	{
655
+		$columns = $index->getColumns();
656
+		$usedBeans = [];
657
+
658
+		/*
659 659
          * The list of elements building this index (expressed as columns or foreign keys)
660 660
          * @var AbstractBeanPropertyDescriptor[]
661 661
          */
662
-        $elements = [];
663
-
664
-        foreach ($columns as $column) {
665
-            $fk = $this->isPartOfForeignKey($this->table, $this->table->getColumn($column));
666
-            if ($fk !== null) {
667
-                if (!in_array($fk, $elements)) {
668
-                    $elements[] = new ObjectBeanPropertyDescriptor($this->table, $fk, $this->schemaAnalyzer);
669
-                }
670
-            } else {
671
-                $elements[] = new ScalarBeanPropertyDescriptor($this->table, $this->table->getColumn($column));
672
-            }
673
-        }
674
-
675
-        // If the index is actually only a foreign key, let's bypass it entirely.
676
-        if (count($elements) === 1 && $elements[0] instanceof ObjectBeanPropertyDescriptor) {
677
-            return [[], ''];
678
-        }
679
-
680
-        $methodNameComponent = [];
681
-        $functionParameters = [];
682
-        $first = true;
683
-        foreach ($elements as $element) {
684
-            $methodNameComponent[] = $element->getUpperCamelCaseName();
685
-            $functionParameter = $element->getClassName();
686
-            if ($functionParameter) {
687
-                $usedBeans[] = $beanNamespace.'\\'.$functionParameter;
688
-                $functionParameter .= ' ';
689
-            }
690
-            $functionParameter .= $element->getVariableName();
691
-            if ($first) {
692
-                $first = false;
693
-            } else {
694
-                $functionParameter .= ' = null';
695
-            }
696
-            $functionParameters[] = $functionParameter;
697
-        }
698
-        if ($index->isUnique()) {
699
-            $methodName = 'findOneBy'.implode('And', $methodNameComponent);
700
-            $calledMethod = 'findOne';
701
-        } else {
702
-            $methodName = 'findBy'.implode('And', $methodNameComponent);
703
-            $calledMethod = 'find';
704
-        }
705
-        $functionParametersString = implode(', ', $functionParameters);
706
-
707
-        $count = 0;
708
-
709
-        $params = [];
710
-        $filterArrayCode = '';
711
-        $commentArguments = [];
712
-        foreach ($elements as $element) {
713
-            $params[] = $element->getParamAnnotation();
714
-            if ($element instanceof ScalarBeanPropertyDescriptor) {
715
-                $filterArrayCode .= '            '.var_export($element->getColumnName(), true).' => '.$element->getVariableName().",\n";
716
-            } else {
717
-                ++$count;
718
-                $filterArrayCode .= '            '.$count.' => '.$element->getVariableName().",\n";
719
-            }
720
-            $commentArguments[] = substr($element->getVariableName(), 1);
721
-        }
722
-        $paramsString = implode("\n", $params);
723
-
724
-        $code = "
662
+		$elements = [];
663
+
664
+		foreach ($columns as $column) {
665
+			$fk = $this->isPartOfForeignKey($this->table, $this->table->getColumn($column));
666
+			if ($fk !== null) {
667
+				if (!in_array($fk, $elements)) {
668
+					$elements[] = new ObjectBeanPropertyDescriptor($this->table, $fk, $this->schemaAnalyzer);
669
+				}
670
+			} else {
671
+				$elements[] = new ScalarBeanPropertyDescriptor($this->table, $this->table->getColumn($column));
672
+			}
673
+		}
674
+
675
+		// If the index is actually only a foreign key, let's bypass it entirely.
676
+		if (count($elements) === 1 && $elements[0] instanceof ObjectBeanPropertyDescriptor) {
677
+			return [[], ''];
678
+		}
679
+
680
+		$methodNameComponent = [];
681
+		$functionParameters = [];
682
+		$first = true;
683
+		foreach ($elements as $element) {
684
+			$methodNameComponent[] = $element->getUpperCamelCaseName();
685
+			$functionParameter = $element->getClassName();
686
+			if ($functionParameter) {
687
+				$usedBeans[] = $beanNamespace.'\\'.$functionParameter;
688
+				$functionParameter .= ' ';
689
+			}
690
+			$functionParameter .= $element->getVariableName();
691
+			if ($first) {
692
+				$first = false;
693
+			} else {
694
+				$functionParameter .= ' = null';
695
+			}
696
+			$functionParameters[] = $functionParameter;
697
+		}
698
+		if ($index->isUnique()) {
699
+			$methodName = 'findOneBy'.implode('And', $methodNameComponent);
700
+			$calledMethod = 'findOne';
701
+		} else {
702
+			$methodName = 'findBy'.implode('And', $methodNameComponent);
703
+			$calledMethod = 'find';
704
+		}
705
+		$functionParametersString = implode(', ', $functionParameters);
706
+
707
+		$count = 0;
708
+
709
+		$params = [];
710
+		$filterArrayCode = '';
711
+		$commentArguments = [];
712
+		foreach ($elements as $element) {
713
+			$params[] = $element->getParamAnnotation();
714
+			if ($element instanceof ScalarBeanPropertyDescriptor) {
715
+				$filterArrayCode .= '            '.var_export($element->getColumnName(), true).' => '.$element->getVariableName().",\n";
716
+			} else {
717
+				++$count;
718
+				$filterArrayCode .= '            '.$count.' => '.$element->getVariableName().",\n";
719
+			}
720
+			$commentArguments[] = substr($element->getVariableName(), 1);
721
+		}
722
+		$paramsString = implode("\n", $params);
723
+
724
+		$code = "
725 725
     /**
726 726
      * Get a list of $beanClassName filtered by ".implode(', ', $commentArguments).".
727 727
      *
@@ -739,6 +739,6 @@  discard block
 block discarded – undo
739 739
     }
740 740
 ";
741 741
 
742
-        return [$usedBeans, $code];
743
-    }
742
+		return [$usedBeans, $code];
743
+	}
744 744
 }
Please login to merge, or discard this patch.
src/Mouf/Database/TDBM/TDBMSchemaAnalyzer.php 1 patch
Indentation   +132 added lines, -132 removed lines patch added patch discarded remove patch
@@ -14,136 +14,136 @@
 block discarded – undo
14 14
  */
15 15
 class TDBMSchemaAnalyzer
16 16
 {
17
-    private $connection;
18
-
19
-    /**
20
-     * @var Schema
21
-     */
22
-    private $schema;
23
-
24
-    /**
25
-     * @var string
26
-     */
27
-    private $cachePrefix;
28
-
29
-    /**
30
-     * @var Cache
31
-     */
32
-    private $cache;
33
-
34
-    /**
35
-     * @var SchemaAnalyzer
36
-     */
37
-    private $schemaAnalyzer;
38
-
39
-    /**
40
-     * @param Connection     $connection     The DBAL DB connection to use
41
-     * @param Cache          $cache          A cache service to be used
42
-     * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
43
-     *                                       Will be automatically created if not passed.
44
-     */
45
-    public function __construct(Connection $connection, Cache $cache, SchemaAnalyzer $schemaAnalyzer)
46
-    {
47
-        $this->connection = $connection;
48
-        $this->cache = $cache;
49
-        $this->schemaAnalyzer = $schemaAnalyzer;
50
-    }
51
-
52
-    /**
53
-     * Returns a unique ID for the current connection. Useful for namespacing cache entries in the current connection.
54
-     *
55
-     * @return string
56
-     */
57
-    public function getCachePrefix()
58
-    {
59
-        if ($this->cachePrefix === null) {
60
-            $this->cachePrefix = hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
61
-        }
62
-
63
-        return $this->cachePrefix;
64
-    }
65
-
66
-    /**
67
-     * Returns the (cached) schema.
68
-     *
69
-     * @return Schema
70
-     */
71
-    public function getSchema()
72
-    {
73
-        if ($this->schema === null) {
74
-            $cacheKey = $this->getCachePrefix().'_schema';
75
-            if ($this->cache->contains($cacheKey)) {
76
-                $this->schema = $this->cache->fetch($cacheKey);
77
-            } else {
78
-                $this->schema = $this->connection->getSchemaManager()->createSchema();
79
-                $this->cache->save($cacheKey, $this->schema);
80
-            }
81
-        }
82
-
83
-        return $this->schema;
84
-    }
85
-
86
-    /**
87
-     * Returns the list of pivot tables linked to table $tableName.
88
-     *
89
-     * @param string $tableName
90
-     *
91
-     * @return array|string[]
92
-     */
93
-    public function getPivotTableLinkedToTable($tableName)
94
-    {
95
-        $cacheKey = $this->getCachePrefix().'_pivottables_link';
96
-        if ($this->cache->contains($cacheKey)) {
97
-            return $this->cache->fetch($cacheKey);
98
-        }
99
-
100
-        $pivotTables = [];
101
-
102
-        $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
103
-        foreach ($junctionTables as $table) {
104
-            $fks = $table->getForeignKeys();
105
-            foreach ($fks as $fk) {
106
-                if ($fk->getForeignTableName() == $tableName) {
107
-                    $pivotTables[] = $table->getName();
108
-                    break;
109
-                }
110
-            }
111
-        }
112
-
113
-        $this->cache->save($cacheKey, $pivotTables);
114
-
115
-        return $pivotTables;
116
-    }
117
-
118
-    /**
119
-     * Returns the list of foreign keys pointing to the table represented by this bean, excluding foreign keys
120
-     * from junction tables and from inheritance.
121
-     *
122
-     * @return ForeignKeyConstraint[]
123
-     */
124
-    public function getIncomingForeignKeys($tableName)
125
-    {
126
-        $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
127
-        $junctionTableNames = array_map(function (Table $table) { return $table->getName(); }, $junctionTables);
128
-        $childrenRelationships = $this->schemaAnalyzer->getChildrenRelationships($tableName);
129
-
130
-        $fks = [];
131
-        foreach ($this->getSchema()->getTables() as $table) {
132
-            foreach ($table->getForeignKeys() as $fk) {
133
-                if ($fk->getForeignTableName() === $tableName) {
134
-                    if (in_array($fk->getLocalTableName(), $junctionTableNames)) {
135
-                        continue;
136
-                    }
137
-                    foreach ($childrenRelationships as $childFk) {
138
-                        if ($fk->getLocalTableName() === $childFk->getLocalTableName() && $fk->getLocalColumns() === $childFk->getLocalColumns()) {
139
-                            continue 2;
140
-                        }
141
-                    }
142
-                    $fks[] = $fk;
143
-                }
144
-            }
145
-        }
146
-
147
-        return $fks;
148
-    }
17
+	private $connection;
18
+
19
+	/**
20
+	 * @var Schema
21
+	 */
22
+	private $schema;
23
+
24
+	/**
25
+	 * @var string
26
+	 */
27
+	private $cachePrefix;
28
+
29
+	/**
30
+	 * @var Cache
31
+	 */
32
+	private $cache;
33
+
34
+	/**
35
+	 * @var SchemaAnalyzer
36
+	 */
37
+	private $schemaAnalyzer;
38
+
39
+	/**
40
+	 * @param Connection     $connection     The DBAL DB connection to use
41
+	 * @param Cache          $cache          A cache service to be used
42
+	 * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
43
+	 *                                       Will be automatically created if not passed.
44
+	 */
45
+	public function __construct(Connection $connection, Cache $cache, SchemaAnalyzer $schemaAnalyzer)
46
+	{
47
+		$this->connection = $connection;
48
+		$this->cache = $cache;
49
+		$this->schemaAnalyzer = $schemaAnalyzer;
50
+	}
51
+
52
+	/**
53
+	 * Returns a unique ID for the current connection. Useful for namespacing cache entries in the current connection.
54
+	 *
55
+	 * @return string
56
+	 */
57
+	public function getCachePrefix()
58
+	{
59
+		if ($this->cachePrefix === null) {
60
+			$this->cachePrefix = hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
61
+		}
62
+
63
+		return $this->cachePrefix;
64
+	}
65
+
66
+	/**
67
+	 * Returns the (cached) schema.
68
+	 *
69
+	 * @return Schema
70
+	 */
71
+	public function getSchema()
72
+	{
73
+		if ($this->schema === null) {
74
+			$cacheKey = $this->getCachePrefix().'_schema';
75
+			if ($this->cache->contains($cacheKey)) {
76
+				$this->schema = $this->cache->fetch($cacheKey);
77
+			} else {
78
+				$this->schema = $this->connection->getSchemaManager()->createSchema();
79
+				$this->cache->save($cacheKey, $this->schema);
80
+			}
81
+		}
82
+
83
+		return $this->schema;
84
+	}
85
+
86
+	/**
87
+	 * Returns the list of pivot tables linked to table $tableName.
88
+	 *
89
+	 * @param string $tableName
90
+	 *
91
+	 * @return array|string[]
92
+	 */
93
+	public function getPivotTableLinkedToTable($tableName)
94
+	{
95
+		$cacheKey = $this->getCachePrefix().'_pivottables_link';
96
+		if ($this->cache->contains($cacheKey)) {
97
+			return $this->cache->fetch($cacheKey);
98
+		}
99
+
100
+		$pivotTables = [];
101
+
102
+		$junctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
103
+		foreach ($junctionTables as $table) {
104
+			$fks = $table->getForeignKeys();
105
+			foreach ($fks as $fk) {
106
+				if ($fk->getForeignTableName() == $tableName) {
107
+					$pivotTables[] = $table->getName();
108
+					break;
109
+				}
110
+			}
111
+		}
112
+
113
+		$this->cache->save($cacheKey, $pivotTables);
114
+
115
+		return $pivotTables;
116
+	}
117
+
118
+	/**
119
+	 * Returns the list of foreign keys pointing to the table represented by this bean, excluding foreign keys
120
+	 * from junction tables and from inheritance.
121
+	 *
122
+	 * @return ForeignKeyConstraint[]
123
+	 */
124
+	public function getIncomingForeignKeys($tableName)
125
+	{
126
+		$junctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
127
+		$junctionTableNames = array_map(function (Table $table) { return $table->getName(); }, $junctionTables);
128
+		$childrenRelationships = $this->schemaAnalyzer->getChildrenRelationships($tableName);
129
+
130
+		$fks = [];
131
+		foreach ($this->getSchema()->getTables() as $table) {
132
+			foreach ($table->getForeignKeys() as $fk) {
133
+				if ($fk->getForeignTableName() === $tableName) {
134
+					if (in_array($fk->getLocalTableName(), $junctionTableNames)) {
135
+						continue;
136
+					}
137
+					foreach ($childrenRelationships as $childFk) {
138
+						if ($fk->getLocalTableName() === $childFk->getLocalTableName() && $fk->getLocalColumns() === $childFk->getLocalColumns()) {
139
+							continue 2;
140
+						}
141
+					}
142
+					$fks[] = $fk;
143
+				}
144
+			}
145
+		}
146
+
147
+		return $fks;
148
+	}
149 149
 }
Please login to merge, or discard this patch.