Completed
Push — 4.2 ( cdba14 )
by David
03:01
created

TDBMService::getColumnsList()   D

Complexity

Conditions 16
Paths 94

Size

Total Lines 90
Code Lines 55

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 90
c 0
b 0
f 0
rs 4.8736
cc 16
eloc 55
nc 94
nop 3

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
/*
4
 Copyright (C) 2006-2016 David Négrier - THE CODING MACHINE
5
6
This program is free software; you can redistribute it and/or modify
7
it under the terms of the GNU General Public License as published by
8
the Free Software Foundation; either version 2 of the License, or
9
(at your option) any later version.
10
11
This program is distributed in the hope that it will be useful,
12
but WITHOUT ANY WARRANTY; without even the implied warranty of
13
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
GNU General Public License for more details.
15
16
You should have received a copy of the GNU General Public License
17
along with this program; if not, write to the Free Software
18
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19
*/
20
21
namespace Mouf\Database\TDBM;
22
23
use Doctrine\Common\Cache\Cache;
24
use Doctrine\Common\Cache\VoidCache;
25
use Doctrine\DBAL\Connection;
26
use Doctrine\DBAL\Schema\Column;
27
use Doctrine\DBAL\Schema\ForeignKeyConstraint;
28
use Doctrine\DBAL\Schema\Schema;
29
use Doctrine\DBAL\Schema\Table;
30
use Doctrine\DBAL\Types\Type;
31
use Logger\Filters\MinLogLevelFilter;
32
use Mouf\Database\MagicQuery;
33
use Mouf\Database\SchemaAnalyzer\SchemaAnalyzer;
34
use Mouf\Database\TDBM\Utils\TDBMDaoGenerator;
35
use Psr\Log\LoggerInterface;
36
use Psr\Log\LogLevel;
37
use Psr\Log\NullLogger;
38
39
/**
40
 * The TDBMService class is the main TDBM class. It provides methods to retrieve TDBMObject instances
41
 * from the database.
42
 *
43
 * @author David Negrier
44
 * @ExtendedAction {"name":"Generate DAOs", "url":"tdbmadmin/", "default":false}
45
 */
46
class TDBMService
47
{
48
    const MODE_CURSOR = 1;
49
    const MODE_ARRAY = 2;
50
51
    /**
52
     * The database connection.
53
     *
54
     * @var Connection
55
     */
56
    private $connection;
57
58
    /**
59
     * @var SchemaAnalyzer
60
     */
61
    private $schemaAnalyzer;
62
63
    /**
64
     * @var MagicQuery
65
     */
66
    private $magicQuery;
67
68
    /**
69
     * @var TDBMSchemaAnalyzer
70
     */
71
    private $tdbmSchemaAnalyzer;
72
73
    /**
74
     * @var string
75
     */
76
    private $cachePrefix;
77
78
    /**
79
     * Cache of table of primary keys.
80
     * Primary keys are stored by tables, as an array of column.
81
     * For instance $primary_key['my_table'][0] will return the first column of the primary key of table 'my_table'.
82
     *
83
     * @var string[]
84
     */
85
    private $primaryKeysColumns;
86
87
    /**
88
     * Service storing objects in memory.
89
     * Access is done by table name and then by primary key.
90
     * If the primary key is split on several columns, access is done by an array of columns, serialized.
91
     *
92
     * @var StandardObjectStorage|WeakrefObjectStorage
93
     */
94
    private $objectStorage;
95
96
    /**
97
     * The fetch mode of the result sets returned by `getObjects`.
98
     * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY or TDBMObjectArray::MODE_COMPATIBLE_ARRAY.
99
     *
100
     * In 'MODE_ARRAY' mode (default), the result is an array. Use this mode by default (unless the list returned is very big).
101
     * 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,
102
     * and it cannot be accessed via key. Use this mode for large datasets processed by batch.
103
     * In 'MODE_COMPATIBLE_ARRAY' mode, the result is an old TDBMObjectArray (used up to TDBM 3.2).
104
     * You can access the array by key, or using foreach, several times.
105
     *
106
     * @var int
107
     */
108
    private $mode = self::MODE_ARRAY;
109
110
    /**
111
     * Table of new objects not yet inserted in database or objects modified that must be saved.
112
     *
113
     * @var \SplObjectStorage of DbRow objects
114
     */
115
    private $toSaveObjects;
116
117
    /**
118
     * A cache service to be used.
119
     *
120
     * @var Cache|null
121
     */
122
    private $cache;
123
124
    /**
125
     * Map associating a table name to a fully qualified Bean class name.
126
     *
127
     * @var array
128
     */
129
    private $tableToBeanMap = [];
130
131
    /**
132
     * @var \ReflectionClass[]
133
     */
134
    private $reflectionClassCache = array();
135
136
    /**
137
     * @var LoggerInterface
138
     */
139
    private $rootLogger;
140
141
    /**
142
     * @var MinLogLevelFilter|NullLogger
143
     */
144
    private $logger;
145
146
    /**
147
     * @var OrderByAnalyzer
148
     */
149
    private $orderByAnalyzer;
150
151
    /**
152
     * @param Connection     $connection     The DBAL DB connection to use
153
     * @param Cache|null     $cache          A cache service to be used
154
     * @param SchemaAnalyzer $schemaAnalyzer The schema analyzer that will be used to find shortest paths...
155
     *                                       Will be automatically created if not passed
156
     */
157
    public function __construct(Connection $connection, Cache $cache = null, SchemaAnalyzer $schemaAnalyzer = null, LoggerInterface $logger = null)
158
    {
159
        if (extension_loaded('weakref')) {
160
            $this->objectStorage = new WeakrefObjectStorage();
161
        } else {
162
            $this->objectStorage = new StandardObjectStorage();
163
        }
164
        $this->connection = $connection;
165
        if ($cache !== null) {
166
            $this->cache = $cache;
167
        } else {
168
            $this->cache = new VoidCache();
169
        }
170
        if ($schemaAnalyzer) {
171
            $this->schemaAnalyzer = $schemaAnalyzer;
172
        } else {
173
            $this->schemaAnalyzer = new SchemaAnalyzer($this->connection->getSchemaManager(), $this->cache, $this->getConnectionUniqueId());
174
        }
175
176
        $this->magicQuery = new MagicQuery($this->connection, $this->cache, $this->schemaAnalyzer);
177
178
        $this->tdbmSchemaAnalyzer = new TDBMSchemaAnalyzer($connection, $this->cache, $this->schemaAnalyzer);
179
        $this->cachePrefix = $this->tdbmSchemaAnalyzer->getCachePrefix();
180
181
        $this->toSaveObjects = new \SplObjectStorage();
182
        if ($logger === null) {
183
            $this->logger = new NullLogger();
184
            $this->rootLogger = new NullLogger();
185
        } else {
186
            $this->rootLogger = $logger;
187
            $this->setLogLevel(LogLevel::WARNING);
188
        }
189
        $this->orderByAnalyzer = new OrderByAnalyzer($this->cache, $this->cachePrefix);
190
    }
191
192
    /**
193
     * Returns the object used to connect to the database.
194
     *
195
     * @return Connection
196
     */
197
    public function getConnection()
198
    {
199
        return $this->connection;
200
    }
201
202
    /**
203
     * Creates a unique cache key for the current connection.
204
     *
205
     * @return string
206
     */
207
    private function getConnectionUniqueId()
208
    {
209
        return hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName());
210
    }
211
212
    /**
213
     * Sets the default fetch mode of the result sets returned by `findObjects`.
214
     * Can be one of: TDBMObjectArray::MODE_CURSOR or TDBMObjectArray::MODE_ARRAY.
215
     *
216
     * 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).
217
     * 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
218
     * several times. In cursor mode, you cannot access the result set by key. Use this mode for large datasets processed by batch.
219
     *
220
     * @param int $mode
221
     *
222
     * @return $this
223
     *
224
     * @throws TDBMException
225
     */
226
    public function setFetchMode($mode)
227
    {
228
        if ($mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
229
            throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
230
        }
231
        $this->mode = $mode;
232
233
        return $this;
234
    }
235
236
    /**
237
     * Returns a TDBMObject associated from table "$table_name".
238
     * If the $filters parameter is an int/string, the object returned will be the object whose primary key = $filters.
239
     * $filters can also be a set of TDBM_Filters (see the findObjects method for more details).
240
     *
241
     * For instance, if there is a table 'users', with a primary key on column 'user_id' and a column 'user_name', then
242
     * 			$user = $tdbmService->getObject('users',1);
243
     * 			echo $user->name;
244
     * will return the name of the user whose user_id is one.
245
     *
246
     * 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.
247
     * For instance:
248
     * 			$group = $tdbmService->getObject('groups',array(1,2));
249
     *
250
     * Note that TDBMObject performs caching for you. If you get twice the same object, the reference of the object you will get
251
     * will be the same.
252
     *
253
     * For instance:
254
     * 			$user1 = $tdbmService->getObject('users',1);
255
     * 			$user2 = $tdbmService->getObject('users',1);
256
     * 			$user1->name = 'John Doe';
257
     * 			echo $user2->name;
258
     * will return 'John Doe'.
259
     *
260
     * You can use filters instead of passing the primary key. For instance:
261
     * 			$user = $tdbmService->getObject('users',new EqualFilter('users', 'login', 'jdoe'));
262
     * This will return the user whose login is 'jdoe'.
263
     * Please note that if 2 users have the jdoe login in database, the method will throw a TDBM_DuplicateRowException.
264
     *
265
     * Also, you can specify the return class for the object (provided the return class extends TDBMObject).
266
     * For instance:
267
     *  	$user = $tdbmService->getObject('users',1,'User');
268
     * will return an object from the "User" class. The "User" class must extend the "TDBMObject" class.
269
     * Please be sure not to override any method or any property unless you perfectly know what you are doing!
270
     *
271
     * @param string $table_name   The name of the table we retrieve an object from
272
     * @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)
273
     * @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
274
     * @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
275
     *
276
     * @return TDBMObject
277
     */
