@@ -15,214 +15,214 @@ discard block |
||
15 | 15 | */ |
16 | 16 | class BeanDescriptor |
17 | 17 | { |
18 | - /** |
|
19 | - * @var Table |
|
20 | - */ |
|
21 | - private $table; |
|
22 | - |
|
23 | - /** |
|
24 | - * @var SchemaAnalyzer |
|
25 | - */ |
|
26 | - private $schemaAnalyzer; |
|
27 | - |
|
28 | - /** |
|
29 | - * @var Schema |
|
30 | - */ |
|
31 | - private $schema; |
|
32 | - |
|
33 | - /** |
|
34 | - * @var AbstractBeanPropertyDescriptor[] |
|
35 | - */ |
|
36 | - private $beanPropertyDescriptors = []; |
|
37 | - |
|
38 | - /** |
|
39 | - * @var TDBMSchemaAnalyzer |
|
40 | - */ |
|
41 | - private $tdbmSchemaAnalyzer; |
|
42 | - |
|
43 | - public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
44 | - { |
|
45 | - $this->table = $table; |
|
46 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
47 | - $this->schema = $schema; |
|
48 | - $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
49 | - $this->initBeanPropertyDescriptors(); |
|
50 | - } |
|
51 | - |
|
52 | - private function initBeanPropertyDescriptors() |
|
53 | - { |
|
54 | - $this->beanPropertyDescriptors = $this->getProperties($this->table); |
|
55 | - } |
|
56 | - |
|
57 | - /** |
|
58 | - * Returns the foreignkey the column is part of, if any. null otherwise. |
|
59 | - * |
|
60 | - * @param Table $table |
|
61 | - * @param Column $column |
|
62 | - * |
|
63 | - * @return ForeignKeyConstraint|null |
|
64 | - */ |
|
65 | - private function isPartOfForeignKey(Table $table, Column $column) |
|
66 | - { |
|
67 | - $localColumnName = $column->getName(); |
|
68 | - foreach ($table->getForeignKeys() as $foreignKey) { |
|
69 | - foreach ($foreignKey->getColumns() as $columnName) { |
|
70 | - if ($columnName === $localColumnName) { |
|
71 | - return $foreignKey; |
|
72 | - } |
|
73 | - } |
|
74 | - } |
|
75 | - |
|
76 | - return; |
|
77 | - } |
|
78 | - |
|
79 | - /** |
|
80 | - * @return AbstractBeanPropertyDescriptor[] |
|
81 | - */ |
|
82 | - public function getBeanPropertyDescriptors() |
|
83 | - { |
|
84 | - return $this->beanPropertyDescriptors; |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent. |
|
89 | - * |
|
90 | - * @return AbstractBeanPropertyDescriptor[] |
|
91 | - */ |
|
92 | - public function getConstructorProperties() |
|
93 | - { |
|
94 | - $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
95 | - return $property->isCompulsory(); |
|
96 | - }); |
|
97 | - |
|
98 | - return $constructorProperties; |
|
99 | - } |
|
100 | - |
|
101 | - /** |
|
102 | - * Returns the list of properties exposed as getters and setters in this class. |
|
103 | - * |
|
104 | - * @return AbstractBeanPropertyDescriptor[] |
|
105 | - */ |
|
106 | - public function getExposedProperties() |
|
107 | - { |
|
108 | - $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
109 | - return $property->getTable()->getName() == $this->table->getName(); |
|
110 | - }); |
|
111 | - |
|
112 | - return $exposedProperties; |
|
113 | - } |
|
114 | - |
|
115 | - /** |
|
116 | - * Returns the list of properties for this table (including parent tables). |
|
117 | - * |
|
118 | - * @param Table $table |
|
119 | - * |
|
120 | - * @return AbstractBeanPropertyDescriptor[] |
|
121 | - */ |
|
122 | - private function getProperties(Table $table) |
|
123 | - { |
|
124 | - $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
125 | - if ($parentRelationship) { |
|
126 | - $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName()); |
|
127 | - $properties = $this->getProperties($parentTable); |
|
128 | - // we merge properties by overriding property names. |
|
129 | - $localProperties = $this->getPropertiesForTable($table); |
|
130 | - foreach ($localProperties as $name => $property) { |
|
131 | - // We do not override properties if this is a primary key! |
|
132 | - if ($property->isPrimaryKey()) { |
|
133 | - continue; |
|
134 | - } |
|
135 | - $properties[$name] = $property; |
|
136 | - } |
|
137 | - //$properties = array_merge($properties, $localProperties); |
|
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 = ' /** |
|
18 | + /** |
|
19 | + * @var Table |
|
20 | + */ |
|
21 | + private $table; |
|
22 | + |
|
23 | + /** |
|
24 | + * @var SchemaAnalyzer |
|
25 | + */ |
|
26 | + private $schemaAnalyzer; |
|
27 | + |
|
28 | + /** |
|
29 | + * @var Schema |
|
30 | + */ |
|
31 | + private $schema; |
|
32 | + |
|
33 | + /** |
|
34 | + * @var AbstractBeanPropertyDescriptor[] |
|
35 | + */ |
|
36 | + private $beanPropertyDescriptors = []; |
|
37 | + |
|
38 | + /** |
|
39 | + * @var TDBMSchemaAnalyzer |
|
40 | + */ |
|
41 | + private $tdbmSchemaAnalyzer; |
|
42 | + |
|
43 | + public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
44 | + { |
|
45 | + $this->table = $table; |
|
46 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
47 | + $this->schema = $schema; |
|
48 | + $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
49 | + $this->initBeanPropertyDescriptors(); |
|
50 | + } |
|
51 | + |
|
52 | + private function initBeanPropertyDescriptors() |
|
53 | + { |
|
54 | + $this->beanPropertyDescriptors = $this->getProperties($this->table); |
|
55 | + } |
|
56 | + |
|
57 | + /** |
|
58 | + * Returns the foreignkey the column is part of, if any. null otherwise. |
|
59 | + * |
|
60 | + * @param Table $table |
|
61 | + * @param Column $column |
|
62 | + * |
|
63 | + * @return ForeignKeyConstraint|null |
|
64 | + */ |
|
65 | + private function isPartOfForeignKey(Table $table, Column $column) |
|
66 | + { |
|
67 | + $localColumnName = $column->getName(); |
|
68 | + foreach ($table->getForeignKeys() as $foreignKey) { |
|
69 | + foreach ($foreignKey->getColumns() as $columnName) { |
|
70 | + if ($columnName === $localColumnName) { |
|
71 | + return $foreignKey; |
|
72 | + } |
|
73 | + } |
|
74 | + } |
|
75 | + |
|
76 | + return; |
|
77 | + } |
|
78 | + |
|
79 | + /** |
|
80 | + * @return AbstractBeanPropertyDescriptor[] |
|
81 | + */ |
|
82 | + public function getBeanPropertyDescriptors() |
|
83 | + { |
|
84 | + return $this->beanPropertyDescriptors; |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent. |
|
89 | + * |
|
90 | + * @return AbstractBeanPropertyDescriptor[] |
|
91 | + */ |
|
92 | + public function getConstructorProperties() |
|
93 | + { |
|
94 | + $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
95 | + return $property->isCompulsory(); |
|
96 | + }); |
|
97 | + |
|
98 | + return $constructorProperties; |
|
99 | + } |
|
100 | + |
|
101 | + /** |
|
102 | + * Returns the list of properties exposed as getters and setters in this class. |
|
103 | + * |
|
104 | + * @return AbstractBeanPropertyDescriptor[] |
|
105 | + */ |
|
106 | + public function getExposedProperties() |
|
107 | + { |
|
108 | + $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
109 | + return $property->getTable()->getName() == $this->table->getName(); |
|
110 | + }); |
|
111 | + |
|
112 | + return $exposedProperties; |
|
113 | + } |
|
114 | + |
|
115 | + /** |
|
116 | + * Returns the list of properties for this table (including parent tables). |
|
117 | + * |
|
118 | + * @param Table $table |
|
119 | + * |
|
120 | + * @return AbstractBeanPropertyDescriptor[] |
|
121 | + */ |
|
122 | + private function getProperties(Table $table) |
|
123 | + { |
|
124 | + $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
125 | + if ($parentRelationship) { |
|
126 | + $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName()); |
|
127 | + $properties = $this->getProperties($parentTable); |
|
128 | + // we merge properties by overriding property names. |
|
129 | + $localProperties = $this->getPropertiesForTable($table); |
|
130 | + foreach ($localProperties as $name => $property) { |
|
131 | + // We do not override properties if this is a primary key! |
|
132 | + if ($property->isPrimaryKey()) { |
|
133 | + continue; |
|
134 | + } |
|
135 | + $properties[$name] = $property; |
|
136 | + } |
|
137 | + //$properties = array_merge($properties, $localProperties); |
|
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 |
||
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] = $fk; |
|
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] = $fk; |
|
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 |
||
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 |
||
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 |
||
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 |
||
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 |
||
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 |
||
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,19 +551,19 @@ discard block |
||
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 | } |
@@ -12,134 +12,134 @@ discard block |
||
12 | 12 | */ |
13 | 13 | class ObjectBeanPropertyDescriptor extends AbstractBeanPropertyDescriptor |
14 | 14 | { |
15 | - /** |
|
16 | - * @var ForeignKeyConstraint |
|
17 | - */ |
|
18 | - private $foreignKey; |
|
19 | - |
|
20 | - /** |
|
21 | - * @var SchemaAnalyzer |
|
22 | - */ |
|
23 | - private $schemaAnalyzer; |
|
24 | - |
|
25 | - public function __construct(Table $table, ForeignKeyConstraint $foreignKey, SchemaAnalyzer $schemaAnalyzer) |
|
26 | - { |
|
27 | - parent::__construct($table); |
|
28 | - $this->foreignKey = $foreignKey; |
|
29 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
30 | - } |
|
31 | - |
|
32 | - /** |
|
33 | - * Returns the foreignkey the column is part of, if any. null otherwise. |
|
34 | - * |
|
35 | - * @return ForeignKeyConstraint|null |
|
36 | - */ |
|
37 | - public function getForeignKey() |
|
38 | - { |
|
39 | - return $this->foreignKey; |
|
40 | - } |
|
41 | - |
|
42 | - /** |
|
43 | - * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
44 | - * |
|
45 | - * @return null|string |
|
46 | - */ |
|
47 | - public function getClassName() |
|
48 | - { |
|
49 | - return TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName()); |
|
50 | - } |
|
51 | - |
|
52 | - /** |
|
53 | - * Returns the param annotation for this property (useful for constructor). |
|
54 | - * |
|
55 | - * @return string |
|
56 | - */ |
|
57 | - public function getParamAnnotation() |
|
58 | - { |
|
59 | - $str = ' * @param %s %s'; |
|
60 | - |
|
61 | - return sprintf($str, $this->getClassName(), $this->getVariableName()); |
|
62 | - } |
|
63 | - |
|
64 | - public function getUpperCamelCaseName() |
|
65 | - { |
|
66 | - // First, are there many column or only one? |
|
67 | - // If one column, we name the setter after it. Otherwise, we name the setter after the table name |
|
68 | - if (count($this->foreignKey->getLocalColumns()) > 1) { |
|
69 | - $name = TDBMDaoGenerator::toSingular(TDBMDaoGenerator::toCamelCase($this->foreignKey->getForeignTableName())); |
|
70 | - if ($this->alternativeName) { |
|
71 | - $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $this->foreignKey->getLocalColumns()); |
|
72 | - |
|
73 | - $name .= 'By'.implode('And', $camelizedColumns); |
|
74 | - } |
|
75 | - } else { |
|
76 | - $column = $this->foreignKey->getLocalColumns()[0]; |
|
77 | - // Let's remove any _id or id_. |
|
78 | - if (strpos(strtolower($column), 'id_') === 0) { |
|
79 | - $column = substr($column, 3); |
|
80 | - } |
|
81 | - if (strrpos(strtolower($column), '_id') === strlen($column) - 3) { |
|
82 | - $column = substr($column, 0, strlen($column) - 3); |
|
83 | - } |
|
84 | - $name = TDBMDaoGenerator::toCamelCase($column); |
|
85 | - if ($this->alternativeName) { |
|
86 | - $name .= 'Object'; |
|
87 | - } |
|
88 | - } |
|
89 | - |
|
90 | - return $name; |
|
91 | - } |
|
92 | - |
|
93 | - /** |
|
94 | - * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
95 | - * |
|
96 | - * @return bool |
|
97 | - */ |
|
98 | - public function isCompulsory() |
|
99 | - { |
|
100 | - // Are all columns nullable? |
|
101 | - $localColumnNames = $this->foreignKey->getLocalColumns(); |
|
102 | - |
|
103 | - foreach ($localColumnNames as $name) { |
|
104 | - $column = $this->table->getColumn($name); |
|
105 | - if ($column->getNotnull()) { |
|
106 | - return true; |
|
107 | - } |
|
108 | - } |
|
109 | - |
|
110 | - return false; |
|
111 | - } |
|
112 | - |
|
113 | - /** |
|
114 | - * Returns true if the property is the primary key. |
|
115 | - * |
|
116 | - * @return bool |
|
117 | - */ |
|
118 | - public function isPrimaryKey() |
|
119 | - { |
|
120 | - $fkColumns = $this->foreignKey->getLocalColumns(); |
|
121 | - sort($fkColumns); |
|
122 | - |
|
123 | - $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
124 | - sort($pkColumns); |
|
125 | - |
|
126 | - return $fkColumns == $pkColumns; |
|
127 | - } |
|
128 | - |
|
129 | - /** |
|
130 | - * Returns the PHP code for getters and setters. |
|
131 | - * |
|
132 | - * @return string |
|
133 | - */ |
|
134 | - public function getGetterSetterCode() |
|
135 | - { |
|
136 | - $tableName = $this->table->getName(); |
|
137 | - $getterName = $this->getGetterName(); |
|
138 | - $setterName = $this->getSetterName(); |
|
139 | - |
|
140 | - $referencedBeanName = TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName()); |
|
141 | - |
|
142 | - $str = ' /** |
|
15 | + /** |
|
16 | + * @var ForeignKeyConstraint |
|
17 | + */ |
|
18 | + private $foreignKey; |
|
19 | + |
|
20 | + /** |
|
21 | + * @var SchemaAnalyzer |
|
22 | + */ |
|
23 | + private $schemaAnalyzer; |
|
24 | + |
|
25 | + public function __construct(Table $table, ForeignKeyConstraint $foreignKey, SchemaAnalyzer $schemaAnalyzer) |
|
26 | + { |
|
27 | + parent::__construct($table); |
|
28 | + $this->foreignKey = $foreignKey; |
|
29 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
30 | + } |
|
31 | + |
|
32 | + /** |
|
33 | + * Returns the foreignkey the column is part of, if any. null otherwise. |
|
34 | + * |
|
35 | + * @return ForeignKeyConstraint|null |
|
36 | + */ |
|
37 | + public function getForeignKey() |
|
38 | + { |
|
39 | + return $this->foreignKey; |
|
40 | + } |
|
41 | + |
|
42 | + /** |
|
43 | + * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
44 | + * |
|
45 | + * @return null|string |
|
46 | + */ |
|
47 | + public function getClassName() |
|
48 | + { |
|
49 | + return TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName()); |
|
50 | + } |
|
51 | + |
|
52 | + /** |
|
53 | + * Returns the param annotation for this property (useful for constructor). |
|
54 | + * |
|
55 | + * @return string |
|
56 | + */ |
|
57 | + public function getParamAnnotation() |
|
58 | + { |
|
59 | + $str = ' * @param %s %s'; |
|
60 | + |
|
61 | + return sprintf($str, $this->getClassName(), $this->getVariableName()); |
|
62 | + } |
|
63 | + |
|
64 | + public function getUpperCamelCaseName() |
|
65 | + { |
|
66 | + // First, are there many column or only one? |
|
67 | + // If one column, we name the setter after it. Otherwise, we name the setter after the table name |
|
68 | + if (count($this->foreignKey->getLocalColumns()) > 1) { |
|
69 | + $name = TDBMDaoGenerator::toSingular(TDBMDaoGenerator::toCamelCase($this->foreignKey->getForeignTableName())); |
|
70 | + if ($this->alternativeName) { |
|
71 | + $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $this->foreignKey->getLocalColumns()); |
|
72 | + |
|
73 | + $name .= 'By'.implode('And', $camelizedColumns); |
|
74 | + } |
|
75 | + } else { |
|
76 | + $column = $this->foreignKey->getLocalColumns()[0]; |
|
77 | + // Let's remove any _id or id_. |
|
78 | + if (strpos(strtolower($column), 'id_') === 0) { |
|
79 | + $column = substr($column, 3); |
|
80 | + } |
|
81 | + if (strrpos(strtolower($column), '_id') === strlen($column) - 3) { |
|
82 | + $column = substr($column, 0, strlen($column) - 3); |
|
83 | + } |
|
84 | + $name = TDBMDaoGenerator::toCamelCase($column); |
|
85 | + if ($this->alternativeName) { |
|
86 | + $name .= 'Object'; |
|
87 | + } |
|
88 | + } |
|
89 | + |
|
90 | + return $name; |
|
91 | + } |
|
92 | + |
|
93 | + /** |
|
94 | + * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
95 | + * |
|
96 | + * @return bool |
|
97 | + */ |
|
98 | + public function isCompulsory() |
|
99 | + { |
|
100 | + // Are all columns nullable? |
|
101 | + $localColumnNames = $this->foreignKey->getLocalColumns(); |
|
102 | + |
|
103 | + foreach ($localColumnNames as $name) { |
|
104 | + $column = $this->table->getColumn($name); |
|
105 | + if ($column->getNotnull()) { |
|
106 | + return true; |
|
107 | + } |
|
108 | + } |
|
109 | + |
|
110 | + return false; |
|
111 | + } |
|
112 | + |
|
113 | + /** |
|
114 | + * Returns true if the property is the primary key. |
|
115 | + * |
|
116 | + * @return bool |
|
117 | + */ |
|
118 | + public function isPrimaryKey() |
|
119 | + { |
|
120 | + $fkColumns = $this->foreignKey->getLocalColumns(); |
|
121 | + sort($fkColumns); |
|
122 | + |
|
123 | + $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
124 | + sort($pkColumns); |
|
125 | + |
|
126 | + return $fkColumns == $pkColumns; |
|
127 | + } |
|
128 | + |
|
129 | + /** |
|
130 | + * Returns the PHP code for getters and setters. |
|
131 | + * |
|
132 | + * @return string |
|
133 | + */ |
|
134 | + public function getGetterSetterCode() |
|
135 | + { |
|
136 | + $tableName = $this->table->getName(); |
|
137 | + $getterName = $this->getGetterName(); |
|
138 | + $setterName = $this->getSetterName(); |
|
139 | + |
|
140 | + $referencedBeanName = TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName()); |
|
141 | + |
|
142 | + $str = ' /** |
|
143 | 143 | * Returns the '.$referencedBeanName.' object bound to this object via the '.implode(' and ', $this->foreignKey->getLocalColumns()).' column. |
144 | 144 | * |
145 | 145 | * @return '.$referencedBeanName.' |
@@ -159,19 +159,19 @@ discard block |
||
159 | 159 | |
160 | 160 | '; |
161 | 161 | |
162 | - return $str; |
|
163 | - } |
|
164 | - |
|
165 | - /** |
|
166 | - * Returns the part of code useful when doing json serialization. |
|
167 | - * |
|
168 | - * @return string |
|
169 | - */ |
|
170 | - public function getJsonSerializeCode() |
|
171 | - { |
|
172 | - return ' if (!$stopRecursion) { |
|
162 | + return $str; |
|
163 | + } |
|
164 | + |
|
165 | + /** |
|
166 | + * Returns the part of code useful when doing json serialization. |
|
167 | + * |
|
168 | + * @return string |
|
169 | + */ |
|
170 | + public function getJsonSerializeCode() |
|
171 | + { |
|
172 | + return ' if (!$stopRecursion) { |
|
173 | 173 | $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName().'()->jsonSerialize(true); |
174 | 174 | } |
175 | 175 | '; |
176 | - } |
|
176 | + } |
|
177 | 177 | } |
@@ -11,100 +11,100 @@ discard block |
||
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 foreignkey the column is part of, if any. null otherwise. |
|
28 | - * |
|
29 | - * @param Column $column |
|
30 | - * |
|
31 | - * @return ForeignKeyConstraint|null |
|
32 | - */ |
|
33 | - public function getForeignKey() |
|
34 | - { |
|
35 | - return false; |
|
36 | - } |
|
37 | - |
|
38 | - /** |
|
39 | - * Returns the param annotation for this property (useful for constructor). |
|
40 | - * |
|
41 | - * @return string |
|
42 | - */ |
|
43 | - public function getParamAnnotation() |
|
44 | - { |
|
45 | - $className = $this->getClassName(); |
|
46 | - $paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType()); |
|
47 | - |
|
48 | - $str = ' * @param %s %s'; |
|
49 | - |
|
50 | - return sprintf($str, $paramType, $this->getVariableName()); |
|
51 | - } |
|
52 | - |
|
53 | - public function getUpperCamelCaseName() |
|
54 | - { |
|
55 | - return TDBMDaoGenerator::toCamelCase($this->column->getName()); |
|
56 | - } |
|
57 | - |
|
58 | - /** |
|
59 | - * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
60 | - * |
|
61 | - * @return null|string |
|
62 | - */ |
|
63 | - public function getClassName() |
|
64 | - { |
|
65 | - return; |
|
66 | - } |
|
67 | - |
|
68 | - /** |
|
69 | - * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
70 | - * |
|
71 | - * @return bool |
|
72 | - */ |
|
73 | - public function isCompulsory() |
|
74 | - { |
|
75 | - return $this->column->getNotnull() && !$this->column->getAutoincrement(); |
|
76 | - } |
|
77 | - |
|
78 | - /** |
|
79 | - * Returns true if the property is the primary key. |
|
80 | - * |
|
81 | - * @return bool |
|
82 | - */ |
|
83 | - public function isPrimaryKey() |
|
84 | - { |
|
85 | - return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns()); |
|
86 | - } |
|
87 | - |
|
88 | - /** |
|
89 | - * Returns the PHP code for getters and setters. |
|
90 | - * |
|
91 | - * @return string |
|
92 | - */ |
|
93 | - public function getGetterSetterCode() |
|
94 | - { |
|
95 | - $type = $this->column->getType(); |
|
96 | - $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
97 | - |
|
98 | - $columnGetterName = $this->getGetterName(); |
|
99 | - $columnSetterName = $this->getSetterName(); |
|
100 | - |
|
101 | - if ($normalizedType == '\\DateTimeInterface') { |
|
102 | - $castTo = '\\DateTimeInterface '; |
|
103 | - } else { |
|
104 | - $castTo = ''; |
|
105 | - } |
|
106 | - |
|
107 | - $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 foreignkey the column is part of, if any. null otherwise. |
|
28 | + * |
|
29 | + * @param Column $column |
|
30 | + * |
|
31 | + * @return ForeignKeyConstraint|null |
|
32 | + */ |
|
33 | + public function getForeignKey() |
|
34 | + { |
|
35 | + return false; |
|
36 | + } |
|
37 | + |
|
38 | + /** |
|
39 | + * Returns the param annotation for this property (useful for constructor). |
|
40 | + * |
|
41 | + * @return string |
|
42 | + */ |
|
43 | + public function getParamAnnotation() |
|
44 | + { |
|
45 | + $className = $this->getClassName(); |
|
46 | + $paramType = $className ?: TDBMDaoGenerator::dbalTypeToPhpType($this->column->getType()); |
|
47 | + |
|
48 | + $str = ' * @param %s %s'; |
|
49 | + |
|
50 | + return sprintf($str, $paramType, $this->getVariableName()); |
|
51 | + } |
|
52 | + |
|
53 | + public function getUpperCamelCaseName() |
|
54 | + { |
|
55 | + return TDBMDaoGenerator::toCamelCase($this->column->getName()); |
|
56 | + } |
|
57 | + |
|
58 | + /** |
|
59 | + * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
60 | + * |
|
61 | + * @return null|string |
|
62 | + */ |
|
63 | + public function getClassName() |
|
64 | + { |
|
65 | + return; |
|
66 | + } |
|
67 | + |
|
68 | + /** |
|
69 | + * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
70 | + * |
|
71 | + * @return bool |
|
72 | + */ |
|
73 | + public function isCompulsory() |
|
74 | + { |
|
75 | + return $this->column->getNotnull() && !$this->column->getAutoincrement(); |
|
76 | + } |
|
77 | + |
|
78 | + /** |
|
79 | + * Returns true if the property is the primary key. |
|
80 | + * |
|
81 | + * @return bool |
|
82 | + */ |
|
83 | + public function isPrimaryKey() |
|
84 | + { |
|
85 | + return in_array($this->column->getName(), $this->table->getPrimaryKeyColumns()); |
|
86 | + } |
|
87 | + |
|
88 | + /** |
|
89 | + * Returns the PHP code for getters and setters. |
|
90 | + * |
|
91 | + * @return string |
|
92 | + */ |
|
93 | + public function getGetterSetterCode() |
|
94 | + { |
|
95 | + $type = $this->column->getType(); |
|
96 | + $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
97 | + |
|
98 | + $columnGetterName = $this->getGetterName(); |
|
99 | + $columnSetterName = $this->getSetterName(); |
|
100 | + |
|
101 | + if ($normalizedType == '\\DateTimeInterface') { |
|
102 | + $castTo = '\\DateTimeInterface '; |
|
103 | + } else { |
|
104 | + $castTo = ''; |
|
105 | + } |
|
106 | + |
|
107 | + $getterAndSetterCode = ' /** |
|
108 | 108 | * The getter for the "%s" column. |
109 | 109 | * |
110 | 110 | * @return %s |
@@ -124,40 +124,40 @@ discard block |
||
124 | 124 | |
125 | 125 | '; |
126 | 126 | |
127 | - return sprintf($getterAndSetterCode, |
|
128 | - // Getter |
|
129 | - $this->column->getName(), |
|
130 | - $normalizedType, |
|
131 | - $columnGetterName, |
|
132 | - var_export($this->column->getName(), true), |
|
133 | - var_export($this->table->getName(), true), |
|
134 | - // Setter |
|
135 | - $this->column->getName(), |
|
136 | - $normalizedType, |
|
137 | - $this->column->getName(), |
|
138 | - $columnSetterName, |
|
139 | - $castTo, |
|
140 | - $this->column->getName(), |
|
141 | - var_export($this->column->getName(), true), |
|
142 | - $this->column->getName(), |
|
143 | - var_export($this->table->getName(), true) |
|
144 | - ); |
|
145 | - } |
|
146 | - |
|
147 | - /** |
|
148 | - * Returns the part of code useful when doing json serialization. |
|
149 | - * |
|
150 | - * @return string |
|
151 | - */ |
|
152 | - public function getJsonSerializeCode() |
|
153 | - { |
|
154 | - $type = $this->column->getType(); |
|
155 | - $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
156 | - |
|
157 | - if ($normalizedType == '\\DateTimeInterface') { |
|
158 | - return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."()->format('c');\n"; |
|
159 | - } else { |
|
160 | - return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n"; |
|
161 | - } |
|
162 | - } |
|
127 | + return sprintf($getterAndSetterCode, |
|
128 | + // Getter |
|
129 | + $this->column->getName(), |
|
130 | + $normalizedType, |
|
131 | + $columnGetterName, |
|
132 | + var_export($this->column->getName(), true), |
|
133 | + var_export($this->table->getName(), true), |
|
134 | + // Setter |
|
135 | + $this->column->getName(), |
|
136 | + $normalizedType, |
|
137 | + $this->column->getName(), |
|
138 | + $columnSetterName, |
|
139 | + $castTo, |
|
140 | + $this->column->getName(), |
|
141 | + var_export($this->column->getName(), true), |
|
142 | + $this->column->getName(), |
|
143 | + var_export($this->table->getName(), true) |
|
144 | + ); |
|
145 | + } |
|
146 | + |
|
147 | + /** |
|
148 | + * Returns the part of code useful when doing json serialization. |
|
149 | + * |
|
150 | + * @return string |
|
151 | + */ |
|
152 | + public function getJsonSerializeCode() |
|
153 | + { |
|
154 | + $type = $this->column->getType(); |
|
155 | + $normalizedType = TDBMDaoGenerator::dbalTypeToPhpType($type); |
|
156 | + |
|
157 | + if ($normalizedType == '\\DateTimeInterface') { |
|
158 | + return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."()->format('c');\n"; |
|
159 | + } else { |
|
160 | + return ' $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName()."();\n"; |
|
161 | + } |
|
162 | + } |
|
163 | 163 | } |
@@ -27,100 +27,100 @@ |
||
27 | 27 | */ |
28 | 28 | class InnerResultArray extends InnerResultIterator |
29 | 29 | { |
30 | - /** |
|
31 | - * The list of results already fetched. |
|
32 | - * |
|
33 | - * @var AbstractTDBMObject[] |
|
34 | - */ |
|
35 | - private $results = []; |
|
30 | + /** |
|
31 | + * The list of results already fetched. |
|
32 | + * |
|
33 | + * @var AbstractTDBMObject[] |
|
34 | + */ |
|
35 | + private $results = []; |
|
36 | 36 | |
37 | - /** |
|
38 | - * Whether a offset exists. |
|
39 | - * |
|
40 | - * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
41 | - * |
|
42 | - * @param mixed $offset <p> |
|
43 | - * An offset to check for. |
|
44 | - * </p> |
|
45 | - * |
|
46 | - * @return bool true on success or false on failure. |
|
47 | - * </p> |
|
48 | - * <p> |
|
49 | - * The return value will be casted to boolean if non-boolean was returned. |
|
50 | - * |
|
51 | - * @since 5.0.0 |
|
52 | - */ |
|
53 | - public function offsetExists($offset) |
|
54 | - { |
|
55 | - try { |
|
56 | - $this->toIndex($offset); |
|
57 | - } catch (TDBMInvalidOffsetException $e) { |
|
58 | - return false; |
|
59 | - } |
|
37 | + /** |
|
38 | + * Whether a offset exists. |
|
39 | + * |
|
40 | + * @link http://php.net/manual/en/arrayaccess.offsetexists.php |
|
41 | + * |
|
42 | + * @param mixed $offset <p> |
|
43 | + * An offset to check for. |
|
44 | + * </p> |
|
45 | + * |
|
46 | + * @return bool true on success or false on failure. |
|
47 | + * </p> |
|
48 | + * <p> |
|
49 | + * The return value will be casted to boolean if non-boolean was returned. |
|
50 | + * |
|
51 | + * @since 5.0.0 |
|
52 | + */ |
|
53 | + public function offsetExists($offset) |
|
54 | + { |
|
55 | + try { |
|
56 | + $this->toIndex($offset); |
|
57 | + } catch (TDBMInvalidOffsetException $e) { |
|
58 | + return false; |
|
59 | + } |
|
60 | 60 | |
61 | - return true; |
|
62 | - } |
|
61 | + return true; |
|
62 | + } |
|
63 | 63 | |
64 | - /** |
|
65 | - * Offset to retrieve. |
|
66 | - * |
|
67 | - * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
68 | - * |
|
69 | - * @param mixed $offset <p> |
|
70 | - * The offset to retrieve. |
|
71 | - * </p> |
|
72 | - * |
|
73 | - * @return mixed Can return all value types. |
|
74 | - * |
|
75 | - * @since 5.0.0 |
|
76 | - */ |
|
77 | - public function offsetGet($offset) |
|
78 | - { |
|
79 | - $this->toIndex($offset); |
|
64 | + /** |
|
65 | + * Offset to retrieve. |
|
66 | + * |
|
67 | + * @link http://php.net/manual/en/arrayaccess.offsetget.php |
|
68 | + * |
|
69 | + * @param mixed $offset <p> |
|
70 | + * The offset to retrieve. |
|
71 | + * </p> |
|
72 | + * |
|
73 | + * @return mixed Can return all value types. |
|
74 | + * |
|
75 | + * @since 5.0.0 |
|
76 | + */ |
|
77 | + public function offsetGet($offset) |
|
78 | + { |
|
79 | + $this->toIndex($offset); |
|
80 | 80 | |
81 | - return $this->results[$offset]; |
|
82 | - } |
|
81 | + return $this->results[$offset]; |
|
82 | + } |
|
83 | 83 | |
84 | - private function toIndex($offset) |
|
85 | - { |
|
86 | - if ($offset < 0 || filter_var($offset, FILTER_VALIDATE_INT) === false) { |
|
87 | - throw new TDBMInvalidOffsetException('Trying to access result set using offset "'.$offset.'". An offset must be a positive integer.'); |
|
88 | - } |
|
89 | - if ($this->statement === null) { |
|
90 | - $this->executeQuery(); |
|
91 | - } |
|
92 | - while (!isset($this->results[$offset])) { |
|
93 | - $this->next(); |
|
94 | - if ($this->current === null) { |
|
95 | - throw new TDBMInvalidOffsetException('Offset "'.$offset.'" does not exist in result set.'); |
|
96 | - } |
|
97 | - } |
|
98 | - } |
|
84 | + private function toIndex($offset) |
|
85 | + { |
|
86 | + if ($offset < 0 || filter_var($offset, FILTER_VALIDATE_INT) === false) { |
|
87 | + throw new TDBMInvalidOffsetException('Trying to access result set using offset "'.$offset.'". An offset must be a positive integer.'); |
|
88 | + } |
|
89 | + if ($this->statement === null) { |
|
90 | + $this->executeQuery(); |
|
91 | + } |
|
92 | + while (!isset($this->results[$offset])) { |
|
93 | + $this->next(); |
|
94 | + if ($this->current === null) { |
|
95 | + throw new TDBMInvalidOffsetException('Offset "'.$offset.'" does not exist in result set.'); |
|
96 | + } |
|
97 | + } |
|
98 | + } |
|
99 | 99 | |
100 | - public function next() |
|
101 | - { |
|
102 | - // Let's overload the next() method to store the result. |
|
103 | - if (isset($this->results[$this->key + 1])) { |
|
104 | - ++$this->key; |
|
105 | - $this->current = $this->results[$this->key]; |
|
106 | - } else { |
|
107 | - parent::next(); |
|
108 | - if ($this->current !== null) { |
|
109 | - $this->results[$this->key] = $this->current; |
|
110 | - } |
|
111 | - } |
|
112 | - } |
|
100 | + public function next() |
|
101 | + { |
|
102 | + // Let's overload the next() method to store the result. |
|
103 | + if (isset($this->results[$this->key + 1])) { |
|
104 | + ++$this->key; |
|
105 | + $this->current = $this->results[$this->key]; |
|
106 | + } else { |
|
107 | + parent::next(); |
|
108 | + if ($this->current !== null) { |
|
109 | + $this->results[$this->key] = $this->current; |
|
110 | + } |
|
111 | + } |
|
112 | + } |
|
113 | 113 | |
114 | - /** |
|
115 | - * Overloads the rewind implementation. |
|
116 | - * Do not reexecute the query. |
|
117 | - */ |
|
118 | - public function rewind() |
|
119 | - { |
|
120 | - if (!$this->fetchStarted) { |
|
121 | - $this->executeQuery(); |
|
122 | - } |
|
123 | - $this->key = -1; |
|
124 | - $this->next(); |
|
125 | - } |
|
114 | + /** |
|
115 | + * Overloads the rewind implementation. |
|
116 | + * Do not reexecute the query. |
|
117 | + */ |
|
118 | + public function rewind() |
|
119 | + { |
|
120 | + if (!$this->fetchStarted) { |
|
121 | + $this->executeQuery(); |
|
122 | + } |
|
123 | + $this->key = -1; |
|
124 | + $this->next(); |
|
125 | + } |
|
126 | 126 | } |
@@ -27,10 +27,10 @@ |
||
27 | 27 | */ |
28 | 28 | final class TDBMObjectStateEnum extends AbstractTDBMObject |
29 | 29 | { |
30 | - const STATE_DETACHED = 'detached'; |
|
31 | - const STATE_NEW = 'new'; |
|
32 | - const STATE_NOT_LOADED = 'not loaded'; |
|
33 | - const STATE_LOADED = 'loaded'; |
|
34 | - const STATE_DIRTY = 'dirty'; |
|
35 | - const STATE_DELETED = 'deleted'; |
|
30 | + const STATE_DETACHED = 'detached'; |
|
31 | + const STATE_NEW = 'new'; |
|
32 | + const STATE_NOT_LOADED = 'not loaded'; |
|
33 | + const STATE_LOADED = 'loaded'; |
|
34 | + const STATE_DIRTY = 'dirty'; |
|
35 | + const STATE_DELETED = 'deleted'; |
|
36 | 36 | } |
@@ -9,86 +9,86 @@ |
||
9 | 9 | */ |
10 | 10 | class MapIterator implements Iterator |
11 | 11 | { |
12 | - /** |
|
13 | - * @var Iterator |
|
14 | - */ |
|
15 | - protected $iterator; |
|
12 | + /** |
|
13 | + * @var Iterator |
|
14 | + */ |
|
15 | + protected $iterator; |
|
16 | 16 | |
17 | - /** |
|
18 | - * @var callable Modifies the current item in iterator |
|
19 | - */ |
|
20 | - protected $callable; |
|
17 | + /** |
|
18 | + * @var callable Modifies the current item in iterator |
|
19 | + */ |
|
20 | + protected $callable; |
|
21 | 21 | |
22 | - /** |
|
23 | - * @param $iterator Iterator|array |
|
24 | - * @param $callable callable This can have two parameters |
|
25 | - * |
|
26 | - * @throws TDBMException |
|
27 | - */ |
|
28 | - public function __construct($iterator, callable $callable) |
|
29 | - { |
|
30 | - if (is_array($iterator)) { |
|
31 | - $this->iterator = new \ArrayIterator($iterator); |
|
32 | - } elseif (!($iterator instanceof Iterator)) { |
|
33 | - throw new TDBMException("\$iterator parameter must be an instance of Iterator"); |
|
34 | - } else { |
|
35 | - $this->iterator = $iterator; |
|
36 | - } |
|
22 | + /** |
|
23 | + * @param $iterator Iterator|array |
|
24 | + * @param $callable callable This can have two parameters |
|
25 | + * |
|
26 | + * @throws TDBMException |
|
27 | + */ |
|
28 | + public function __construct($iterator, callable $callable) |
|
29 | + { |
|
30 | + if (is_array($iterator)) { |
|
31 | + $this->iterator = new \ArrayIterator($iterator); |
|
32 | + } elseif (!($iterator instanceof Iterator)) { |
|
33 | + throw new TDBMException("\$iterator parameter must be an instance of Iterator"); |
|
34 | + } else { |
|
35 | + $this->iterator = $iterator; |
|
36 | + } |
|
37 | 37 | |
38 | - if ($callable instanceof \Closure) { |
|
39 | - // make sure there's one argument |
|
40 | - $reflection = new \ReflectionObject($callable); |
|
41 | - if ($reflection->hasMethod('__invoke')) { |
|
42 | - $method = $reflection->getMethod('__invoke'); |
|
43 | - if ($method->getNumberOfParameters() !== 1) { |
|
44 | - throw new TDBMException("\$callable must accept one and only one parameter."); |
|
45 | - } |
|
46 | - } |
|
47 | - } |
|
38 | + if ($callable instanceof \Closure) { |
|
39 | + // make sure there's one argument |
|
40 | + $reflection = new \ReflectionObject($callable); |
|
41 | + if ($reflection->hasMethod('__invoke')) { |
|
42 | + $method = $reflection->getMethod('__invoke'); |
|
43 | + if ($method->getNumberOfParameters() !== 1) { |
|
44 | + throw new TDBMException("\$callable must accept one and only one parameter."); |
|
45 | + } |
|
46 | + } |
|
47 | + } |
|
48 | 48 | |
49 | - $this->callable = $callable; |
|
50 | - } |
|
49 | + $this->callable = $callable; |
|
50 | + } |
|
51 | 51 | |
52 | - /** |
|
53 | - * Alters the current item with $this->callable and returns a new item. |
|
54 | - * Be careful with your types as we can't do static type checking here! |
|
55 | - * |
|
56 | - * @return mixed |
|
57 | - */ |
|
58 | - public function current() |
|
59 | - { |
|
60 | - $callable = $this->callable; |
|
52 | + /** |
|
53 | + * Alters the current item with $this->callable and returns a new item. |
|
54 | + * Be careful with your types as we can't do static type checking here! |
|
55 | + * |
|
56 | + * @return mixed |
|
57 | + */ |
|
58 | + public function current() |
|
59 | + { |
|
60 | + $callable = $this->callable; |
|
61 | 61 | |
62 | - return $callable($this->iterator->current()); |
|
63 | - } |
|
62 | + return $callable($this->iterator->current()); |
|
63 | + } |
|
64 | 64 | |
65 | - public function next() |
|
66 | - { |
|
67 | - $this->iterator->next(); |
|
68 | - } |
|
65 | + public function next() |
|
66 | + { |
|
67 | + $this->iterator->next(); |
|
68 | + } |
|
69 | 69 | |
70 | - public function key() |
|
71 | - { |
|
72 | - return $this->iterator->key(); |
|
73 | - } |
|
70 | + public function key() |
|
71 | + { |
|
72 | + return $this->iterator->key(); |
|
73 | + } |
|
74 | 74 | |
75 | - public function valid() |
|
76 | - { |
|
77 | - return $this->iterator->valid(); |
|
78 | - } |
|
75 | + public function valid() |
|
76 | + { |
|
77 | + return $this->iterator->valid(); |
|
78 | + } |
|
79 | 79 | |
80 | - public function rewind() |
|
81 | - { |
|
82 | - $this->iterator->rewind(); |
|
83 | - } |
|
80 | + public function rewind() |
|
81 | + { |
|
82 | + $this->iterator->rewind(); |
|
83 | + } |
|
84 | 84 | |
85 | - /** |
|
86 | - * Casts the iterator to a PHP array. |
|
87 | - * |
|
88 | - * @return array |
|
89 | - */ |
|
90 | - public function toArray() |
|
91 | - { |
|
92 | - return iterator_to_array($this); |
|
93 | - } |
|
85 | + /** |
|
86 | + * Casts the iterator to a PHP array. |
|
87 | + * |
|
88 | + * @return array |
|
89 | + */ |
|
90 | + public function toArray() |
|
91 | + { |
|
92 | + return iterator_to_array($this); |
|
93 | + } |
|
94 | 94 | } |
@@ -30,78 +30,78 @@ |
||
30 | 30 | */ |
31 | 31 | class StandardObjectStorage |
32 | 32 | { |
33 | - /** |
|
34 | - * An array of fetched object, accessible via table name and primary key. |
|
35 | - * If the primary key is split on several columns, access is done by an array of columns, serialized. |
|
36 | - * |
|
37 | - * @var array<string, array<string, TDBMObject>> |
|
38 | - */ |
|
39 | - private $objects = array(); |
|
33 | + /** |
|
34 | + * An array of fetched object, accessible via table name and primary key. |
|
35 | + * If the primary key is split on several columns, access is done by an array of columns, serialized. |
|
36 | + * |
|
37 | + * @var array<string, array<string, TDBMObject>> |
|
38 | + */ |
|
39 | + private $objects = array(); |
|
40 | 40 | |
41 | - /** |
|
42 | - * Sets an object in the storage. |
|
43 | - * |
|
44 | - * @param string $tableName |
|
45 | - * @param string $id |
|
46 | - * @param TDBMObject $dbRow |
|
47 | - */ |
|
48 | - public function set($tableName, $id, DbRow $dbRow) |
|
49 | - { |
|
50 | - $this->objects[$tableName][$id] = $dbRow; |
|
51 | - } |
|
41 | + /** |
|
42 | + * Sets an object in the storage. |
|
43 | + * |
|
44 | + * @param string $tableName |
|
45 | + * @param string $id |
|
46 | + * @param TDBMObject $dbRow |
|
47 | + */ |
|
48 | + public function set($tableName, $id, DbRow $dbRow) |
|
49 | + { |
|
50 | + $this->objects[$tableName][$id] = $dbRow; |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * Checks if an object is in the storage. |
|
55 | - * |
|
56 | - * @param string $tableName |
|
57 | - * @param string $id |
|
58 | - * |
|
59 | - * @return bool |
|
60 | - */ |
|
61 | - public function has($tableName, $id) |
|
62 | - { |
|
63 | - return isset($this->objects[$tableName][$id]); |
|
64 | - } |
|
53 | + /** |
|
54 | + * Checks if an object is in the storage. |
|
55 | + * |
|
56 | + * @param string $tableName |
|
57 | + * @param string $id |
|
58 | + * |
|
59 | + * @return bool |
|
60 | + */ |
|
61 | + public function has($tableName, $id) |
|
62 | + { |
|
63 | + return isset($this->objects[$tableName][$id]); |
|
64 | + } |
|
65 | 65 | |
66 | - /** |
|
67 | - * Returns an object from the storage (or null if no object is set). |
|
68 | - * |
|
69 | - * @param string $tableName |
|
70 | - * @param string $id |
|
71 | - * |
|
72 | - * @return DbRow |
|
73 | - */ |
|
74 | - public function get($tableName, $id) |
|
75 | - { |
|
76 | - if (isset($this->objects[$tableName][$id])) { |
|
77 | - return $this->objects[$tableName][$id]; |
|
78 | - } else { |
|
79 | - return; |
|
80 | - } |
|
81 | - } |
|
66 | + /** |
|
67 | + * Returns an object from the storage (or null if no object is set). |
|
68 | + * |
|
69 | + * @param string $tableName |
|
70 | + * @param string $id |
|
71 | + * |
|
72 | + * @return DbRow |
|
73 | + */ |
|
74 | + public function get($tableName, $id) |
|
75 | + { |
|
76 | + if (isset($this->objects[$tableName][$id])) { |
|
77 | + return $this->objects[$tableName][$id]; |
|
78 | + } else { |
|
79 | + return; |
|
80 | + } |
|
81 | + } |
|
82 | 82 | |
83 | - /** |
|
84 | - * Removes an object from the storage. |
|
85 | - * |
|
86 | - * @param string $tableName |
|
87 | - * @param string $id |
|
88 | - */ |
|
89 | - public function remove($tableName, $id) |
|
90 | - { |
|
91 | - unset($this->objects[$tableName][$id]); |
|
92 | - } |
|
83 | + /** |
|
84 | + * Removes an object from the storage. |
|
85 | + * |
|
86 | + * @param string $tableName |
|
87 | + * @param string $id |
|
88 | + */ |
|
89 | + public function remove($tableName, $id) |
|
90 | + { |
|
91 | + unset($this->objects[$tableName][$id]); |
|
92 | + } |
|
93 | 93 | |
94 | - /** |
|
95 | - * Applies the callback to all objects. |
|
96 | - * |
|
97 | - * @param callable $callback |
|
98 | - */ |
|
99 | - public function apply(callable $callback) |
|
100 | - { |
|
101 | - foreach ($this->objects as $tableName => $table) { |
|
102 | - foreach ($table as $id => $obj) { |
|
103 | - $callback($obj, $tableName, $id); |
|
104 | - } |
|
105 | - } |
|
106 | - } |
|
94 | + /** |
|
95 | + * Applies the callback to all objects. |
|
96 | + * |
|
97 | + * @param callable $callback |
|
98 | + */ |
|
99 | + public function apply(callable $callback) |
|
100 | + { |
|
101 | + foreach ($this->objects as $tableName => $table) { |
|
102 | + foreach ($table as $id => $obj) { |
|
103 | + $callback($obj, $tableName, $id); |
|
104 | + } |
|
105 | + } |
|
106 | + } |
|
107 | 107 | } |
@@ -29,521 +29,521 @@ |
||
29 | 29 | */ |
30 | 30 | abstract class AbstractTDBMObject |
31 | 31 | { |
32 | - /** |
|
33 | - * The service this object is bound to. |
|
34 | - * |
|
35 | - * @var TDBMService |
|
36 | - */ |
|
37 | - protected $tdbmService; |
|
38 | - |
|
39 | - /** |
|
40 | - * An array of DbRow, indexed by table name. |
|
41 | - * |
|
42 | - * @var DbRow[] |
|
43 | - */ |
|
44 | - protected $dbRows = array(); |
|
45 | - |
|
46 | - /** |
|
47 | - * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
48 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
49 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
50 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
51 | - * |
|
52 | - * @var string |
|
53 | - */ |
|
54 | - private $status; |
|
55 | - |
|
56 | - /** |
|
57 | - * Array storing beans related via many to many relationships (pivot tables). |
|
58 | - * |
|
59 | - * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage |
|
60 | - */ |
|
61 | - private $relationships = []; |
|
62 | - |
|
63 | - /** |
|
64 | - * @var bool[] Key: pivot table name, value: whether a query was performed to load the data. |
|
65 | - */ |
|
66 | - private $loadedRelationships = []; |
|
67 | - |
|
68 | - /** |
|
69 | - * Used with $primaryKeys when we want to retrieve an existing object |
|
70 | - * and $primaryKeys=[] if we want a new object. |
|
71 | - * |
|
72 | - * @param string $tableName |
|
73 | - * @param array $primaryKeys |
|
74 | - * @param TDBMService $tdbmService |
|
75 | - * |
|
76 | - * @throws TDBMException |
|
77 | - * @throws TDBMInvalidOperationException |
|
78 | - */ |
|
79 | - public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null) |
|
80 | - { |
|
81 | - // FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation... |
|
82 | - if (!empty($tableName)) { |
|
83 | - $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
84 | - } |
|
85 | - |
|
86 | - if ($tdbmService === null) { |
|
87 | - $this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED); |
|
88 | - } else { |
|
89 | - $this->_attach($tdbmService); |
|
90 | - if (!empty($primaryKeys)) { |
|
91 | - $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
92 | - } else { |
|
93 | - $this->_setStatus(TDBMObjectStateEnum::STATE_NEW); |
|
94 | - } |
|
95 | - } |
|
96 | - } |
|
97 | - |
|
98 | - /** |
|
99 | - * Alternative constructor called when data is fetched from database via a SELECT. |
|
100 | - * |
|
101 | - * @param array $beanData array<table, array<column, value>> |
|
102 | - * @param TDBMService $tdbmService |
|
103 | - */ |
|
104 | - public function _constructFromData(array $beanData, TDBMService $tdbmService) |
|
105 | - { |
|
106 | - $this->tdbmService = $tdbmService; |
|
107 | - |
|
108 | - foreach ($beanData as $table => $columns) { |
|
109 | - $this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns); |
|
110 | - } |
|
111 | - |
|
112 | - $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
113 | - } |
|
114 | - |
|
115 | - /** |
|
116 | - * Alternative constructor called when bean is lazily loaded. |
|
117 | - * |
|
118 | - * @param string $tableName |
|
119 | - * @param array $primaryKeys |
|
120 | - * @param TDBMService $tdbmService |
|
121 | - */ |
|
122 | - public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService) |
|
123 | - { |
|
124 | - $this->tdbmService = $tdbmService; |
|
125 | - |
|
126 | - $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
127 | - |
|
128 | - $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED; |
|
129 | - } |
|
130 | - |
|
131 | - public function _attach(TDBMService $tdbmService) |
|
132 | - { |
|
133 | - if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) { |
|
134 | - throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.'); |
|
135 | - } |
|
136 | - $this->tdbmService = $tdbmService; |
|
137 | - |
|
138 | - // If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level) |
|
139 | - $tableNames = array_keys($this->dbRows); |
|
140 | - $tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames); |
|
141 | - $tableNames = array_reverse($tableNames); |
|
142 | - |
|
143 | - $newDbRows = []; |
|
144 | - |
|
145 | - foreach ($tableNames as $table) { |
|
146 | - if (!isset($this->dbRows[$table])) { |
|
147 | - $this->registerTable($table); |
|
148 | - } |
|
149 | - $newDbRows[$table] = $this->dbRows[$table]; |
|
150 | - } |
|
151 | - $this->dbRows = $newDbRows; |
|
152 | - |
|
153 | - $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
154 | - foreach ($this->dbRows as $dbRow) { |
|
155 | - $dbRow->_attach($tdbmService); |
|
156 | - } |
|
157 | - } |
|
158 | - |
|
159 | - /** |
|
160 | - * Sets the state of the TDBM Object |
|
161 | - * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
162 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
163 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
164 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
165 | - * |
|
166 | - * @param string $state |
|
167 | - */ |
|
168 | - public function _setStatus($state) |
|
169 | - { |
|
170 | - $this->status = $state; |
|
171 | - |
|
172 | - // TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself. |
|
173 | - foreach ($this->dbRows as $dbRow) { |
|
174 | - $dbRow->_setStatus($state); |
|
175 | - } |
|
176 | - } |
|
177 | - |
|
178 | - public function get($var, $tableName = null) |
|
179 | - { |
|
180 | - if ($tableName === null) { |
|
181 | - if (count($this->dbRows) > 1) { |
|
182 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
183 | - } elseif (count($this->dbRows) === 1) { |
|
184 | - $tableName = array_keys($this->dbRows)[0]; |
|
185 | - } |
|
186 | - } |
|
187 | - |
|
188 | - if (!isset($this->dbRows[$tableName])) { |
|
189 | - if (count($this->dbRows[$tableName] === 0)) { |
|
190 | - throw new TDBMException('Object is not yet bound to any table.'); |
|
191 | - } else { |
|
192 | - throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
193 | - } |
|
194 | - } |
|
195 | - |
|
196 | - return $this->dbRows[$tableName]->get($var); |
|
197 | - } |
|
198 | - |
|
199 | - /** |
|
200 | - * Returns true if a column is set, false otherwise. |
|
201 | - * |
|
202 | - * @param string $var |
|
203 | - * |
|
204 | - * @return bool |
|
205 | - */ |
|
206 | - public function has($var, $tableName = null) |
|
207 | - { |
|
208 | - if ($tableName === null) { |
|
209 | - if (count($this->dbRows) > 1) { |
|
210 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
211 | - } elseif (count($this->dbRows) === 1) { |
|
212 | - $tableName = array_keys($this->dbRows)[0]; |
|
213 | - } |
|
214 | - } |
|
215 | - |
|
216 | - if (!isset($this->dbRows[$tableName])) { |
|
217 | - if (count($this->dbRows[$tableName] === 0)) { |
|
218 | - throw new TDBMException('Object is not yet bound to any table.'); |
|
219 | - } else { |
|
220 | - throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
221 | - } |
|
222 | - } |
|
223 | - |
|
224 | - return $this->dbRows[$tableName]->has($var); |
|
225 | - } |
|
226 | - |
|
227 | - public function set($var, $value, $tableName = null) |
|
228 | - { |
|
229 | - if ($tableName === null) { |
|
230 | - if (count($this->dbRows) > 1) { |
|
231 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
232 | - } elseif (count($this->dbRows) === 1) { |
|
233 | - $tableName = array_keys($this->dbRows)[0]; |
|
234 | - } else { |
|
235 | - throw new TDBMException('Please specify a table for this object.'); |
|
236 | - } |
|
237 | - } |
|
238 | - |
|
239 | - if (!isset($this->dbRows[$tableName])) { |
|
240 | - $this->registerTable($tableName); |
|
241 | - } |
|
242 | - |
|
243 | - $this->dbRows[$tableName]->set($var, $value); |
|
244 | - if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
245 | - $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
246 | - } |
|
247 | - } |
|
248 | - |
|
249 | - /** |
|
250 | - * @param string $foreignKeyName |
|
251 | - * @param AbstractTDBMObject $bean |
|
252 | - */ |
|
253 | - public function setRef($foreignKeyName, AbstractTDBMObject $bean, $tableName = null) |
|
254 | - { |
|
255 | - if ($tableName === null) { |
|
256 | - if (count($this->dbRows) > 1) { |
|
257 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
258 | - } elseif (count($this->dbRows) === 1) { |
|
259 | - $tableName = array_keys($this->dbRows)[0]; |
|
260 | - } else { |
|
261 | - throw new TDBMException('Please specify a table for this object.'); |
|
262 | - } |
|
263 | - } |
|
264 | - |
|
265 | - if (!isset($this->dbRows[$tableName])) { |
|
266 | - $this->registerTable($tableName); |
|
267 | - } |
|
268 | - |
|
269 | - $this->dbRows[$tableName]->setRef($foreignKeyName, $bean); |
|
270 | - if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
271 | - $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
272 | - } |
|
273 | - } |
|
274 | - |
|
275 | - /** |
|
276 | - * @param string $foreignKeyName A unique name for this reference |
|
277 | - * |
|
278 | - * @return AbstractTDBMObject|null |
|
279 | - */ |
|
280 | - public function getRef($foreignKeyName, $tableName = null) |
|
281 | - { |
|
282 | - if ($tableName === null) { |
|
283 | - if (count($this->dbRows) > 1) { |
|
284 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
285 | - } elseif (count($this->dbRows) === 1) { |
|
286 | - $tableName = array_keys($this->dbRows)[0]; |
|
287 | - } |
|
288 | - } |
|
289 | - |
|
290 | - if (!isset($this->dbRows[$tableName])) { |
|
291 | - if (count($this->dbRows[$tableName] === 0)) { |
|
292 | - throw new TDBMException('Object is not yet bound to any table.'); |
|
293 | - } else { |
|
294 | - throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
295 | - } |
|
296 | - } |
|
297 | - |
|
298 | - return $this->dbRows[$tableName]->getRef($foreignKeyName); |
|
299 | - } |
|
300 | - |
|
301 | - /** |
|
302 | - * Adds a many to many relationship to this bean. |
|
303 | - * |
|
304 | - * @param string $pivotTableName |
|
305 | - * @param AbstractTDBMObject $remoteBean |
|
306 | - */ |
|
307 | - protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
308 | - { |
|
309 | - $this->setRelationship($pivotTableName, $remoteBean, 'new'); |
|
310 | - } |
|
311 | - |
|
312 | - /** |
|
313 | - * Returns true if there is a relationship to this bean. |
|
314 | - * |
|
315 | - * @param string $pivotTableName |
|
316 | - * @param AbstractTDBMObject $remoteBean |
|
317 | - * |
|
318 | - * @return bool |
|
319 | - */ |
|
320 | - protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
321 | - { |
|
322 | - $storage = $this->retrieveRelationshipsStorage($pivotTableName); |
|
323 | - |
|
324 | - if ($storage->contains($remoteBean)) { |
|
325 | - if ($storage[$remoteBean]['status'] !== 'delete') { |
|
326 | - return true; |
|
327 | - } |
|
328 | - } |
|
329 | - |
|
330 | - return false; |
|
331 | - } |
|
332 | - |
|
333 | - /** |
|
334 | - * Internal TDBM method. Removes a many to many relationship from this bean. |
|
335 | - * |
|
336 | - * @param string $pivotTableName |
|
337 | - * @param AbstractTDBMObject $remoteBean |
|
338 | - */ |
|
339 | - public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
340 | - { |
|
341 | - if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') { |
|
342 | - unset($this->relationships[$pivotTableName][$remoteBean]); |
|
343 | - unset($remoteBean->relationships[$pivotTableName][$this]); |
|
344 | - } else { |
|
345 | - $this->setRelationship($pivotTableName, $remoteBean, 'delete'); |
|
346 | - } |
|
347 | - } |
|
348 | - |
|
349 | - /** |
|
350 | - * Returns the list of objects linked to this bean via $pivotTableName. |
|
351 | - * |
|
352 | - * @param $pivotTableName |
|
353 | - * |
|
354 | - * @return \SplObjectStorage |
|
355 | - */ |
|
356 | - private function retrieveRelationshipsStorage($pivotTableName) |
|
357 | - { |
|
358 | - $storage = $this->getRelationshipStorage($pivotTableName); |
|
359 | - if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName]) { |
|
360 | - return $storage; |
|
361 | - } |
|
362 | - |
|
363 | - $beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this); |
|
364 | - $this->loadedRelationships[$pivotTableName] = true; |
|
365 | - |
|
366 | - foreach ($beans as $bean) { |
|
367 | - if (isset($storage[$bean])) { |
|
368 | - $oldStatus = $storage[$bean]['status']; |
|
369 | - if ($oldStatus === 'delete') { |
|
370 | - // Keep deleted things deleted |
|
371 | - continue; |
|
372 | - } |
|
373 | - } |
|
374 | - $this->setRelationship($pivotTableName, $bean, 'loaded'); |
|
375 | - } |
|
376 | - |
|
377 | - return $storage; |
|
378 | - } |
|
379 | - |
|
380 | - /** |
|
381 | - * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName. |
|
382 | - * |
|
383 | - * @param $pivotTableName |
|
384 | - * |
|
385 | - * @return AbstractTDBMObject[] |
|
386 | - */ |
|
387 | - public function _getRelationships($pivotTableName) |
|
388 | - { |
|
389 | - return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName)); |
|
390 | - } |
|
391 | - |
|
392 | - private function relationshipStorageToArray(\SplObjectStorage $storage) |
|
393 | - { |
|
394 | - $beans = []; |
|
395 | - foreach ($storage as $bean) { |
|
396 | - $statusArr = $storage[$bean]; |
|
397 | - if ($statusArr['status'] !== 'delete') { |
|
398 | - $beans[] = $bean; |
|
399 | - } |
|
400 | - } |
|
401 | - |
|
402 | - return $beans; |
|
403 | - } |
|
404 | - |
|
405 | - /** |
|
406 | - * Declares a relationship between. |
|
407 | - * |
|
408 | - * @param string $pivotTableName |
|
409 | - * @param AbstractTDBMObject $remoteBean |
|
410 | - * @param string $status |
|
411 | - */ |
|
412 | - private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status) |
|
413 | - { |
|
414 | - $storage = $this->getRelationshipStorage($pivotTableName); |
|
415 | - $storage->attach($remoteBean, ['status' => $status, 'reverse' => false]); |
|
416 | - if ($this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
417 | - $this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY); |
|
418 | - } |
|
419 | - |
|
420 | - $remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName); |
|
421 | - $remoteStorage->attach($this, ['status' => $status, 'reverse' => true]); |
|
422 | - } |
|
423 | - |
|
424 | - /** |
|
425 | - * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists). |
|
426 | - * |
|
427 | - * @param $pivotTableName |
|
428 | - * |
|
429 | - * @return \SplObjectStorage |
|
430 | - */ |
|
431 | - private function getRelationshipStorage($pivotTableName) |
|
432 | - { |
|
433 | - if (isset($this->relationships[$pivotTableName])) { |
|
434 | - $storage = $this->relationships[$pivotTableName]; |
|
435 | - } else { |
|
436 | - $storage = new \SplObjectStorage(); |
|
437 | - $this->relationships[$pivotTableName] = $storage; |
|
438 | - } |
|
439 | - |
|
440 | - return $storage; |
|
441 | - } |
|
442 | - |
|
443 | - /** |
|
444 | - * Reverts any changes made to the object and resumes it to its DB state. |
|
445 | - * This can only be called on objects that come from database and that have not been deleted. |
|
446 | - * Otherwise, this will throw an exception. |
|
447 | - * |
|
448 | - * @throws TDBMException |
|
449 | - */ |
|
450 | - public function discardChanges() |
|
451 | - { |
|
452 | - if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
453 | - 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."); |
|
454 | - } |
|
455 | - |
|
456 | - if ($this->status === TDBMObjectStateEnum::STATE_DELETED) { |
|
457 | - throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.'); |
|
458 | - } |
|
459 | - |
|
460 | - $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
461 | - } |
|
462 | - |
|
463 | - /** |
|
464 | - * Method used internally by TDBM. You should not use it directly. |
|
465 | - * This method returns the status of the TDBMObject. |
|
466 | - * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
467 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
468 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
469 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
470 | - * |
|
471 | - * @return string |
|
472 | - */ |
|
473 | - public function _getStatus() |
|
474 | - { |
|
475 | - return $this->status; |
|
476 | - } |
|
477 | - |
|
478 | - /** |
|
479 | - * Override the native php clone function for TDBMObjects. |
|
480 | - */ |
|
481 | - public function __clone() |
|
482 | - { |
|
483 | - // Let's clone the many to many relationships |
|
484 | - if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
485 | - $pivotTableList = array_keys($this->relationships); |
|
486 | - } else { |
|
487 | - $pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this); |
|
488 | - } |
|
489 | - |
|
490 | - foreach ($pivotTableList as $pivotTable) { |
|
491 | - $storage = $this->retrieveRelationshipsStorage($pivotTable); |
|
492 | - |
|
493 | - // Let's duplicate the reverse side of the relationship |
|
494 | - foreach ($storage as $remoteBean) { |
|
495 | - $metadata = $storage[$remoteBean]; |
|
496 | - |
|
497 | - $remoteStorage = $remoteBean->getRelationshipStorage($pivotTable); |
|
498 | - $remoteStorage->attach($this, ['status' => $metadata['status'], 'reverse' => !$metadata['reverse']]); |
|
499 | - } |
|
500 | - } |
|
501 | - |
|
502 | - // Let's clone each row |
|
503 | - foreach ($this->dbRows as $key => $dbRow) { |
|
504 | - $this->dbRows[$key] = clone $dbRow; |
|
505 | - } |
|
506 | - |
|
507 | - // Let's set the status to new (to enter the save function) |
|
508 | - $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
509 | - } |
|
510 | - |
|
511 | - /** |
|
512 | - * Returns raw database rows. |
|
513 | - * |
|
514 | - * @return DbRow[] Key: table name, Value: DbRow object |
|
515 | - */ |
|
516 | - public function _getDbRows() |
|
517 | - { |
|
518 | - return $this->dbRows; |
|
519 | - } |
|
520 | - |
|
521 | - private function registerTable($tableName) |
|
522 | - { |
|
523 | - $dbRow = new DbRow($this, $tableName); |
|
524 | - |
|
525 | - if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) { |
|
526 | - // Let's get the primary key for the new table |
|
527 | - $anotherDbRow = array_values($this->dbRows)[0]; |
|
528 | - /* @var $anotherDbRow DbRow */ |
|
529 | - $indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys()); |
|
530 | - $primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys); |
|
531 | - $dbRow->_setPrimaryKeys($primaryKeys); |
|
532 | - } |
|
533 | - |
|
534 | - $dbRow->_setStatus($this->status); |
|
535 | - |
|
536 | - $this->dbRows[$tableName] = $dbRow; |
|
537 | - // TODO: look at status (if not new)=> get primary key from tdbmservice |
|
538 | - } |
|
539 | - |
|
540 | - /** |
|
541 | - * Internal function: return the list of relationships. |
|
542 | - * |
|
543 | - * @return \SplObjectStorage[] |
|
544 | - */ |
|
545 | - public function _getCachedRelationships() |
|
546 | - { |
|
547 | - return $this->relationships; |
|
548 | - } |
|
32 | + /** |
|
33 | + * The service this object is bound to. |
|
34 | + * |
|
35 | + * @var TDBMService |
|
36 | + */ |
|
37 | + protected $tdbmService; |
|
38 | + |
|
39 | + /** |
|
40 | + * An array of DbRow, indexed by table name. |
|
41 | + * |
|
42 | + * @var DbRow[] |
|
43 | + */ |
|
44 | + protected $dbRows = array(); |
|
45 | + |
|
46 | + /** |
|
47 | + * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
48 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
49 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
50 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
51 | + * |
|
52 | + * @var string |
|
53 | + */ |
|
54 | + private $status; |
|
55 | + |
|
56 | + /** |
|
57 | + * Array storing beans related via many to many relationships (pivot tables). |
|
58 | + * |
|
59 | + * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage |
|
60 | + */ |
|
61 | + private $relationships = []; |
|
62 | + |
|
63 | + /** |
|
64 | + * @var bool[] Key: pivot table name, value: whether a query was performed to load the data. |
|
65 | + */ |
|
66 | + private $loadedRelationships = []; |
|
67 | + |
|
68 | + /** |
|
69 | + * Used with $primaryKeys when we want to retrieve an existing object |
|
70 | + * and $primaryKeys=[] if we want a new object. |
|
71 | + * |
|
72 | + * @param string $tableName |
|
73 | + * @param array $primaryKeys |
|
74 | + * @param TDBMService $tdbmService |
|
75 | + * |
|
76 | + * @throws TDBMException |
|
77 | + * @throws TDBMInvalidOperationException |
|
78 | + */ |
|
79 | + public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null) |
|
80 | + { |
|
81 | + // FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation... |
|
82 | + if (!empty($tableName)) { |
|
83 | + $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
84 | + } |
|
85 | + |
|
86 | + if ($tdbmService === null) { |
|
87 | + $this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED); |
|
88 | + } else { |
|
89 | + $this->_attach($tdbmService); |
|
90 | + if (!empty($primaryKeys)) { |
|
91 | + $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
92 | + } else { |
|
93 | + $this->_setStatus(TDBMObjectStateEnum::STATE_NEW); |
|
94 | + } |
|
95 | + } |
|
96 | + } |
|
97 | + |
|
98 | + /** |
|
99 | + * Alternative constructor called when data is fetched from database via a SELECT. |
|
100 | + * |
|
101 | + * @param array $beanData array<table, array<column, value>> |
|
102 | + * @param TDBMService $tdbmService |
|
103 | + */ |
|
104 | + public function _constructFromData(array $beanData, TDBMService $tdbmService) |
|
105 | + { |
|
106 | + $this->tdbmService = $tdbmService; |
|
107 | + |
|
108 | + foreach ($beanData as $table => $columns) { |
|
109 | + $this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns); |
|
110 | + } |
|
111 | + |
|
112 | + $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
113 | + } |
|
114 | + |
|
115 | + /** |
|
116 | + * Alternative constructor called when bean is lazily loaded. |
|
117 | + * |
|
118 | + * @param string $tableName |
|
119 | + * @param array $primaryKeys |
|
120 | + * @param TDBMService $tdbmService |
|
121 | + */ |
|
122 | + public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService) |
|
123 | + { |
|
124 | + $this->tdbmService = $tdbmService; |
|
125 | + |
|
126 | + $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
127 | + |
|
128 | + $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED; |
|
129 | + } |
|
130 | + |
|
131 | + public function _attach(TDBMService $tdbmService) |
|
132 | + { |
|
133 | + if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) { |
|
134 | + throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.'); |
|
135 | + } |
|
136 | + $this->tdbmService = $tdbmService; |
|
137 | + |
|
138 | + // If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level) |
|
139 | + $tableNames = array_keys($this->dbRows); |
|
140 | + $tableNames = $this->tdbmService->_getLinkBetweenInheritedTables($tableNames); |
|
141 | + $tableNames = array_reverse($tableNames); |
|
142 | + |
|
143 | + $newDbRows = []; |
|
144 | + |
|
145 | + foreach ($tableNames as $table) { |
|
146 | + if (!isset($this->dbRows[$table])) { |
|
147 | + $this->registerTable($table); |
|
148 | + } |
|
149 | + $newDbRows[$table] = $this->dbRows[$table]; |
|
150 | + } |
|
151 | + $this->dbRows = $newDbRows; |
|
152 | + |
|
153 | + $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
154 | + foreach ($this->dbRows as $dbRow) { |
|
155 | + $dbRow->_attach($tdbmService); |
|
156 | + } |
|
157 | + } |
|
158 | + |
|
159 | + /** |
|
160 | + * Sets the state of the TDBM Object |
|
161 | + * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
162 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
163 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
164 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
165 | + * |
|
166 | + * @param string $state |
|
167 | + */ |
|
168 | + public function _setStatus($state) |
|
169 | + { |
|
170 | + $this->status = $state; |
|
171 | + |
|
172 | + // TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself. |
|
173 | + foreach ($this->dbRows as $dbRow) { |
|
174 | + $dbRow->_setStatus($state); |
|
175 | + } |
|
176 | + } |
|
177 | + |
|
178 | + public function get($var, $tableName = null) |
|
179 | + { |
|
180 | + if ($tableName === null) { |
|
181 | + if (count($this->dbRows) > 1) { |
|
182 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
183 | + } elseif (count($this->dbRows) === 1) { |
|
184 | + $tableName = array_keys($this->dbRows)[0]; |
|
185 | + } |
|
186 | + } |
|
187 | + |
|
188 | + if (!isset($this->dbRows[$tableName])) { |
|
189 | + if (count($this->dbRows[$tableName] === 0)) { |
|
190 | + throw new TDBMException('Object is not yet bound to any table.'); |
|
191 | + } else { |
|
192 | + throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
193 | + } |
|
194 | + } |
|
195 | + |
|
196 | + return $this->dbRows[$tableName]->get($var); |
|
197 | + } |
|
198 | + |
|
199 | + /** |
|
200 | + * Returns true if a column is set, false otherwise. |
|
201 | + * |
|
202 | + * @param string $var |
|
203 | + * |
|
204 | + * @return bool |
|
205 | + */ |
|
206 | + public function has($var, $tableName = null) |
|
207 | + { |
|
208 | + if ($tableName === null) { |
|
209 | + if (count($this->dbRows) > 1) { |
|
210 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
211 | + } elseif (count($this->dbRows) === 1) { |
|
212 | + $tableName = array_keys($this->dbRows)[0]; |
|
213 | + } |
|
214 | + } |
|
215 | + |
|
216 | + if (!isset($this->dbRows[$tableName])) { |
|
217 | + if (count($this->dbRows[$tableName] === 0)) { |
|
218 | + throw new TDBMException('Object is not yet bound to any table.'); |
|
219 | + } else { |
|
220 | + throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
221 | + } |
|
222 | + } |
|
223 | + |
|
224 | + return $this->dbRows[$tableName]->has($var); |
|
225 | + } |
|
226 | + |
|
227 | + public function set($var, $value, $tableName = null) |
|
228 | + { |
|
229 | + if ($tableName === null) { |
|
230 | + if (count($this->dbRows) > 1) { |
|
231 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
232 | + } elseif (count($this->dbRows) === 1) { |
|
233 | + $tableName = array_keys($this->dbRows)[0]; |
|
234 | + } else { |
|
235 | + throw new TDBMException('Please specify a table for this object.'); |
|
236 | + } |
|
237 | + } |
|
238 | + |
|
239 | + if (!isset($this->dbRows[$tableName])) { |
|
240 | + $this->registerTable($tableName); |
|
241 | + } |
|
242 | + |
|
243 | + $this->dbRows[$tableName]->set($var, $value); |
|
244 | + if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
245 | + $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
246 | + } |
|
247 | + } |
|
248 | + |
|
249 | + /** |
|
250 | + * @param string $foreignKeyName |
|
251 | + * @param AbstractTDBMObject $bean |
|
252 | + */ |
|
253 | + public function setRef($foreignKeyName, AbstractTDBMObject $bean, $tableName = null) |
|
254 | + { |
|
255 | + if ($tableName === null) { |
|
256 | + if (count($this->dbRows) > 1) { |
|
257 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
258 | + } elseif (count($this->dbRows) === 1) { |
|
259 | + $tableName = array_keys($this->dbRows)[0]; |
|
260 | + } else { |
|
261 | + throw new TDBMException('Please specify a table for this object.'); |
|
262 | + } |
|
263 | + } |
|
264 | + |
|
265 | + if (!isset($this->dbRows[$tableName])) { |
|
266 | + $this->registerTable($tableName); |
|
267 | + } |
|
268 | + |
|
269 | + $this->dbRows[$tableName]->setRef($foreignKeyName, $bean); |
|
270 | + if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
271 | + $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
272 | + } |
|
273 | + } |
|
274 | + |
|
275 | + /** |
|
276 | + * @param string $foreignKeyName A unique name for this reference |
|
277 | + * |
|
278 | + * @return AbstractTDBMObject|null |
|
279 | + */ |
|
280 | + public function getRef($foreignKeyName, $tableName = null) |
|
281 | + { |
|
282 | + if ($tableName === null) { |
|
283 | + if (count($this->dbRows) > 1) { |
|
284 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
285 | + } elseif (count($this->dbRows) === 1) { |
|
286 | + $tableName = array_keys($this->dbRows)[0]; |
|
287 | + } |
|
288 | + } |
|
289 | + |
|
290 | + if (!isset($this->dbRows[$tableName])) { |
|
291 | + if (count($this->dbRows[$tableName] === 0)) { |
|
292 | + throw new TDBMException('Object is not yet bound to any table.'); |
|
293 | + } else { |
|
294 | + throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
295 | + } |
|
296 | + } |
|
297 | + |
|
298 | + return $this->dbRows[$tableName]->getRef($foreignKeyName); |
|
299 | + } |
|
300 | + |
|
301 | + /** |
|
302 | + * Adds a many to many relationship to this bean. |
|
303 | + * |
|
304 | + * @param string $pivotTableName |
|
305 | + * @param AbstractTDBMObject $remoteBean |
|
306 | + */ |
|
307 | + protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
308 | + { |
|
309 | + $this->setRelationship($pivotTableName, $remoteBean, 'new'); |
|
310 | + } |
|
311 | + |
|
312 | + /** |
|
313 | + * Returns true if there is a relationship to this bean. |
|
314 | + * |
|
315 | + * @param string $pivotTableName |
|
316 | + * @param AbstractTDBMObject $remoteBean |
|
317 | + * |
|
318 | + * @return bool |
|
319 | + */ |
|
320 | + protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
321 | + { |
|
322 | + $storage = $this->retrieveRelationshipsStorage($pivotTableName); |
|
323 | + |
|
324 | + if ($storage->contains($remoteBean)) { |
|
325 | + if ($storage[$remoteBean]['status'] !== 'delete') { |
|
326 | + return true; |
|
327 | + } |
|
328 | + } |
|
329 | + |
|
330 | + return false; |
|
331 | + } |
|
332 | + |
|
333 | + /** |
|
334 | + * Internal TDBM method. Removes a many to many relationship from this bean. |
|
335 | + * |
|
336 | + * @param string $pivotTableName |
|
337 | + * @param AbstractTDBMObject $remoteBean |
|
338 | + */ |
|
339 | + public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
340 | + { |
|
341 | + if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') { |
|
342 | + unset($this->relationships[$pivotTableName][$remoteBean]); |
|
343 | + unset($remoteBean->relationships[$pivotTableName][$this]); |
|
344 | + } else { |
|
345 | + $this->setRelationship($pivotTableName, $remoteBean, 'delete'); |
|
346 | + } |
|
347 | + } |
|
348 | + |
|
349 | + /** |
|
350 | + * Returns the list of objects linked to this bean via $pivotTableName. |
|
351 | + * |
|
352 | + * @param $pivotTableName |
|
353 | + * |
|
354 | + * @return \SplObjectStorage |
|
355 | + */ |
|
356 | + private function retrieveRelationshipsStorage($pivotTableName) |
|
357 | + { |
|
358 | + $storage = $this->getRelationshipStorage($pivotTableName); |
|
359 | + if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName]) { |
|
360 | + return $storage; |
|
361 | + } |
|
362 | + |
|
363 | + $beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this); |
|
364 | + $this->loadedRelationships[$pivotTableName] = true; |
|
365 | + |
|
366 | + foreach ($beans as $bean) { |
|
367 | + if (isset($storage[$bean])) { |
|
368 | + $oldStatus = $storage[$bean]['status']; |
|
369 | + if ($oldStatus === 'delete') { |
|
370 | + // Keep deleted things deleted |
|
371 | + continue; |
|
372 | + } |
|
373 | + } |
|
374 | + $this->setRelationship($pivotTableName, $bean, 'loaded'); |
|
375 | + } |
|
376 | + |
|
377 | + return $storage; |
|
378 | + } |
|
379 | + |
|
380 | + /** |
|
381 | + * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName. |
|
382 | + * |
|
383 | + * @param $pivotTableName |
|
384 | + * |
|
385 | + * @return AbstractTDBMObject[] |
|
386 | + */ |
|
387 | + public function _getRelationships($pivotTableName) |
|
388 | + { |
|
389 | + return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName)); |
|
390 | + } |
|
391 | + |
|
392 | + private function relationshipStorageToArray(\SplObjectStorage $storage) |
|
393 | + { |
|
394 | + $beans = []; |
|
395 | + foreach ($storage as $bean) { |
|
396 | + $statusArr = $storage[$bean]; |
|
397 | + if ($statusArr['status'] !== 'delete') { |
|
398 | + $beans[] = $bean; |
|
399 | + } |
|
400 | + } |
|
401 | + |
|
402 | + return $beans; |
|
403 | + } |
|
404 | + |
|
405 | + /** |
|
406 | + * Declares a relationship between. |
|
407 | + * |
|
408 | + * @param string $pivotTableName |
|
409 | + * @param AbstractTDBMObject $remoteBean |
|
410 | + * @param string $status |
|
411 | + */ |
|
412 | + private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status) |
|
413 | + { |
|
414 | + $storage = $this->getRelationshipStorage($pivotTableName); |
|
415 | + $storage->attach($remoteBean, ['status' => $status, 'reverse' => false]); |
|
416 | + if ($this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
417 | + $this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY); |
|
418 | + } |
|
419 | + |
|
420 | + $remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName); |
|
421 | + $remoteStorage->attach($this, ['status' => $status, 'reverse' => true]); |
|
422 | + } |
|
423 | + |
|
424 | + /** |
|
425 | + * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists). |
|
426 | + * |
|
427 | + * @param $pivotTableName |
|
428 | + * |
|
429 | + * @return \SplObjectStorage |
|
430 | + */ |
|
431 | + private function getRelationshipStorage($pivotTableName) |
|
432 | + { |
|
433 | + if (isset($this->relationships[$pivotTableName])) { |
|
434 | + $storage = $this->relationships[$pivotTableName]; |
|
435 | + } else { |
|
436 | + $storage = new \SplObjectStorage(); |
|
437 | + $this->relationships[$pivotTableName] = $storage; |
|
438 | + } |
|
439 | + |
|
440 | + return $storage; |
|
441 | + } |
|
442 | + |
|
443 | + /** |
|
444 | + * Reverts any changes made to the object and resumes it to its DB state. |
|
445 | + * This can only be called on objects that come from database and that have not been deleted. |
|
446 | + * Otherwise, this will throw an exception. |
|
447 | + * |
|
448 | + * @throws TDBMException |
|
449 | + */ |
|
450 | + public function discardChanges() |
|
451 | + { |
|
452 | + if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
453 | + 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."); |
|
454 | + } |
|
455 | + |
|
456 | + if ($this->status === TDBMObjectStateEnum::STATE_DELETED) { |
|
457 | + throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.'); |
|
458 | + } |
|
459 | + |
|
460 | + $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
461 | + } |
|
462 | + |
|
463 | + /** |
|
464 | + * Method used internally by TDBM. You should not use it directly. |
|
465 | + * This method returns the status of the TDBMObject. |
|
466 | + * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
467 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
468 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
469 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
470 | + * |
|
471 | + * @return string |
|
472 | + */ |
|
473 | + public function _getStatus() |
|
474 | + { |
|
475 | + return $this->status; |
|
476 | + } |
|
477 | + |
|
478 | + /** |
|
479 | + * Override the native php clone function for TDBMObjects. |
|
480 | + */ |
|
481 | + public function __clone() |
|
482 | + { |
|
483 | + // Let's clone the many to many relationships |
|
484 | + if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
485 | + $pivotTableList = array_keys($this->relationships); |
|
486 | + } else { |
|
487 | + $pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this); |
|
488 | + } |
|
489 | + |
|
490 | + foreach ($pivotTableList as $pivotTable) { |
|
491 | + $storage = $this->retrieveRelationshipsStorage($pivotTable); |
|
492 | + |
|
493 | + // Let's duplicate the reverse side of the relationship |
|
494 | + foreach ($storage as $remoteBean) { |
|
495 | + $metadata = $storage[$remoteBean]; |
|
496 | + |
|
497 | + $remoteStorage = $remoteBean->getRelationshipStorage($pivotTable); |
|
498 | + $remoteStorage->attach($this, ['status' => $metadata['status'], 'reverse' => !$metadata['reverse']]); |
|
499 | + } |
|
500 | + } |
|
501 | + |
|
502 | + // Let's clone each row |
|
503 | + foreach ($this->dbRows as $key => $dbRow) { |
|
504 | + $this->dbRows[$key] = clone $dbRow; |
|
505 | + } |
|
506 | + |
|
507 | + // Let's set the status to new (to enter the save function) |
|
508 | + $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
509 | + } |
|
510 | + |
|
511 | + /** |
|
512 | + * Returns raw database rows. |
|
513 | + * |
|
514 | + * @return DbRow[] Key: table name, Value: DbRow object |
|
515 | + */ |
|
516 | + public function _getDbRows() |
|
517 | + { |
|
518 | + return $this->dbRows; |
|
519 | + } |
|
520 | + |
|
521 | + private function registerTable($tableName) |
|
522 | + { |
|
523 | + $dbRow = new DbRow($this, $tableName); |
|
524 | + |
|
525 | + if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) { |
|
526 | + // Let's get the primary key for the new table |
|
527 | + $anotherDbRow = array_values($this->dbRows)[0]; |
|
528 | + /* @var $anotherDbRow DbRow */ |
|
529 | + $indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys()); |
|
530 | + $primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys); |
|
531 | + $dbRow->_setPrimaryKeys($primaryKeys); |
|
532 | + } |
|
533 | + |
|
534 | + $dbRow->_setStatus($this->status); |
|
535 | + |
|
536 | + $this->dbRows[$tableName] = $dbRow; |
|
537 | + // TODO: look at status (if not new)=> get primary key from tdbmservice |
|
538 | + } |
|
539 | + |
|
540 | + /** |
|
541 | + * Internal function: return the list of relationships. |
|
542 | + * |
|
543 | + * @return \SplObjectStorage[] |
|
544 | + */ |
|
545 | + public function _getCachedRelationships() |
|
546 | + { |
|
547 | + return $this->relationships; |
|
548 | + } |
|
549 | 549 | } |
@@ -26,77 +26,77 @@ |
||
26 | 26 | */ |
27 | 27 | class TDBMObjectArray extends \ArrayObject implements \JsonSerializable |
28 | 28 | { |
29 | - public function __get($var) |
|
30 | - { |
|
31 | - $cnt = count($this); |
|
32 | - if ($cnt == 1) { |
|
33 | - return $this[0]->__get($var); |
|
34 | - } elseif ($cnt > 1) { |
|
35 | - throw new TDBMException('Array contains many objects! Use getarray_'.$var.' to retrieve an array of '.$var); |
|
36 | - } else { |
|
37 | - throw new TDBMException('Array contains no objects'); |
|
38 | - } |
|
39 | - } |
|
29 | + public function __get($var) |
|
30 | + { |
|
31 | + $cnt = count($this); |
|
32 | + if ($cnt == 1) { |
|
33 | + return $this[0]->__get($var); |
|
34 | + } elseif ($cnt > 1) { |
|
35 | + throw new TDBMException('Array contains many objects! Use getarray_'.$var.' to retrieve an array of '.$var); |
|
36 | + } else { |
|
37 | + throw new TDBMException('Array contains no objects'); |
|
38 | + } |
|
39 | + } |
|
40 | 40 | |
41 | - public function __set($var, $value) |
|
42 | - { |
|
43 | - $cnt = count($this); |
|
44 | - if ($cnt == 1) { |
|
45 | - return $this[0]->__set($var, $value); |
|
46 | - } elseif ($cnt > 1) { |
|
47 | - throw new TDBMException('Array contains many objects! Use setarray_'.$var.' to set the array of '.$var); |
|
48 | - } else { |
|
49 | - throw new TDBMException('Array contains no objects'); |
|
50 | - } |
|
51 | - } |
|
41 | + public function __set($var, $value) |
|
42 | + { |
|
43 | + $cnt = count($this); |
|
44 | + if ($cnt == 1) { |
|
45 | + return $this[0]->__set($var, $value); |
|
46 | + } elseif ($cnt > 1) { |
|
47 | + throw new TDBMException('Array contains many objects! Use setarray_'.$var.' to set the array of '.$var); |
|
48 | + } else { |
|
49 | + throw new TDBMException('Array contains no objects'); |
|
50 | + } |
|
51 | + } |
|
52 | 52 | |
53 | - /** |
|
54 | - * getarray_column_name returns an array containing the values of the column of the given objects. |
|
55 | - * setarray_column_name sets the value of the given column for all the objects. |
|
56 | - * |
|
57 | - * @param string $func_name |
|
58 | - * @param $values |
|
59 | - * |
|
60 | - * @return array|void |
|
61 | - * |
|
62 | - * @throws TDBMException |
|
63 | - */ |
|
64 | - public function __call($func_name, $values) |
|
65 | - { |
|
66 | - if (strpos($func_name, 'getarray_') === 0) { |
|
67 | - $column = substr($func_name, 9); |
|
53 | + /** |
|
54 | + * getarray_column_name returns an array containing the values of the column of the given objects. |
|
55 | + * setarray_column_name sets the value of the given column for all the objects. |
|
56 | + * |
|
57 | + * @param string $func_name |
|
58 | + * @param $values |
|
59 | + * |
|
60 | + * @return array|void |
|
61 | + * |
|
62 | + * @throws TDBMException |
|
63 | + */ |
|
64 | + public function __call($func_name, $values) |
|
65 | + { |
|
66 | + if (strpos($func_name, 'getarray_') === 0) { |
|
67 | + $column = substr($func_name, 9); |
|
68 | 68 | |
69 | - return $this->getarray($column); |
|
70 | - } elseif (strpos($func_name, 'setarray_') === 0) { |
|
71 | - $column = substr($func_name, 9); |
|
69 | + return $this->getarray($column); |
|
70 | + } elseif (strpos($func_name, 'setarray_') === 0) { |
|
71 | + $column = substr($func_name, 9); |
|
72 | 72 | |
73 | - return $this->setarray($column, $values[0]); |
|
74 | - } elseif (count($this) == 1) { |
|
75 | - $this[0]->__call($func_name, $values); |
|
76 | - } else { |
|
77 | - throw new TDBMException('Method '.$func_name.' not found'); |
|
78 | - } |
|
79 | - } |
|
73 | + return $this->setarray($column, $values[0]); |
|
74 | + } elseif (count($this) == 1) { |
|
75 | + $this[0]->__call($func_name, $values); |
|
76 | + } else { |
|
77 | + throw new TDBMException('Method '.$func_name.' not found'); |
|
78 | + } |
|
79 | + } |
|
80 | 80 | |
81 | - private function getarray($column) |
|
82 | - { |
|
83 | - $arr = array(); |
|
84 | - foreach ($this as $object) { |
|
85 | - $arr[] = $object->__get($column); |
|
86 | - } |
|
81 | + private function getarray($column) |
|
82 | + { |
|
83 | + $arr = array(); |
|
84 | + foreach ($this as $object) { |
|
85 | + $arr[] = $object->__get($column); |
|
86 | + } |
|
87 | 87 | |
88 | - return $arr; |
|
89 | - } |
|
88 | + return $arr; |
|
89 | + } |
|
90 | 90 | |
91 | - private function setarray($column, $value) |
|
92 | - { |
|
93 | - foreach ($this as $object) { |
|
94 | - $object->__set($column, $value); |
|
95 | - } |
|
96 | - } |
|
91 | + private function setarray($column, $value) |
|
92 | + { |
|
93 | + foreach ($this as $object) { |
|
94 | + $object->__set($column, $value); |
|
95 | + } |
|
96 | + } |
|
97 | 97 | |
98 | - public function jsonSerialize() |
|
99 | - { |
|
100 | - return (array) $this; |
|
101 | - } |
|
98 | + public function jsonSerialize() |
|
99 | + { |
|
100 | + return (array) $this; |
|
101 | + } |
|
102 | 102 | } |