@@ -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 = TDBMDaoGenerator::dbalTypeToPhpType($table->getColumn($primaryKeyColumn)->getType()); |
|
381 | - $str .= " |
|
378 | + if (count($primaryKeyColumns) === 1) { |
|
379 | + $primaryKeyColumn = $primaryKeyColumns[0]; |
|
380 | + $primaryKeyPhpType = TDBMDaoGenerator::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 | } |