278
/*	public function getObject($table_name, $filters, $className = null, $lazy_loading = false) {
279
280
        if (is_array($filters) || $filters instanceof FilterInterface) {
281
            $isFilterBag = false;
282
            if (is_array($filters)) {
283
                // Is this a multiple primary key or a filter bag?
284
                // Let's have a look at the first item of the array to decide.
285
                foreach ($filters as $filter) {
286
                    if (is_array($filter) || $filter instanceof FilterInterface) {
287
                        $isFilterBag = true;
288
                    }
289
                    break;
290
                }
291
            } else {
292
                $isFilterBag = true;
293
            }
294
295
            if ($isFilterBag == true) {
296
                // If a filter bag was passer in parameter, let's perform a findObjects.
297
                $objects = $this->findObjects($table_name, $filters, null, null, null, $className);
298
                if (count($objects) == 0) {
299
                    return null;
300
                } elseif (count($objects) > 1) {
301
                    throw new DuplicateRowException("Error while querying an object for table '$table_name': ".count($objects)." rows have been returned, but we should have received at most one.");
302
                }
303
                // Return the first and only object.
304
                if ($objects instanceof \Generator) {
305
                    return $objects->current();
306
                } else {
307
                    return $objects[0];
308
                }
309
            }
310
        }
311
        $id = $filters;
312
        if ($this->connection == null) {
313
            throw new TDBMException("Error while calling TdbmService->getObject(): No connection has been established on the database!");
314
        }
315
        $table_name = $this->connection->toStandardcase($table_name);
316
317
        // If the ID is null, let's throw an exception
318
        if ($id === null) {
319
            throw new TDBMException("The ID you passed to TdbmService->getObject is null for the object of type '$table_name'. Objects primary keys cannot be null.");
320
        }
321
322
        // If the primary key is split over many columns, the IDs are passed in an array. Let's serialize this array to store it.
323
        if (is_array($id)) {
324
            $id = serialize($id);
325
        }
326
327
        if ($className === null) {
328
            if (isset($this->tableToBeanMap[$table_name])) {
329
                $className = $this->tableToBeanMap[$table_name];
330
            } else {
331
                $className = "Mouf\\Database\\TDBM\\TDBMObject";
332
            }
333
        }
334
335
        if ($this->objectStorage->has($table_name, $id)) {
336
            $obj = $this->objectStorage->get($table_name, $id);
337
            if (is_a($obj, $className)) {
338
                return $obj;
339
            } else {
340
                throw new TDBMException("Error! The object with ID '$id' for table '$table_name' has already been retrieved. The type for this object is '".get_class($obj)."'' which is not a subtype of '$className'");
341
            }
342
        }
343
344
        if ($className != "Mouf\\Database\\TDBM\\TDBMObject" && !is_subclass_of($className, "Mouf\\Database\\TDBM\\TDBMObject")) {
345
            if (!class_exists($className)) {
346
                throw new TDBMException("Error while calling TDBMService->getObject: The class ".$className." does not exist.");
347
            } else {
348
                throw new TDBMException("Error while calling TDBMService->getObject: The class ".$className." should extend TDBMObject.");
349
            }
350
        }
351
        $obj = new $className($this, $table_name, $id);
352
353
        if ($lazy_loading == false) {
354
            // If we are not doing lazy loading, let's load the object:
355
            $obj->_dbLoadIfNotLoaded();
356
        }
357
358
        $this->objectStorage->set($table_name, $id, $obj);
359
360
        return $obj;
361
    }*/
362
363
    /**
364
     * Removes the given object from database.
365
     * This cannot be called on an object that is not attached to this TDBMService
366
     * (will throw a TDBMInvalidOperationException).
367
     *
368
     * @param AbstractTDBMObject $object the object to delete
369
     *
370
     * @throws TDBMException
371
     * @throws TDBMInvalidOperationException
372
     */
373
    public function delete(AbstractTDBMObject $object)
374
    {
375
        switch ($object->_getStatus()) {
376
            case TDBMObjectStateEnum::STATE_DELETED:
377
                // Nothing to do, object already deleted.
378
                return;
379
            case TDBMObjectStateEnum::STATE_DETACHED:
380
                throw new TDBMInvalidOperationException('Cannot delete a detached object');
381
            case TDBMObjectStateEnum::STATE_NEW:
382
                $this->deleteManyToManyRelationships($object);
383
                foreach ($object->_getDbRows() as $dbRow) {
384
                    $this->removeFromToSaveObjectList($dbRow);
385
                }
386
                break;
387
            case TDBMObjectStateEnum::STATE_DIRTY:
388
                foreach ($object->_getDbRows() as $dbRow) {
389
                    $this->removeFromToSaveObjectList($dbRow);
390
                }
391
                // And continue deleting...
0 ignored issues
show
Unused Code Comprehensibility introduced by
43% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
392
            case TDBMObjectStateEnum::STATE_NOT_LOADED:
393
            case TDBMObjectStateEnum::STATE_LOADED:
394
                $this->deleteManyToManyRelationships($object);
395
                // Let's delete db rows, in reverse order.
396
                foreach (array_reverse($object->_getDbRows()) as $dbRow) {
397
                    $tableName = $dbRow->_getDbTableName();
398
                    $primaryKeys = $dbRow->_getPrimaryKeys();
399
                    $this->connection->delete($tableName, $primaryKeys);
400
                    $this->objectStorage->remove($dbRow->_getDbTableName(), $this->getObjectHash($primaryKeys));
401
                }
402
                break;
403
            // @codeCoverageIgnoreStart
404
            default:
405
                throw new TDBMInvalidOperationException('Unexpected status for bean');
406
            // @codeCoverageIgnoreEnd
407
        }
408
409
        $object->_setStatus(TDBMObjectStateEnum::STATE_DELETED);
410
    }
411
412
    /**
413
     * Removes all many to many relationships for this object.
414
     *
415
     * @param AbstractTDBMObject $object
416
     */
417
    private function deleteManyToManyRelationships(AbstractTDBMObject $object)
418
    {
419
        foreach ($object->_getDbRows() as $tableName => $dbRow) {
420
            $pivotTables = $this->tdbmSchemaAnalyzer->getPivotTableLinkedToTable($tableName);
421
            foreach ($pivotTables as $pivotTable) {
422
                $remoteBeans = $object->_getRelationships($pivotTable);
423
                foreach ($remoteBeans as $remoteBean) {
424
                    $object->_removeRelationship($pivotTable, $remoteBean);
425
                }
426
            }
427
        }
428
        $this->persistManyToManyRelationships($object);
429
    }
430
431
    /**
432
     * This function removes the given object from the database. It will also remove all objects relied to the one given
433
     * by parameter before all.
434
     *
435
     * Notice: if the object has a multiple primary key, the function will not work.
436
     *
437
     * @param AbstractTDBMObject $objToDelete
438
     */
439
    public function deleteCascade(AbstractTDBMObject $objToDelete)
440
    {
441
        $this->deleteAllConstraintWithThisObject($objToDelete);
442
        $this->delete($objToDelete);
443
    }
444
445
    /**
446
     * This function is used only in TDBMService (private function)
447
     * It will call deleteCascade function foreach object relied with a foreign key to the object given by parameter.
448
     *
449
     * @param AbstractTDBMObject $obj
450
     */
451
    private function deleteAllConstraintWithThisObject(AbstractTDBMObject $obj)
452
    {
453
        $dbRows = $obj->_getDbRows();
454
        foreach ($dbRows as $dbRow) {
455
            $tableName = $dbRow->_getDbTableName();
456
            $pks = array_values($dbRow->_getPrimaryKeys());
457
            if (!empty($pks)) {
458
                $incomingFks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($tableName);
459
460
                foreach ($incomingFks as $incomingFk) {
461
                    $filter = array_combine($incomingFk->getLocalColumns(), $pks);
462
463
                    $results = $this->findObjects($incomingFk->getLocalTableName(), $filter);
464
465
                    foreach ($results as $bean) {
466
                        $this->deleteCascade($bean);
467
                    }
468
                }
469
            }
470
        }
471
    }
472
473
    /**
474
     * This function performs a save() of all the objects that have been modified.
475
     */
476
    public function completeSave()
477
    {
478
        foreach ($this->toSaveObjects as $dbRow) {
479
            $this->save($dbRow->getTDBMObject());
480
        }
481
    }
482
483
    /**
484
     * Takes in input a filter_bag (which can be about anything from a string to an array of TDBMObjects... see above from documentation),
485
     * and gives back a proper Filter object.
486
     *
487
     * @param mixed $filter_bag
488
     * @param int   $counter
489
     *
490
     * @return array First item: filter string, second item: parameters
491
     *
492
     * @throws TDBMException
493
     */
494
    public function buildFilterFromFilterBag($filter_bag, $counter = 1)
