@@ -17,228 +17,228 @@ discard block |
||
| 17 | 17 | */ |
| 18 | 18 | class BeanDescriptor |
| 19 | 19 | { |
| 20 | - /** |
|
| 21 | - * @var Table |
|
| 22 | - */ |
|
| 23 | - private $table; |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * @var SchemaAnalyzer |
|
| 27 | - */ |
|
| 28 | - private $schemaAnalyzer; |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * @var Schema |
|
| 32 | - */ |
|
| 33 | - private $schema; |
|
| 34 | - |
|
| 35 | - /** |
|
| 36 | - * @var AbstractBeanPropertyDescriptor[] |
|
| 37 | - */ |
|
| 38 | - private $beanPropertyDescriptors = []; |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * @var TDBMSchemaAnalyzer |
|
| 42 | - */ |
|
| 43 | - private $tdbmSchemaAnalyzer; |
|
| 44 | - |
|
| 45 | - public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
| 46 | - { |
|
| 47 | - $this->table = $table; |
|
| 48 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
| 49 | - $this->schema = $schema; |
|
| 50 | - $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
| 51 | - $this->initBeanPropertyDescriptors(); |
|
| 52 | - } |
|
| 53 | - |
|
| 54 | - private function initBeanPropertyDescriptors() |
|
| 55 | - { |
|
| 56 | - $this->beanPropertyDescriptors = $this->getProperties($this->table); |
|
| 57 | - } |
|
| 58 | - |
|
| 59 | - /** |
|
| 60 | - * Returns the foreign-key the column is part of, if any. null otherwise. |
|
| 61 | - * |
|
| 62 | - * @param Table $table |
|
| 63 | - * @param Column $column |
|
| 64 | - * |
|
| 65 | - * @return ForeignKeyConstraint|null |
|
| 66 | - */ |
|
| 67 | - private function isPartOfForeignKey(Table $table, Column $column) |
|
| 68 | - { |
|
| 69 | - $localColumnName = $column->getName(); |
|
| 70 | - foreach ($table->getForeignKeys() as $foreignKey) { |
|
| 71 | - foreach ($foreignKey->getColumns() as $columnName) { |
|
| 72 | - if ($columnName === $localColumnName) { |
|
| 73 | - return $foreignKey; |
|
| 74 | - } |
|
| 75 | - } |
|
| 76 | - } |
|
| 77 | - |
|
| 78 | - return; |
|
| 79 | - } |
|
| 80 | - |
|
| 81 | - /** |
|
| 82 | - * @return AbstractBeanPropertyDescriptor[] |
|
| 83 | - */ |
|
| 84 | - public function getBeanPropertyDescriptors() |
|
| 85 | - { |
|
| 86 | - return $this->beanPropertyDescriptors; |
|
| 87 | - } |
|
| 88 | - |
|
| 89 | - /** |
|
| 90 | - * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent. |
|
| 91 | - * |
|
| 92 | - * @return AbstractBeanPropertyDescriptor[] |
|
| 93 | - */ |
|
| 94 | - public function getConstructorProperties() |
|
| 95 | - { |
|
| 96 | - $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
| 97 | - return $property->isCompulsory(); |
|
| 98 | - }); |
|
| 99 | - |
|
| 100 | - return $constructorProperties; |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * Returns the list of columns that have default values for a given table. |
|
| 105 | - * |
|
| 106 | - * @return AbstractBeanPropertyDescriptor[] |
|
| 107 | - */ |
|
| 108 | - public function getPropertiesWithDefault() |
|
| 109 | - { |
|
| 110 | - $properties = $this->getPropertiesForTable($this->table); |
|
| 111 | - $defaultProperties = array_filter($properties, function (AbstractBeanPropertyDescriptor $property) { |
|
| 112 | - return $property->hasDefault(); |
|
| 113 | - }); |
|
| 114 | - |
|
| 115 | - return $defaultProperties; |
|
| 116 | - } |
|
| 117 | - |
|
| 118 | - /** |
|
| 119 | - * Returns the list of properties exposed as getters and setters in this class. |
|
| 120 | - * |
|
| 121 | - * @return AbstractBeanPropertyDescriptor[] |
|
| 122 | - */ |
|
| 123 | - public function getExposedProperties() |
|
| 124 | - { |
|
| 125 | - $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
| 126 | - return $property->getTable()->getName() == $this->table->getName(); |
|
| 127 | - }); |
|
| 128 | - |
|
| 129 | - return $exposedProperties; |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * Returns the list of properties for this table (including parent tables). |
|
| 134 | - * |
|
| 135 | - * @param Table $table |
|
| 136 | - * |
|
| 137 | - * @return AbstractBeanPropertyDescriptor[] |
|
| 138 | - */ |
|
| 139 | - private function getProperties(Table $table) |
|
| 140 | - { |
|
| 141 | - $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
| 142 | - if ($parentRelationship) { |
|
| 143 | - $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName()); |
|
| 144 | - $properties = $this->getProperties($parentTable); |
|
| 145 | - // we merge properties by overriding property names. |
|
| 146 | - $localProperties = $this->getPropertiesForTable($table); |
|
| 147 | - foreach ($localProperties as $name => $property) { |
|
| 148 | - // We do not override properties if this is a primary key! |
|
| 149 | - if ($property->isPrimaryKey()) { |
|
| 150 | - continue; |
|
| 151 | - } |
|
| 152 | - $properties[$name] = $property; |
|
| 153 | - } |
|
| 154 | - } else { |
|
| 155 | - $properties = $this->getPropertiesForTable($table); |
|
| 156 | - } |
|
| 157 | - |
|
| 158 | - return $properties; |
|
| 159 | - } |
|
| 160 | - |
|
| 161 | - /** |
|
| 162 | - * Returns the list of properties for this table (ignoring parent tables). |
|
| 163 | - * |
|
| 164 | - * @param Table $table |
|
| 165 | - * |
|
| 166 | - * @return AbstractBeanPropertyDescriptor[] |
|
| 167 | - */ |
|
| 168 | - private function getPropertiesForTable(Table $table) |
|
| 169 | - { |
|
| 170 | - $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
| 171 | - if ($parentRelationship) { |
|
| 172 | - $ignoreColumns = $parentRelationship->getLocalColumns(); |
|
| 173 | - } else { |
|
| 174 | - $ignoreColumns = []; |
|
| 175 | - } |
|
| 176 | - |
|
| 177 | - $beanPropertyDescriptors = []; |
|
| 178 | - |
|
| 179 | - foreach ($table->getColumns() as $column) { |
|
| 180 | - if (array_search($column->getName(), $ignoreColumns) !== false) { |
|
| 181 | - continue; |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - $fk = $this->isPartOfForeignKey($table, $column); |
|
| 185 | - if ($fk !== null) { |
|
| 186 | - // Check that previously added descriptors are not added on same FK (can happen with multi key FK). |
|
| 187 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
| 188 | - if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) { |
|
| 189 | - continue 2; |
|
| 190 | - } |
|
| 191 | - } |
|
| 192 | - // Check that this property is not an inheritance relationship |
|
| 193 | - $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
| 194 | - if ($parentRelationship === $fk) { |
|
| 195 | - continue; |
|
| 196 | - } |
|
| 197 | - |
|
| 198 | - $beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer); |
|
| 199 | - } else { |
|
| 200 | - $beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column); |
|
| 201 | - } |
|
| 202 | - } |
|
| 203 | - |
|
| 204 | - // Now, let's get the name of all properties and let's check there is no duplicate. |
|
| 205 | - /** @var $names AbstractBeanPropertyDescriptor[] */ |
|
| 206 | - $names = []; |
|
| 207 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
| 208 | - $name = $beanDescriptor->getUpperCamelCaseName(); |
|
| 209 | - if (isset($names[$name])) { |
|
| 210 | - $names[$name]->useAlternativeName(); |
|
| 211 | - $beanDescriptor->useAlternativeName(); |
|
| 212 | - } else { |
|
| 213 | - $names[$name] = $beanDescriptor; |
|
| 214 | - } |
|
| 215 | - } |
|
| 216 | - |
|
| 217 | - // Final check (throw exceptions if problem arises) |
|
| 218 | - $names = []; |
|
| 219 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
| 220 | - $name = $beanDescriptor->getUpperCamelCaseName(); |
|
| 221 | - if (isset($names[$name])) { |
|
| 222 | - throw new TDBMException('Unsolvable name conflict while generating method name'); |
|
| 223 | - } else { |
|
| 224 | - $names[$name] = $beanDescriptor; |
|
| 225 | - } |
|
| 226 | - } |
|
| 227 | - |
|
| 228 | - // Last step, let's rebuild the list with a map: |
|
| 229 | - $beanPropertyDescriptorsMap = []; |
|
| 230 | - foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
| 231 | - $beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor; |
|
| 232 | - } |
|
| 233 | - |
|
| 234 | - return $beanPropertyDescriptorsMap; |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - public function generateBeanConstructor() |
|
| 238 | - { |
|
| 239 | - $constructorProperties = $this->getConstructorProperties(); |
|
| 240 | - |
|
| 241 | - $constructorCode = ' /** |
|
| 20 | + /** |
|
| 21 | + * @var Table |
|
| 22 | + */ |
|
| 23 | + private $table; |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * @var SchemaAnalyzer |
|
| 27 | + */ |
|
| 28 | + private $schemaAnalyzer; |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * @var Schema |
|
| 32 | + */ |
|
| 33 | + private $schema; |
|
| 34 | + |
|
| 35 | + /** |
|
| 36 | + * @var AbstractBeanPropertyDescriptor[] |
|
| 37 | + */ |
|
| 38 | + private $beanPropertyDescriptors = []; |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * @var TDBMSchemaAnalyzer |
|
| 42 | + */ |
|
| 43 | + private $tdbmSchemaAnalyzer; |
|
| 44 | + |
|
| 45 | + public function __construct(Table $table, SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
| 46 | + { |
|
| 47 | + $this->table = $table; |
|
| 48 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
| 49 | + $this->schema = $schema; |
|
| 50 | + $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
| 51 | + $this->initBeanPropertyDescriptors(); |
|
| 52 | + } |
|
| 53 | + |
|
| 54 | + private function initBeanPropertyDescriptors() |
|
| 55 | + { |
|
| 56 | + $this->beanPropertyDescriptors = $this->getProperties($this->table); |
|
| 57 | + } |
|
| 58 | + |
|
| 59 | + /** |
|
| 60 | + * Returns the foreign-key the column is part of, if any. null otherwise. |
|
| 61 | + * |
|
| 62 | + * @param Table $table |
|
| 63 | + * @param Column $column |
|
| 64 | + * |
|
| 65 | + * @return ForeignKeyConstraint|null |
|
| 66 | + */ |
|
| 67 | + private function isPartOfForeignKey(Table $table, Column $column) |
|
| 68 | + { |
|
| 69 | + $localColumnName = $column->getName(); |
|
| 70 | + foreach ($table->getForeignKeys() as $foreignKey) { |
|
| 71 | + foreach ($foreignKey->getColumns() as $columnName) { |
|
| 72 | + if ($columnName === $localColumnName) { |
|
| 73 | + return $foreignKey; |
|
| 74 | + } |
|
| 75 | + } |
|
| 76 | + } |
|
| 77 | + |
|
| 78 | + return; |
|
| 79 | + } |
|
| 80 | + |
|
| 81 | + /** |
|
| 82 | + * @return AbstractBeanPropertyDescriptor[] |
|
| 83 | + */ |
|
| 84 | + public function getBeanPropertyDescriptors() |
|
| 85 | + { |
|
| 86 | + return $this->beanPropertyDescriptors; |
|
| 87 | + } |
|
| 88 | + |
|
| 89 | + /** |
|
| 90 | + * Returns the list of columns that are not nullable and not autogenerated for a given table and its parent. |
|
| 91 | + * |
|
| 92 | + * @return AbstractBeanPropertyDescriptor[] |
|
| 93 | + */ |
|
| 94 | + public function getConstructorProperties() |
|
| 95 | + { |
|
| 96 | + $constructorProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
| 97 | + return $property->isCompulsory(); |
|
| 98 | + }); |
|
| 99 | + |
|
| 100 | + return $constructorProperties; |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * Returns the list of columns that have default values for a given table. |
|
| 105 | + * |
|
| 106 | + * @return AbstractBeanPropertyDescriptor[] |
|
| 107 | + */ |
|
| 108 | + public function getPropertiesWithDefault() |
|
| 109 | + { |
|
| 110 | + $properties = $this->getPropertiesForTable($this->table); |
|
| 111 | + $defaultProperties = array_filter($properties, function (AbstractBeanPropertyDescriptor $property) { |
|
| 112 | + return $property->hasDefault(); |
|
| 113 | + }); |
|
| 114 | + |
|
| 115 | + return $defaultProperties; |
|
| 116 | + } |
|
| 117 | + |
|
| 118 | + /** |
|
| 119 | + * Returns the list of properties exposed as getters and setters in this class. |
|
| 120 | + * |
|
| 121 | + * @return AbstractBeanPropertyDescriptor[] |
|
| 122 | + */ |
|
| 123 | + public function getExposedProperties() |
|
| 124 | + { |
|
| 125 | + $exposedProperties = array_filter($this->beanPropertyDescriptors, function (AbstractBeanPropertyDescriptor $property) { |
|
| 126 | + return $property->getTable()->getName() == $this->table->getName(); |
|
| 127 | + }); |
|
| 128 | + |
|
| 129 | + return $exposedProperties; |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * Returns the list of properties for this table (including parent tables). |
|
| 134 | + * |
|
| 135 | + * @param Table $table |
|
| 136 | + * |
|
| 137 | + * @return AbstractBeanPropertyDescriptor[] |
|
| 138 | + */ |
|
| 139 | + private function getProperties(Table $table) |
|
| 140 | + { |
|
| 141 | + $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
| 142 | + if ($parentRelationship) { |
|
| 143 | + $parentTable = $this->schema->getTable($parentRelationship->getForeignTableName()); |
|
| 144 | + $properties = $this->getProperties($parentTable); |
|
| 145 | + // we merge properties by overriding property names. |
|
| 146 | + $localProperties = $this->getPropertiesForTable($table); |
|
| 147 | + foreach ($localProperties as $name => $property) { |
|
| 148 | + // We do not override properties if this is a primary key! |
|
| 149 | + if ($property->isPrimaryKey()) { |
|
| 150 | + continue; |
|
| 151 | + } |
|
| 152 | + $properties[$name] = $property; |
|
| 153 | + } |
|
| 154 | + } else { |
|
| 155 | + $properties = $this->getPropertiesForTable($table); |
|
| 156 | + } |
|
| 157 | + |
|
| 158 | + return $properties; |
|
| 159 | + } |
|
| 160 | + |
|
| 161 | + /** |
|
| 162 | + * Returns the list of properties for this table (ignoring parent tables). |
|
| 163 | + * |
|
| 164 | + * @param Table $table |
|
| 165 | + * |
|
| 166 | + * @return AbstractBeanPropertyDescriptor[] |
|
| 167 | + */ |
|
| 168 | + private function getPropertiesForTable(Table $table) |
|
| 169 | + { |
|
| 170 | + $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
| 171 | + if ($parentRelationship) { |
|
| 172 | + $ignoreColumns = $parentRelationship->getLocalColumns(); |
|
| 173 | + } else { |
|
| 174 | + $ignoreColumns = []; |
|
| 175 | + } |
|
| 176 | + |
|
| 177 | + $beanPropertyDescriptors = []; |
|
| 178 | + |
|
| 179 | + foreach ($table->getColumns() as $column) { |
|
| 180 | + if (array_search($column->getName(), $ignoreColumns) !== false) { |
|
| 181 | + continue; |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + $fk = $this->isPartOfForeignKey($table, $column); |
|
| 185 | + if ($fk !== null) { |
|
| 186 | + // Check that previously added descriptors are not added on same FK (can happen with multi key FK). |
|
| 187 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
| 188 | + if ($beanDescriptor instanceof ObjectBeanPropertyDescriptor && $beanDescriptor->getForeignKey() === $fk) { |
|
| 189 | + continue 2; |
|
| 190 | + } |
|
| 191 | + } |
|
| 192 | + // Check that this property is not an inheritance relationship |
|
| 193 | + $parentRelationship = $this->schemaAnalyzer->getParentRelationship($table->getName()); |
|
| 194 | + if ($parentRelationship === $fk) { |
|
| 195 | + continue; |
|
| 196 | + } |
|
| 197 | + |
|
| 198 | + $beanPropertyDescriptors[] = new ObjectBeanPropertyDescriptor($table, $fk, $this->schemaAnalyzer); |
|
| 199 | + } else { |
|
| 200 | + $beanPropertyDescriptors[] = new ScalarBeanPropertyDescriptor($table, $column); |
|
| 201 | + } |
|
| 202 | + } |
|
| 203 | + |
|
| 204 | + // Now, let's get the name of all properties and let's check there is no duplicate. |
|
| 205 | + /** @var $names AbstractBeanPropertyDescriptor[] */ |
|
| 206 | + $names = []; |
|
| 207 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
| 208 | + $name = $beanDescriptor->getUpperCamelCaseName(); |
|
| 209 | + if (isset($names[$name])) { |
|
| 210 | + $names[$name]->useAlternativeName(); |
|
| 211 | + $beanDescriptor->useAlternativeName(); |
|
| 212 | + } else { |
|
| 213 | + $names[$name] = $beanDescriptor; |
|
| 214 | + } |
|
| 215 | + } |
|
| 216 | + |
|
| 217 | + // Final check (throw exceptions if problem arises) |
|
| 218 | + $names = []; |
|
| 219 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
| 220 | + $name = $beanDescriptor->getUpperCamelCaseName(); |
|
| 221 | + if (isset($names[$name])) { |
|
| 222 | + throw new TDBMException('Unsolvable name conflict while generating method name'); |
|
| 223 | + } else { |
|
| 224 | + $names[$name] = $beanDescriptor; |
|
| 225 | + } |
|
| 226 | + } |
|
| 227 | + |
|
| 228 | + // Last step, let's rebuild the list with a map: |
|
| 229 | + $beanPropertyDescriptorsMap = []; |
|
| 230 | + foreach ($beanPropertyDescriptors as $beanDescriptor) { |
|
| 231 | + $beanPropertyDescriptorsMap[$beanDescriptor->getLowerCamelCaseName()] = $beanDescriptor; |
|
| 232 | + } |
|
| 233 | + |
|
| 234 | + return $beanPropertyDescriptorsMap; |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + public function generateBeanConstructor() |
|
| 238 | + { |
|
| 239 | + $constructorProperties = $this->getConstructorProperties(); |
|
| 240 | + |
|
| 241 | + $constructorCode = ' /** |
|
| 242 | 242 | * The constructor takes all compulsory arguments. |
| 243 | 243 | * |
| 244 | 244 | %s |
@@ -248,70 +248,70 @@ discard block |
||
| 248 | 248 | %s } |
| 249 | 249 | '; |
| 250 | 250 | |
| 251 | - $paramAnnotations = []; |
|
| 252 | - $arguments = []; |
|
| 253 | - $assigns = []; |
|
| 254 | - $parentConstructorArguments = []; |
|
| 255 | - |
|
| 256 | - foreach ($constructorProperties as $property) { |
|
| 257 | - $className = $property->getClassName(); |
|
| 258 | - if ($className) { |
|
| 259 | - $arguments[] = $className.' '.$property->getVariableName(); |
|
| 260 | - } else { |
|
| 261 | - $arguments[] = $property->getVariableName(); |
|
| 262 | - } |
|
| 263 | - $paramAnnotations[] = $property->getParamAnnotation(); |
|
| 264 | - if ($property->getTable()->getName() === $this->table->getName()) { |
|
| 265 | - $assigns[] = $property->getConstructorAssignCode(); |
|
| 266 | - } else { |
|
| 267 | - $parentConstructorArguments[] = $property->getVariableName(); |
|
| 268 | - } |
|
| 269 | - } |
|
| 270 | - |
|
| 271 | - $parentConstructorCode = sprintf(" parent::__construct(%s);\n", implode(', ', $parentConstructorArguments)); |
|
| 272 | - |
|
| 273 | - $defaultAssigns = []; |
|
| 274 | - foreach ($this->getPropertiesWithDefault() as $property) { |
|
| 275 | - $defaultAssigns[] = $property->assignToDefaultCode(); |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstructorCode, implode("\n", $assigns), implode("\n", $defaultAssigns)); |
|
| 279 | - } |
|
| 280 | - |
|
| 281 | - public function generateDirectForeignKeysCode() |
|
| 282 | - { |
|
| 283 | - $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName()); |
|
| 284 | - |
|
| 285 | - $fksByTable = []; |
|
| 286 | - |
|
| 287 | - foreach ($fks as $fk) { |
|
| 288 | - $fksByTable[$fk->getLocalTableName()][] = $fk; |
|
| 289 | - } |
|
| 290 | - |
|
| 291 | - /* @var $fksByMethodName ForeignKeyConstraint[] */ |
|
| 292 | - $fksByMethodName = []; |
|
| 293 | - |
|
| 294 | - foreach ($fksByTable as $tableName => $fksForTable) { |
|
| 295 | - if (count($fksForTable) > 1) { |
|
| 296 | - foreach ($fksForTable as $fk) { |
|
| 297 | - $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By'; |
|
| 298 | - |
|
| 299 | - $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns()); |
|
| 300 | - |
|
| 301 | - $methodName .= implode('And', $camelizedColumns); |
|
| 302 | - |
|
| 303 | - $fksByMethodName[$methodName] = $fk; |
|
| 304 | - } |
|
| 305 | - } else { |
|
| 306 | - $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName()); |
|
| 307 | - $fksByMethodName[$methodName] = $fksForTable[0]; |
|
| 308 | - } |
|
| 309 | - } |
|
| 310 | - |
|
| 311 | - $code = ''; |
|
| 312 | - |
|
| 313 | - foreach ($fksByMethodName as $methodName => $fk) { |
|
| 314 | - $getterCode = ' /** |
|
| 251 | + $paramAnnotations = []; |
|
| 252 | + $arguments = []; |
|
| 253 | + $assigns = []; |
|
| 254 | + $parentConstructorArguments = []; |
|
| 255 | + |
|
| 256 | + foreach ($constructorProperties as $property) { |
|
| 257 | + $className = $property->getClassName(); |
|
| 258 | + if ($className) { |
|
| 259 | + $arguments[] = $className.' '.$property->getVariableName(); |
|
| 260 | + } else { |
|
| 261 | + $arguments[] = $property->getVariableName(); |
|
| 262 | + } |
|
| 263 | + $paramAnnotations[] = $property->getParamAnnotation(); |
|
| 264 | + if ($property->getTable()->getName() === $this->table->getName()) { |
|
| 265 | + $assigns[] = $property->getConstructorAssignCode(); |
|
| 266 | + } else { |
|
| 267 | + $parentConstructorArguments[] = $property->getVariableName(); |
|
| 268 | + } |
|
| 269 | + } |
|
| 270 | + |
|
| 271 | + $parentConstructorCode = sprintf(" parent::__construct(%s);\n", implode(', ', $parentConstructorArguments)); |
|
| 272 | + |
|
| 273 | + $defaultAssigns = []; |
|
| 274 | + foreach ($this->getPropertiesWithDefault() as $property) { |
|
| 275 | + $defaultAssigns[] = $property->assignToDefaultCode(); |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + return sprintf($constructorCode, implode("\n", $paramAnnotations), implode(', ', $arguments), $parentConstructorCode, implode("\n", $assigns), implode("\n", $defaultAssigns)); |
|
| 279 | + } |
|
| 280 | + |
|
| 281 | + public function generateDirectForeignKeysCode() |
|
| 282 | + { |
|
| 283 | + $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName()); |
|
| 284 | + |
|
| 285 | + $fksByTable = []; |
|
| 286 | + |
|
| 287 | + foreach ($fks as $fk) { |
|
| 288 | + $fksByTable[$fk->getLocalTableName()][] = $fk; |
|
| 289 | + } |
|
| 290 | + |
|
| 291 | + /* @var $fksByMethodName ForeignKeyConstraint[] */ |
|
| 292 | + $fksByMethodName = []; |
|
| 293 | + |
|
| 294 | + foreach ($fksByTable as $tableName => $fksForTable) { |
|
| 295 | + if (count($fksForTable) > 1) { |
|
| 296 | + foreach ($fksForTable as $fk) { |
|
| 297 | + $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fk->getLocalTableName()).'By'; |
|
| 298 | + |
|
| 299 | + $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $fk->getLocalColumns()); |
|
| 300 | + |
|
| 301 | + $methodName .= implode('And', $camelizedColumns); |
|
| 302 | + |
|
| 303 | + $fksByMethodName[$methodName] = $fk; |
|
| 304 | + } |
|
| 305 | + } else { |
|
| 306 | + $methodName = 'get'.TDBMDaoGenerator::toCamelCase($fksForTable[0]->getLocalTableName()); |
|
| 307 | + $fksByMethodName[$methodName] = $fksForTable[0]; |
|
| 308 | + } |
|
| 309 | + } |
|
| 310 | + |
|
| 311 | + $code = ''; |
|
| 312 | + |
|
| 313 | + foreach ($fksByMethodName as $methodName => $fk) { |
|
| 314 | + $getterCode = ' /** |
|
| 315 | 315 | * Returns the list of %s pointing to this bean via the %s column. |
| 316 | 316 | * |
| 317 | 317 | * @return %s[]|AlterableResultIterator |
@@ -323,107 +323,107 @@ discard block |
||
| 323 | 323 | |
| 324 | 324 | '; |
| 325 | 325 | |
| 326 | - $beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName()); |
|
| 327 | - $code .= sprintf($getterCode, |
|
| 328 | - $beanClass, |
|
| 329 | - implode(', ', $fk->getColumns()), |
|
| 330 | - $beanClass, |
|
| 331 | - $methodName, |
|
| 332 | - var_export($fk->getLocalTableName(), true), |
|
| 333 | - var_export($fk->getName(), true), |
|
| 334 | - var_export($fk->getLocalTableName(), true), |
|
| 335 | - $this->getFilters($fk) |
|
| 336 | - ); |
|
| 337 | - } |
|
| 338 | - |
|
| 339 | - return $code; |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - private function getFilters(ForeignKeyConstraint $fk) : string |
|
| 343 | - { |
|
| 344 | - $counter = 0; |
|
| 345 | - $parameters = []; |
|
| 346 | - |
|
| 347 | - $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
| 348 | - |
|
| 349 | - foreach ($fk->getLocalColumns() as $columnName) { |
|
| 350 | - $pkColumn = $pkColumns[$counter]; |
|
| 351 | - $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($fk->getLocalTableName().'.'.$columnName, true), var_export($pkColumn, true), var_export($this->table->getName(), true)); |
|
| 352 | - ++$counter; |
|
| 353 | - } |
|
| 354 | - $parametersCode = '[ '.implode(', ', $parameters).' ]'; |
|
| 355 | - |
|
| 356 | - return $parametersCode; |
|
| 357 | - } |
|
| 358 | - |
|
| 359 | - /** |
|
| 360 | - * Generate code section about pivot tables. |
|
| 361 | - * |
|
| 362 | - * @return string |
|
| 363 | - */ |
|
| 364 | - public function generatePivotTableCode() |
|
| 365 | - { |
|
| 366 | - $finalDescs = $this->getPivotTableDescriptors(); |
|
| 367 | - |
|
| 368 | - $code = ''; |
|
| 369 | - |
|
| 370 | - foreach ($finalDescs as $desc) { |
|
| 371 | - $code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']); |
|
| 372 | - } |
|
| 373 | - |
|
| 374 | - return $code; |
|
| 375 | - } |
|
| 376 | - |
|
| 377 | - private function getPivotTableDescriptors() |
|
| 378 | - { |
|
| 379 | - $descs = []; |
|
| 380 | - foreach ($this->schemaAnalyzer->detectJunctionTables(true) as $table) { |
|
| 381 | - // There are exactly 2 FKs since this is a pivot table. |
|
| 382 | - $fks = array_values($table->getForeignKeys()); |
|
| 383 | - |
|
| 384 | - if ($fks[0]->getForeignTableName() === $this->table->getName()) { |
|
| 385 | - $localFK = $fks[0]; |
|
| 386 | - $remoteFK = $fks[1]; |
|
| 387 | - } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) { |
|
| 388 | - $localFK = $fks[1]; |
|
| 389 | - $remoteFK = $fks[0]; |
|
| 390 | - } else { |
|
| 391 | - continue; |
|
| 392 | - } |
|
| 393 | - |
|
| 394 | - $descs[$remoteFK->getForeignTableName()][] = [ |
|
| 395 | - 'table' => $table, |
|
| 396 | - 'localFK' => $localFK, |
|
| 397 | - 'remoteFK' => $remoteFK, |
|
| 398 | - ]; |
|
| 399 | - } |
|
| 400 | - |
|
| 401 | - $finalDescs = []; |
|
| 402 | - foreach ($descs as $descArray) { |
|
| 403 | - if (count($descArray) > 1) { |
|
| 404 | - foreach ($descArray as $desc) { |
|
| 405 | - $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName()); |
|
| 406 | - $finalDescs[] = $desc; |
|
| 407 | - } |
|
| 408 | - } else { |
|
| 409 | - $desc = $descArray[0]; |
|
| 410 | - $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()); |
|
| 411 | - $finalDescs[] = $desc; |
|
| 412 | - } |
|
| 413 | - } |
|
| 414 | - |
|
| 415 | - return $finalDescs; |
|
| 416 | - } |
|
| 417 | - |
|
| 418 | - public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK) |
|
| 419 | - { |
|
| 420 | - $singularName = TDBMDaoGenerator::toSingular($name); |
|
| 421 | - $pluralName = $name; |
|
| 422 | - $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
| 423 | - $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
| 424 | - $pluralVariableName = $variableName.'s'; |
|
| 425 | - |
|
| 426 | - $str = ' /** |
|
| 326 | + $beanClass = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName()); |
|
| 327 | + $code .= sprintf($getterCode, |
|
| 328 | + $beanClass, |
|
| 329 | + implode(', ', $fk->getColumns()), |
|
| 330 | + $beanClass, |
|
| 331 | + $methodName, |
|
| 332 | + var_export($fk->getLocalTableName(), true), |
|
| 333 | + var_export($fk->getName(), true), |
|
| 334 | + var_export($fk->getLocalTableName(), true), |
|
| 335 | + $this->getFilters($fk) |
|
| 336 | + ); |
|
| 337 | + } |
|
| 338 | + |
|
| 339 | + return $code; |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + private function getFilters(ForeignKeyConstraint $fk) : string |
|
| 343 | + { |
|
| 344 | + $counter = 0; |
|
| 345 | + $parameters = []; |
|
| 346 | + |
|
| 347 | + $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
| 348 | + |
|
| 349 | + foreach ($fk->getLocalColumns() as $columnName) { |
|
| 350 | + $pkColumn = $pkColumns[$counter]; |
|
| 351 | + $parameters[] = sprintf('%s => $this->get(%s, %s)', var_export($fk->getLocalTableName().'.'.$columnName, true), var_export($pkColumn, true), var_export($this->table->getName(), true)); |
|
| 352 | + ++$counter; |
|
| 353 | + } |
|
| 354 | + $parametersCode = '[ '.implode(', ', $parameters).' ]'; |
|
| 355 | + |
|
| 356 | + return $parametersCode; |
|
| 357 | + } |
|
| 358 | + |
|
| 359 | + /** |
|
| 360 | + * Generate code section about pivot tables. |
|
| 361 | + * |
|
| 362 | + * @return string |
|
| 363 | + */ |
|
| 364 | + public function generatePivotTableCode() |
|
| 365 | + { |
|
| 366 | + $finalDescs = $this->getPivotTableDescriptors(); |
|
| 367 | + |
|
| 368 | + $code = ''; |
|
| 369 | + |
|
| 370 | + foreach ($finalDescs as $desc) { |
|
| 371 | + $code .= $this->getPivotTableCode($desc['name'], $desc['table'], $desc['localFK'], $desc['remoteFK']); |
|
| 372 | + } |
|
| 373 | + |
|
| 374 | + return $code; |
|
| 375 | + } |
|
| 376 | + |
|
| 377 | + private function getPivotTableDescriptors() |
|
| 378 | + { |
|
| 379 | + $descs = []; |
|
| 380 | + foreach ($this->schemaAnalyzer->detectJunctionTables(true) as $table) { |
|
| 381 | + // There are exactly 2 FKs since this is a pivot table. |
|
| 382 | + $fks = array_values($table->getForeignKeys()); |
|
| 383 | + |
|
| 384 | + if ($fks[0]->getForeignTableName() === $this->table->getName()) { |
|
| 385 | + $localFK = $fks[0]; |
|
| 386 | + $remoteFK = $fks[1]; |
|
| 387 | + } elseif ($fks[1]->getForeignTableName() === $this->table->getName()) { |
|
| 388 | + $localFK = $fks[1]; |
|
| 389 | + $remoteFK = $fks[0]; |
|
| 390 | + } else { |
|
| 391 | + continue; |
|
| 392 | + } |
|
| 393 | + |
|
| 394 | + $descs[$remoteFK->getForeignTableName()][] = [ |
|
| 395 | + 'table' => $table, |
|
| 396 | + 'localFK' => $localFK, |
|
| 397 | + 'remoteFK' => $remoteFK, |
|
| 398 | + ]; |
|
| 399 | + } |
|
| 400 | + |
|
| 401 | + $finalDescs = []; |
|
| 402 | + foreach ($descs as $descArray) { |
|
| 403 | + if (count($descArray) > 1) { |
|
| 404 | + foreach ($descArray as $desc) { |
|
| 405 | + $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()).'By'.TDBMDaoGenerator::toCamelCase($desc['table']->getName()); |
|
| 406 | + $finalDescs[] = $desc; |
|
| 407 | + } |
|
| 408 | + } else { |
|
| 409 | + $desc = $descArray[0]; |
|
| 410 | + $desc['name'] = TDBMDaoGenerator::toCamelCase($desc['remoteFK']->getForeignTableName()); |
|
| 411 | + $finalDescs[] = $desc; |
|
| 412 | + } |
|
| 413 | + } |
|
| 414 | + |
|
| 415 | + return $finalDescs; |
|
| 416 | + } |
|
| 417 | + |
|
| 418 | + public function getPivotTableCode($name, Table $table, ForeignKeyConstraint $localFK, ForeignKeyConstraint $remoteFK) |
|
| 419 | + { |
|
| 420 | + $singularName = TDBMDaoGenerator::toSingular($name); |
|
| 421 | + $pluralName = $name; |
|
| 422 | + $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
| 423 | + $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
| 424 | + $pluralVariableName = $variableName.'s'; |
|
| 425 | + |
|
| 426 | + $str = ' /** |
|
| 427 | 427 | * Returns the list of %s associated to this bean via the %s pivot table. |
| 428 | 428 | * |
| 429 | 429 | * @return %s[] |
@@ -433,9 +433,9 @@ discard block |
||
| 433 | 433 | } |
| 434 | 434 | '; |
| 435 | 435 | |
| 436 | - $getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true)); |
|
| 436 | + $getterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $name, var_export($remoteFK->getLocalTableName(), true)); |
|
| 437 | 437 | |
| 438 | - $str = ' /** |
|
| 438 | + $str = ' /** |
|
| 439 | 439 | * Adds a relationship with %s associated to this bean via the %s pivot table. |
| 440 | 440 | * |
| 441 | 441 | * @param %s %s |
@@ -445,9 +445,9 @@ discard block |
||
| 445 | 445 | } |
| 446 | 446 | '; |
| 447 | 447 | |
| 448 | - $adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
| 448 | + $adderCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
| 449 | 449 | |
| 450 | - $str = ' /** |
|
| 450 | + $str = ' /** |
|
| 451 | 451 | * Deletes the relationship with %s associated to this bean via the %s pivot table. |
| 452 | 452 | * |
| 453 | 453 | * @param %s %s |
@@ -457,9 +457,9 @@ discard block |
||
| 457 | 457 | } |
| 458 | 458 | '; |
| 459 | 459 | |
| 460 | - $removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
| 460 | + $removerCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
| 461 | 461 | |
| 462 | - $str = ' /** |
|
| 462 | + $str = ' /** |
|
| 463 | 463 | * Returns whether this bean is associated with %s via the %s pivot table. |
| 464 | 464 | * |
| 465 | 465 | * @param %s %s |
@@ -470,9 +470,9 @@ discard block |
||
| 470 | 470 | } |
| 471 | 471 | '; |
| 472 | 472 | |
| 473 | - $hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
| 473 | + $hasCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $variableName, $singularName, $remoteBeanName, $variableName, var_export($remoteFK->getLocalTableName(), true), $variableName); |
|
| 474 | 474 | |
| 475 | - $str = ' /** |
|
| 475 | + $str = ' /** |
|
| 476 | 476 | * Sets all relationships with %s associated to this bean via the %s pivot table. |
| 477 | 477 | * Exiting relationships will be removed and replaced by the provided relationships. |
| 478 | 478 | * |
@@ -483,24 +483,24 @@ discard block |
||
| 483 | 483 | } |
| 484 | 484 | '; |
| 485 | 485 | |
| 486 | - $setterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $pluralVariableName, $pluralName, $pluralVariableName, var_export($remoteFK->getLocalTableName(), true), $pluralVariableName); |
|
| 486 | + $setterCode = sprintf($str, $remoteBeanName, $table->getName(), $remoteBeanName, $pluralVariableName, $pluralName, $pluralVariableName, var_export($remoteFK->getLocalTableName(), true), $pluralVariableName); |
|
| 487 | 487 | |
| 488 | - $code = $getterCode.$adderCode.$removerCode.$hasCode.$setterCode; |
|
| 488 | + $code = $getterCode.$adderCode.$removerCode.$hasCode.$setterCode; |
|
| 489 | 489 | |
| 490 | - return $code; |
|
| 491 | - } |
|
| 490 | + return $code; |
|
| 491 | + } |
|
| 492 | 492 | |
| 493 | - public function generateJsonSerialize() |
|
| 494 | - { |
|
| 495 | - $tableName = $this->table->getName(); |
|
| 496 | - $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
| 497 | - if ($parentFk !== null) { |
|
| 498 | - $initializer = '$array = parent::jsonSerialize($stopRecursion);'; |
|
| 499 | - } else { |
|
| 500 | - $initializer = '$array = [];'; |
|
| 501 | - } |
|
| 493 | + public function generateJsonSerialize() |
|
| 494 | + { |
|
| 495 | + $tableName = $this->table->getName(); |
|
| 496 | + $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
| 497 | + if ($parentFk !== null) { |
|
| 498 | + $initializer = '$array = parent::jsonSerialize($stopRecursion);'; |
|
| 499 | + } else { |
|
| 500 | + $initializer = '$array = [];'; |
|
| 501 | + } |
|
| 502 | 502 | |
| 503 | - $str = ' |
|
| 503 | + $str = ' |
|
| 504 | 504 | /** |
| 505 | 505 | * Serializes the object for JSON encoding |
| 506 | 506 | * |
@@ -516,97 +516,97 @@ discard block |
||
| 516 | 516 | } |
| 517 | 517 | '; |
| 518 | 518 | |
| 519 | - $propertiesCode = ''; |
|
| 520 | - foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) { |
|
| 521 | - $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode(); |
|
| 522 | - } |
|
| 519 | + $propertiesCode = ''; |
|
| 520 | + foreach ($this->beanPropertyDescriptors as $beanPropertyDescriptor) { |
|
| 521 | + $propertiesCode .= $beanPropertyDescriptor->getJsonSerializeCode(); |
|
| 522 | + } |
|
| 523 | 523 | |
| 524 | - // Many to many relationships: |
|
| 524 | + // Many to many relationships: |
|
| 525 | 525 | |
| 526 | - $descs = $this->getPivotTableDescriptors(); |
|
| 526 | + $descs = $this->getPivotTableDescriptors(); |
|
| 527 | 527 | |
| 528 | - $many2manyCode = ''; |
|
| 528 | + $many2manyCode = ''; |
|
| 529 | 529 | |
| 530 | - foreach ($descs as $desc) { |
|
| 531 | - $remoteFK = $desc['remoteFK']; |
|
| 532 | - $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
| 533 | - $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
| 530 | + foreach ($descs as $desc) { |
|
| 531 | + $remoteFK = $desc['remoteFK']; |
|
| 532 | + $remoteBeanName = TDBMDaoGenerator::getBeanNameFromTableName($remoteFK->getForeignTableName()); |
|
| 533 | + $variableName = '$'.TDBMDaoGenerator::toVariableName($remoteBeanName); |
|
| 534 | 534 | |
| 535 | - $many2manyCode .= ' if (!$stopRecursion) { |
|
| 535 | + $many2manyCode .= ' if (!$stopRecursion) { |
|
| 536 | 536 | $array[\''.lcfirst($desc['name']).'\'] = array_map(function('.$remoteBeanName.' '.$variableName.') { |
| 537 | 537 | return '.$variableName.'->jsonSerialize(true); |
| 538 | 538 | }, $this->get'.$desc['name'].'()); |
| 539 | 539 | } |
| 540 | 540 | '; |
| 541 | - } |
|
| 542 | - |
|
| 543 | - return sprintf($str, $initializer, $propertiesCode, $many2manyCode); |
|
| 544 | - } |
|
| 545 | - |
|
| 546 | - /** |
|
| 547 | - * Returns as an array the class we need to extend from and the list of use statements. |
|
| 548 | - * |
|
| 549 | - * @return array |
|
| 550 | - */ |
|
| 551 | - private function generateExtendsAndUseStatements(ForeignKeyConstraint $parentFk = null) |
|
| 552 | - { |
|
| 553 | - $classes = []; |
|
| 554 | - if ($parentFk !== null) { |
|
| 555 | - $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName()); |
|
| 556 | - $classes[] = $extends; |
|
| 557 | - } |
|
| 558 | - |
|
| 559 | - foreach ($this->getBeanPropertyDescriptors() as $beanPropertyDescriptor) { |
|
| 560 | - $className = $beanPropertyDescriptor->getClassName(); |
|
| 561 | - if (null !== $className) { |
|
| 562 | - $classes[] = $beanPropertyDescriptor->getClassName(); |
|
| 563 | - } |
|
| 564 | - } |
|
| 565 | - |
|
| 566 | - foreach ($this->getPivotTableDescriptors() as $descriptor) { |
|
| 567 | - /* @var $fk ForeignKeyConstraint */ |
|
| 568 | - $fk = $descriptor['remoteFK']; |
|
| 569 | - $classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getForeignTableName()); |
|
| 570 | - } |
|
| 571 | - |
|
| 572 | - // Many-to-one relationships |
|
| 573 | - $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName()); |
|
| 574 | - foreach ($fks as $fk) { |
|
| 575 | - $classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName()); |
|
| 576 | - } |
|
| 577 | - |
|
| 578 | - $classes = array_unique($classes); |
|
| 579 | - |
|
| 580 | - return $classes; |
|
| 581 | - } |
|
| 582 | - |
|
| 583 | - /** |
|
| 584 | - * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
| 585 | - * |
|
| 586 | - * @param string $beannamespace The namespace of the bean |
|
| 587 | - */ |
|
| 588 | - public function generatePhpCode($beannamespace) |
|
| 589 | - { |
|
| 590 | - $tableName = $this->table->getName(); |
|
| 591 | - $baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($tableName); |
|
| 592 | - $className = TDBMDaoGenerator::getBeanNameFromTableName($tableName); |
|
| 593 | - $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
| 594 | - |
|
| 595 | - $classes = $this->generateExtendsAndUseStatements($parentFk); |
|
| 596 | - |
|
| 597 | - $uses = array_map(function ($className) use ($beannamespace) { |
|
| 598 | - return 'use '.$beannamespace.'\\'.$className.";\n"; |
|
| 599 | - }, $classes); |
|
| 600 | - $use = implode('', $uses); |
|
| 601 | - |
|
| 602 | - if ($parentFk !== null) { |
|
| 603 | - $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName()); |
|
| 604 | - } else { |
|
| 605 | - $extends = 'AbstractTDBMObject'; |
|
| 606 | - $use .= "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n"; |
|
| 607 | - } |
|
| 608 | - |
|
| 609 | - $str = "<?php |
|
| 541 | + } |
|
| 542 | + |
|
| 543 | + return sprintf($str, $initializer, $propertiesCode, $many2manyCode); |
|
| 544 | + } |
|
| 545 | + |
|
| 546 | + /** |
|
| 547 | + * Returns as an array the class we need to extend from and the list of use statements. |
|
| 548 | + * |
|
| 549 | + * @return array |
|
| 550 | + */ |
|
| 551 | + private function generateExtendsAndUseStatements(ForeignKeyConstraint $parentFk = null) |
|
| 552 | + { |
|
| 553 | + $classes = []; |
|
| 554 | + if ($parentFk !== null) { |
|
| 555 | + $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName()); |
|
| 556 | + $classes[] = $extends; |
|
| 557 | + } |
|
| 558 | + |
|
| 559 | + foreach ($this->getBeanPropertyDescriptors() as $beanPropertyDescriptor) { |
|
| 560 | + $className = $beanPropertyDescriptor->getClassName(); |
|
| 561 | + if (null !== $className) { |
|
| 562 | + $classes[] = $beanPropertyDescriptor->getClassName(); |
|
| 563 | + } |
|
| 564 | + } |
|
| 565 | + |
|
| 566 | + foreach ($this->getPivotTableDescriptors() as $descriptor) { |
|
| 567 | + /* @var $fk ForeignKeyConstraint */ |
|
| 568 | + $fk = $descriptor['remoteFK']; |
|
| 569 | + $classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getForeignTableName()); |
|
| 570 | + } |
|
| 571 | + |
|
| 572 | + // Many-to-one relationships |
|
| 573 | + $fks = $this->tdbmSchemaAnalyzer->getIncomingForeignKeys($this->table->getName()); |
|
| 574 | + foreach ($fks as $fk) { |
|
| 575 | + $classes[] = TDBMDaoGenerator::getBeanNameFromTableName($fk->getLocalTableName()); |
|
| 576 | + } |
|
| 577 | + |
|
| 578 | + $classes = array_unique($classes); |
|
| 579 | + |
|
| 580 | + return $classes; |
|
| 581 | + } |
|
| 582 | + |
|
| 583 | + /** |
|
| 584 | + * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
| 585 | + * |
|
| 586 | + * @param string $beannamespace The namespace of the bean |
|
| 587 | + */ |
|
| 588 | + public function generatePhpCode($beannamespace) |
|
| 589 | + { |
|
| 590 | + $tableName = $this->table->getName(); |
|
| 591 | + $baseClassName = TDBMDaoGenerator::getBaseBeanNameFromTableName($tableName); |
|
| 592 | + $className = TDBMDaoGenerator::getBeanNameFromTableName($tableName); |
|
| 593 | + $parentFk = $this->schemaAnalyzer->getParentRelationship($tableName); |
|
| 594 | + |
|
| 595 | + $classes = $this->generateExtendsAndUseStatements($parentFk); |
|
| 596 | + |
|
| 597 | + $uses = array_map(function ($className) use ($beannamespace) { |
|
| 598 | + return 'use '.$beannamespace.'\\'.$className.";\n"; |
|
| 599 | + }, $classes); |
|
| 600 | + $use = implode('', $uses); |
|
| 601 | + |
|
| 602 | + if ($parentFk !== null) { |
|
| 603 | + $extends = TDBMDaoGenerator::getBeanNameFromTableName($parentFk->getForeignTableName()); |
|
| 604 | + } else { |
|
| 605 | + $extends = 'AbstractTDBMObject'; |
|
| 606 | + $use .= "use Mouf\\Database\\TDBM\\AbstractTDBMObject;\n"; |
|
| 607 | + } |
|
| 608 | + |
|
| 609 | + $str = "<?php |
|
| 610 | 610 | namespace {$beannamespace}\\Generated; |
| 611 | 611 | |
| 612 | 612 | use Mouf\\Database\\TDBM\\ResultIterator; |
@@ -626,126 +626,126 @@ discard block |
||
| 626 | 626 | { |
| 627 | 627 | "; |
| 628 | 628 | |
| 629 | - $str .= $this->generateBeanConstructor(); |
|
| 629 | + $str .= $this->generateBeanConstructor(); |
|
| 630 | 630 | |
| 631 | - foreach ($this->getExposedProperties() as $property) { |
|
| 632 | - $str .= $property->getGetterSetterCode(); |
|
| 633 | - } |
|
| 631 | + foreach ($this->getExposedProperties() as $property) { |
|
| 632 | + $str .= $property->getGetterSetterCode(); |
|
| 633 | + } |
|
| 634 | 634 | |
| 635 | - $str .= $this->generateDirectForeignKeysCode(); |
|
| 636 | - $str .= $this->generatePivotTableCode(); |
|
| 637 | - $str .= $this->generateJsonSerialize(); |
|
| 635 | + $str .= $this->generateDirectForeignKeysCode(); |
|
| 636 | + $str .= $this->generatePivotTableCode(); |
|
| 637 | + $str .= $this->generateJsonSerialize(); |
|
| 638 | 638 | |
| 639 | - $str .= $this->generateGetUsedTablesCode(); |
|
| 639 | + $str .= $this->generateGetUsedTablesCode(); |
|
| 640 | 640 | |
| 641 | - $str .= '} |
|
| 641 | + $str .= '} |
|
| 642 | 642 | '; |
| 643 | 643 | |
| 644 | - return $str; |
|
| 645 | - } |
|
| 646 | - |
|
| 647 | - /** |
|
| 648 | - * @param string $beanNamespace |
|
| 649 | - * @param string $beanClassName |
|
| 650 | - * |
|
| 651 | - * @return array first element: list of used beans, second item: PHP code as a string |
|
| 652 | - */ |
|
| 653 | - public function generateFindByDaoCode($beanNamespace, $beanClassName) |
|
| 654 | - { |
|
| 655 | - $code = ''; |
|
| 656 | - $usedBeans = []; |
|
| 657 | - foreach ($this->table->getIndexes() as $index) { |
|
| 658 | - if (!$index->isPrimary()) { |
|
| 659 | - list($usedBeansForIndex, $codeForIndex) = $this->generateFindByDaoCodeForIndex($index, $beanNamespace, $beanClassName); |
|
| 660 | - $code .= $codeForIndex; |
|
| 661 | - $usedBeans = array_merge($usedBeans, $usedBeansForIndex); |
|
| 662 | - } |
|
| 663 | - } |
|
| 664 | - |
|
| 665 | - return [$usedBeans, $code]; |
|
| 666 | - } |
|
| 667 | - |
|
| 668 | - /** |
|
| 669 | - * @param Index $index |
|
| 670 | - * @param string $beanNamespace |
|
| 671 | - * @param string $beanClassName |
|
| 672 | - * |
|
| 673 | - * @return array first element: list of used beans, second item: PHP code as a string |
|
| 674 | - */ |
|
| 675 | - private function generateFindByDaoCodeForIndex(Index $index, $beanNamespace, $beanClassName) |
|
| 676 | - { |
|
| 677 | - $columns = $index->getColumns(); |
|
| 678 | - $usedBeans = []; |
|
| 679 | - |
|
| 680 | - /* |
|
| 644 | + return $str; |
|
| 645 | + } |
|
| 646 | + |
|
| 647 | + /** |
|
| 648 | + * @param string $beanNamespace |
|
| 649 | + * @param string $beanClassName |
|
| 650 | + * |
|
| 651 | + * @return array first element: list of used beans, second item: PHP code as a string |
|
| 652 | + */ |
|
| 653 | + public function generateFindByDaoCode($beanNamespace, $beanClassName) |
|
| 654 | + { |
|
| 655 | + $code = ''; |
|
| 656 | + $usedBeans = []; |
|
| 657 | + foreach ($this->table->getIndexes() as $index) { |
|
| 658 | + if (!$index->isPrimary()) { |
|
| 659 | + list($usedBeansForIndex, $codeForIndex) = $this->generateFindByDaoCodeForIndex($index, $beanNamespace, $beanClassName); |
|
| 660 | + $code .= $codeForIndex; |
|
| 661 | + $usedBeans = array_merge($usedBeans, $usedBeansForIndex); |
|
| 662 | + } |
|
| 663 | + } |
|
| 664 | + |
|
| 665 | + return [$usedBeans, $code]; |
|
| 666 | + } |
|
| 667 | + |
|
| 668 | + /** |
|
| 669 | + * @param Index $index |
|
| 670 | + * @param string $beanNamespace |
|
| 671 | + * @param string $beanClassName |
|
| 672 | + * |
|
| 673 | + * @return array first element: list of used beans, second item: PHP code as a string |
|
| 674 | + */ |
|
| 675 | + private function generateFindByDaoCodeForIndex(Index $index, $beanNamespace, $beanClassName) |
|
| 676 | + { |
|
| 677 | + $columns = $index->getColumns(); |
|
| 678 | + $usedBeans = []; |
|
| 679 | + |
|
| 680 | + /* |
|
| 681 | 681 | * The list of elements building this index (expressed as columns or foreign keys) |
| 682 | 682 | * @var AbstractBeanPropertyDescriptor[] |
| 683 | 683 | */ |
| 684 | - $elements = []; |
|
| 685 | - |
|
| 686 | - foreach ($columns as $column) { |
|
| 687 | - $fk = $this->isPartOfForeignKey($this->table, $this->table->getColumn($column)); |
|
| 688 | - if ($fk !== null) { |
|
| 689 | - if (!in_array($fk, $elements)) { |
|
| 690 | - $elements[] = new ObjectBeanPropertyDescriptor($this->table, $fk, $this->schemaAnalyzer); |
|
| 691 | - } |
|
| 692 | - } else { |
|
| 693 | - $elements[] = new ScalarBeanPropertyDescriptor($this->table, $this->table->getColumn($column)); |
|
| 694 | - } |
|
| 695 | - } |
|
| 696 | - |
|
| 697 | - // If the index is actually only a foreign key, let's bypass it entirely. |
|
| 698 | - if (count($elements) === 1 && $elements[0] instanceof ObjectBeanPropertyDescriptor) { |
|
| 699 | - return [[], '']; |
|
| 700 | - } |
|
| 701 | - |
|
| 702 | - $methodNameComponent = []; |
|
| 703 | - $functionParameters = []; |
|
| 704 | - $first = true; |
|
| 705 | - foreach ($elements as $element) { |
|
| 706 | - $methodNameComponent[] = $element->getUpperCamelCaseName(); |
|
| 707 | - $functionParameter = $element->getClassName(); |
|
| 708 | - if ($functionParameter) { |
|
| 709 | - $usedBeans[] = $beanNamespace.'\\'.$functionParameter; |
|
| 710 | - $functionParameter .= ' '; |
|
| 711 | - } |
|
| 712 | - $functionParameter .= $element->getVariableName(); |
|
| 713 | - if ($first) { |
|
| 714 | - $first = false; |
|
| 715 | - } else { |
|
| 716 | - $functionParameter .= ' = null'; |
|
| 717 | - } |
|
| 718 | - $functionParameters[] = $functionParameter; |
|
| 719 | - } |
|
| 720 | - if ($index->isUnique()) { |
|
| 721 | - $methodName = 'findOneBy'.implode('And', $methodNameComponent); |
|
| 722 | - $calledMethod = 'findOne'; |
|
| 723 | - $returnType = "{$beanClassName}"; |
|
| 724 | - } else { |
|
| 725 | - $methodName = 'findBy'.implode('And', $methodNameComponent); |
|
| 726 | - $returnType = "{$beanClassName}[]|ResultIterator|ResultArray"; |
|
| 727 | - $calledMethod = 'find'; |
|
| 728 | - } |
|
| 729 | - $functionParametersString = implode(', ', $functionParameters); |
|
| 730 | - |
|
| 731 | - $count = 0; |
|
| 732 | - |
|
| 733 | - $params = []; |
|
| 734 | - $filterArrayCode = ''; |
|
| 735 | - $commentArguments = []; |
|
| 736 | - foreach ($elements as $element) { |
|
| 737 | - $params[] = $element->getParamAnnotation(); |
|
| 738 | - if ($element instanceof ScalarBeanPropertyDescriptor) { |
|
| 739 | - $filterArrayCode .= ' '.var_export($element->getColumnName(), true).' => '.$element->getVariableName().",\n"; |
|
| 740 | - } else { |
|
| 741 | - ++$count; |
|
| 742 | - $filterArrayCode .= ' '.$count.' => '.$element->getVariableName().",\n"; |
|
| 743 | - } |
|
| 744 | - $commentArguments[] = substr($element->getVariableName(), 1); |
|
| 745 | - } |
|
| 746 | - $paramsString = implode("\n", $params); |
|
| 747 | - |
|
| 748 | - $code = " |
|
| 684 | + $elements = []; |
|
| 685 | + |
|
| 686 | + foreach ($columns as $column) { |
|
| 687 | + $fk = $this->isPartOfForeignKey($this->table, $this->table->getColumn($column)); |
|
| 688 | + if ($fk !== null) { |
|
| 689 | + if (!in_array($fk, $elements)) { |
|
| 690 | + $elements[] = new ObjectBeanPropertyDescriptor($this->table, $fk, $this->schemaAnalyzer); |
|
| 691 | + } |
|
| 692 | + } else { |
|
| 693 | + $elements[] = new ScalarBeanPropertyDescriptor($this->table, $this->table->getColumn($column)); |
|
| 694 | + } |
|
| 695 | + } |
|
| 696 | + |
|
| 697 | + // If the index is actually only a foreign key, let's bypass it entirely. |
|
| 698 | + if (count($elements) === 1 && $elements[0] instanceof ObjectBeanPropertyDescriptor) { |
|
| 699 | + return [[], '']; |
|
| 700 | + } |
|
| 701 | + |
|
| 702 | + $methodNameComponent = []; |
|
| 703 | + $functionParameters = []; |
|
| 704 | + $first = true; |
|
| 705 | + foreach ($elements as $element) { |
|
| 706 | + $methodNameComponent[] = $element->getUpperCamelCaseName(); |
|
| 707 | + $functionParameter = $element->getClassName(); |
|
| 708 | + if ($functionParameter) { |
|
| 709 | + $usedBeans[] = $beanNamespace.'\\'.$functionParameter; |
|
| 710 | + $functionParameter .= ' '; |
|
| 711 | + } |
|
| 712 | + $functionParameter .= $element->getVariableName(); |
|
| 713 | + if ($first) { |
|
| 714 | + $first = false; |
|
| 715 | + } else { |
|
| 716 | + $functionParameter .= ' = null'; |
|
| 717 | + } |
|
| 718 | + $functionParameters[] = $functionParameter; |
|
| 719 | + } |
|
| 720 | + if ($index->isUnique()) { |
|
| 721 | + $methodName = 'findOneBy'.implode('And', $methodNameComponent); |
|
| 722 | + $calledMethod = 'findOne'; |
|
| 723 | + $returnType = "{$beanClassName}"; |
|
| 724 | + } else { |
|
| 725 | + $methodName = 'findBy'.implode('And', $methodNameComponent); |
|
| 726 | + $returnType = "{$beanClassName}[]|ResultIterator|ResultArray"; |
|
| 727 | + $calledMethod = 'find'; |
|
| 728 | + } |
|
| 729 | + $functionParametersString = implode(', ', $functionParameters); |
|
| 730 | + |
|
| 731 | + $count = 0; |
|
| 732 | + |
|
| 733 | + $params = []; |
|
| 734 | + $filterArrayCode = ''; |
|
| 735 | + $commentArguments = []; |
|
| 736 | + foreach ($elements as $element) { |
|
| 737 | + $params[] = $element->getParamAnnotation(); |
|
| 738 | + if ($element instanceof ScalarBeanPropertyDescriptor) { |
|
| 739 | + $filterArrayCode .= ' '.var_export($element->getColumnName(), true).' => '.$element->getVariableName().",\n"; |
|
| 740 | + } else { |
|
| 741 | + ++$count; |
|
| 742 | + $filterArrayCode .= ' '.$count.' => '.$element->getVariableName().",\n"; |
|
| 743 | + } |
|
| 744 | + $commentArguments[] = substr($element->getVariableName(), 1); |
|
| 745 | + } |
|
| 746 | + $paramsString = implode("\n", $params); |
|
| 747 | + |
|
| 748 | + $code = " |
|
| 749 | 749 | /** |
| 750 | 750 | * Get a list of $beanClassName filtered by ".implode(', ', $commentArguments).". |
| 751 | 751 | * |
@@ -763,27 +763,27 @@ discard block |
||
| 763 | 763 | } |
| 764 | 764 | "; |
| 765 | 765 | |
| 766 | - return [$usedBeans, $code]; |
|
| 767 | - } |
|
| 768 | - |
|
| 769 | - /** |
|
| 770 | - * Generates the code for the getUsedTable protected method. |
|
| 771 | - * |
|
| 772 | - * @return string |
|
| 773 | - */ |
|
| 774 | - private function generateGetUsedTablesCode() |
|
| 775 | - { |
|
| 776 | - $hasParentRelationship = $this->schemaAnalyzer->getParentRelationship($this->table->getName()) !== null; |
|
| 777 | - if ($hasParentRelationship) { |
|
| 778 | - $code = sprintf(' $tables = parent::getUsedTables(); |
|
| 766 | + return [$usedBeans, $code]; |
|
| 767 | + } |
|
| 768 | + |
|
| 769 | + /** |
|
| 770 | + * Generates the code for the getUsedTable protected method. |
|
| 771 | + * |
|
| 772 | + * @return string |
|
| 773 | + */ |
|
| 774 | + private function generateGetUsedTablesCode() |
|
| 775 | + { |
|
| 776 | + $hasParentRelationship = $this->schemaAnalyzer->getParentRelationship($this->table->getName()) !== null; |
|
| 777 | + if ($hasParentRelationship) { |
|
| 778 | + $code = sprintf(' $tables = parent::getUsedTables(); |
|
| 779 | 779 | $tables[] = %s; |
| 780 | 780 | |
| 781 | 781 | return $tables;', var_export($this->table->getName(), true)); |
| 782 | - } else { |
|
| 783 | - $code = sprintf(' return [ %s ];', var_export($this->table->getName(), true)); |
|
| 784 | - } |
|
| 782 | + } else { |
|
| 783 | + $code = sprintf(' return [ %s ];', var_export($this->table->getName(), true)); |
|
| 784 | + } |
|
| 785 | 785 | |
| 786 | - return sprintf(' |
|
| 786 | + return sprintf(' |
|
| 787 | 787 | /** |
| 788 | 788 | * Returns an array of used tables by this bean (from parent to child relationship). |
| 789 | 789 | * |
@@ -794,5 +794,5 @@ discard block |
||
| 794 | 794 | %s |
| 795 | 795 | } |
| 796 | 796 | ', $code); |
| 797 | - } |
|
| 797 | + } |
|
| 798 | 798 | } |
@@ -17,202 +17,202 @@ discard block |
||
| 17 | 17 | */ |
| 18 | 18 | class TDBMDaoGenerator |
| 19 | 19 | { |
| 20 | - /** |
|
| 21 | - * @var SchemaAnalyzer |
|
| 22 | - */ |
|
| 23 | - private $schemaAnalyzer; |
|
| 24 | - |
|
| 25 | - /** |
|
| 26 | - * @var Schema |
|
| 27 | - */ |
|
| 28 | - private $schema; |
|
| 29 | - |
|
| 30 | - /** |
|
| 31 | - * The root directory of the project. |
|
| 32 | - * |
|
| 33 | - * @var string |
|
| 34 | - */ |
|
| 35 | - private $rootPath; |
|
| 36 | - |
|
| 37 | - /** |
|
| 38 | - * Name of composer file. |
|
| 39 | - * |
|
| 40 | - * @var string |
|
| 41 | - */ |
|
| 42 | - private $composerFile; |
|
| 43 | - |
|
| 44 | - /** |
|
| 45 | - * @var TDBMSchemaAnalyzer |
|
| 46 | - */ |
|
| 47 | - private $tdbmSchemaAnalyzer; |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * Constructor. |
|
| 51 | - * |
|
| 52 | - * @param SchemaAnalyzer $schemaAnalyzer |
|
| 53 | - * @param Schema $schema |
|
| 54 | - * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer |
|
| 55 | - */ |
|
| 56 | - public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
| 57 | - { |
|
| 58 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
| 59 | - $this->schema = $schema; |
|
| 60 | - $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
| 61 | - $this->rootPath = __DIR__.'/../../../../../../../../'; |
|
| 62 | - $this->composerFile = 'composer.json'; |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * Generates all the daos and beans. |
|
| 67 | - * |
|
| 68 | - * @param string $daoFactoryClassName The classe name of the DAO factory |
|
| 69 | - * @param string $daonamespace The namespace for the DAOs, without trailing \ |
|
| 70 | - * @param string $beannamespace The Namespace for the beans, without trailing \ |
|
| 71 | - * @param bool $storeInUtc If the generated daos should store the date in UTC timezone instead of user's timezone |
|
| 72 | - * |
|
| 73 | - * @return \string[] the list of tables |
|
| 74 | - * |
|
| 75 | - * @throws TDBMException |
|
| 76 | - */ |
|
| 77 | - public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc) |
|
| 78 | - { |
|
| 79 | - $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.$this->composerFile); |
|
| 80 | - // TODO: check that no class name ends with "Base". Otherwise, there will be name clash. |
|
| 81 | - |
|
| 82 | - $tableList = $this->schema->getTables(); |
|
| 83 | - |
|
| 84 | - // Remove all beans and daos from junction tables |
|
| 85 | - $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true); |
|
| 86 | - $junctionTableNames = array_map(function (Table $table) { |
|
| 87 | - return $table->getName(); |
|
| 88 | - }, $junctionTables); |
|
| 89 | - |
|
| 90 | - $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) { |
|
| 91 | - return !in_array($table->getName(), $junctionTableNames); |
|
| 92 | - }); |
|
| 93 | - |
|
| 94 | - foreach ($tableList as $table) { |
|
| 95 | - $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper); |
|
| 99 | - |
|
| 100 | - // Ok, let's return the list of all tables. |
|
| 101 | - // These will be used by the calling script to create Mouf instances. |
|
| 102 | - |
|
| 103 | - return array_map(function (Table $table) { |
|
| 104 | - return $table->getName(); |
|
| 105 | - }, $tableList); |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - /** |
|
| 109 | - * Generates in one method call the daos and the beans for one table. |
|
| 110 | - * |
|
| 111 | - * @param Table $table |
|
| 112 | - * @param string $daonamespace |
|
| 113 | - * @param string $beannamespace |
|
| 114 | - * @param ClassNameMapper $classNameMapper |
|
| 115 | - * @param bool $storeInUtc |
|
| 116 | - * |
|
| 117 | - * @throws TDBMException |
|
| 118 | - */ |
|
| 119 | - public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
| 120 | - { |
|
| 121 | - $tableName = $table->getName(); |
|
| 122 | - $daoName = $this->getDaoNameFromTableName($tableName); |
|
| 123 | - $beanName = $this->getBeanNameFromTableName($tableName); |
|
| 124 | - $baseBeanName = $this->getBaseBeanNameFromTableName($tableName); |
|
| 125 | - $baseDaoName = $this->getBaseDaoNameFromTableName($tableName); |
|
| 126 | - |
|
| 127 | - $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer); |
|
| 128 | - $this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc); |
|
| 129 | - $this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper); |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * Returns the name of the bean class from the table name. |
|
| 134 | - * |
|
| 135 | - * @param $tableName |
|
| 136 | - * |
|
| 137 | - * @return string |
|
| 138 | - */ |
|
| 139 | - public static function getBeanNameFromTableName($tableName) |
|
| 140 | - { |
|
| 141 | - return self::toSingular(self::toCamelCase($tableName)).'Bean'; |
|
| 142 | - } |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * Returns the name of the DAO class from the table name. |
|
| 146 | - * |
|
| 147 | - * @param $tableName |
|
| 148 | - * |
|
| 149 | - * @return string |
|
| 150 | - */ |
|
| 151 | - public static function getDaoNameFromTableName($tableName) |
|
| 152 | - { |
|
| 153 | - return self::toSingular(self::toCamelCase($tableName)).'Dao'; |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * Returns the name of the base bean class from the table name. |
|
| 158 | - * |
|
| 159 | - * @param $tableName |
|
| 160 | - * |
|
| 161 | - * @return string |
|
| 162 | - */ |
|
| 163 | - public static function getBaseBeanNameFromTableName($tableName) |
|
| 164 | - { |
|
| 165 | - return self::toSingular(self::toCamelCase($tableName)).'BaseBean'; |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - /** |
|
| 169 | - * Returns the name of the base DAO class from the table name. |
|
| 170 | - * |
|
| 171 | - * @param $tableName |
|
| 172 | - * |
|
| 173 | - * @return string |
|
| 174 | - */ |
|
| 175 | - public static function getBaseDaoNameFromTableName($tableName) |
|
| 176 | - { |
|
| 177 | - return self::toSingular(self::toCamelCase($tableName)).'BaseDao'; |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - /** |
|
| 181 | - * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
| 182 | - * |
|
| 183 | - * @param BeanDescriptor $beanDescriptor |
|
| 184 | - * @param string $className The name of the class |
|
| 185 | - * @param string $baseClassName The name of the base class which will be extended (name only, no directory) |
|
| 186 | - * @param Table $table The table |
|
| 187 | - * @param string $beannamespace The namespace of the bean |
|
| 188 | - * @param ClassNameMapper $classNameMapper |
|
| 189 | - * |
|
| 190 | - * @throws TDBMException |
|
| 191 | - */ |
|
| 192 | - public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
| 193 | - { |
|
| 194 | - $str = $beanDescriptor->generatePhpCode($beannamespace); |
|
| 195 | - |
|
| 196 | - $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\Generated\\'.$baseClassName); |
|
| 197 | - if (empty($possibleBaseFileNames)) { |
|
| 198 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.'); |
|
| 199 | - } |
|
| 200 | - $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
| 201 | - |
|
| 202 | - $this->ensureDirectoryExist($possibleBaseFileName); |
|
| 203 | - file_put_contents($possibleBaseFileName, $str); |
|
| 204 | - @chmod($possibleBaseFileName, 0664); |
|
| 205 | - |
|
| 206 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className); |
|
| 207 | - if (empty($possibleFileNames)) { |
|
| 208 | - // @codeCoverageIgnoreStart |
|
| 209 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.'); |
|
| 210 | - // @codeCoverageIgnoreEnd |
|
| 211 | - } |
|
| 212 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
| 213 | - if (!file_exists($possibleFileName)) { |
|
| 214 | - $tableName = $table->getName(); |
|
| 215 | - $str = "<?php |
|
| 20 | + /** |
|
| 21 | + * @var SchemaAnalyzer |
|
| 22 | + */ |
|
| 23 | + private $schemaAnalyzer; |
|
| 24 | + |
|
| 25 | + /** |
|
| 26 | + * @var Schema |
|
| 27 | + */ |
|
| 28 | + private $schema; |
|
| 29 | + |
|
| 30 | + /** |
|
| 31 | + * The root directory of the project. |
|
| 32 | + * |
|
| 33 | + * @var string |
|
| 34 | + */ |
|
| 35 | + private $rootPath; |
|
| 36 | + |
|
| 37 | + /** |
|
| 38 | + * Name of composer file. |
|
| 39 | + * |
|
| 40 | + * @var string |
|
| 41 | + */ |
|
| 42 | + private $composerFile; |
|
| 43 | + |
|
| 44 | + /** |
|
| 45 | + * @var TDBMSchemaAnalyzer |
|
| 46 | + */ |
|
| 47 | + private $tdbmSchemaAnalyzer; |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * Constructor. |
|
| 51 | + * |
|
| 52 | + * @param SchemaAnalyzer $schemaAnalyzer |
|
| 53 | + * @param Schema $schema |
|
| 54 | + * @param TDBMSchemaAnalyzer $tdbmSchemaAnalyzer |
|
| 55 | + */ |
|
| 56 | + public function __construct(SchemaAnalyzer $schemaAnalyzer, Schema $schema, TDBMSchemaAnalyzer $tdbmSchemaAnalyzer) |
|
| 57 | + { |
|
| 58 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
| 59 | + $this->schema = $schema; |
|
| 60 | + $this->tdbmSchemaAnalyzer = $tdbmSchemaAnalyzer; |
|
| 61 | + $this->rootPath = __DIR__.'/../../../../../../../../'; |
|
| 62 | + $this->composerFile = 'composer.json'; |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * Generates all the daos and beans. |
|
| 67 | + * |
|
| 68 | + * @param string $daoFactoryClassName The classe name of the DAO factory |
|
| 69 | + * @param string $daonamespace The namespace for the DAOs, without trailing \ |
|
| 70 | + * @param string $beannamespace The Namespace for the beans, without trailing \ |
|
| 71 | + * @param bool $storeInUtc If the generated daos should store the date in UTC timezone instead of user's timezone |
|
| 72 | + * |
|
| 73 | + * @return \string[] the list of tables |
|
| 74 | + * |
|
| 75 | + * @throws TDBMException |
|
| 76 | + */ |
|
| 77 | + public function generateAllDaosAndBeans($daoFactoryClassName, $daonamespace, $beannamespace, $storeInUtc) |
|
| 78 | + { |
|
| 79 | + $classNameMapper = ClassNameMapper::createFromComposerFile($this->rootPath.$this->composerFile); |
|
| 80 | + // TODO: check that no class name ends with "Base". Otherwise, there will be name clash. |
|
| 81 | + |
|
| 82 | + $tableList = $this->schema->getTables(); |
|
| 83 | + |
|
| 84 | + // Remove all beans and daos from junction tables |
|
| 85 | + $junctionTables = $this->schemaAnalyzer->detectJunctionTables(true); |
|
| 86 | + $junctionTableNames = array_map(function (Table $table) { |
|
| 87 | + return $table->getName(); |
|
| 88 | + }, $junctionTables); |
|
| 89 | + |
|
| 90 | + $tableList = array_filter($tableList, function (Table $table) use ($junctionTableNames) { |
|
| 91 | + return !in_array($table->getName(), $junctionTableNames); |
|
| 92 | + }); |
|
| 93 | + |
|
| 94 | + foreach ($tableList as $table) { |
|
| 95 | + $this->generateDaoAndBean($table, $daonamespace, $beannamespace, $classNameMapper, $storeInUtc); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + $this->generateFactory($tableList, $daoFactoryClassName, $daonamespace, $classNameMapper); |
|
| 99 | + |
|
| 100 | + // Ok, let's return the list of all tables. |
|
| 101 | + // These will be used by the calling script to create Mouf instances. |
|
| 102 | + |
|
| 103 | + return array_map(function (Table $table) { |
|
| 104 | + return $table->getName(); |
|
| 105 | + }, $tableList); |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + /** |
|
| 109 | + * Generates in one method call the daos and the beans for one table. |
|
| 110 | + * |
|
| 111 | + * @param Table $table |
|
| 112 | + * @param string $daonamespace |
|
| 113 | + * @param string $beannamespace |
|
| 114 | + * @param ClassNameMapper $classNameMapper |
|
| 115 | + * @param bool $storeInUtc |
|
| 116 | + * |
|
| 117 | + * @throws TDBMException |
|
| 118 | + */ |
|
| 119 | + public function generateDaoAndBean(Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
| 120 | + { |
|
| 121 | + $tableName = $table->getName(); |
|
| 122 | + $daoName = $this->getDaoNameFromTableName($tableName); |
|
| 123 | + $beanName = $this->getBeanNameFromTableName($tableName); |
|
| 124 | + $baseBeanName = $this->getBaseBeanNameFromTableName($tableName); |
|
| 125 | + $baseDaoName = $this->getBaseDaoNameFromTableName($tableName); |
|
| 126 | + |
|
| 127 | + $beanDescriptor = new BeanDescriptor($table, $this->schemaAnalyzer, $this->schema, $this->tdbmSchemaAnalyzer); |
|
| 128 | + $this->generateBean($beanDescriptor, $beanName, $baseBeanName, $table, $beannamespace, $classNameMapper, $storeInUtc); |
|
| 129 | + $this->generateDao($beanDescriptor, $daoName, $baseDaoName, $beanName, $table, $daonamespace, $beannamespace, $classNameMapper); |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * Returns the name of the bean class from the table name. |
|
| 134 | + * |
|
| 135 | + * @param $tableName |
|
| 136 | + * |
|
| 137 | + * @return string |
|
| 138 | + */ |
|
| 139 | + public static function getBeanNameFromTableName($tableName) |
|
| 140 | + { |
|
| 141 | + return self::toSingular(self::toCamelCase($tableName)).'Bean'; |
|
| 142 | + } |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * Returns the name of the DAO class from the table name. |
|
| 146 | + * |
|
| 147 | + * @param $tableName |
|
| 148 | + * |
|
| 149 | + * @return string |
|
| 150 | + */ |
|
| 151 | + public static function getDaoNameFromTableName($tableName) |
|
| 152 | + { |
|
| 153 | + return self::toSingular(self::toCamelCase($tableName)).'Dao'; |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * Returns the name of the base bean class from the table name. |
|
| 158 | + * |
|
| 159 | + * @param $tableName |
|
| 160 | + * |
|
| 161 | + * @return string |
|
| 162 | + */ |
|
| 163 | + public static function getBaseBeanNameFromTableName($tableName) |
|
| 164 | + { |
|
| 165 | + return self::toSingular(self::toCamelCase($tableName)).'BaseBean'; |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + /** |
|
| 169 | + * Returns the name of the base DAO class from the table name. |
|
| 170 | + * |
|
| 171 | + * @param $tableName |
|
| 172 | + * |
|
| 173 | + * @return string |
|
| 174 | + */ |
|
| 175 | + public static function getBaseDaoNameFromTableName($tableName) |
|
| 176 | + { |
|
| 177 | + return self::toSingular(self::toCamelCase($tableName)).'BaseDao'; |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + /** |
|
| 181 | + * Writes the PHP bean file with all getters and setters from the table passed in parameter. |
|
| 182 | + * |
|
| 183 | + * @param BeanDescriptor $beanDescriptor |
|
| 184 | + * @param string $className The name of the class |
|
| 185 | + * @param string $baseClassName The name of the base class which will be extended (name only, no directory) |
|
| 186 | + * @param Table $table The table |
|
| 187 | + * @param string $beannamespace The namespace of the bean |
|
| 188 | + * @param ClassNameMapper $classNameMapper |
|
| 189 | + * |
|
| 190 | + * @throws TDBMException |
|
| 191 | + */ |
|
| 192 | + public function generateBean(BeanDescriptor $beanDescriptor, $className, $baseClassName, Table $table, $beannamespace, ClassNameMapper $classNameMapper, $storeInUtc) |
|
| 193 | + { |
|
| 194 | + $str = $beanDescriptor->generatePhpCode($beannamespace); |
|
| 195 | + |
|
| 196 | + $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\Generated\\'.$baseClassName); |
|
| 197 | + if (empty($possibleBaseFileNames)) { |
|
| 198 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$baseClassName.'" is not autoloadable.'); |
|
| 199 | + } |
|
| 200 | + $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
| 201 | + |
|
| 202 | + $this->ensureDirectoryExist($possibleBaseFileName); |
|
| 203 | + file_put_contents($possibleBaseFileName, $str); |
|
| 204 | + @chmod($possibleBaseFileName, 0664); |
|
| 205 | + |
|
| 206 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($beannamespace.'\\'.$className); |
|
| 207 | + if (empty($possibleFileNames)) { |
|
| 208 | + // @codeCoverageIgnoreStart |
|
| 209 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$beannamespace.'\\'.$className.'" is not autoloadable.'); |
|
| 210 | + // @codeCoverageIgnoreEnd |
|
| 211 | + } |
|
| 212 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
| 213 | + if (!file_exists($possibleFileName)) { |
|
| 214 | + $tableName = $table->getName(); |
|
| 215 | + $str = "<?php |
|
| 216 | 216 | /* |
| 217 | 217 | * This file has been automatically generated by TDBM. |
| 218 | 218 | * You can edit this file as it will not be overwritten. |
@@ -229,76 +229,76 @@ discard block |
||
| 229 | 229 | { |
| 230 | 230 | |
| 231 | 231 | }"; |
| 232 | - $this->ensureDirectoryExist($possibleFileName); |
|
| 233 | - file_put_contents($possibleFileName, $str); |
|
| 234 | - @chmod($possibleFileName, 0664); |
|
| 235 | - } |
|
| 236 | - } |
|
| 237 | - |
|
| 238 | - /** |
|
| 239 | - * Tries to find a @defaultSort annotation in one of the columns. |
|
| 240 | - * |
|
| 241 | - * @param Table $table |
|
| 242 | - * |
|
| 243 | - * @return array First item: column name, Second item: column order (asc/desc) |
|
| 244 | - */ |
|
| 245 | - private function getDefaultSortColumnFromAnnotation(Table $table) |
|
| 246 | - { |
|
| 247 | - $defaultSort = null; |
|
| 248 | - $defaultSortDirection = null; |
|
| 249 | - foreach ($table->getColumns() as $column) { |
|
| 250 | - $comments = $column->getComment(); |
|
| 251 | - $matches = []; |
|
| 252 | - if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) { |
|
| 253 | - $defaultSort = $column->getName(); |
|
| 254 | - if (count($matches) === 3) { |
|
| 255 | - $defaultSortDirection = $matches[2]; |
|
| 256 | - } else { |
|
| 257 | - $defaultSortDirection = 'ASC'; |
|
| 258 | - } |
|
| 259 | - } |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - return [$defaultSort, $defaultSortDirection]; |
|
| 263 | - } |
|
| 264 | - |
|
| 265 | - /** |
|
| 266 | - * Writes the PHP bean DAO with simple functions to create/get/save objects. |
|
| 267 | - * |
|
| 268 | - * @param BeanDescriptor $beanDescriptor |
|
| 269 | - * @param string $className The name of the class |
|
| 270 | - * @param string $baseClassName |
|
| 271 | - * @param string $beanClassName |
|
| 272 | - * @param Table $table |
|
| 273 | - * @param string $daonamespace |
|
| 274 | - * @param string $beannamespace |
|
| 275 | - * @param ClassNameMapper $classNameMapper |
|
| 276 | - * |
|
| 277 | - * @throws TDBMException |
|
| 278 | - */ |
|
| 279 | - public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper) |
|
| 280 | - { |
|
| 281 | - $tableName = $table->getName(); |
|
| 282 | - $primaryKeyColumns = $table->getPrimaryKeyColumns(); |
|
| 283 | - |
|
| 284 | - list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table); |
|
| 285 | - |
|
| 286 | - // FIXME: lowercase tables with _ in the name should work! |
|
| 287 | - $tableCamel = self::toSingular(self::toCamelCase($tableName)); |
|
| 288 | - |
|
| 289 | - $beanClassWithoutNameSpace = $beanClassName; |
|
| 290 | - $beanClassName = $beannamespace.'\\'.$beanClassName; |
|
| 291 | - |
|
| 292 | - list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace); |
|
| 293 | - |
|
| 294 | - $usedBeans[] = $beanClassName; |
|
| 295 | - // Let's suppress duplicates in used beans (if any) |
|
| 296 | - $usedBeans = array_flip(array_flip($usedBeans)); |
|
| 297 | - $useStatements = array_map(function ($usedBean) { |
|
| 298 | - return "use $usedBean;\n"; |
|
| 299 | - }, $usedBeans); |
|
| 300 | - |
|
| 301 | - $str = "<?php |
|
| 232 | + $this->ensureDirectoryExist($possibleFileName); |
|
| 233 | + file_put_contents($possibleFileName, $str); |
|
| 234 | + @chmod($possibleFileName, 0664); |
|
| 235 | + } |
|
| 236 | + } |
|
| 237 | + |
|
| 238 | + /** |
|
| 239 | + * Tries to find a @defaultSort annotation in one of the columns. |
|
| 240 | + * |
|
| 241 | + * @param Table $table |
|
| 242 | + * |
|
| 243 | + * @return array First item: column name, Second item: column order (asc/desc) |
|
| 244 | + */ |
|
| 245 | + private function getDefaultSortColumnFromAnnotation(Table $table) |
|
| 246 | + { |
|
| 247 | + $defaultSort = null; |
|
| 248 | + $defaultSortDirection = null; |
|
| 249 | + foreach ($table->getColumns() as $column) { |
|
| 250 | + $comments = $column->getComment(); |
|
| 251 | + $matches = []; |
|
| 252 | + if (preg_match('/@defaultSort(\((desc|asc)\))*/', $comments, $matches) != 0) { |
|
| 253 | + $defaultSort = $column->getName(); |
|
| 254 | + if (count($matches) === 3) { |
|
| 255 | + $defaultSortDirection = $matches[2]; |
|
| 256 | + } else { |
|
| 257 | + $defaultSortDirection = 'ASC'; |
|
| 258 | + } |
|
| 259 | + } |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + return [$defaultSort, $defaultSortDirection]; |
|
| 263 | + } |
|
| 264 | + |
|
| 265 | + /** |
|
| 266 | + * Writes the PHP bean DAO with simple functions to create/get/save objects. |
|
| 267 | + * |
|
| 268 | + * @param BeanDescriptor $beanDescriptor |
|
| 269 | + * @param string $className The name of the class |
|
| 270 | + * @param string $baseClassName |
|
| 271 | + * @param string $beanClassName |
|
| 272 | + * @param Table $table |
|
| 273 | + * @param string $daonamespace |
|
| 274 | + * @param string $beannamespace |
|
| 275 | + * @param ClassNameMapper $classNameMapper |
|
| 276 | + * |
|
| 277 | + * @throws TDBMException |
|
| 278 | + */ |
|
| 279 | + public function generateDao(BeanDescriptor $beanDescriptor, $className, $baseClassName, $beanClassName, Table $table, $daonamespace, $beannamespace, ClassNameMapper $classNameMapper) |
|
| 280 | + { |
|
| 281 | + $tableName = $table->getName(); |
|
| 282 | + $primaryKeyColumns = $table->getPrimaryKeyColumns(); |
|
| 283 | + |
|
| 284 | + list($defaultSort, $defaultSortDirection) = $this->getDefaultSortColumnFromAnnotation($table); |
|
| 285 | + |
|
| 286 | + // FIXME: lowercase tables with _ in the name should work! |
|
| 287 | + $tableCamel = self::toSingular(self::toCamelCase($tableName)); |
|
| 288 | + |
|
| 289 | + $beanClassWithoutNameSpace = $beanClassName; |
|
| 290 | + $beanClassName = $beannamespace.'\\'.$beanClassName; |
|
| 291 | + |
|
| 292 | + list($usedBeans, $findByDaoCode) = $beanDescriptor->generateFindByDaoCode($beannamespace, $beanClassWithoutNameSpace); |
|
| 293 | + |
|
| 294 | + $usedBeans[] = $beanClassName; |
|
| 295 | + // Let's suppress duplicates in used beans (if any) |
|
| 296 | + $usedBeans = array_flip(array_flip($usedBeans)); |
|
| 297 | + $useStatements = array_map(function ($usedBean) { |
|
| 298 | + return "use $usedBean;\n"; |
|
| 299 | + }, $usedBeans); |
|
| 300 | + |
|
| 301 | + $str = "<?php |
|
| 302 | 302 | |
| 303 | 303 | /* |
| 304 | 304 | * This file has been automatically generated by TDBM. |
@@ -375,10 +375,10 @@ discard block |
||
| 375 | 375 | } |
| 376 | 376 | "; |
| 377 | 377 | |
| 378 | - if (count($primaryKeyColumns) === 1) { |
|
| 379 | - $primaryKeyColumn = $primaryKeyColumns[0]; |
|
| 380 | - $primaryKeyPhpType = self::dbalTypeToPhpType($table->getColumn($primaryKeyColumn)->getType()); |
|
| 381 | - $str .= " |
|
| 378 | + if (count($primaryKeyColumns) === 1) { |
|
| 379 | + $primaryKeyColumn = $primaryKeyColumns[0]; |
|
| 380 | + $primaryKeyPhpType = self::dbalTypeToPhpType($table->getColumn($primaryKeyColumn)->getType()); |
|
| 381 | + $str .= " |
|
| 382 | 382 | /** |
| 383 | 383 | * Get $beanClassWithoutNameSpace specified by its ID (its primary key) |
| 384 | 384 | * If the primary key does not exist, an exception is thrown. |
@@ -393,8 +393,8 @@ discard block |
||
| 393 | 393 | return \$this->tdbmService->findObjectByPk('$tableName', ['$primaryKeyColumn' => \$id], [], \$lazyLoading); |
| 394 | 394 | } |
| 395 | 395 | "; |
| 396 | - } |
|
| 397 | - $str .= " |
|
| 396 | + } |
|
| 397 | + $str .= " |
|
| 398 | 398 | /** |
| 399 | 399 | * Deletes the $beanClassWithoutNameSpace passed in parameter. |
| 400 | 400 | * |
@@ -493,33 +493,33 @@ discard block |
||
| 493 | 493 | } |
| 494 | 494 | "; |
| 495 | 495 | |
| 496 | - $str .= $findByDaoCode; |
|
| 497 | - $str .= '} |
|
| 496 | + $str .= $findByDaoCode; |
|
| 497 | + $str .= '} |
|
| 498 | 498 | '; |
| 499 | 499 | |
| 500 | - $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\Generated\\'.$baseClassName); |
|
| 501 | - if (empty($possibleBaseFileNames)) { |
|
| 502 | - // @codeCoverageIgnoreStart |
|
| 503 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.'); |
|
| 504 | - // @codeCoverageIgnoreEnd |
|
| 505 | - } |
|
| 506 | - $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
| 507 | - |
|
| 508 | - $this->ensureDirectoryExist($possibleBaseFileName); |
|
| 509 | - file_put_contents($possibleBaseFileName, $str); |
|
| 510 | - @chmod($possibleBaseFileName, 0664); |
|
| 511 | - |
|
| 512 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className); |
|
| 513 | - if (empty($possibleFileNames)) { |
|
| 514 | - // @codeCoverageIgnoreStart |
|
| 515 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.'); |
|
| 516 | - // @codeCoverageIgnoreEnd |
|
| 517 | - } |
|
| 518 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
| 519 | - |
|
| 520 | - // Now, let's generate the "editable" class |
|
| 521 | - if (!file_exists($possibleFileName)) { |
|
| 522 | - $str = "<?php |
|
| 500 | + $possibleBaseFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\Generated\\'.$baseClassName); |
|
| 501 | + if (empty($possibleBaseFileNames)) { |
|
| 502 | + // @codeCoverageIgnoreStart |
|
| 503 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$baseClassName.'" is not autoloadable.'); |
|
| 504 | + // @codeCoverageIgnoreEnd |
|
| 505 | + } |
|
| 506 | + $possibleBaseFileName = $this->rootPath.$possibleBaseFileNames[0]; |
|
| 507 | + |
|
| 508 | + $this->ensureDirectoryExist($possibleBaseFileName); |
|
| 509 | + file_put_contents($possibleBaseFileName, $str); |
|
| 510 | + @chmod($possibleBaseFileName, 0664); |
|
| 511 | + |
|
| 512 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($daonamespace.'\\'.$className); |
|
| 513 | + if (empty($possibleFileNames)) { |
|
| 514 | + // @codeCoverageIgnoreStart |
|
| 515 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$className.'" is not autoloadable.'); |
|
| 516 | + // @codeCoverageIgnoreEnd |
|
| 517 | + } |
|
| 518 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
| 519 | + |
|
| 520 | + // Now, let's generate the "editable" class |
|
| 521 | + if (!file_exists($possibleFileName)) { |
|
| 522 | + $str = "<?php |
|
| 523 | 523 | |
| 524 | 524 | /* |
| 525 | 525 | * This file has been automatically generated by TDBM. |
@@ -538,22 +538,22 @@ discard block |
||
| 538 | 538 | |
| 539 | 539 | } |
| 540 | 540 | "; |
| 541 | - $this->ensureDirectoryExist($possibleFileName); |
|
| 542 | - file_put_contents($possibleFileName, $str); |
|
| 543 | - @chmod($possibleFileName, 0664); |
|
| 544 | - } |
|
| 545 | - } |
|
| 546 | - |
|
| 547 | - /** |
|
| 548 | - * Generates the factory bean. |
|
| 549 | - * |
|
| 550 | - * @param Table[] $tableList |
|
| 551 | - */ |
|
| 552 | - private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) |
|
| 553 | - { |
|
| 554 | - // For each table, let's write a property. |
|
| 555 | - |
|
| 556 | - $str = "<?php |
|
| 541 | + $this->ensureDirectoryExist($possibleFileName); |
|
| 542 | + file_put_contents($possibleFileName, $str); |
|
| 543 | + @chmod($possibleFileName, 0664); |
|
| 544 | + } |
|
| 545 | + } |
|
| 546 | + |
|
| 547 | + /** |
|
| 548 | + * Generates the factory bean. |
|
| 549 | + * |
|
| 550 | + * @param Table[] $tableList |
|
| 551 | + */ |
|
| 552 | + private function generateFactory(array $tableList, $daoFactoryClassName, $daoNamespace, ClassNameMapper $classNameMapper) |
|
| 553 | + { |
|
| 554 | + // For each table, let's write a property. |
|
| 555 | + |
|
| 556 | + $str = "<?php |
|
| 557 | 557 | |
| 558 | 558 | /* |
| 559 | 559 | * This file has been automatically generated by TDBM. |
@@ -562,13 +562,13 @@ discard block |
||
| 562 | 562 | |
| 563 | 563 | namespace {$daoNamespace}\\Generated; |
| 564 | 564 | "; |
| 565 | - foreach ($tableList as $table) { |
|
| 566 | - $tableName = $table->getName(); |
|
| 567 | - $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
| 568 | - $str .= "use {$daoNamespace}\\".$daoClassName.";\n"; |
|
| 569 | - } |
|
| 565 | + foreach ($tableList as $table) { |
|
| 566 | + $tableName = $table->getName(); |
|
| 567 | + $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
| 568 | + $str .= "use {$daoNamespace}\\".$daoClassName.";\n"; |
|
| 569 | + } |
|
| 570 | 570 | |
| 571 | - $str .= " |
|
| 571 | + $str .= " |
|
| 572 | 572 | /** |
| 573 | 573 | * The $daoFactoryClassName provides an easy access to all DAOs generated by TDBM. |
| 574 | 574 | * |
@@ -577,12 +577,12 @@ discard block |
||
| 577 | 577 | { |
| 578 | 578 | "; |
| 579 | 579 | |
| 580 | - foreach ($tableList as $table) { |
|
| 581 | - $tableName = $table->getName(); |
|
| 582 | - $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
| 583 | - $daoInstanceName = self::toVariableName($daoClassName); |
|
| 580 | + foreach ($tableList as $table) { |
|
| 581 | + $tableName = $table->getName(); |
|
| 582 | + $daoClassName = $this->getDaoNameFromTableName($tableName); |
|
| 583 | + $daoInstanceName = self::toVariableName($daoClassName); |
|
| 584 | 584 | |
| 585 | - $str .= ' /** |
|
| 585 | + $str .= ' /** |
|
| 586 | 586 | * @var '.$daoClassName.' |
| 587 | 587 | */ |
| 588 | 588 | private $'.$daoInstanceName.'; |
@@ -607,158 +607,158 @@ discard block |
||
| 607 | 607 | } |
| 608 | 608 | |
| 609 | 609 | '; |
| 610 | - } |
|
| 610 | + } |
|
| 611 | 611 | |
| 612 | - $str .= ' |
|
| 612 | + $str .= ' |
|
| 613 | 613 | } |
| 614 | 614 | '; |
| 615 | 615 | |
| 616 | - $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\Generated\\'.$daoFactoryClassName); |
|
| 617 | - if (empty($possibleFileNames)) { |
|
| 618 | - throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.'); |
|
| 619 | - } |
|
| 620 | - $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
| 621 | - |
|
| 622 | - $this->ensureDirectoryExist($possibleFileName); |
|
| 623 | - file_put_contents($possibleFileName, $str); |
|
| 624 | - @chmod($possibleFileName, 0664); |
|
| 625 | - } |
|
| 626 | - |
|
| 627 | - /** |
|
| 628 | - * Transforms a string to camelCase (except the first letter will be uppercase too). |
|
| 629 | - * Underscores and spaces are removed and the first letter after the underscore is uppercased. |
|
| 630 | - * |
|
| 631 | - * @param $str string |
|
| 632 | - * |
|
| 633 | - * @return string |
|
| 634 | - */ |
|
| 635 | - public static function toCamelCase($str) |
|
| 636 | - { |
|
| 637 | - $str = strtoupper(substr($str, 0, 1)).substr($str, 1); |
|
| 638 | - while (true) { |
|
| 639 | - if (strpos($str, '_') === false && strpos($str, ' ') === false) { |
|
| 640 | - break; |
|
| 641 | - } |
|
| 642 | - |
|
| 643 | - $pos = strpos($str, '_'); |
|
| 644 | - if ($pos === false) { |
|
| 645 | - $pos = strpos($str, ' '); |
|
| 646 | - } |
|
| 647 | - $before = substr($str, 0, $pos); |
|
| 648 | - $after = substr($str, $pos + 1); |
|
| 649 | - $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1); |
|
| 650 | - } |
|
| 651 | - |
|
| 652 | - return $str; |
|
| 653 | - } |
|
| 654 | - |
|
| 655 | - /** |
|
| 656 | - * Tries to put string to the singular form (if it is plural). |
|
| 657 | - * We assume the table names are in english. |
|
| 658 | - * |
|
| 659 | - * @param $str string |
|
| 660 | - * |
|
| 661 | - * @return string |
|
| 662 | - */ |
|
| 663 | - public static function toSingular($str) |
|
| 664 | - { |
|
| 665 | - return Inflector::singularize($str); |
|
| 666 | - } |
|
| 667 | - |
|
| 668 | - /** |
|
| 669 | - * Put the first letter of the string in lower case. |
|
| 670 | - * Very useful to transform a class name into a variable name. |
|
| 671 | - * |
|
| 672 | - * @param $str string |
|
| 673 | - * |
|
| 674 | - * @return string |
|
| 675 | - */ |
|
| 676 | - public static function toVariableName($str) |
|
| 677 | - { |
|
| 678 | - return strtolower(substr($str, 0, 1)).substr($str, 1); |
|
| 679 | - } |
|
| 680 | - |
|
| 681 | - /** |
|
| 682 | - * Ensures the file passed in parameter can be written in its directory. |
|
| 683 | - * |
|
| 684 | - * @param string $fileName |
|
| 685 | - * |
|
| 686 | - * @throws TDBMException |
|
| 687 | - */ |
|
| 688 | - private function ensureDirectoryExist($fileName) |
|
| 689 | - { |
|
| 690 | - $dirName = dirname($fileName); |
|
| 691 | - if (!file_exists($dirName)) { |
|
| 692 | - $old = umask(0); |
|
| 693 | - $result = mkdir($dirName, 0775, true); |
|
| 694 | - umask($old); |
|
| 695 | - if ($result === false) { |
|
| 696 | - throw new TDBMException("Unable to create directory: '".$dirName."'."); |
|
| 697 | - } |
|
| 698 | - } |
|
| 699 | - } |
|
| 700 | - |
|
| 701 | - /** |
|
| 702 | - * Absolute path to composer json file. |
|
| 703 | - * |
|
| 704 | - * @param string $composerFile |
|
| 705 | - */ |
|
| 706 | - public function setComposerFile($composerFile) |
|
| 707 | - { |
|
| 708 | - $this->rootPath = dirname($composerFile).'/'; |
|
| 709 | - $this->composerFile = basename($composerFile); |
|
| 710 | - } |
|
| 711 | - |
|
| 712 | - /** |
|
| 713 | - * Transforms a DBAL type into a PHP type (for PHPDoc purpose). |
|
| 714 | - * |
|
| 715 | - * @param Type $type The DBAL type |
|
| 716 | - * |
|
| 717 | - * @return string The PHP type |
|
| 718 | - */ |
|
| 719 | - public static function dbalTypeToPhpType(Type $type) |
|
| 720 | - { |
|
| 721 | - $map = [ |
|
| 722 | - Type::TARRAY => 'array', |
|
| 723 | - Type::SIMPLE_ARRAY => 'array', |
|
| 724 | - Type::JSON_ARRAY => 'array', |
|
| 725 | - Type::BIGINT => 'string', |
|
| 726 | - Type::BOOLEAN => 'bool', |
|
| 727 | - Type::DATETIME => '\DateTimeInterface', |
|
| 728 | - Type::DATETIMETZ => '\DateTimeInterface', |
|
| 729 | - Type::DATE => '\DateTimeInterface', |
|
| 730 | - Type::TIME => '\DateTimeInterface', |
|
| 731 | - Type::DECIMAL => 'float', |
|
| 732 | - Type::INTEGER => 'int', |
|
| 733 | - Type::OBJECT => 'string', |
|
| 734 | - Type::SMALLINT => 'int', |
|
| 735 | - Type::STRING => 'string', |
|
| 736 | - Type::TEXT => 'string', |
|
| 737 | - Type::BINARY => 'string', |
|
| 738 | - Type::BLOB => 'string', |
|
| 739 | - Type::FLOAT => 'float', |
|
| 740 | - Type::GUID => 'string', |
|
| 741 | - ]; |
|
| 742 | - |
|
| 743 | - return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName(); |
|
| 744 | - } |
|
| 745 | - |
|
| 746 | - /** |
|
| 747 | - * @param string $beanNamespace |
|
| 748 | - * |
|
| 749 | - * @return \string[] Returns a map mapping table name to beans name |
|
| 750 | - */ |
|
| 751 | - public function buildTableToBeanMap($beanNamespace) |
|
| 752 | - { |
|
| 753 | - $tableToBeanMap = []; |
|
| 754 | - |
|
| 755 | - $tables = $this->schema->getTables(); |
|
| 756 | - |
|
| 757 | - foreach ($tables as $table) { |
|
| 758 | - $tableName = $table->getName(); |
|
| 759 | - $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName); |
|
| 760 | - } |
|
| 761 | - |
|
| 762 | - return $tableToBeanMap; |
|
| 763 | - } |
|
| 616 | + $possibleFileNames = $classNameMapper->getPossibleFileNames($daoNamespace.'\\Generated\\'.$daoFactoryClassName); |
|
| 617 | + if (empty($possibleFileNames)) { |
|
| 618 | + throw new TDBMException('Sorry, autoload namespace issue. The class "'.$daoNamespace.'\\'.$daoFactoryClassName.'" is not autoloadable.'); |
|
| 619 | + } |
|
| 620 | + $possibleFileName = $this->rootPath.$possibleFileNames[0]; |
|
| 621 | + |
|
| 622 | + $this->ensureDirectoryExist($possibleFileName); |
|
| 623 | + file_put_contents($possibleFileName, $str); |
|
| 624 | + @chmod($possibleFileName, 0664); |
|
| 625 | + } |
|
| 626 | + |
|
| 627 | + /** |
|
| 628 | + * Transforms a string to camelCase (except the first letter will be uppercase too). |
|
| 629 | + * Underscores and spaces are removed and the first letter after the underscore is uppercased. |
|
| 630 | + * |
|
| 631 | + * @param $str string |
|
| 632 | + * |
|
| 633 | + * @return string |
|
| 634 | + */ |
|
| 635 | + public static function toCamelCase($str) |
|
| 636 | + { |
|
| 637 | + $str = strtoupper(substr($str, 0, 1)).substr($str, 1); |
|
| 638 | + while (true) { |
|
| 639 | + if (strpos($str, '_') === false && strpos($str, ' ') === false) { |
|
| 640 | + break; |
|
| 641 | + } |
|
| 642 | + |
|
| 643 | + $pos = strpos($str, '_'); |
|
| 644 | + if ($pos === false) { |
|
| 645 | + $pos = strpos($str, ' '); |
|
| 646 | + } |
|
| 647 | + $before = substr($str, 0, $pos); |
|
| 648 | + $after = substr($str, $pos + 1); |
|
| 649 | + $str = $before.strtoupper(substr($after, 0, 1)).substr($after, 1); |
|
| 650 | + } |
|
| 651 | + |
|
| 652 | + return $str; |
|
| 653 | + } |
|
| 654 | + |
|
| 655 | + /** |
|
| 656 | + * Tries to put string to the singular form (if it is plural). |
|
| 657 | + * We assume the table names are in english. |
|
| 658 | + * |
|
| 659 | + * @param $str string |
|
| 660 | + * |
|
| 661 | + * @return string |
|
| 662 | + */ |
|
| 663 | + public static function toSingular($str) |
|
| 664 | + { |
|
| 665 | + return Inflector::singularize($str); |
|
| 666 | + } |
|
| 667 | + |
|
| 668 | + /** |
|
| 669 | + * Put the first letter of the string in lower case. |
|
| 670 | + * Very useful to transform a class name into a variable name. |
|
| 671 | + * |
|
| 672 | + * @param $str string |
|
| 673 | + * |
|
| 674 | + * @return string |
|
| 675 | + */ |
|
| 676 | + public static function toVariableName($str) |
|
| 677 | + { |
|
| 678 | + return strtolower(substr($str, 0, 1)).substr($str, 1); |
|
| 679 | + } |
|
| 680 | + |
|
| 681 | + /** |
|
| 682 | + * Ensures the file passed in parameter can be written in its directory. |
|
| 683 | + * |
|
| 684 | + * @param string $fileName |
|
| 685 | + * |
|
| 686 | + * @throws TDBMException |
|
| 687 | + */ |
|
| 688 | + private function ensureDirectoryExist($fileName) |
|
| 689 | + { |
|
| 690 | + $dirName = dirname($fileName); |
|
| 691 | + if (!file_exists($dirName)) { |
|
| 692 | + $old = umask(0); |
|
| 693 | + $result = mkdir($dirName, 0775, true); |
|
| 694 | + umask($old); |
|
| 695 | + if ($result === false) { |
|
| 696 | + throw new TDBMException("Unable to create directory: '".$dirName."'."); |
|
| 697 | + } |
|
| 698 | + } |
|
| 699 | + } |
|
| 700 | + |
|
| 701 | + /** |
|
| 702 | + * Absolute path to composer json file. |
|
| 703 | + * |
|
| 704 | + * @param string $composerFile |
|
| 705 | + */ |
|
| 706 | + public function setComposerFile($composerFile) |
|
| 707 | + { |
|
| 708 | + $this->rootPath = dirname($composerFile).'/'; |
|
| 709 | + $this->composerFile = basename($composerFile); |
|
| 710 | + } |
|
| 711 | + |
|
| 712 | + /** |
|
| 713 | + * Transforms a DBAL type into a PHP type (for PHPDoc purpose). |
|
| 714 | + * |
|
| 715 | + * @param Type $type The DBAL type |
|
| 716 | + * |
|
| 717 | + * @return string The PHP type |
|
| 718 | + */ |
|
| 719 | + public static function dbalTypeToPhpType(Type $type) |
|
| 720 | + { |
|
| 721 | + $map = [ |
|
| 722 | + Type::TARRAY => 'array', |
|
| 723 | + Type::SIMPLE_ARRAY => 'array', |
|
| 724 | + Type::JSON_ARRAY => 'array', |
|
| 725 | + Type::BIGINT => 'string', |
|
| 726 | + Type::BOOLEAN => 'bool', |
|
| 727 | + Type::DATETIME => '\DateTimeInterface', |
|
| 728 | + Type::DATETIMETZ => '\DateTimeInterface', |
|
| 729 | + Type::DATE => '\DateTimeInterface', |
|
| 730 | + Type::TIME => '\DateTimeInterface', |
|
| 731 | + Type::DECIMAL => 'float', |
|
| 732 | + Type::INTEGER => 'int', |
|
| 733 | + Type::OBJECT => 'string', |
|
| 734 | + Type::SMALLINT => 'int', |
|
| 735 | + Type::STRING => 'string', |
|
| 736 | + Type::TEXT => 'string', |
|
| 737 | + Type::BINARY => 'string', |
|
| 738 | + Type::BLOB => 'string', |
|
| 739 | + Type::FLOAT => 'float', |
|
| 740 | + Type::GUID => 'string', |
|
| 741 | + ]; |
|
| 742 | + |
|
| 743 | + return isset($map[$type->getName()]) ? $map[$type->getName()] : $type->getName(); |
|
| 744 | + } |
|
| 745 | + |
|
| 746 | + /** |
|
| 747 | + * @param string $beanNamespace |
|
| 748 | + * |
|
| 749 | + * @return \string[] Returns a map mapping table name to beans name |
|
| 750 | + */ |
|
| 751 | + public function buildTableToBeanMap($beanNamespace) |
|
| 752 | + { |
|
| 753 | + $tableToBeanMap = []; |
|
| 754 | + |
|
| 755 | + $tables = $this->schema->getTables(); |
|
| 756 | + |
|
| 757 | + foreach ($tables as $table) { |
|
| 758 | + $tableName = $table->getName(); |
|
| 759 | + $tableToBeanMap[$tableName] = $beanNamespace.'\\'.self::getBeanNameFromTableName($tableName); |
|
| 760 | + } |
|
| 761 | + |
|
| 762 | + return $tableToBeanMap; |
|
| 763 | + } |
|
| 764 | 764 | } |
@@ -31,604 +31,604 @@ |
||
| 31 | 31 | */ |
| 32 | 32 | abstract class AbstractTDBMObject implements JsonSerializable |
| 33 | 33 | { |
| 34 | - /** |
|
| 35 | - * The service this object is bound to. |
|
| 36 | - * |
|
| 37 | - * @var TDBMService |
|
| 38 | - */ |
|
| 39 | - protected $tdbmService; |
|
| 40 | - |
|
| 41 | - /** |
|
| 42 | - * An array of DbRow, indexed by table name. |
|
| 43 | - * |
|
| 44 | - * @var DbRow[] |
|
| 45 | - */ |
|
| 46 | - protected $dbRows = array(); |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
| 50 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
| 51 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
| 52 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
| 53 | - * |
|
| 54 | - * @var string |
|
| 55 | - */ |
|
| 56 | - private $status; |
|
| 57 | - |
|
| 58 | - /** |
|
| 59 | - * Array storing beans related via many to many relationships (pivot tables). |
|
| 60 | - * |
|
| 61 | - * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage |
|
| 62 | - */ |
|
| 63 | - private $relationships = []; |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * @var bool[] Key: pivot table name, value: whether a query was performed to load the data |
|
| 67 | - */ |
|
| 68 | - private $loadedRelationships = []; |
|
| 69 | - |
|
| 70 | - /** |
|
| 71 | - * Array storing beans related via many to one relationships (this bean is pointed by external beans). |
|
| 72 | - * |
|
| 73 | - * @var AlterableResultIterator[] Key: [external_table]___[external_column], value: SplObjectStorage |
|
| 74 | - */ |
|
| 75 | - private $manyToOneRelationships = []; |
|
| 76 | - |
|
| 77 | - /** |
|
| 78 | - * Used with $primaryKeys when we want to retrieve an existing object |
|
| 79 | - * and $primaryKeys=[] if we want a new object. |
|
| 80 | - * |
|
| 81 | - * @param string $tableName |
|
| 82 | - * @param array $primaryKeys |
|
| 83 | - * @param TDBMService $tdbmService |
|
| 84 | - * |
|
| 85 | - * @throws TDBMException |
|
| 86 | - * @throws TDBMInvalidOperationException |
|
| 87 | - */ |
|
| 88 | - public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null) |
|
| 89 | - { |
|
| 90 | - // FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation... |
|
| 91 | - if (!empty($tableName)) { |
|
| 92 | - $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - if ($tdbmService === null) { |
|
| 96 | - $this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED); |
|
| 97 | - } else { |
|
| 98 | - $this->_attach($tdbmService); |
|
| 99 | - if (!empty($primaryKeys)) { |
|
| 100 | - $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
| 101 | - } else { |
|
| 102 | - $this->_setStatus(TDBMObjectStateEnum::STATE_NEW); |
|
| 103 | - } |
|
| 104 | - } |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - /** |
|
| 108 | - * Alternative constructor called when data is fetched from database via a SELECT. |
|
| 109 | - * |
|
| 110 | - * @param array $beanData array<table, array<column, value>> |
|
| 111 | - * @param TDBMService $tdbmService |
|
| 112 | - */ |
|
| 113 | - public function _constructFromData(array $beanData, TDBMService $tdbmService) |
|
| 114 | - { |
|
| 115 | - $this->tdbmService = $tdbmService; |
|
| 116 | - |
|
| 117 | - foreach ($beanData as $table => $columns) { |
|
| 118 | - $this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns); |
|
| 119 | - } |
|
| 120 | - |
|
| 121 | - $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - /** |
|
| 125 | - * Alternative constructor called when bean is lazily loaded. |
|
| 126 | - * |
|
| 127 | - * @param string $tableName |
|
| 128 | - * @param array $primaryKeys |
|
| 129 | - * @param TDBMService $tdbmService |
|
| 130 | - */ |
|
| 131 | - public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService) |
|
| 132 | - { |
|
| 133 | - $this->tdbmService = $tdbmService; |
|
| 134 | - |
|
| 135 | - $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
| 136 | - |
|
| 137 | - $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED; |
|
| 138 | - } |
|
| 139 | - |
|
| 140 | - public function _attach(TDBMService $tdbmService) |
|
| 141 | - { |
|
| 142 | - if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) { |
|
| 143 | - throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.'); |
|
| 144 | - } |
|
| 145 | - $this->tdbmService = $tdbmService; |
|
| 146 | - |
|
| 147 | - // If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level) |
|
| 148 | - $tableNames = $this->getUsedTables(); |
|
| 149 | - |
|
| 150 | - $newDbRows = []; |
|
| 151 | - |
|
| 152 | - foreach ($tableNames as $table) { |
|
| 153 | - if (!isset($this->dbRows[$table])) { |
|
| 154 | - $this->registerTable($table); |
|
| 155 | - } |
|
| 156 | - $newDbRows[$table] = $this->dbRows[$table]; |
|
| 157 | - } |
|
| 158 | - $this->dbRows = $newDbRows; |
|
| 159 | - |
|
| 160 | - $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
| 161 | - foreach ($this->dbRows as $dbRow) { |
|
| 162 | - $dbRow->_attach($tdbmService); |
|
| 163 | - } |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - /** |
|
| 167 | - * Sets the state of the TDBM Object |
|
| 168 | - * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
| 169 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
| 170 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
| 171 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
| 172 | - * |
|
| 173 | - * @param string $state |
|
| 174 | - */ |
|
| 175 | - public function _setStatus($state) |
|
| 176 | - { |
|
| 177 | - $this->status = $state; |
|
| 178 | - |
|
| 179 | - // TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself. |
|
| 180 | - foreach ($this->dbRows as $dbRow) { |
|
| 181 | - $dbRow->_setStatus($state); |
|
| 182 | - } |
|
| 183 | - } |
|
| 184 | - |
|
| 185 | - /** |
|
| 186 | - * Checks that $tableName is ok, or returns the only possible table name if "$tableName = null" |
|
| 187 | - * or throws an error. |
|
| 188 | - * |
|
| 189 | - * @param string $tableName |
|
| 190 | - * |
|
| 191 | - * @return string |
|
| 192 | - */ |
|
| 193 | - private function checkTableName($tableName = null) |
|
| 194 | - { |
|
| 195 | - if ($tableName === null) { |
|
| 196 | - if (count($this->dbRows) > 1) { |
|
| 197 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
| 198 | - } elseif (count($this->dbRows) === 1) { |
|
| 199 | - $tableName = array_keys($this->dbRows)[0]; |
|
| 200 | - } |
|
| 201 | - } |
|
| 202 | - |
|
| 203 | - if (!isset($this->dbRows[$tableName])) { |
|
| 204 | - if (count($this->dbRows === 0)) { |
|
| 205 | - throw new TDBMException('Object is not yet bound to any table.'); |
|
| 206 | - } else { |
|
| 207 | - throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
| 208 | - } |
|
| 209 | - } |
|
| 210 | - |
|
| 211 | - return $tableName; |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - protected function get($var, $tableName = null) |
|
| 215 | - { |
|
| 216 | - $tableName = $this->checkTableName($tableName); |
|
| 217 | - |
|
| 218 | - return $this->dbRows[$tableName]->get($var); |
|
| 219 | - } |
|
| 220 | - |
|
| 221 | - protected function set($var, $value, $tableName = null) |
|
| 222 | - { |
|
| 223 | - if ($tableName === null) { |
|
| 224 | - if (count($this->dbRows) > 1) { |
|
| 225 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
| 226 | - } elseif (count($this->dbRows) === 1) { |
|
| 227 | - $tableName = array_keys($this->dbRows)[0]; |
|
| 228 | - } else { |
|
| 229 | - throw new TDBMException('Please specify a table for this object.'); |
|
| 230 | - } |
|
| 231 | - } |
|
| 232 | - |
|
| 233 | - if (!isset($this->dbRows[$tableName])) { |
|
| 234 | - $this->registerTable($tableName); |
|
| 235 | - } |
|
| 236 | - |
|
| 237 | - $this->dbRows[$tableName]->set($var, $value); |
|
| 238 | - if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
| 239 | - $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
| 240 | - } |
|
| 241 | - } |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * @param string $foreignKeyName |
|
| 245 | - * @param AbstractTDBMObject $bean |
|
| 246 | - */ |
|
| 247 | - protected function setRef($foreignKeyName, AbstractTDBMObject $bean = null, $tableName = null) |
|
| 248 | - { |
|
| 249 | - if ($tableName === null) { |
|
| 250 | - if (count($this->dbRows) > 1) { |
|
| 251 | - throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
| 252 | - } elseif (count($this->dbRows) === 1) { |
|
| 253 | - $tableName = array_keys($this->dbRows)[0]; |
|
| 254 | - } else { |
|
| 255 | - throw new TDBMException('Please specify a table for this object.'); |
|
| 256 | - } |
|
| 257 | - } |
|
| 258 | - |
|
| 259 | - if (!isset($this->dbRows[$tableName])) { |
|
| 260 | - $this->registerTable($tableName); |
|
| 261 | - } |
|
| 262 | - |
|
| 263 | - $oldLinkedBean = $this->dbRows[$tableName]->getRef($foreignKeyName); |
|
| 264 | - if ($oldLinkedBean !== null) { |
|
| 265 | - $oldLinkedBean->removeManyToOneRelationship($tableName, $foreignKeyName, $this); |
|
| 266 | - } |
|
| 267 | - |
|
| 268 | - $this->dbRows[$tableName]->setRef($foreignKeyName, $bean); |
|
| 269 | - if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
| 270 | - $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
| 271 | - } |
|
| 272 | - |
|
| 273 | - if ($bean !== null) { |
|
| 274 | - $bean->setManyToOneRelationship($tableName, $foreignKeyName, $this); |
|
| 275 | - } |
|
| 276 | - } |
|
| 277 | - |
|
| 278 | - /** |
|
| 279 | - * @param string $foreignKeyName A unique name for this reference |
|
| 280 | - * |
|
| 281 | - * @return AbstractTDBMObject|null |
|
| 282 | - */ |
|
| 283 | - protected function getRef($foreignKeyName, $tableName = null) |
|
| 284 | - { |
|
| 285 | - $tableName = $this->checkTableName($tableName); |
|
| 286 | - |
|
| 287 | - return $this->dbRows[$tableName]->getRef($foreignKeyName); |
|
| 288 | - } |
|
| 289 | - |
|
| 290 | - /** |
|
| 291 | - * Adds a many to many relationship to this bean. |
|
| 292 | - * |
|
| 293 | - * @param string $pivotTableName |
|
| 294 | - * @param AbstractTDBMObject $remoteBean |
|
| 295 | - */ |
|
| 296 | - protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
| 297 | - { |
|
| 298 | - $this->setRelationship($pivotTableName, $remoteBean, 'new'); |
|
| 299 | - } |
|
| 300 | - |
|
| 301 | - /** |
|
| 302 | - * Returns true if there is a relationship to this bean. |
|
| 303 | - * |
|
| 304 | - * @param string $pivotTableName |
|
| 305 | - * @param AbstractTDBMObject $remoteBean |
|
| 306 | - * |
|
| 307 | - * @return bool |
|
| 308 | - */ |
|
| 309 | - protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
| 310 | - { |
|
| 311 | - $storage = $this->retrieveRelationshipsStorage($pivotTableName); |
|
| 312 | - |
|
| 313 | - if ($storage->contains($remoteBean)) { |
|
| 314 | - if ($storage[$remoteBean]['status'] !== 'delete') { |
|
| 315 | - return true; |
|
| 316 | - } |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - return false; |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - /** |
|
| 323 | - * Internal TDBM method. Removes a many to many relationship from this bean. |
|
| 324 | - * |
|
| 325 | - * @param string $pivotTableName |
|
| 326 | - * @param AbstractTDBMObject $remoteBean |
|
| 327 | - */ |
|
| 328 | - public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
| 329 | - { |
|
| 330 | - if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') { |
|
| 331 | - unset($this->relationships[$pivotTableName][$remoteBean]); |
|
| 332 | - unset($remoteBean->relationships[$pivotTableName][$this]); |
|
| 333 | - } else { |
|
| 334 | - $this->setRelationship($pivotTableName, $remoteBean, 'delete'); |
|
| 335 | - } |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - /** |
|
| 339 | - * Sets many to many relationships for this bean. |
|
| 340 | - * Adds new relationships and removes unused ones. |
|
| 341 | - * |
|
| 342 | - * @param $pivotTableName |
|
| 343 | - * @param array $remoteBeans |
|
| 344 | - */ |
|
| 345 | - protected function setRelationships($pivotTableName, array $remoteBeans) |
|
| 346 | - { |
|
| 347 | - $storage = $this->retrieveRelationshipsStorage($pivotTableName); |
|
| 348 | - |
|
| 349 | - foreach ($storage as $oldRemoteBean) { |
|
| 350 | - if (!in_array($oldRemoteBean, $remoteBeans, true)) { |
|
| 351 | - // $oldRemoteBean must be removed |
|
| 352 | - $this->_removeRelationship($pivotTableName, $oldRemoteBean); |
|
| 353 | - } |
|
| 354 | - } |
|
| 355 | - |
|
| 356 | - foreach ($remoteBeans as $remoteBean) { |
|
| 357 | - if (!$storage->contains($remoteBean) || $storage[$remoteBean]['status'] === 'delete') { |
|
| 358 | - // $remoteBean must be added |
|
| 359 | - $this->addRelationship($pivotTableName, $remoteBean); |
|
| 360 | - } |
|
| 361 | - } |
|
| 362 | - } |
|
| 363 | - |
|
| 364 | - /** |
|
| 365 | - * Returns the list of objects linked to this bean via $pivotTableName. |
|
| 366 | - * |
|
| 367 | - * @param $pivotTableName |
|
| 368 | - * |
|
| 369 | - * @return \SplObjectStorage |
|
| 370 | - */ |
|
| 371 | - private function retrieveRelationshipsStorage($pivotTableName) |
|
| 372 | - { |
|
| 373 | - $storage = $this->getRelationshipStorage($pivotTableName); |
|
| 374 | - if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || (isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName])) { |
|
| 375 | - return $storage; |
|
| 376 | - } |
|
| 377 | - |
|
| 378 | - $beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this); |
|
| 379 | - $this->loadedRelationships[$pivotTableName] = true; |
|
| 380 | - |
|
| 381 | - foreach ($beans as $bean) { |
|
| 382 | - if (isset($storage[$bean])) { |
|
| 383 | - $oldStatus = $storage[$bean]['status']; |
|
| 384 | - if ($oldStatus === 'delete') { |
|
| 385 | - // Keep deleted things deleted |
|
| 386 | - continue; |
|
| 387 | - } |
|
| 388 | - } |
|
| 389 | - $this->setRelationship($pivotTableName, $bean, 'loaded'); |
|
| 390 | - } |
|
| 391 | - |
|
| 392 | - return $storage; |
|
| 393 | - } |
|
| 394 | - |
|
| 395 | - /** |
|
| 396 | - * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName. |
|
| 397 | - * |
|
| 398 | - * @param $pivotTableName |
|
| 399 | - * |
|
| 400 | - * @return AbstractTDBMObject[] |
|
| 401 | - */ |
|
| 402 | - public function _getRelationships($pivotTableName) |
|
| 403 | - { |
|
| 404 | - return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName)); |
|
| 405 | - } |
|
| 406 | - |
|
| 407 | - private function relationshipStorageToArray(\SplObjectStorage $storage) |
|
| 408 | - { |
|
| 409 | - $beans = []; |
|
| 410 | - foreach ($storage as $bean) { |
|
| 411 | - $statusArr = $storage[$bean]; |
|
| 412 | - if ($statusArr['status'] !== 'delete') { |
|
| 413 | - $beans[] = $bean; |
|
| 414 | - } |
|
| 415 | - } |
|
| 416 | - |
|
| 417 | - return $beans; |
|
| 418 | - } |
|
| 419 | - |
|
| 420 | - /** |
|
| 421 | - * Declares a relationship between. |
|
| 422 | - * |
|
| 423 | - * @param string $pivotTableName |
|
| 424 | - * @param AbstractTDBMObject $remoteBean |
|
| 425 | - * @param string $status |
|
| 426 | - */ |
|
| 427 | - private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status) |
|
| 428 | - { |
|
| 429 | - $storage = $this->getRelationshipStorage($pivotTableName); |
|
| 430 | - $storage->attach($remoteBean, ['status' => $status, 'reverse' => false]); |
|
| 431 | - if ($this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
| 432 | - $this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY); |
|
| 433 | - } |
|
| 434 | - |
|
| 435 | - $remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName); |
|
| 436 | - $remoteStorage->attach($this, ['status' => $status, 'reverse' => true]); |
|
| 437 | - } |
|
| 438 | - |
|
| 439 | - /** |
|
| 440 | - * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists). |
|
| 441 | - * |
|
| 442 | - * @param string $pivotTableName |
|
| 443 | - * |
|
| 444 | - * @return \SplObjectStorage |
|
| 445 | - */ |
|
| 446 | - private function getRelationshipStorage(string $pivotTableName) : \SplObjectStorage |
|
| 447 | - { |
|
| 448 | - return $this->relationships[$pivotTableName] ?? $this->relationships[$pivotTableName] = new \SplObjectStorage(); |
|
| 449 | - } |
|
| 450 | - |
|
| 451 | - /** |
|
| 452 | - * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists). |
|
| 453 | - * |
|
| 454 | - * @param string $tableName |
|
| 455 | - * @param string $foreignKeyName |
|
| 456 | - * |
|
| 457 | - * @return AlterableResultIterator |
|
| 458 | - */ |
|
| 459 | - private function getManyToOneAlterableResultIterator(string $tableName, string $foreignKeyName) : AlterableResultIterator |
|
| 460 | - { |
|
| 461 | - $key = $tableName.'___'.$foreignKeyName; |
|
| 462 | - |
|
| 463 | - return $this->manyToOneRelationships[$key] ?? $this->manyToOneRelationships[$key] = new AlterableResultIterator(); |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - /** |
|
| 467 | - * Declares a relationship between this bean and the bean pointing to it. |
|
| 468 | - * |
|
| 469 | - * @param string $tableName |
|
| 470 | - * @param string $foreignKeyName |
|
| 471 | - * @param AbstractTDBMObject $remoteBean |
|
| 472 | - */ |
|
| 473 | - private function setManyToOneRelationship(string $tableName, string $foreignKeyName, AbstractTDBMObject $remoteBean) |
|
| 474 | - { |
|
| 475 | - $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName); |
|
| 476 | - $alterableResultIterator->add($remoteBean); |
|
| 477 | - } |
|
| 478 | - |
|
| 479 | - /** |
|
| 480 | - * Declares a relationship between this bean and the bean pointing to it. |
|
| 481 | - * |
|
| 482 | - * @param string $tableName |
|
| 483 | - * @param string $foreignKeyName |
|
| 484 | - * @param AbstractTDBMObject $remoteBean |
|
| 485 | - */ |
|
| 486 | - private function removeManyToOneRelationship(string $tableName, string $foreignKeyName, AbstractTDBMObject $remoteBean) |
|
| 487 | - { |
|
| 488 | - $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName); |
|
| 489 | - $alterableResultIterator->remove($remoteBean); |
|
| 490 | - } |
|
| 491 | - |
|
| 492 | - /** |
|
| 493 | - * Returns the list of objects linked to this bean via a given foreign key. |
|
| 494 | - * |
|
| 495 | - * @param string $tableName |
|
| 496 | - * @param string $foreignKeyName |
|
| 497 | - * @param string $searchTableName |
|
| 498 | - * @param array $searchFilter |
|
| 499 | - * @param string $orderString The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column). WARNING : This parameter is not kept when there is an additionnal or removal object ! |
|
| 500 | - * |
|
| 501 | - * @return AlterableResultIterator |
|
| 502 | - */ |
|
| 503 | - protected function retrieveManyToOneRelationshipsStorage(string $tableName, string $foreignKeyName, string $searchTableName, array $searchFilter, $orderString = null) : AlterableResultIterator |
|
| 504 | - { |
|
| 505 | - $key = $tableName.'___'.$foreignKeyName; |
|
| 506 | - $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName); |
|
| 507 | - if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || (isset($this->manyToOneRelationships[$key]) && $this->manyToOneRelationships[$key]->getUnderlyingResultIterator() !== null)) { |
|
| 508 | - return $alterableResultIterator; |
|
| 509 | - } |
|
| 510 | - |
|
| 511 | - $unalteredResultIterator = $this->tdbmService->findObjects($searchTableName, $searchFilter, [], $orderString); |
|
| 512 | - |
|
| 513 | - $alterableResultIterator->setResultIterator($unalteredResultIterator->getIterator()); |
|
| 514 | - |
|
| 515 | - return $alterableResultIterator; |
|
| 516 | - } |
|
| 517 | - |
|
| 518 | - /** |
|
| 519 | - * Reverts any changes made to the object and resumes it to its DB state. |
|
| 520 | - * This can only be called on objects that come from database and that have not been deleted. |
|
| 521 | - * Otherwise, this will throw an exception. |
|
| 522 | - * |
|
| 523 | - * @throws TDBMException |
|
| 524 | - */ |
|
| 525 | - public function discardChanges() |
|
| 526 | - { |
|
| 527 | - if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
| 528 | - 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."); |
|
| 529 | - } |
|
| 530 | - |
|
| 531 | - if ($this->status === TDBMObjectStateEnum::STATE_DELETED) { |
|
| 532 | - throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.'); |
|
| 533 | - } |
|
| 534 | - |
|
| 535 | - $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
| 536 | - } |
|
| 537 | - |
|
| 538 | - /** |
|
| 539 | - * Method used internally by TDBM. You should not use it directly. |
|
| 540 | - * This method returns the status of the TDBMObject. |
|
| 541 | - * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
| 542 | - * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
| 543 | - * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
| 544 | - * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
| 545 | - * |
|
| 546 | - * @return string |
|
| 547 | - */ |
|
| 548 | - public function _getStatus() |
|
| 549 | - { |
|
| 550 | - return $this->status; |
|
| 551 | - } |
|
| 552 | - |
|
| 553 | - /** |
|
| 554 | - * Override the native php clone function for TDBMObjects. |
|
| 555 | - */ |
|
| 556 | - public function __clone() |
|
| 557 | - { |
|
| 558 | - // Let's clone the many to many relationships |
|
| 559 | - if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
| 560 | - $pivotTableList = array_keys($this->relationships); |
|
| 561 | - } else { |
|
| 562 | - $pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this); |
|
| 563 | - } |
|
| 564 | - |
|
| 565 | - foreach ($pivotTableList as $pivotTable) { |
|
| 566 | - $storage = $this->retrieveRelationshipsStorage($pivotTable); |
|
| 567 | - |
|
| 568 | - // Let's duplicate the reverse side of the relationship // This is useless: already done by "retrieveRelationshipsStorage"!!! |
|
| 569 | - /*foreach ($storage as $remoteBean) { |
|
| 34 | + /** |
|
| 35 | + * The service this object is bound to. |
|
| 36 | + * |
|
| 37 | + * @var TDBMService |
|
| 38 | + */ |
|
| 39 | + protected $tdbmService; |
|
| 40 | + |
|
| 41 | + /** |
|
| 42 | + * An array of DbRow, indexed by table name. |
|
| 43 | + * |
|
| 44 | + * @var DbRow[] |
|
| 45 | + */ |
|
| 46 | + protected $dbRows = array(); |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
| 50 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
| 51 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
| 52 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
| 53 | + * |
|
| 54 | + * @var string |
|
| 55 | + */ |
|
| 56 | + private $status; |
|
| 57 | + |
|
| 58 | + /** |
|
| 59 | + * Array storing beans related via many to many relationships (pivot tables). |
|
| 60 | + * |
|
| 61 | + * @var \SplObjectStorage[] Key: pivot table name, value: SplObjectStorage |
|
| 62 | + */ |
|
| 63 | + private $relationships = []; |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * @var bool[] Key: pivot table name, value: whether a query was performed to load the data |
|
| 67 | + */ |
|
| 68 | + private $loadedRelationships = []; |
|
| 69 | + |
|
| 70 | + /** |
|
| 71 | + * Array storing beans related via many to one relationships (this bean is pointed by external beans). |
|
| 72 | + * |
|
| 73 | + * @var AlterableResultIterator[] Key: [external_table]___[external_column], value: SplObjectStorage |
|
| 74 | + */ |
|
| 75 | + private $manyToOneRelationships = []; |
|
| 76 | + |
|
| 77 | + /** |
|
| 78 | + * Used with $primaryKeys when we want to retrieve an existing object |
|
| 79 | + * and $primaryKeys=[] if we want a new object. |
|
| 80 | + * |
|
| 81 | + * @param string $tableName |
|
| 82 | + * @param array $primaryKeys |
|
| 83 | + * @param TDBMService $tdbmService |
|
| 84 | + * |
|
| 85 | + * @throws TDBMException |
|
| 86 | + * @throws TDBMInvalidOperationException |
|
| 87 | + */ |
|
| 88 | + public function __construct($tableName = null, array $primaryKeys = array(), TDBMService $tdbmService = null) |
|
| 89 | + { |
|
| 90 | + // FIXME: lazy loading should be forbidden on tables with inheritance and dynamic type assignation... |
|
| 91 | + if (!empty($tableName)) { |
|
| 92 | + $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + if ($tdbmService === null) { |
|
| 96 | + $this->_setStatus(TDBMObjectStateEnum::STATE_DETACHED); |
|
| 97 | + } else { |
|
| 98 | + $this->_attach($tdbmService); |
|
| 99 | + if (!empty($primaryKeys)) { |
|
| 100 | + $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
| 101 | + } else { |
|
| 102 | + $this->_setStatus(TDBMObjectStateEnum::STATE_NEW); |
|
| 103 | + } |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + /** |
|
| 108 | + * Alternative constructor called when data is fetched from database via a SELECT. |
|
| 109 | + * |
|
| 110 | + * @param array $beanData array<table, array<column, value>> |
|
| 111 | + * @param TDBMService $tdbmService |
|
| 112 | + */ |
|
| 113 | + public function _constructFromData(array $beanData, TDBMService $tdbmService) |
|
| 114 | + { |
|
| 115 | + $this->tdbmService = $tdbmService; |
|
| 116 | + |
|
| 117 | + foreach ($beanData as $table => $columns) { |
|
| 118 | + $this->dbRows[$table] = new DbRow($this, $table, $tdbmService->_getPrimaryKeysFromObjectData($table, $columns), $tdbmService, $columns); |
|
| 119 | + } |
|
| 120 | + |
|
| 121 | + $this->status = TDBMObjectStateEnum::STATE_LOADED; |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + /** |
|
| 125 | + * Alternative constructor called when bean is lazily loaded. |
|
| 126 | + * |
|
| 127 | + * @param string $tableName |
|
| 128 | + * @param array $primaryKeys |
|
| 129 | + * @param TDBMService $tdbmService |
|
| 130 | + */ |
|
| 131 | + public function _constructLazy($tableName, array $primaryKeys, TDBMService $tdbmService) |
|
| 132 | + { |
|
| 133 | + $this->tdbmService = $tdbmService; |
|
| 134 | + |
|
| 135 | + $this->dbRows[$tableName] = new DbRow($this, $tableName, $primaryKeys, $tdbmService); |
|
| 136 | + |
|
| 137 | + $this->status = TDBMObjectStateEnum::STATE_NOT_LOADED; |
|
| 138 | + } |
|
| 139 | + |
|
| 140 | + public function _attach(TDBMService $tdbmService) |
|
| 141 | + { |
|
| 142 | + if ($this->status !== TDBMObjectStateEnum::STATE_DETACHED) { |
|
| 143 | + throw new TDBMInvalidOperationException('Cannot attach an object that is already attached to TDBM.'); |
|
| 144 | + } |
|
| 145 | + $this->tdbmService = $tdbmService; |
|
| 146 | + |
|
| 147 | + // If we attach this object, we must work to make sure the tables are in ascending order (from low level to top level) |
|
| 148 | + $tableNames = $this->getUsedTables(); |
|
| 149 | + |
|
| 150 | + $newDbRows = []; |
|
| 151 | + |
|
| 152 | + foreach ($tableNames as $table) { |
|
| 153 | + if (!isset($this->dbRows[$table])) { |
|
| 154 | + $this->registerTable($table); |
|
| 155 | + } |
|
| 156 | + $newDbRows[$table] = $this->dbRows[$table]; |
|
| 157 | + } |
|
| 158 | + $this->dbRows = $newDbRows; |
|
| 159 | + |
|
| 160 | + $this->status = TDBMObjectStateEnum::STATE_NEW; |
|
| 161 | + foreach ($this->dbRows as $dbRow) { |
|
| 162 | + $dbRow->_attach($tdbmService); |
|
| 163 | + } |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + /** |
|
| 167 | + * Sets the state of the TDBM Object |
|
| 168 | + * One of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
| 169 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
| 170 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
| 171 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
| 172 | + * |
|
| 173 | + * @param string $state |
|
| 174 | + */ |
|
| 175 | + public function _setStatus($state) |
|
| 176 | + { |
|
| 177 | + $this->status = $state; |
|
| 178 | + |
|
| 179 | + // TODO: we might ignore the loaded => dirty state here! dirty status comes from the db_row itself. |
|
| 180 | + foreach ($this->dbRows as $dbRow) { |
|
| 181 | + $dbRow->_setStatus($state); |
|
| 182 | + } |
|
| 183 | + } |
|
| 184 | + |
|
| 185 | + /** |
|
| 186 | + * Checks that $tableName is ok, or returns the only possible table name if "$tableName = null" |
|
| 187 | + * or throws an error. |
|
| 188 | + * |
|
| 189 | + * @param string $tableName |
|
| 190 | + * |
|
| 191 | + * @return string |
|
| 192 | + */ |
|
| 193 | + private function checkTableName($tableName = null) |
|
| 194 | + { |
|
| 195 | + if ($tableName === null) { |
|
| 196 | + if (count($this->dbRows) > 1) { |
|
| 197 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
| 198 | + } elseif (count($this->dbRows) === 1) { |
|
| 199 | + $tableName = array_keys($this->dbRows)[0]; |
|
| 200 | + } |
|
| 201 | + } |
|
| 202 | + |
|
| 203 | + if (!isset($this->dbRows[$tableName])) { |
|
| 204 | + if (count($this->dbRows === 0)) { |
|
| 205 | + throw new TDBMException('Object is not yet bound to any table.'); |
|
| 206 | + } else { |
|
| 207 | + throw new TDBMException('Unknown table "'.$tableName.'"" in object.'); |
|
| 208 | + } |
|
| 209 | + } |
|
| 210 | + |
|
| 211 | + return $tableName; |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + protected function get($var, $tableName = null) |
|
| 215 | + { |
|
| 216 | + $tableName = $this->checkTableName($tableName); |
|
| 217 | + |
|
| 218 | + return $this->dbRows[$tableName]->get($var); |
|
| 219 | + } |
|
| 220 | + |
|
| 221 | + protected function set($var, $value, $tableName = null) |
|
| 222 | + { |
|
| 223 | + if ($tableName === null) { |
|
| 224 | + if (count($this->dbRows) > 1) { |
|
| 225 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
| 226 | + } elseif (count($this->dbRows) === 1) { |
|
| 227 | + $tableName = array_keys($this->dbRows)[0]; |
|
| 228 | + } else { |
|
| 229 | + throw new TDBMException('Please specify a table for this object.'); |
|
| 230 | + } |
|
| 231 | + } |
|
| 232 | + |
|
| 233 | + if (!isset($this->dbRows[$tableName])) { |
|
| 234 | + $this->registerTable($tableName); |
|
| 235 | + } |
|
| 236 | + |
|
| 237 | + $this->dbRows[$tableName]->set($var, $value); |
|
| 238 | + if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
| 239 | + $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
| 240 | + } |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * @param string $foreignKeyName |
|
| 245 | + * @param AbstractTDBMObject $bean |
|
| 246 | + */ |
|
| 247 | + protected function setRef($foreignKeyName, AbstractTDBMObject $bean = null, $tableName = null) |
|
| 248 | + { |
|
| 249 | + if ($tableName === null) { |
|
| 250 | + if (count($this->dbRows) > 1) { |
|
| 251 | + throw new TDBMException('This object is based on several tables. You must specify which table you are retrieving data from.'); |
|
| 252 | + } elseif (count($this->dbRows) === 1) { |
|
| 253 | + $tableName = array_keys($this->dbRows)[0]; |
|
| 254 | + } else { |
|
| 255 | + throw new TDBMException('Please specify a table for this object.'); |
|
| 256 | + } |
|
| 257 | + } |
|
| 258 | + |
|
| 259 | + if (!isset($this->dbRows[$tableName])) { |
|
| 260 | + $this->registerTable($tableName); |
|
| 261 | + } |
|
| 262 | + |
|
| 263 | + $oldLinkedBean = $this->dbRows[$tableName]->getRef($foreignKeyName); |
|
| 264 | + if ($oldLinkedBean !== null) { |
|
| 265 | + $oldLinkedBean->removeManyToOneRelationship($tableName, $foreignKeyName, $this); |
|
| 266 | + } |
|
| 267 | + |
|
| 268 | + $this->dbRows[$tableName]->setRef($foreignKeyName, $bean); |
|
| 269 | + if ($this->dbRows[$tableName]->_getStatus() === TDBMObjectStateEnum::STATE_DIRTY) { |
|
| 270 | + $this->status = TDBMObjectStateEnum::STATE_DIRTY; |
|
| 271 | + } |
|
| 272 | + |
|
| 273 | + if ($bean !== null) { |
|
| 274 | + $bean->setManyToOneRelationship($tableName, $foreignKeyName, $this); |
|
| 275 | + } |
|
| 276 | + } |
|
| 277 | + |
|
| 278 | + /** |
|
| 279 | + * @param string $foreignKeyName A unique name for this reference |
|
| 280 | + * |
|
| 281 | + * @return AbstractTDBMObject|null |
|
| 282 | + */ |
|
| 283 | + protected function getRef($foreignKeyName, $tableName = null) |
|
| 284 | + { |
|
| 285 | + $tableName = $this->checkTableName($tableName); |
|
| 286 | + |
|
| 287 | + return $this->dbRows[$tableName]->getRef($foreignKeyName); |
|
| 288 | + } |
|
| 289 | + |
|
| 290 | + /** |
|
| 291 | + * Adds a many to many relationship to this bean. |
|
| 292 | + * |
|
| 293 | + * @param string $pivotTableName |
|
| 294 | + * @param AbstractTDBMObject $remoteBean |
|
| 295 | + */ |
|
| 296 | + protected function addRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
| 297 | + { |
|
| 298 | + $this->setRelationship($pivotTableName, $remoteBean, 'new'); |
|
| 299 | + } |
|
| 300 | + |
|
| 301 | + /** |
|
| 302 | + * Returns true if there is a relationship to this bean. |
|
| 303 | + * |
|
| 304 | + * @param string $pivotTableName |
|
| 305 | + * @param AbstractTDBMObject $remoteBean |
|
| 306 | + * |
|
| 307 | + * @return bool |
|
| 308 | + */ |
|
| 309 | + protected function hasRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
| 310 | + { |
|
| 311 | + $storage = $this->retrieveRelationshipsStorage($pivotTableName); |
|
| 312 | + |
|
| 313 | + if ($storage->contains($remoteBean)) { |
|
| 314 | + if ($storage[$remoteBean]['status'] !== 'delete') { |
|
| 315 | + return true; |
|
| 316 | + } |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + return false; |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + /** |
|
| 323 | + * Internal TDBM method. Removes a many to many relationship from this bean. |
|
| 324 | + * |
|
| 325 | + * @param string $pivotTableName |
|
| 326 | + * @param AbstractTDBMObject $remoteBean |
|
| 327 | + */ |
|
| 328 | + public function _removeRelationship($pivotTableName, AbstractTDBMObject $remoteBean) |
|
| 329 | + { |
|
| 330 | + if (isset($this->relationships[$pivotTableName][$remoteBean]) && $this->relationships[$pivotTableName][$remoteBean]['status'] === 'new') { |
|
| 331 | + unset($this->relationships[$pivotTableName][$remoteBean]); |
|
| 332 | + unset($remoteBean->relationships[$pivotTableName][$this]); |
|
| 333 | + } else { |
|
| 334 | + $this->setRelationship($pivotTableName, $remoteBean, 'delete'); |
|
| 335 | + } |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + /** |
|
| 339 | + * Sets many to many relationships for this bean. |
|
| 340 | + * Adds new relationships and removes unused ones. |
|
| 341 | + * |
|
| 342 | + * @param $pivotTableName |
|
| 343 | + * @param array $remoteBeans |
|
| 344 | + */ |
|
| 345 | + protected function setRelationships($pivotTableName, array $remoteBeans) |
|
| 346 | + { |
|
| 347 | + $storage = $this->retrieveRelationshipsStorage($pivotTableName); |
|
| 348 | + |
|
| 349 | + foreach ($storage as $oldRemoteBean) { |
|
| 350 | + if (!in_array($oldRemoteBean, $remoteBeans, true)) { |
|
| 351 | + // $oldRemoteBean must be removed |
|
| 352 | + $this->_removeRelationship($pivotTableName, $oldRemoteBean); |
|
| 353 | + } |
|
| 354 | + } |
|
| 355 | + |
|
| 356 | + foreach ($remoteBeans as $remoteBean) { |
|
| 357 | + if (!$storage->contains($remoteBean) || $storage[$remoteBean]['status'] === 'delete') { |
|
| 358 | + // $remoteBean must be added |
|
| 359 | + $this->addRelationship($pivotTableName, $remoteBean); |
|
| 360 | + } |
|
| 361 | + } |
|
| 362 | + } |
|
| 363 | + |
|
| 364 | + /** |
|
| 365 | + * Returns the list of objects linked to this bean via $pivotTableName. |
|
| 366 | + * |
|
| 367 | + * @param $pivotTableName |
|
| 368 | + * |
|
| 369 | + * @return \SplObjectStorage |
|
| 370 | + */ |
|
| 371 | + private function retrieveRelationshipsStorage($pivotTableName) |
|
| 372 | + { |
|
| 373 | + $storage = $this->getRelationshipStorage($pivotTableName); |
|
| 374 | + if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || (isset($this->loadedRelationships[$pivotTableName]) && $this->loadedRelationships[$pivotTableName])) { |
|
| 375 | + return $storage; |
|
| 376 | + } |
|
| 377 | + |
|
| 378 | + $beans = $this->tdbmService->_getRelatedBeans($pivotTableName, $this); |
|
| 379 | + $this->loadedRelationships[$pivotTableName] = true; |
|
| 380 | + |
|
| 381 | + foreach ($beans as $bean) { |
|
| 382 | + if (isset($storage[$bean])) { |
|
| 383 | + $oldStatus = $storage[$bean]['status']; |
|
| 384 | + if ($oldStatus === 'delete') { |
|
| 385 | + // Keep deleted things deleted |
|
| 386 | + continue; |
|
| 387 | + } |
|
| 388 | + } |
|
| 389 | + $this->setRelationship($pivotTableName, $bean, 'loaded'); |
|
| 390 | + } |
|
| 391 | + |
|
| 392 | + return $storage; |
|
| 393 | + } |
|
| 394 | + |
|
| 395 | + /** |
|
| 396 | + * Internal TDBM method. Returns the list of objects linked to this bean via $pivotTableName. |
|
| 397 | + * |
|
| 398 | + * @param $pivotTableName |
|
| 399 | + * |
|
| 400 | + * @return AbstractTDBMObject[] |
|
| 401 | + */ |
|
| 402 | + public function _getRelationships($pivotTableName) |
|
| 403 | + { |
|
| 404 | + return $this->relationshipStorageToArray($this->retrieveRelationshipsStorage($pivotTableName)); |
|
| 405 | + } |
|
| 406 | + |
|
| 407 | + private function relationshipStorageToArray(\SplObjectStorage $storage) |
|
| 408 | + { |
|
| 409 | + $beans = []; |
|
| 410 | + foreach ($storage as $bean) { |
|
| 411 | + $statusArr = $storage[$bean]; |
|
| 412 | + if ($statusArr['status'] !== 'delete') { |
|
| 413 | + $beans[] = $bean; |
|
| 414 | + } |
|
| 415 | + } |
|
| 416 | + |
|
| 417 | + return $beans; |
|
| 418 | + } |
|
| 419 | + |
|
| 420 | + /** |
|
| 421 | + * Declares a relationship between. |
|
| 422 | + * |
|
| 423 | + * @param string $pivotTableName |
|
| 424 | + * @param AbstractTDBMObject $remoteBean |
|
| 425 | + * @param string $status |
|
| 426 | + */ |
|
| 427 | + private function setRelationship($pivotTableName, AbstractTDBMObject $remoteBean, $status) |
|
| 428 | + { |
|
| 429 | + $storage = $this->getRelationshipStorage($pivotTableName); |
|
| 430 | + $storage->attach($remoteBean, ['status' => $status, 'reverse' => false]); |
|
| 431 | + if ($this->status === TDBMObjectStateEnum::STATE_LOADED) { |
|
| 432 | + $this->_setStatus(TDBMObjectStateEnum::STATE_DIRTY); |
|
| 433 | + } |
|
| 434 | + |
|
| 435 | + $remoteStorage = $remoteBean->getRelationshipStorage($pivotTableName); |
|
| 436 | + $remoteStorage->attach($this, ['status' => $status, 'reverse' => true]); |
|
| 437 | + } |
|
| 438 | + |
|
| 439 | + /** |
|
| 440 | + * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists). |
|
| 441 | + * |
|
| 442 | + * @param string $pivotTableName |
|
| 443 | + * |
|
| 444 | + * @return \SplObjectStorage |
|
| 445 | + */ |
|
| 446 | + private function getRelationshipStorage(string $pivotTableName) : \SplObjectStorage |
|
| 447 | + { |
|
| 448 | + return $this->relationships[$pivotTableName] ?? $this->relationships[$pivotTableName] = new \SplObjectStorage(); |
|
| 449 | + } |
|
| 450 | + |
|
| 451 | + /** |
|
| 452 | + * Returns the SplObjectStorage associated to this relationship (creates it if it does not exists). |
|
| 453 | + * |
|
| 454 | + * @param string $tableName |
|
| 455 | + * @param string $foreignKeyName |
|
| 456 | + * |
|
| 457 | + * @return AlterableResultIterator |
|
| 458 | + */ |
|
| 459 | + private function getManyToOneAlterableResultIterator(string $tableName, string $foreignKeyName) : AlterableResultIterator |
|
| 460 | + { |
|
| 461 | + $key = $tableName.'___'.$foreignKeyName; |
|
| 462 | + |
|
| 463 | + return $this->manyToOneRelationships[$key] ?? $this->manyToOneRelationships[$key] = new AlterableResultIterator(); |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + /** |
|
| 467 | + * Declares a relationship between this bean and the bean pointing to it. |
|
| 468 | + * |
|
| 469 | + * @param string $tableName |
|
| 470 | + * @param string $foreignKeyName |
|
| 471 | + * @param AbstractTDBMObject $remoteBean |
|
| 472 | + */ |
|
| 473 | + private function setManyToOneRelationship(string $tableName, string $foreignKeyName, AbstractTDBMObject $remoteBean) |
|
| 474 | + { |
|
| 475 | + $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName); |
|
| 476 | + $alterableResultIterator->add($remoteBean); |
|
| 477 | + } |
|
| 478 | + |
|
| 479 | + /** |
|
| 480 | + * Declares a relationship between this bean and the bean pointing to it. |
|
| 481 | + * |
|
| 482 | + * @param string $tableName |
|
| 483 | + * @param string $foreignKeyName |
|
| 484 | + * @param AbstractTDBMObject $remoteBean |
|
| 485 | + */ |
|
| 486 | + private function removeManyToOneRelationship(string $tableName, string $foreignKeyName, AbstractTDBMObject $remoteBean) |
|
| 487 | + { |
|
| 488 | + $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName); |
|
| 489 | + $alterableResultIterator->remove($remoteBean); |
|
| 490 | + } |
|
| 491 | + |
|
| 492 | + /** |
|
| 493 | + * Returns the list of objects linked to this bean via a given foreign key. |
|
| 494 | + * |
|
| 495 | + * @param string $tableName |
|
| 496 | + * @param string $foreignKeyName |
|
| 497 | + * @param string $searchTableName |
|
| 498 | + * @param array $searchFilter |
|
| 499 | + * @param string $orderString The ORDER BY part of the query. All columns must be prefixed by the table name (in the form: table.column). WARNING : This parameter is not kept when there is an additionnal or removal object ! |
|
| 500 | + * |
|
| 501 | + * @return AlterableResultIterator |
|
| 502 | + */ |
|
| 503 | + protected function retrieveManyToOneRelationshipsStorage(string $tableName, string $foreignKeyName, string $searchTableName, array $searchFilter, $orderString = null) : AlterableResultIterator |
|
| 504 | + { |
|
| 505 | + $key = $tableName.'___'.$foreignKeyName; |
|
| 506 | + $alterableResultIterator = $this->getManyToOneAlterableResultIterator($tableName, $foreignKeyName); |
|
| 507 | + if ($this->status === TDBMObjectStateEnum::STATE_DETACHED || $this->status === TDBMObjectStateEnum::STATE_NEW || (isset($this->manyToOneRelationships[$key]) && $this->manyToOneRelationships[$key]->getUnderlyingResultIterator() !== null)) { |
|
| 508 | + return $alterableResultIterator; |
|
| 509 | + } |
|
| 510 | + |
|
| 511 | + $unalteredResultIterator = $this->tdbmService->findObjects($searchTableName, $searchFilter, [], $orderString); |
|
| 512 | + |
|
| 513 | + $alterableResultIterator->setResultIterator($unalteredResultIterator->getIterator()); |
|
| 514 | + |
|
| 515 | + return $alterableResultIterator; |
|
| 516 | + } |
|
| 517 | + |
|
| 518 | + /** |
|
| 519 | + * Reverts any changes made to the object and resumes it to its DB state. |
|
| 520 | + * This can only be called on objects that come from database and that have not been deleted. |
|
| 521 | + * Otherwise, this will throw an exception. |
|
| 522 | + * |
|
| 523 | + * @throws TDBMException |
|
| 524 | + */ |
|
| 525 | + public function discardChanges() |
|
| 526 | + { |
|
| 527 | + if ($this->status === TDBMObjectStateEnum::STATE_NEW || $this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
| 528 | + 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."); |
|
| 529 | + } |
|
| 530 | + |
|
| 531 | + if ($this->status === TDBMObjectStateEnum::STATE_DELETED) { |
|
| 532 | + throw new TDBMException('You cannot call discardChanges() on an object that has been deleted.'); |
|
| 533 | + } |
|
| 534 | + |
|
| 535 | + $this->_setStatus(TDBMObjectStateEnum::STATE_NOT_LOADED); |
|
| 536 | + } |
|
| 537 | + |
|
| 538 | + /** |
|
| 539 | + * Method used internally by TDBM. You should not use it directly. |
|
| 540 | + * This method returns the status of the TDBMObject. |
|
| 541 | + * This is one of TDBMObjectStateEnum::STATE_NEW, TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DELETED. |
|
| 542 | + * $status = TDBMObjectStateEnum::STATE_NEW when a new object is created with DBMObject:getNewObject. |
|
| 543 | + * $status = TDBMObjectStateEnum::STATE_NOT_LOADED when the object has been retrieved with getObject but when no data has been accessed in it yet. |
|
| 544 | + * $status = TDBMObjectStateEnum::STATE_LOADED when the object is cached in memory. |
|
| 545 | + * |
|
| 546 | + * @return string |
|
| 547 | + */ |
|
| 548 | + public function _getStatus() |
|
| 549 | + { |
|
| 550 | + return $this->status; |
|
| 551 | + } |
|
| 552 | + |
|
| 553 | + /** |
|
| 554 | + * Override the native php clone function for TDBMObjects. |
|
| 555 | + */ |
|
| 556 | + public function __clone() |
|
| 557 | + { |
|
| 558 | + // Let's clone the many to many relationships |
|
| 559 | + if ($this->status === TDBMObjectStateEnum::STATE_DETACHED) { |
|
| 560 | + $pivotTableList = array_keys($this->relationships); |
|
| 561 | + } else { |
|
| 562 | + $pivotTableList = $this->tdbmService->_getPivotTablesLinkedToBean($this); |
|
| 563 | + } |
|
| 564 | + |
|
| 565 | + foreach ($pivotTableList as $pivotTable) { |
|
| 566 | + $storage = $this->retrieveRelationshipsStorage($pivotTable); |
|
| 567 | + |
|
| 568 | + // Let's duplicate the reverse side of the relationship // This is useless: already done by "retrieveRelationshipsStorage"!!! |
|
| 569 | + /*foreach ($storage as $remoteBean) { |
|
| 570 | 570 | $metadata = $storage[$remoteBean]; |
| 571 | 571 | |
| 572 | 572 | $remoteStorage = $remoteBean->getRelationshipStorage($pivotTable); |
| 573 | 573 | $remoteStorage->attach($this, ['status' => $metadata['status'], 'reverse' => !$metadata['reverse']]); |
| 574 | 574 | }*/ |
| 575 | - } |
|
| 576 | - |
|
| 577 | - // Let's clone each row |
|
| 578 | - foreach ($this->dbRows as $key => &$dbRow) { |
|
| 579 | - $dbRow = clone $dbRow; |
|
| 580 | - $dbRow->setTDBMObject($this); |
|
| 581 | - } |
|
| 582 | - |
|
| 583 | - $this->manyToOneRelationships = []; |
|
| 584 | - |
|
| 585 | - // Let's set the status to new (to enter the save function) |
|
| 586 | - $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
| 587 | - } |
|
| 588 | - |
|
| 589 | - /** |
|
| 590 | - * Returns raw database rows. |
|
| 591 | - * |
|
| 592 | - * @return DbRow[] Key: table name, Value: DbRow object |
|
| 593 | - */ |
|
| 594 | - public function _getDbRows() |
|
| 595 | - { |
|
| 596 | - return $this->dbRows; |
|
| 597 | - } |
|
| 598 | - |
|
| 599 | - private function registerTable($tableName) |
|
| 600 | - { |
|
| 601 | - $dbRow = new DbRow($this, $tableName); |
|
| 602 | - |
|
| 603 | - if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) { |
|
| 604 | - // Let's get the primary key for the new table |
|
| 605 | - $anotherDbRow = array_values($this->dbRows)[0]; |
|
| 606 | - /* @var $anotherDbRow DbRow */ |
|
| 607 | - $indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys()); |
|
| 608 | - $primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys); |
|
| 609 | - $dbRow->_setPrimaryKeys($primaryKeys); |
|
| 610 | - } |
|
| 611 | - |
|
| 612 | - $dbRow->_setStatus($this->status); |
|
| 613 | - |
|
| 614 | - $this->dbRows[$tableName] = $dbRow; |
|
| 615 | - // TODO: look at status (if not new)=> get primary key from tdbmservice |
|
| 616 | - } |
|
| 617 | - |
|
| 618 | - /** |
|
| 619 | - * Internal function: return the list of relationships. |
|
| 620 | - * |
|
| 621 | - * @return \SplObjectStorage[] |
|
| 622 | - */ |
|
| 623 | - public function _getCachedRelationships() |
|
| 624 | - { |
|
| 625 | - return $this->relationships; |
|
| 626 | - } |
|
| 627 | - |
|
| 628 | - /** |
|
| 629 | - * Returns an array of used tables by this bean (from parent to child relationship). |
|
| 630 | - * |
|
| 631 | - * @return string[] |
|
| 632 | - */ |
|
| 633 | - abstract protected function getUsedTables(); |
|
| 575 | + } |
|
| 576 | + |
|
| 577 | + // Let's clone each row |
|
| 578 | + foreach ($this->dbRows as $key => &$dbRow) { |
|
| 579 | + $dbRow = clone $dbRow; |
|
| 580 | + $dbRow->setTDBMObject($this); |
|
| 581 | + } |
|
| 582 | + |
|
| 583 | + $this->manyToOneRelationships = []; |
|
| 584 | + |
|
| 585 | + // Let's set the status to new (to enter the save function) |
|
| 586 | + $this->status = TDBMObjectStateEnum::STATE_DETACHED; |
|
| 587 | + } |
|
| 588 | + |
|
| 589 | + /** |
|
| 590 | + * Returns raw database rows. |
|
| 591 | + * |
|
| 592 | + * @return DbRow[] Key: table name, Value: DbRow object |
|
| 593 | + */ |
|
| 594 | + public function _getDbRows() |
|
| 595 | + { |
|
| 596 | + return $this->dbRows; |
|
| 597 | + } |
|
| 598 | + |
|
| 599 | + private function registerTable($tableName) |
|
| 600 | + { |
|
| 601 | + $dbRow = new DbRow($this, $tableName); |
|
| 602 | + |
|
| 603 | + if (in_array($this->status, [TDBMObjectStateEnum::STATE_NOT_LOADED, TDBMObjectStateEnum::STATE_LOADED, TDBMObjectStateEnum::STATE_DIRTY])) { |
|
| 604 | + // Let's get the primary key for the new table |
|
| 605 | + $anotherDbRow = array_values($this->dbRows)[0]; |
|
| 606 | + /* @var $anotherDbRow DbRow */ |
|
| 607 | + $indexedPrimaryKeys = array_values($anotherDbRow->_getPrimaryKeys()); |
|
| 608 | + $primaryKeys = $this->tdbmService->_getPrimaryKeysFromIndexedPrimaryKeys($tableName, $indexedPrimaryKeys); |
|
| 609 | + $dbRow->_setPrimaryKeys($primaryKeys); |
|
| 610 | + } |
|
| 611 | + |
|
| 612 | + $dbRow->_setStatus($this->status); |
|
| 613 | + |
|
| 614 | + $this->dbRows[$tableName] = $dbRow; |
|
| 615 | + // TODO: look at status (if not new)=> get primary key from tdbmservice |
|
| 616 | + } |
|
| 617 | + |
|
| 618 | + /** |
|
| 619 | + * Internal function: return the list of relationships. |
|
| 620 | + * |
|
| 621 | + * @return \SplObjectStorage[] |
|
| 622 | + */ |
|
| 623 | + public function _getCachedRelationships() |
|
| 624 | + { |
|
| 625 | + return $this->relationships; |
|
| 626 | + } |
|
| 627 | + |
|
| 628 | + /** |
|
| 629 | + * Returns an array of used tables by this bean (from parent to child relationship). |
|
| 630 | + * |
|
| 631 | + * @return string[] |
|
| 632 | + */ |
|
| 633 | + abstract protected function getUsedTables(); |
|
| 634 | 634 | } |