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