495
    {
496
        if ($filter_bag === null) {
497
            return ['', []];
498
        } elseif (is_string($filter_bag)) {
499
            return [$filter_bag, []];
500
        } elseif (is_array($filter_bag)) {
501
            $sqlParts = [];
502
            $parameters = [];
503
            foreach ($filter_bag as $column => $value) {
504
                if (is_int($column)) {
505
                    list($subSqlPart, $subParameters) = $this->buildFilterFromFilterBag($value, $counter);
506
                    $sqlParts[] = $subSqlPart;
507
                    $parameters += $subParameters;
508
                } else {
509
                    $paramName = 'tdbmparam'.$counter;
510
                    if (is_array($value)) {
511
                        $sqlParts[] = $this->connection->quoteIdentifier($column).' IN :'.$paramName;
512
                    } else {
513
                        $sqlParts[] = $this->connection->quoteIdentifier($column).' = :'.$paramName;
514
                    }
515
                    $parameters[$paramName] = $value;
516
                    ++$counter;
517
                }
518
            }
519
520
            return [implode(' AND ', $sqlParts), $parameters];
521
        } elseif ($filter_bag instanceof AbstractTDBMObject) {
522
            $sqlParts = [];
523
            $parameters = [];
524
            $dbRows = $filter_bag->_getDbRows();
525
            $dbRow = reset($dbRows);
526
            $primaryKeys = $dbRow->_getPrimaryKeys();
527
528
            foreach ($primaryKeys as $column => $value) {
529
                $paramName = 'tdbmparam'.$counter;
530
                $sqlParts[] = $this->connection->quoteIdentifier($dbRow->_getDbTableName()).'.'.$this->connection->quoteIdentifier($column).' = :'.$paramName;
531
                $parameters[$paramName] = $value;
532
                ++$counter;
533
            }
534
535
            return [implode(' AND ', $sqlParts), $parameters];
536
        } elseif ($filter_bag instanceof \Iterator) {
537
            return $this->buildFilterFromFilterBag(iterator_to_array($filter_bag), $counter);
538
        } else {
539
            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.');
540
        }
541
    }
542
543
    /**
544
     * @param string $table
545
     *
546
     * @return string[]
547
     */
548
    public function getPrimaryKeyColumns($table)
549
    {
550
        if (!isset($this->primaryKeysColumns[$table])) {
551
            $this->primaryKeysColumns[$table] = $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getPrimaryKeyColumns();
552
553
            // TODO TDBM4: See if we need to improve error reporting if table name does not exist.
554
555
            /*$arr = array();
556
            foreach ($this->connection->getPrimaryKey($table) as $col) {
557
                $arr[] = $col->name;
558
            }
559
            // The primaryKeysColumns contains only the column's name, not the DB_Column object.
560
            $this->primaryKeysColumns[$table] = $arr;
561
            if (empty($this->primaryKeysColumns[$table]))
562
            {
563
                // Unable to find primary key.... this is an error
564
                // Let's try to be precise in error reporting. Let's try to find the table.
565
                $tables = $this->connection->checkTableExist($table);
566
                if ($tables === true)
567
                throw new TDBMException("Could not find table primary key for table '$table'. Please define a primary key for this table.");
568
                elseif ($tables !== null) {
569
                    if (count($tables)==1)
570
                    $str = "Could not find table '$table'. Maybe you meant this table: '".$tables[0]."'";
571
                    else
572
                    $str = "Could not find table '$table'. Maybe you meant one of those tables: '".implode("', '",$tables)."'";
573
                    throw new TDBMException($str);
574
                }
575
            }*/
576
        }
577
578
        return $this->primaryKeysColumns[$table];
579
    }
580
581
    /**
582
     * This is an internal function, you should not use it in your application.
583
     * This is used internally by TDBM to add an object to the object cache.
584
     *
585
     * @param DbRow $dbRow
586
     */
587
    public function _addToCache(DbRow $dbRow)
588
    {
589
        $primaryKey = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
590
        $hash = $this->getObjectHash($primaryKey);
591
        $this->objectStorage->set($dbRow->_getDbTableName(), $hash, $dbRow);
592
    }
593
594
    /**
595
     * This is an internal function, you should not use it in your application.
596
     * This is used internally by TDBM to remove the object from the list of objects that have been
597
     * created/updated but not saved yet.
598
     *
599
     * @param DbRow $myObject
600
     */
601
    private function removeFromToSaveObjectList(DbRow $myObject)
602
    {
603
        unset($this->toSaveObjects[$myObject]);
604
    }
605
606
    /**
607
     * This is an internal function, you should not use it in your application.
608
     * This is used internally by TDBM to add an object to the list of objects that have been
609
     * created/updated but not saved yet.
610
     *
611
     * @param AbstractTDBMObject $myObject
612
     */
613
    public function _addToToSaveObjectList(DbRow $myObject)
614
    {
615
        $this->toSaveObjects[$myObject] = true;
616
    }
617
618
    /**
619
     * Generates all the daos and beans.
620
     *
621
     * @param string $daoFactoryClassName The classe name of the DAO factory
622
     * @param string $daonamespace        The namespace for the DAOs, without trailing \
623
     * @param string $beannamespace       The Namespace for the beans, without trailing \
624
     * @param bool   $storeInUtc          If the generated daos should store the date in UTC timezone instead of user's timezone
625
     * @param string $composerFile        If it's set, location of custom Composer file. Relative to project root
626
     *
627
     * @return \string[] the list of tables
628
     */
629
    public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc, $composerFile = null)
630
    {
631
        // Purge cache before generating anything.
632
        $this->cache->deleteAll();
0 ignored issues
show
Bug introduced by
The method deleteAll() does not exist on Doctrine\Common\Cache\Cache. Did you maybe mean delete()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
633
634
        $tdbmDaoGenerator = new TDBMDaoGenerator($this->schemaAnalyzer, $this->tdbmSchemaAnalyzer->getSchema(), $this->tdbmSchemaAnalyzer);
635
        if (null !== $composerFile) {
636
            $tdbmDaoGenerator->setComposerFile(__DIR__.'/../../../../../../../'.$composerFile);
637
        }
638
639
        return $tdbmDaoGenerator->generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc);
640
    }
641
642
    /**
643
     * @param array<string, string> $tableToBeanMap
644
     */
645
    public function setTableToBeanMap(array $tableToBeanMap)
646
    {
647
        $this->tableToBeanMap = $tableToBeanMap;
648
    }
649
650
    /**
651
     * Saves $object by INSERTing or UPDAT(E)ing it in the database.
652
     *
653
     * @param AbstractTDBMObject $object
654
     *
655
     * @throws TDBMException
656
     */
657
    public function save(AbstractTDBMObject $object)
658
    {
659
        $status = $object->_getStatus();
660
661
        if ($status === null) {
662
            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)));
663
        }
664
665
        // Let's attach this object if it is in detached state.
666
        if ($status === TDBMObjectStateEnum::STATE_DETACHED) {
667
            $object->_attach($this);
668
            $status = $object->_getStatus();
669
        }
670
671
        if ($status === TDBMObjectStateEnum::STATE_NEW) {
672
            $dbRows = $object->_getDbRows();
673
674
            $unindexedPrimaryKeys = array();
675
676
            foreach ($dbRows as $dbRow) {
677
                $tableName = $dbRow->_getDbTableName();
678
679
                $schema = $this->tdbmSchemaAnalyzer->getSchema();
680
                $tableDescriptor = $schema->getTable($tableName);
681
682
                $primaryKeyColumns = $this->getPrimaryKeyColumns($tableName);
683
684
                if (empty($unindexedPrimaryKeys)) {
685
                    $primaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
686
                } else {
687
                    // First insert, the children must have the same primary key as the parent.
688
                    $primaryKeys = $this->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $unindexedPrimaryKeys);
689
                    $dbRow->_setPrimaryKeys($primaryKeys);
690
                }
691
692
                $references = $dbRow->_getReferences();
693
694
                // Let's save all references in NEW or DETACHED state (we need their primary key)
695
                foreach ($references as $fkName => $reference) {
696
                    if ($reference !== null) {
697
                        $refStatus = $reference->_getStatus();
698
                        if ($refStatus === TDBMObjectStateEnum::STATE_NEW || $refStatus === TDBMObjectStateEnum::STATE_DETACHED) {
699
                            $this->save($reference);
700
                        }
701
                    }
702
                }
703
704
                $dbRowData = $dbRow->_getDbRow();
705
706
                // Let's see if the columns for primary key have been set before inserting.
707
                // We assume that if one of the value of the PK has been set, the PK is set.
708
                $isPkSet = !empty($primaryKeys);
709
710
                /*if (!$isPkSet) {
711
                    // if there is no autoincrement and no pk set, let's go in error.
712
                    $isAutoIncrement = true;
713
714
                    foreach ($primaryKeyColumns as $pkColumnName) {
715
                        $pkColumn = $tableDescriptor->getColumn($pkColumnName);
716
                        if (!$pkColumn->getAutoincrement()) {
717
                            $isAutoIncrement = false;
718
                        }
719
                    }
720
721
                    if (!$isAutoIncrement) {
722
                        $msg = "Error! You did not set the primary key(s) for the new object of type '$tableName'. The primary key is not set to 'autoincrement' so you must either set the primary key in the object or modify the DB model to create an primary key with auto-increment.";
723
                        throw new TDBMException($msg);
724
                    }
725
726
                }*/
727
728
                $types = [];
729
                $escapedDbRowData = [];
730
731 View Code Duplication
                foreach ($dbRowData as $columnName => $value) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
732
                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
733
                    $types[] = $columnDescriptor->getType();
734
                    $escapedDbRowData[$this->connection->quoteIdentifier($columnName)] = $value;
735
                }
736
737
                $this->connection->insert($tableName, $escapedDbRowData, $types);
738
739
                if (!$isPkSet && count($primaryKeyColumns) == 1) {
740
                    $id = $this->connection->lastInsertId();
741
                    $primaryKeys[$primaryKeyColumns[0]] = $id;
742
                }
743
744
                // TODO: change this to some private magic accessor in future
745
                $dbRow->_setPrimaryKeys($primaryKeys);
746
                $unindexedPrimaryKeys = array_values($primaryKeys);
