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