747
748
                /*
749
                 * When attached, on "save", we check if the column updated is part of a primary key
750
                 * If this is part of a primary key, we call the _update_id method that updates the id in the list of known objects.
751
                 * This method should first verify that the id is not already used (and is not auto-incremented)
752
                 *
753
                 * In the object, the key is stored in an array of  (column => value), that can be directly used to update the record.
754
                 *
755
                 *
756
                 */
757
758
                /*try {
0 ignored issues
show
Unused Code Comprehensibility introduced by
42% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
759
                    $this->db_connection->exec($sql);
760
                } catch (TDBMException $e) {
761
                    $this->db_onerror = true;
762
763
                    // Strange..... if we do not have the line below, bad inserts are not catched.
764
                    // It seems that destructors are called before the registered shutdown function (PHP >=5.0.5)
765
                    //if ($this->tdbmService->isProgramExiting())
766
                    //	trigger_error("program exiting");
767
                    trigger_error($e->getMessage(), E_USER_ERROR);
768
769
                    if (!$this->tdbmService->isProgramExiting())
770
                        throw $e;
771
                    else
772
                    {
773
                        trigger_error($e->getMessage(), E_USER_ERROR);
774
                    }
775
                }*/
776
777
                // Let's remove this object from the $new_objects static table.
778
                $this->removeFromToSaveObjectList($dbRow);
779
780
                // TODO: change this behaviour to something more sensible performance-wise
781
                // Maybe a setting to trigger this globally?
782
                //$this->status = TDBMObjectStateEnum::STATE_NOT_LOADED;
0 ignored issues
show
Unused Code Comprehensibility introduced by
40% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
783
                //$this->db_modified_state = false;
0 ignored issues
show
Unused Code Comprehensibility introduced by
50% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
784
                //$dbRow = array();
0 ignored issues
show
Unused Code Comprehensibility introduced by
63% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
785
786
                // Let's add this object to the list of objects in cache.
787
                $this->_addToCache($dbRow);
788
            }
789
790
            $object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
791
        } elseif ($status === TDBMObjectStateEnum::STATE_DIRTY) {
792
            $dbRows = $object->_getDbRows();
793
794
            foreach ($dbRows as $dbRow) {
795
                $references = $dbRow->_getReferences();
796
797
                // Let's save all references in NEW state (we need their primary key)
798
                foreach ($references as $fkName => $reference) {
799
                    if ($reference !== null && $reference->_getStatus() === TDBMObjectStateEnum::STATE_NEW) {
800
                        $this->save($reference);
801
                    }
802
                }
803
804
                // Let's first get the primary keys
805
                $tableName = $dbRow->_getDbTableName();
806
                $dbRowData = $dbRow->_getDbRow();
807
808
                $schema = $this->tdbmSchemaAnalyzer->getSchema();
809
                $tableDescriptor = $schema->getTable($tableName);
810
811
                $primaryKeys = $dbRow->_getPrimaryKeys();
812
813
                $types = [];
814
                $escapedDbRowData = [];
815
                $escapedPrimaryKeys = [];
816
817 View Code Duplication
                foreach ($dbRowData as $columnName => $value) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
818
                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
819
                    $types[] = $columnDescriptor->getType();
820
                    $escapedDbRowData[$this->connection->quoteIdentifier($columnName)] = $value;
821
                }
822 View Code Duplication
                foreach ($primaryKeys as $columnName => $value) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
823
                    $columnDescriptor = $tableDescriptor->getColumn($columnName);
824
                    $types[] = $columnDescriptor->getType();
825
                    $escapedPrimaryKeys[$this->connection->quoteIdentifier($columnName)] = $value;
826
                }
827
828
                $this->connection->update($tableName, $escapedDbRowData, $escapedPrimaryKeys, $types);
829
830
                // Let's check if the primary key has been updated...
831
                $needsUpdatePk = false;
832
                foreach ($primaryKeys as $column => $value) {
833
                    if (!isset($dbRowData[$column]) || $dbRowData[$column] != $value) {
834
                        $needsUpdatePk = true;
835
                        break;
836
                    }
837
                }
838
                if ($needsUpdatePk) {
839
                    $this->objectStorage->remove($tableName, $this->getObjectHash($primaryKeys));
840
                    $newPrimaryKeys = $this->getPrimaryKeysForObjectFromDbRow($dbRow);
841
                    $dbRow->_setPrimaryKeys($newPrimaryKeys);
842
                    $this->objectStorage->set($tableName, $this->getObjectHash($primaryKeys), $dbRow);
843
                }
844
845
                // Let's remove this object from the list of objects to save.
846
                $this->removeFromToSaveObjectList($dbRow);
847
            }
848
849
            $object->_setStatus(TDBMObjectStateEnum::STATE_LOADED);
850
        } elseif ($status === TDBMObjectStateEnum::STATE_DELETED) {
851
            throw new TDBMInvalidOperationException('This object has been deleted. It cannot be saved.');
852
        }
853
854
        // Finally, let's save all the many to many relationships to this bean.
855
        $this->persistManyToManyRelationships($object);
856
    }
857
858
    private function persistManyToManyRelationships(AbstractTDBMObject $object)
859
    {
860
        foreach ($object->_getCachedRelationships() as $pivotTableName => $storage) {
861
            $tableDescriptor = $this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName);
862
            list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $object);
863
864
            $toRemoveFromStorage = [];
865
866
            foreach ($storage as $remoteBean) {
867
                /* @var $remoteBean AbstractTDBMObject */
868
                $statusArr = $storage[$remoteBean];
869
                $status = $statusArr['status'];
870
                $reverse = $statusArr['reverse'];
871
                if ($reverse) {
872
                    continue;
873
                }
874
875
                if ($status === 'new') {
876
                    $remoteBeanStatus = $remoteBean->_getStatus();
877
                    if ($remoteBeanStatus === TDBMObjectStateEnum::STATE_NEW || $remoteBeanStatus === TDBMObjectStateEnum::STATE_DETACHED) {
878
                        // Let's save remote bean if needed.
879
                        $this->save($remoteBean);
880
                    }
881
882
                    $filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
883
884
                    $types = [];
885
                    $escapedFilters = [];
886
887 View Code Duplication
                    foreach ($filters as $columnName => $value) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
888
                        $columnDescriptor = $tableDescriptor->getColumn($columnName);
889
                        $types[] = $columnDescriptor->getType();
890
                        $escapedFilters[$this->connection->quoteIdentifier($columnName)] = $value;
891
                    }
892
893
                    $this->connection->insert($pivotTableName, $escapedFilters, $types);
894
895
                    // Finally, let's mark relationships as saved.
896
                    $statusArr['status'] = 'loaded';
897
                    $storage[$remoteBean] = $statusArr;
898
                    $remoteStorage = $remoteBean->_getCachedRelationships()[$pivotTableName];
899
                    $remoteStatusArr = $remoteStorage[$object];
900
                    $remoteStatusArr['status'] = 'loaded';
901
                    $remoteStorage[$object] = $remoteStatusArr;
902
                } elseif ($status === 'delete') {
903
                    $filters = $this->getPivotFilters($object, $remoteBean, $localFk, $remoteFk);
904
905
                    $types = [];
906
907
                    foreach ($filters as $columnName => $value) {
908
                        $columnDescriptor = $tableDescriptor->getColumn($columnName);
909
                        $types[] = $columnDescriptor->getType();
910
                    }
911
912
                    $this->connection->delete($pivotTableName, $filters, $types);
913
914
                    // Finally, let's remove relationships completely from bean.
915
                    $toRemoveFromStorage[] = $remoteBean;
916
917
                    $remoteBean->_getCachedRelationships()[$pivotTableName]->detach($object);
918
                }
919
            }
920
921
            // Note: due to https://bugs.php.net/bug.php?id=65629, we cannot delete an element inside a foreach loop on a SplStorageObject.
922
            // Therefore, we cache elements in the $toRemoveFromStorage to remove them at a later stage.
923
            foreach ($toRemoveFromStorage as $remoteBean) {
924
                $storage->detach($remoteBean);
925
            }
926
        }
927
    }
928
929
    private function getPivotFilters(AbstractTDBMObject $localBean, AbstractTDBMObject $remoteBean, ForeignKeyConstraint $localFk, ForeignKeyConstraint $remoteFk)
930
    {
931
        $localBeanPk = $this->getPrimaryKeyValues($localBean);
932
        $remoteBeanPk = $this->getPrimaryKeyValues($remoteBean);
933
        $localColumns = $localFk->getLocalColumns();
934
        $remoteColumns = $remoteFk->getLocalColumns();
935
936
        $localFilters = array_combine($localColumns, $localBeanPk);
937
        $remoteFilters = array_combine($remoteColumns, $remoteBeanPk);
938
939
        return array_merge($localFilters, $remoteFilters);
940
    }
941
942
    /**
943
     * Returns the "values" of the primary key.
944
     * This returns the primary key from the $primaryKey attribute, not the one stored in the columns.
945
     *
946
     * @param AbstractTDBMObject $bean
947
     *
948
     * @return array numerically indexed array of values
949
     */
950
    private function getPrimaryKeyValues(AbstractTDBMObject $bean)
951
    {
952
        $dbRows = $bean->_getDbRows();
953
        $dbRow = reset($dbRows);
954
955
        return array_values($dbRow->_getPrimaryKeys());
956
    }
957
958
    /**
959
     * Returns a unique hash used to store the object based on its primary key.
960
     * If the array contains only one value, then the value is returned.
961
     * Otherwise, a hash representing the array is returned.
962
     *
963
     * @param array $primaryKeys An array of columns => values forming the primary key
964
     *
965
     * @return string
966
     */
967
    public function getObjectHash(array $primaryKeys)
968
    {
969
        if (count($primaryKeys) === 1) {
970
            return reset($primaryKeys);
971
        } else {
972
            ksort($primaryKeys);
973
974
            return md5(json_encode($primaryKeys));
975
        }
976
    }
977
978
    /**
979
     * Returns an array of primary keys from the object.
980
     * The primary keys are extracted from the object columns and not from the primary keys stored in the
981
     * $primaryKeys variable of the object.
982
     *
983
     * @param DbRow $dbRow
984
     *
985
     * @return array Returns an array of column => value
986
     */
987
    public function getPrimaryKeysForObjectFromDbRow(DbRow $dbRow)
988
    {
989
        $table = $dbRow->_getDbTableName();
990
        $dbRowData = $dbRow->_getDbRow();
991
992
        return $this->_getPrimaryKeysFromObjectData($table, $dbRowData);
993
    }
994
995
    /**
996
     * Returns an array of primary keys for the given row.
997
     * The primary keys are extracted from the object columns.
998
     *
999
     * @param $table
1000
     * @param array $columns
1001
     *
1002
     * @return array
1003
     */
1004
    public function _getPrimaryKeysFromObjectData($table, array $columns)
1005
    {
1006
        $primaryKeyColumns = $this->getPrimaryKeyColumns($table);
1007
        $values = array();
1008
        foreach ($primaryKeyColumns as $column) {
1009
            if (isset($columns[$column])) {
1010
                $values[$column] = $columns[$column];
1011
            }
1012
        }
1013
1014
        return $values;
1015
    }
1016
1017
    /**
1018
     * Attaches $object to this TDBMService.
1019
     * The $object must be in DETACHED state and will pass in NEW state.
1020
     *
1021
     * @param AbstractTDBMObject $object
1022
     *
1023
     * @throws TDBMInvalidOperationException
1024
     */
1025
    public function attach(AbstractTDBMObject $object)
1026
    {
1027
        $object->_attach($this);
1028
    }
1029
1030
    /**
1031
     * Returns an associative array (column => value) for the primary keys from the table name and an
1032
     * indexed array of primary key values.
1033
     *
1034
     * @param string $tableName
1035
     * @param array  $indexedPrimaryKeys
1036
     */
1037
    public function _getPrimaryKeysFromIndexedPrimaryKeys($tableName, array $indexedPrimaryKeys)
1038
    {
1039
        $primaryKeyColumns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getPrimaryKeyColumns();
1040
1041
        if (count($primaryKeyColumns) !== count($indexedPrimaryKeys)) {
1042
            throw new TDBMException(sprintf('Wrong number of columns passed for primary key. Expected %s columns for table "%s",
1043
			got %s instead.', count($primaryKeyColumns), $tableName, count($indexedPrimaryKeys)));
1044
        }
1045
1046
        return array_combine($primaryKeyColumns, $indexedPrimaryKeys);
1047
    }
1048
1049
    /**
1050
     * Return the list of tables (from child to parent) joining the tables passed in parameter.
1051
     * Tables must be in a single line of inheritance. The method will find missing tables.
1052
     *
1053
     * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1054
     * we must be able to find all other tables.
1055
     *
1056
     * @param string[] $tables
1057
     *
1058
     * @return string[]
1059
     */
1060
    public function _getLinkBetweenInheritedTables(array $tables)
1061
    {
1062
        sort($tables);
1063
1064
        return $this->fromCache($this->cachePrefix.'_linkbetweeninheritedtables_'.implode('__split__', $tables),
1065
            function () use ($tables) {
1066
                return $this->_getLinkBetweenInheritedTablesWithoutCache($tables);
1067
            });
1068
    }
1069
1070
    /**
1071
     * Return the list of tables (from child to parent) joining the tables passed in parameter.
1072
     * Tables must be in a single line of inheritance. The method will find missing tables.
1073
     *
1074
     * Algorithm: one of those tables is the ultimate child. From this child, by recursively getting the parent,
1075
     * we must be able to find all other tables.
1076
     *
1077
     * @param string[] $tables
1078
     *
1079
     * @return string[]
1080
     */
1081
    private function _getLinkBetweenInheritedTablesWithoutCache(array $tables)
1082
    {
1083
        $schemaAnalyzer = $this->schemaAnalyzer;
1084
1085
        foreach ($tables as $currentTable) {
1086
            $allParents = [$currentTable];
1087
            while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1088
                $currentTable = $currentFk->getForeignTableName();
1089
                $allParents[] = $currentTable;
1090
            }
1091
1092
            // Now, does the $allParents contain all the tables we want?
1093
            $notFoundTables = array_diff($tables, $allParents);
1094
            if (empty($notFoundTables)) {
1095
                // We have a winner!
1096
                return $allParents;
1097
            }
1098
        }
1099
1100
        throw new TDBMException(sprintf('The tables (%s) cannot be linked by an inheritance relationship.', implode(', ', $tables)));
1101
    }
1102
1103
    /**
1104
     * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1105
     *
1106
     * @param string $table
1107
     *
1108
     * @return string[]
1109
     */
1110
    public function _getRelatedTablesByInheritance($table)
1111
    {
1112
        return $this->fromCache($this->cachePrefix.'_relatedtables_'.$table, function () use ($table) {
1113
            return $this->_getRelatedTablesByInheritanceWithoutCache($table);
1114
        });
1115
    }
1116
1117
    /**
1118
     * Returns the list of tables related to this table (via a parent or child inheritance relationship).
1119
     *
1120
     * @param string $table
1121
     *
1122
     * @return string[]
1123
     */
1124
    private function _getRelatedTablesByInheritanceWithoutCache($table)
1125
    {
1126
        $schemaAnalyzer = $this->schemaAnalyzer;
1127
1128
        // Let's scan the parent tables
1129
        $currentTable = $table;
1130
1131
        $parentTables = [];
1132
1133
        // Get parent relationship
1134
        while ($currentFk = $schemaAnalyzer->getParentRelationship($currentTable)) {
1135
            $currentTable = $currentFk->getForeignTableName();
1136
            $parentTables[] = $currentTable;
1137
        }
1138
1139
        // Let's recurse in children
1140
        $childrenTables = $this->exploreChildrenTablesRelationships($schemaAnalyzer, $table);
1141
1142
        return array_merge(array_reverse($parentTables), $childrenTables);
1143
    }
1144
1145
    /**
1146
     * Explore all the children and descendant of $table and returns ForeignKeyConstraints on those.
1147
     *
1148
     * @param string $table
1149
     *
1150
     * @return string[]
1151
     */
1152
    private function exploreChildrenTablesRelationships(SchemaAnalyzer $schemaAnalyzer, $table)
1153
    {
1154
        $tables = [$table];
1155
        $keys = $schemaAnalyzer->getChildrenRelationships($table);
1156
1157
        foreach ($keys as $key) {
1158
            $tables = array_merge($tables, $this->exploreChildrenTablesRelationships($schemaAnalyzer, $key->getLocalTableName()));
1159
        }
1160
1161
        return $tables;
1162
    }
1163
1164
    /**
1165
     * @param string $tableName
1166
     *
1167
     * @return ForeignKeyConstraint[]
1168
     */
1169
    private function getParentRelationshipForeignKeys($tableName)
1170
    {
1171
        return $this->fromCache($this->cachePrefix.'_parentrelationshipfks_'.$tableName, function () use ($tableName) {
1172
            return $this->getParentRelationshipForeignKeysWithoutCache($tableName);
1173
        });
1174
    }
1175
1176
    /**
1177
     * @param string $tableName
1178
     *
1179
     * @return ForeignKeyConstraint[]
1180
     */
1181
    private function getParentRelationshipForeignKeysWithoutCache($tableName)
1182
    {
1183
        $parentFks = [];
1184
        $currentTable = $tableName;
1185
        while ($currentFk = $this->schemaAnalyzer->getParentRelationship($currentTable)) {
1186
            $currentTable = $currentFk->getForeignTableName();
1187
            $parentFks[] = $currentFk;
1188
        }
1189
1190
        return $parentFks;
1191
    }
1192
1193
    /**
1194
     * @param string $tableName
1195
     *
1196
     * @return ForeignKeyConstraint[]
1197
     */
1198
    private function getChildrenRelationshipForeignKeys($tableName)
1199
    {
1200
        return $this->fromCache($this->cachePrefix.'_childrenrelationshipfks_'.$tableName, function () use ($tableName) {
1201
            return $this->getChildrenRelationshipForeignKeysWithoutCache($tableName);
1202
        });
1203
    }
1204
1205
    /**
1206
     * @param string $tableName
1207
     *
1208
     * @return ForeignKeyConstraint[]
1209
     */
1210
    private function getChildrenRelationshipForeignKeysWithoutCache($tableName)
1211
    {
1212
        $children = $this->schemaAnalyzer->getChildrenRelationships($tableName);
1213
1214
        if (!empty($children)) {
1215
            $fksTables = array_map(function (ForeignKeyConstraint $fk) {
1216
                return $this->getChildrenRelationshipForeignKeys($fk->getLocalTableName());
1217
            }, $children);
1218
1219
            $fks = array_merge($children, call_user_func_array('array_merge', $fksTables));
1220
1221
            return $fks;
1222
        } else {
1223
            return [];
1224
        }
1225
    }
1226
1227
    /**
1228
     * Casts a foreign key into SQL, assuming table name is used with no alias.
1229
     * The returned value does contain only one table. For instance:.
1230
     *
1231
     * " LEFT JOIN table2 ON table1.id = table2.table1_id"
1232
     *
1233
     * @param ForeignKeyConstraint $fk
1234
     * @param bool                 $leftTableIsLocal
1235
     *
1236
     * @return string
1237
     */
1238
    /*private function foreignKeyToSql(ForeignKeyConstraint $fk, $leftTableIsLocal) {
0 ignored issues
show
Unused Code Comprehensibility introduced by
59% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
1239
        $onClauses = [];
1240
        $foreignTableName = $this->connection->quoteIdentifier($fk->getForeignTableName());
1241
        $foreignColumns = $fk->getForeignColumns();
1242
        $localTableName = $this->connection->quoteIdentifier($fk->getLocalTableName());
1243
        $localColumns = $fk->getLocalColumns();
1244
        $columnCount = count($localTableName);
1245
1246
        for ($i = 0; $i < $columnCount; $i++) {
1247
            $onClauses[] = sprintf("%s.%s = %s.%s",
1248
                $localTableName,
1249
                $this->connection->quoteIdentifier($localColumns[$i]),
1250
                $foreignColumns,
1251
                $this->connection->quoteIdentifier($foreignColumns[$i])
1252
                );
1253
        }
1254
1255
        $onClause = implode(' AND ', $onClauses);
1256
1257
        if ($leftTableIsLocal) {
1258
            return sprintf(" LEFT JOIN %s ON (%s)", $foreignTableName, $onClause);
1259
        } else {
1260
            return sprintf(" LEFT JOIN %s ON (%s)", $localTableName, $onClause);
1261
        }
1262
    }*/
1263
1264
    /**
1265
     * Returns an identifier for the group of tables passed in parameter.
1266
     *
1267
     * @param string[] $relatedTables
1268
     *
1269
     * @return string
1270
     */
1271
    private function getTableGroupName(array $relatedTables)
1272
    {
1273
        sort($relatedTables);
1274
1275
        return implode('_``_', $relatedTables);
1276
    }
1277
1278
    /**
1279
     * Returns a `ResultIterator` object representing filtered records of "$mainTable" .
1280
     *
1281
     * The findObjects method should be the most used query method in TDBM if you want to query the database for objects.
1282
     * (Note: if you want to query the database for an object by its primary key, use the findObjectByPk method).
1283
     *
1284
     * The findObjects method takes in parameter:
1285
     * 	- mainTable: the kind of bean you want to retrieve. In TDBM, a bean matches a database row, so the
1286
     * 			`$mainTable` parameter should be the name of an existing table in database.
1287
     *  - filter: The filter is a filter bag. It is what you use to filter your request (the WHERE part in SQL).
1288
     *          It can be a string (SQL Where clause), or even a bean or an associative array (key = column to filter, value = value to find)
1289
     *  - parameters: The parameters used in the filter. If you pass a SQL string as a filter, be sure to avoid
1290
     *          concatenating parameters in the string (this leads to SQL injection and also to poor caching performance).
1291
     *          Instead, please consider passing parameters (see documentation for more details).
1292
     *  - additionalTablesFetch: An array of SQL tables names. The beans related to those tables will be fetched along
1293
     *          the main table. This is useful to avoid hitting the database with numerous subqueries.
1294
     *  - mode: The fetch mode of the result. See `setFetchMode()` method for more details.
1295
     *
1296
     * The `findObjects` method will return a `ResultIterator`. A `ResultIterator` is an object that behaves as an array
1297
     * (in ARRAY mode) at least. It can be iterated using a `foreach` loop.
1298
     *
1299
     * Finally, if filter_bag is null, the whole table is returned.
1300
     *
1301
     * @param string                       $mainTable             The name of the table queried
1302
     * @param string|array|null            $filter                The SQL filters to apply to the query (the WHERE part). Columns from tables different from $mainTable must be prefixed by the table name (in the form: table.column)
1303
     * @param array                        $parameters
1304
     * @param string|UncheckedOrderBy|null $orderString           The ORDER BY part of the query. Columns from tables different from $mainTable must be prefixed by the table name (in the form: table.column)
1305
     * @param array                        $additionalTablesFetch
1306
     * @param int                          $mode
1307
     * @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
1308
     *
1309
     * @return ResultIterator An object representing an array of results
1310
     *
1311
     * @throws TDBMException
1312
     */
1313
    public function findObjects(string $mainTable, $filter = null, array $parameters = array(), $orderString = null, array $additionalTablesFetch = array(), $mode = null, string $className = null)
1314
    {
1315
        // $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
1316
        if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
1317
            throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
1318
        }
1319
1320
        list($filterString, $additionalParameters) = $this->buildFilterFromFilterBag($filter);
1321
1322
        $parameters = array_merge($parameters, $additionalParameters);
1323
1324
        list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($mainTable, $additionalTablesFetch, $orderString);
1325
1326
        $sql = 'SELECT DISTINCT '.implode(', ', $columnsList).' FROM MAGICJOIN('.$mainTable.')';
1327
1328
        $schema = $this->tdbmSchemaAnalyzer->getSchema();
1329
        $pkColumnNames = $schema->getTable($mainTable)->getPrimaryKeyColumns();
1330
        $pkColumnNames = array_map(function ($pkColumn) use ($mainTable) {
1331
            return $this->connection->quoteIdentifier($mainTable).'.'.$this->connection->quoteIdentifier($pkColumn);
1332
        }, $pkColumnNames);
1333
1334
        $countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM MAGICJOIN('.$mainTable.')';
1335
1336
        if (!empty($filterString)) {
1337
            $sql .= ' WHERE '.$filterString;
1338
            $countSql .= ' WHERE '.$filterString;
1339
        }
1340
1341
        if (!empty($orderString)) {
1342
            $sql .= ' ORDER BY '.$orderString;
1343
        }
1344
1345 View Code Duplication
        if ($mode !== null && $mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1346
            throw new TDBMException("Unknown fetch mode: '".$this->mode."'");
1347
        }
1348
1349
        $mode = $mode ?: $this->mode;
1350
1351
        return new ResultIterator($sql, $countSql, $parameters, $columnDescList, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
1352
    }
1353
1354
    /**
1355
     * @param string                       $mainTable   The name of the table queried
1356
     * @param string                       $from        The from sql statement
1357
     * @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)
1358
     * @param array                        $parameters
1359
     * @param string|UncheckedOrderBy|null $orderString The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column)
1360
     * @param int                          $mode
1361
     * @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
1362
     *
1363
     * @return ResultIterator An object representing an array of results
1364
     *
1365
     * @throws TDBMException
1366
     */
1367
    public function findObjectsFromSql(string $mainTable, string $from, $filter = null, array $parameters = array(), $orderString = null, $mode = null, string $className = null)
1368
    {
1369
        // $mainTable is not secured in MagicJoin, let's add a bit of security to avoid SQL injection.
1370
        if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $mainTable)) {
1371
            throw new TDBMException(sprintf("Invalid table name: '%s'", $mainTable));
1372
        }
1373
1374
        $columnsList = null;
1375
1376
        list($filterString, $additionalParameters) = $this->buildFilterFromFilterBag($filter);
1377
1378
        $parameters = array_merge($parameters, $additionalParameters);
1379
1380
        $allFetchedTables = $this->_getRelatedTablesByInheritance($mainTable);
1381
1382
        $columnDescList = [];
1383
        $schema = $this->tdbmSchemaAnalyzer->getSchema();
1384
        $tableGroupName = $this->getTableGroupName($allFetchedTables);
1385
1386
        foreach ($schema->getTable($mainTable)->getColumns() as $column) {
1387
            $columnName = $column->getName();
1388
            $columnDescList[] = [
1389
                'as' => $columnName,
1390
                'table' => $mainTable,
1391
                'column' => $columnName,
1392
                'type' => $column->getType(),
1393
                'tableGroup' => $tableGroupName,
1394
            ];
1395
        }
1396
1397
        $sql = 'SELECT DISTINCT '.implode(', ', array_map(function ($columnDesc) use ($mainTable) {
1398
            return $this->connection->quoteIdentifier($mainTable).'.'.$this->connection->quoteIdentifier($columnDesc['column']);
1399
        }, $columnDescList)).' FROM '.$from;
1400
1401
        if (count($allFetchedTables) > 1) {
1402
            list($columnDescList, $columnsList, $orderString) = $this->getColumnsList($mainTable, [], $orderString);
1403
        }
1404
1405
        // Let's compute the COUNT.
1406
        $pkColumnNames = $schema->getTable($mainTable)->getPrimaryKeyColumns();
1407
        $pkColumnNames = array_map(function ($pkColumn) use ($mainTable) {
1408
            return $this->connection->quoteIdentifier($mainTable).'.'.$this->connection->quoteIdentifier($pkColumn);
1409
        }, $pkColumnNames);
1410
1411
        $countSql = 'SELECT COUNT(DISTINCT '.implode(', ', $pkColumnNames).') FROM '.$from;
1412
1413
        if (!empty($filterString)) {
1414
            $sql .= ' WHERE '.$filterString;
1415
            $countSql .= ' WHERE '.$filterString;
1416
        }
1417
1418
        if (!empty($orderString)) {
1419
            $sql .= ' ORDER BY '.$orderString;
1420
        }
1421
1422
        if (stripos($countSql, 'GROUP BY') !== false) {
1423
            throw new TDBMException('Unsupported use of GROUP BY in SQL request.');
1424
        }
1425
1426 View Code Duplication
        if ($mode !== null && $mode !== self::MODE_CURSOR && $mode !== self::MODE_ARRAY) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1427
            throw new TDBMException("Unknown fetch mode: '".$mode."'");
1428
        }
1429
1430
        if ($columnsList !== null) {
1431
            $joinSql = '';
1432
            $parentFks = $this->getParentRelationshipForeignKeys($mainTable);
1433 View Code Duplication
            foreach ($parentFks as $fk) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1434
                $joinSql .= sprintf(' JOIN %s ON (%s.%s = %s.%s)',
1435
                    $this->connection->quoteIdentifier($fk->getForeignTableName()),
1436
                    $this->connection->quoteIdentifier($fk->getLocalTableName()),
1437
                    $this->connection->quoteIdentifier($fk->getLocalColumns()[0]),
1438
                    $this->connection->quoteIdentifier($fk->getForeignTableName()),
1439
                    $this->connection->quoteIdentifier($fk->getForeignColumns()[0])
1440
                    );
1441
            }
1442
1443
            $childrenFks = $this->getChildrenRelationshipForeignKeys($mainTable);
1444 View Code Duplication
            foreach ($childrenFks as $fk) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1445
                $joinSql .= sprintf(' LEFT JOIN %s ON (%s.%s = %s.%s)',
1446
                    $this->connection->quoteIdentifier($fk->getLocalTableName()),
1447
                    $this->connection->quoteIdentifier($fk->getForeignTableName()),
1448
                    $this->connection->quoteIdentifier($fk->getForeignColumns()[0]),
1449
                    $this->connection->quoteIdentifier($fk->getLocalTableName()),
1450
                    $this->connection->quoteIdentifier($fk->getLocalColumns()[0])
1451
                );
1452
            }
1453
1454
            $sql = 'SELECT '.implode(', ', $columnsList).' FROM ('.$sql.') AS '.$mainTable.' '.$joinSql;
1455
        }
1456
1457
        $mode = $mode ?: $this->mode;
1458
1459
        return new ResultIterator($sql, $countSql, $parameters, $columnDescList, $this->objectStorage, $className, $this, $this->magicQuery, $mode, $this->logger);
1460
    }
1461
1462
    /**
1463
     * Returns the column list that must be fetched for the SQL request.
1464
     *
1465
     * Note: MySQL dictates that ORDER BYed columns should appear in the SELECT clause.
1466
     *
1467
     * @param string                       $mainTable
1468
     * @param array                        $additionalTablesFetch
1469
     * @param string|UncheckedOrderBy|null $orderBy
1470
     *
1471
     * @return array
1472
     *
1473
     * @throws \Doctrine\DBAL\Schema\SchemaException
1474
     */
1475
    private function getColumnsList(string $mainTable, array $additionalTablesFetch = array(), $orderBy = null)
1476
    {
1477
        // From the table name and the additional tables we want to fetch, let's build a list of all tables
1478
        // that must be part of the select columns.
1479
1480
        $tableGroups = [];
1481
        $allFetchedTables = $this->_getRelatedTablesByInheritance($mainTable);
1482
        $tableGroupName = $this->getTableGroupName($allFetchedTables);
1483
        foreach ($allFetchedTables as $table) {
1484
            $tableGroups[$table] = $tableGroupName;
1485
        }
1486
1487
        $columnsList = [];
1488
        $columnDescList = [];
1489
        $sortColumn = 0;
1490
        $reconstructedOrderBy = null;
1491
1492
        // Now, let's deal with "order by columns"
1493
        if ($orderBy !== null) {
1494
            if ($orderBy instanceof UncheckedOrderBy) {
1495
                $securedOrderBy = false;
1496
                $orderBy = $orderBy->getOrderBy();
1497
                $reconstructedOrderBy = $orderBy;
1498
            } else {
1499
                $securedOrderBy = true;
1500
                $reconstructedOrderBys = [];
1501
            }
1502
            $orderByColumns = $this->orderByAnalyzer->analyzeOrderBy($orderBy);
1503
1504
            // If we sort by a column, there is a high chance we will fetch the bean containing this column.
1505
            // Hence, we should add the table to the $additionalTablesFetch
1506
            foreach ($orderByColumns as $orderByColumn) {
1507
                if ($orderByColumn['type'] === 'colref') {
1508
                    if ($orderByColumn['table'] !== null) {
1509
                        $additionalTablesFetch[] = $orderByColumn['table'];
1510
                    }
1511
                    if ($securedOrderBy) {
1512
                        $reconstructedOrderBys[] = ($orderByColumn['table'] !== null ? $orderByColumn['table'].'.' : '').$orderByColumn['column'].' '.$orderByColumn['direction'];
0 ignored issues
show
Bug introduced by
The variable $reconstructedOrderBys does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1513
                    }
1514
                } elseif ($orderByColumn['type'] === 'expr') {
1515
                    $sortColumnName = 'sort_column_'.$sortColumn;
1516
                    $columnsList[] = $orderByColumn['expr'].' as '.$sortColumnName;
1517
                    $columnDescList[] = [
1518
                        'tableGroup' => null,
1519
                    ];
1520
                    ++$sortColumn;
1521
1522
                    if ($securedOrderBy) {
1523
                        throw new TDBMInvalidArgumentException('Invalid ORDER BY column: "'.$orderByColumn['expr'].'". If you want to use expression in your ORDER BY clause, you must wrap them in a UncheckedOrderBy object. For instance: new UncheckedOrderBy("col1 + col2 DESC")');
1524
                    }
1525
                }
1526
            }
1527
1528
            if ($reconstructedOrderBy === null) {
1529
                $reconstructedOrderBy = implode(', ', $reconstructedOrderBys);
1530
            }
1531
        }
1532
1533
        foreach ($additionalTablesFetch as $additionalTable) {
1534
            $relatedTables = $this->_getRelatedTablesByInheritance($additionalTable);
1535
            $tableGroupName = $this->getTableGroupName($relatedTables);
1536
            foreach ($relatedTables as $table) {
1537
                $tableGroups[$table] = $tableGroupName;
1538
            }
1539
            $allFetchedTables = array_merge($allFetchedTables, $relatedTables);
1540
        }
1541
1542
        // Let's remove any duplicate
1543
        $allFetchedTables = array_flip(array_flip($allFetchedTables));
1544
1545
        $schema = $this->tdbmSchemaAnalyzer->getSchema();
1546
1547
        // Now, let's build the column list
1548
        foreach ($allFetchedTables as $table) {
1549
            foreach ($schema->getTable($table)->getColumns() as $column) {
1550
                $columnName = $column->getName();
1551
                $columnDescList[] = [
1552
                    'as' => $table.'____'.$columnName,
1553
                    'table' => $table,
1554
                    'column' => $columnName,
1555
                    'type' => $column->getType(),
1556
                    'tableGroup' => $tableGroups[$table],
1557
                ];
1558
                $columnsList[] = $this->connection->quoteIdentifier($table).'.'.$this->connection->quoteIdentifier($columnName).' as '.
1559
                    $this->connection->quoteIdentifier($table.'____'.$columnName);
1560
            }
1561
        }
1562
1563
        return [$columnDescList, $columnsList, $reconstructedOrderBy];
1564
    }
1565
1566
    /**
1567
     * @param $table
1568
     * @param array  $primaryKeys
1569
     * @param array  $additionalTablesFetch
1570
     * @param bool   $lazy                  Whether to perform lazy loading on this object or not
1571
     * @param string $className
1572
     *
1573
     * @return AbstractTDBMObject
1574
     *
1575
     * @throws TDBMException
1576
     */
1577
    public function findObjectByPk(string $table, array $primaryKeys, array $additionalTablesFetch = array(), bool $lazy = false, string $className = null)
1578
    {
1579
        $primaryKeys = $this->_getPrimaryKeysFromObjectData($table, $primaryKeys);
1580
        $hash = $this->getObjectHash($primaryKeys);
1581
1582
        if ($this->objectStorage->has($table, $hash)) {
1583
            $dbRow = $this->objectStorage->get($table, $hash);
1584
            $bean = $dbRow->getTDBMObject();
1585
            if ($className !== null && !is_a($bean, $className)) {
1586
                throw new TDBMException("TDBM cannot create a bean of class '".$className."'. The requested object was already loaded and its class is '".get_class($bean)."'");
1587
            }
1588
1589
            return $bean;
1590
        }
1591
1592
        // Are we performing lazy fetching?
1593
        if ($lazy === true) {
1594
            // Can we perform lazy fetching?
1595
            $tables = $this->_getRelatedTablesByInheritance($table);
1596
            // Only allowed if no inheritance.
1597
            if (count($tables) === 1) {
1598
                if ($className === null) {
1599
                    $className = isset($this->tableToBeanMap[$table]) ? $this->tableToBeanMap[$table] : 'Mouf\\Database\\TDBM\\TDBMObject';
1600
                }
1601
1602
                // Let's construct the bean
1603
                if (!isset($this->reflectionClassCache[$className])) {
1604
                    $this->reflectionClassCache[$className] = new \ReflectionClass($className);
1605
                }
1606
                // Let's bypass the constructor when creating the bean!
1607
                $bean = $this->reflectionClassCache[$className]->newInstanceWithoutConstructor();
1608
                /* @var $bean AbstractTDBMObject */
1609
                $bean->_constructLazy($table, $primaryKeys, $this);
1610
1611
                return $bean;
1612
            }
1613
        }
1614
1615
        // Did not find the object in cache? Let's query it!
1616
        return $this->findObjectOrFail($table, $primaryKeys, [], $additionalTablesFetch, $className);
1617
    }
1618
1619
    /**
1620
     * Returns a unique bean (or null) according to the filters passed in parameter.
1621
     *
1622
     * @param string            $mainTable             The name of the table queried
1623
     * @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)
1624
     * @param array             $parameters
1625
     * @param array             $additionalTablesFetch
1626
     * @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
1627
     *
1628
     * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters
1629
     *
1630
     * @throws TDBMException
1631
     */
1632 View Code Duplication
    public function findObject(string $mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), string $className = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1633
    {
1634
        $objects = $this->findObjects($mainTable, $filter, $parameters, null, $additionalTablesFetch, self::MODE_ARRAY, $className);
1635
        $page = $objects->take(0, 2);
1636
        $count = $page->count();
1637
        if ($count > 1) {
1638
            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.");
1639
        } elseif ($count === 0) {
1640
            return;
1641
        }
1642
1643
        return $page[0];
1644
    }
1645
1646
    /**
1647
     * Returns a unique bean (or null) according to the filters passed in parameter.
1648
     *
1649
     * @param string            $mainTable  The name of the table queried
1650
     * @param string            $from       The from sql statement
1651
     * @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)
1652
     * @param array             $parameters
1653
     * @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
1654
     *
1655
     * @return AbstractTDBMObject|null The object we want, or null if no object matches the filters
1656
     *
1657
     * @throws TDBMException
1658
     */
1659 View Code Duplication
    public function findObjectFromSql($mainTable, $from, $filter = null, array $parameters = array(), $className = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1660
    {
1661
        $objects = $this->findObjectsFromSql($mainTable, $from, $filter, $parameters, null, self::MODE_ARRAY, $className);
1662
        $page = $objects->take(0, 2);
1663
        $count = $page->count();
1664
        if ($count > 1) {
1665
            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.");
1666
        } elseif ($count === 0) {
1667
            return;
1668
        }
1669
1670
        return $page[0];
1671
    }
1672
1673
    /**
1674
     * Returns a unique bean according to the filters passed in parameter.
1675
     * Throws a NoBeanFoundException if no bean was found for the filter passed in parameter.
1676
     *
1677
     * @param string            $mainTable             The name of the table queried
1678
     * @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)
1679
     * @param array             $parameters
1680
     * @param array             $additionalTablesFetch
1681
     * @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
1682
     *
1683
     * @return AbstractTDBMObject The object we want
1684
     *
1685
     * @throws TDBMException
1686
     */
1687
    public function findObjectOrFail(string $mainTable, $filter = null, array $parameters = array(), array $additionalTablesFetch = array(), string $className = null)
1688
    {
1689
        $bean = $this->findObject($mainTable, $filter, $parameters, $additionalTablesFetch, $className);
1690
        if ($bean === null) {
1691
            throw new NoBeanFoundException("No result found for query on table '".$mainTable."'");
1692
        }
1693
1694
        return $bean;
1695
    }
1696
1697
    /**
1698
     * @param array $beanData An array of data: array<table, array<column, value>>
1699
     *
1700
     * @return array an array with first item = class name, second item = table name and third item = list of tables needed
1701
     */
1702
    public function _getClassNameFromBeanData(array $beanData)
1703
    {
1704
        if (count($beanData) === 1) {
1705
            $tableName = array_keys($beanData)[0];
1706
            $allTables = [$tableName];
1707
        } else {
1708
            $tables = [];
1709
            foreach ($beanData as $table => $row) {
1710
                $primaryKeyColumns = $this->getPrimaryKeyColumns($table);
1711
                $pkSet = false;
1712
                foreach ($primaryKeyColumns as $columnName) {
1713
                    if ($row[$columnName] !== null) {
1714
                        $pkSet = true;
1715
                        break;
1716
                    }
1717
                }
1718
                if ($pkSet) {
1719
                    $tables[] = $table;
1720
                }
1721
            }
1722
1723
            // $tables contains the tables for this bean. Let's view the top most part of the hierarchy
1724
            $allTables = $this->_getLinkBetweenInheritedTables($tables);
1725
            $tableName = $allTables[0];
1726
        }
1727
1728
        // Only one table in this bean. Life is sweat, let's look at its type:
1729
        if (isset($this->tableToBeanMap[$tableName])) {
1730
            return [$this->tableToBeanMap[$tableName], $tableName, $allTables];
1731
        } else {
1732
            return ['Mouf\\Database\\TDBM\\TDBMObject', $tableName, $allTables];
1733
        }
1734
    }
1735
1736
    /**
1737
     * Returns an item from cache or computes it using $closure and puts it in cache.
1738
     *
1739
     * @param string   $key
1740
     * @param callable $closure
1741
     *
1742
     * @return mixed
1743
     */
1744
    private function fromCache(string $key, callable $closure)
1745
    {
1746
        $item = $this->cache->fetch($key);
1747
        if ($item === false) {
1748
            $item = $closure();
1749
            $this->cache->save($key, $item);
1750
        }
1751
1752
        return $item;
1753
    }
1754
1755
    /**
1756
     * Returns the foreign key object.
1757
     *
1758
     * @param string $table
1759
     * @param string $fkName
1760
     *
1761
     * @return ForeignKeyConstraint
1762
     */
1763
    public function _getForeignKeyByName(string $table, string $fkName)
1764
    {
1765
        return $this->tdbmSchemaAnalyzer->getSchema()->getTable($table)->getForeignKey($fkName);
1766
    }
1767
1768
    /**
1769
     * @param $pivotTableName
1770
     * @param AbstractTDBMObject $bean
1771
     *
1772
     * @return AbstractTDBMObject[]
1773
     */
1774
    public function _getRelatedBeans(string $pivotTableName, AbstractTDBMObject $bean)
1775
    {
1776
        list($localFk, $remoteFk) = $this->getPivotTableForeignKeys($pivotTableName, $bean);
1777
        /* @var $localFk ForeignKeyConstraint */
1778
        /* @var $remoteFk ForeignKeyConstraint */
1779
        $remoteTable = $remoteFk->getForeignTableName();
1780
1781
        $primaryKeys = $this->getPrimaryKeyValues($bean);
1782
        $columnNames = array_map(function ($name) use ($pivotTableName) {
1783
            return $pivotTableName.'.'.$name;
1784
        }, $localFk->getLocalColumns());
1785
1786
        $filter = array_combine($columnNames, $primaryKeys);
1787
1788
        return $this->findObjects($remoteTable, $filter);
1789
    }
1790
1791
    /**
1792
     * @param $pivotTableName
1793
     * @param AbstractTDBMObject $bean The LOCAL bean
1794
     *
1795
     * @return ForeignKeyConstraint[] First item: the LOCAL bean, second item: the REMOTE bean
1796
     *
1797
     * @throws TDBMException
1798
     */
1799
    private function getPivotTableForeignKeys(string $pivotTableName, AbstractTDBMObject $bean)
1800
    {
1801
        $fks = array_values($this->tdbmSchemaAnalyzer->getSchema()->getTable($pivotTableName)->getForeignKeys());
1802
        $table1 = $fks[0]->getForeignTableName();
1803
        $table2 = $fks[1]->getForeignTableName();
1804
1805
        $beanTables = array_map(function (DbRow $dbRow) {
1806
            return $dbRow->_getDbTableName();
1807
        }, $bean->_getDbRows());
1808
1809
        if (in_array($table1, $beanTables)) {
1810
            return [$fks[0], $fks[1]];
1811
        } elseif (in_array($table2, $beanTables)) {
1812
            return [$fks[1], $fks[0]];
1813
        } else {
1814
            throw new TDBMException("Unexpected bean type in getPivotTableForeignKeys. Awaiting beans from table {$table1} and {$table2} for pivot table {$pivotTableName}");
1815
        }
1816
    }
1817
1818
    /**
1819
     * Returns a list of pivot tables linked to $bean.
1820
     *
1821
     * @param AbstractTDBMObject $bean
1822
     *
1823
     * @return string[]
1824
     */
1825
    public function _getPivotTablesLinkedToBean(AbstractTDBMObject $bean)
1826
    {
1827
        $junctionTables = [];
1828
        $allJunctionTables = $this->schemaAnalyzer->detectJunctionTables(true);
1829
        foreach ($bean->_getDbRows() as $dbRow) {
1830
            foreach ($allJunctionTables as $table) {
1831
                // There are exactly 2 FKs since this is a pivot table.
1832
                $fks = array_values($table->getForeignKeys());
1833
1834
                if ($fks[0]->getForeignTableName() === $dbRow->_getDbTableName() || $fks[1]->getForeignTableName() === $dbRow->_getDbTableName()) {
1835
                    $junctionTables[] = $table->getName();
1836
                }
1837
            }
1838
        }
1839
1840
        return $junctionTables;
1841
    }
1842
1843
    /**
1844
     * Array of types for tables.
1845
     * Key: table name
1846
     * Value: array of types indexed by column.
1847
     *
1848
     * @var array[]
1849
     */
1850
    private $typesForTable = [];
0 ignored issues
show
Unused Code introduced by
The property $typesForTable is not used and could be removed.

This check marks private properties in classes that are never used. Those properties can be removed.

Loading history...
1851
1852
    /**
1853
     * @internal
1854
     *
1855
     * @param string $tableName
1856
     *
1857
     * @return Type[]
1858
     */
1859
    public function _getColumnTypesForTable(string $tableName)
1860
    {
1861
        if (!isset($typesForTable[$tableName])) {
0 ignored issues
show
Bug introduced by
The variable $typesForTable seems only to be defined at a later point. As such the call to isset() seems to always evaluate to false.

This check marks calls to isset(...) or empty(...) that are found before the variable itself is defined. These will always have the same result.

This is likely the result of code being shifted around. Consider removing these calls.

Loading history...
1862
            $columns = $this->tdbmSchemaAnalyzer->getSchema()->getTable($tableName)->getColumns();
1863
            $typesForTable[$tableName] = array_map(function (Column $column) {
0 ignored issues
show
Coding Style Comprehensibility introduced by
$typesForTable was never initialized. Although not strictly required by PHP, it is generally a good practice to add $typesForTable = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
1864
                return $column->getType();
1865
            }, $columns);
1866
        }
1867
1868
        return $typesForTable[$tableName];
1869
    }
1870
1871
    /**
1872
     * Sets the minimum log level.
1873
     * $level must be one of Psr\Log\LogLevel::xxx.
1874
     *
1875
     * Defaults to LogLevel::WARNING
1876
     *
1877
     * @param string $level
1878
     */
1879
    public function setLogLevel(string $level)
1880
    {
1881
        $this->logger = new MinLogLevelFilter($this->rootLogger, $level);
1882
    }
1883
}
1884