@@ -4,7 +4,6 @@ |
||
| 4 | 4 | |
| 5 | 5 | use Doctrine\Common\Inflector\Inflector; |
| 6 | 6 | use Doctrine\DBAL\Driver\Connection; |
| 7 | -use Doctrine\DBAL\Schema\Column; |
|
| 8 | 7 | use Doctrine\DBAL\Schema\Schema; |
| 9 | 8 | use Doctrine\DBAL\Schema\Table; |
| 10 | 9 | use Doctrine\DBAL\Types\Type; |
@@ -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 | } |
@@ -8,7 +8,7 @@ |
||
| 8 | 8 | <input type="hidden" id="selfedit" name="selfedit" value="<?php echo plainstring_to_htmlprotected($this->selfedit) ?>" /> |
| 9 | 9 | |
| 10 | 10 | <?php if (!$this->autoloadDetected) { |
| 11 | - ?> |
|
| 11 | + ?> |
|
| 12 | 12 | <div class="alert">Warning! TDBM could not detect the autoload section of your composer.json file. |
| 13 | 13 | Unless you are developing your own autoload system, you should configure <strong>composer.json</strong> to <a href="http://getcomposer.org/doc/01-basic-usage.md#autoloading" target="_blank">define a source directory and a root namespace using PSR-0</a>.</div> |
| 14 | 14 | <?php |
@@ -31,117 +31,117 @@ |
||
| 31 | 31 | */ |
| 32 | 32 | class WeakrefObjectStorage |
| 33 | 33 | { |
| 34 | - /** |
|
| 35 | - * An array of fetched object, accessible via table name and primary key. |
|
| 36 | - * If the primary key is split on several columns, access is done by an array of columns, serialized. |
|
| 37 | - * |
|
| 38 | - * @var array<string, WeakMap<string, TDBMObject>> |
|
| 39 | - */ |
|
| 40 | - private $objects = array(); |
|
| 34 | + /** |
|
| 35 | + * An array of fetched object, accessible via table name and primary key. |
|
| 36 | + * If the primary key is split on several columns, access is done by an array of columns, serialized. |
|
| 37 | + * |
|
| 38 | + * @var array<string, WeakMap<string, TDBMObject>> |
|
| 39 | + */ |
|
| 40 | + private $objects = array(); |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * Every 10000 set in the dataset, we perform a cleanup to ensure the WeakRef instances |
|
| 44 | - * are removed if they are no more valid. |
|
| 45 | - * This is to avoid having memory used by dangling WeakRef instances. |
|
| 46 | - * |
|
| 47 | - * @var int |
|
| 48 | - */ |
|
| 49 | - private $garbageCollectorCount = 0; |
|
| 42 | + /** |
|
| 43 | + * Every 10000 set in the dataset, we perform a cleanup to ensure the WeakRef instances |
|
| 44 | + * are removed if they are no more valid. |
|
| 45 | + * This is to avoid having memory used by dangling WeakRef instances. |
|
| 46 | + * |
|
| 47 | + * @var int |
|
| 48 | + */ |
|
| 49 | + private $garbageCollectorCount = 0; |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * Sets an object in the storage. |
|
| 53 | - * |
|
| 54 | - * @param string $tableName |
|
| 55 | - * @param string $id |
|
| 56 | - * @param DbRow $dbRow |
|
| 57 | - */ |
|
| 58 | - public function set($tableName, $id, DbRow $dbRow) |
|
| 59 | - { |
|
| 60 | - $this->objects[$tableName][$id] = new \WeakRef($dbRow); |
|
| 61 | - ++$this->garbageCollectorCount; |
|
| 62 | - if ($this->garbageCollectorCount == 10000) { |
|
| 63 | - $this->garbageCollectorCount = 0; |
|
| 64 | - $this->cleanupDanglingWeakRefs(); |
|
| 65 | - } |
|
| 66 | - } |
|
| 51 | + /** |
|
| 52 | + * Sets an object in the storage. |
|
| 53 | + * |
|
| 54 | + * @param string $tableName |
|
| 55 | + * @param string $id |
|
| 56 | + * @param DbRow $dbRow |
|
| 57 | + */ |
|
| 58 | + public function set($tableName, $id, DbRow $dbRow) |
|
| 59 | + { |
|
| 60 | + $this->objects[$tableName][$id] = new \WeakRef($dbRow); |
|
| 61 | + ++$this->garbageCollectorCount; |
|
| 62 | + if ($this->garbageCollectorCount == 10000) { |
|
| 63 | + $this->garbageCollectorCount = 0; |
|
| 64 | + $this->cleanupDanglingWeakRefs(); |
|
| 65 | + } |
|
| 66 | + } |
|
| 67 | 67 | |
| 68 | - /** |
|
| 69 | - * Checks if an object is in the storage. |
|
| 70 | - * |
|
| 71 | - * @param string $tableName |
|
| 72 | - * @param string $id |
|
| 73 | - * |
|
| 74 | - * @return bool |
|
| 75 | - */ |
|
| 76 | - public function has($tableName, $id) |
|
| 77 | - { |
|
| 78 | - if (isset($this->objects[$tableName][$id])) { |
|
| 79 | - if ($this->objects[$tableName][$id]->valid()) { |
|
| 80 | - return true; |
|
| 81 | - } else { |
|
| 82 | - unset($this->objects[$tableName][$id]); |
|
| 83 | - } |
|
| 84 | - } |
|
| 68 | + /** |
|
| 69 | + * Checks if an object is in the storage. |
|
| 70 | + * |
|
| 71 | + * @param string $tableName |
|
| 72 | + * @param string $id |
|
| 73 | + * |
|
| 74 | + * @return bool |
|
| 75 | + */ |
|
| 76 | + public function has($tableName, $id) |
|
| 77 | + { |
|
| 78 | + if (isset($this->objects[$tableName][$id])) { |
|
| 79 | + if ($this->objects[$tableName][$id]->valid()) { |
|
| 80 | + return true; |
|
| 81 | + } else { |
|
| 82 | + unset($this->objects[$tableName][$id]); |
|
| 83 | + } |
|
| 84 | + } |
|
| 85 | 85 | |
| 86 | - return false; |
|
| 87 | - } |
|
| 86 | + return false; |
|
| 87 | + } |
|
| 88 | 88 | |
| 89 | - /** |
|
| 90 | - * Returns an object from the storage (or null if no object is set). |
|
| 91 | - * |
|
| 92 | - * @param string $tableName |
|
| 93 | - * @param string $id |
|
| 94 | - * |
|
| 95 | - * @return DbRow |
|
| 96 | - */ |
|
| 97 | - public function get($tableName, $id) |
|
| 98 | - { |
|
| 99 | - if (isset($this->objects[$tableName][$id])) { |
|
| 100 | - if ($this->objects[$tableName][$id]->valid()) { |
|
| 101 | - return $this->objects[$tableName][$id]->get(); |
|
| 102 | - } |
|
| 103 | - } else { |
|
| 104 | - return; |
|
| 105 | - } |
|
| 106 | - } |
|
| 89 | + /** |
|
| 90 | + * Returns an object from the storage (or null if no object is set). |
|
| 91 | + * |
|
| 92 | + * @param string $tableName |
|
| 93 | + * @param string $id |
|
| 94 | + * |
|
| 95 | + * @return DbRow |
|
| 96 | + */ |
|
| 97 | + public function get($tableName, $id) |
|
| 98 | + { |
|
| 99 | + if (isset($this->objects[$tableName][$id])) { |
|
| 100 | + if ($this->objects[$tableName][$id]->valid()) { |
|
| 101 | + return $this->objects[$tableName][$id]->get(); |
|
| 102 | + } |
|
| 103 | + } else { |
|
| 104 | + return; |
|
| 105 | + } |
|
| 106 | + } |
|
| 107 | 107 | |
| 108 | - /** |
|
| 109 | - * Removes an object from the storage. |
|
| 110 | - * |
|
| 111 | - * @param string $tableName |
|
| 112 | - * @param string $id |
|
| 113 | - */ |
|
| 114 | - public function remove($tableName, $id) |
|
| 115 | - { |
|
| 116 | - unset($this->objects[$tableName][$id]); |
|
| 117 | - } |
|
| 108 | + /** |
|
| 109 | + * Removes an object from the storage. |
|
| 110 | + * |
|
| 111 | + * @param string $tableName |
|
| 112 | + * @param string $id |
|
| 113 | + */ |
|
| 114 | + public function remove($tableName, $id) |
|
| 115 | + { |
|
| 116 | + unset($this->objects[$tableName][$id]); |
|
| 117 | + } |
|
| 118 | 118 | |
| 119 | - /** |
|
| 120 | - * Applies the callback to all objects. |
|
| 121 | - * |
|
| 122 | - * @param callable $callback |
|
| 123 | - */ |
|
| 124 | - public function apply(callable $callback) |
|
| 125 | - { |
|
| 126 | - foreach ($this->objects as $tableName => $table) { |
|
| 127 | - foreach ($table as $id => $obj) { |
|
| 128 | - if ($obj->valid()) { |
|
| 129 | - $callback($obj->get(), $tableName, $id); |
|
| 130 | - } else { |
|
| 131 | - unset($this->objects[$tableName][$id]); |
|
| 132 | - } |
|
| 133 | - } |
|
| 134 | - } |
|
| 135 | - } |
|
| 119 | + /** |
|
| 120 | + * Applies the callback to all objects. |
|
| 121 | + * |
|
| 122 | + * @param callable $callback |
|
| 123 | + */ |
|
| 124 | + public function apply(callable $callback) |
|
| 125 | + { |
|
| 126 | + foreach ($this->objects as $tableName => $table) { |
|
| 127 | + foreach ($table as $id => $obj) { |
|
| 128 | + if ($obj->valid()) { |
|
| 129 | + $callback($obj->get(), $tableName, $id); |
|
| 130 | + } else { |
|
| 131 | + unset($this->objects[$tableName][$id]); |
|
| 132 | + } |
|
| 133 | + } |
|
| 134 | + } |
|
| 135 | + } |
|
| 136 | 136 | |
| 137 | - private function cleanupDanglingWeakRefs() |
|
| 138 | - { |
|
| 139 | - foreach ($this->objects as $tableName => $table) { |
|
| 140 | - foreach ($table as $id => $obj) { |
|
| 141 | - if (!$obj->valid()) { |
|
| 142 | - unset($this->objects[$tableName][$id]); |
|
| 143 | - } |
|
| 144 | - } |
|
| 145 | - } |
|
| 146 | - } |
|
| 137 | + private function cleanupDanglingWeakRefs() |
|
| 138 | + { |
|
| 139 | + foreach ($this->objects as $tableName => $table) { |
|
| 140 | + foreach ($table as $id => $obj) { |
|
| 141 | + if (!$obj->valid()) { |
|
| 142 | + unset($this->objects[$tableName][$id]); |
|
| 143 | + } |
|
| 144 | + } |
|
| 145 | + } |
|
| 146 | + } |
|
| 147 | 147 | } |
@@ -27,10 +27,10 @@ |
||
| 27 | 27 | */ |
| 28 | 28 | final class TDBMObjectStateEnum extends AbstractTDBMObject |
| 29 | 29 | { |
| 30 | - const STATE_DETACHED = 'detached'; |
|
| 31 | - const STATE_NEW = 'new'; |
|
| 32 | - const STATE_NOT_LOADED = 'not loaded'; |
|
| 33 | - const STATE_LOADED = 'loaded'; |
|
| 34 | - const STATE_DIRTY = 'dirty'; |
|
| 35 | - const STATE_DELETED = 'deleted'; |
|
| 30 | + const STATE_DETACHED = 'detached'; |
|
| 31 | + const STATE_NEW = 'new'; |
|
| 32 | + const STATE_NOT_LOADED = 'not loaded'; |
|
| 33 | + const STATE_LOADED = 'loaded'; |
|
| 34 | + const STATE_DIRTY = 'dirty'; |
|
| 35 | + const STATE_DELETED = 'deleted'; |
|
| 36 | 36 | } |
@@ -30,78 +30,78 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | class StandardObjectStorage |
| 32 | 32 | { |
| 33 | - /** |
|
| 34 | - * An array of fetched object, accessible via table name and primary key. |
|
| 35 | - * If the primary key is split on several columns, access is done by an array of columns, serialized. |
|
| 36 | - * |
|
| 37 | - * @var array<string, array<string, TDBMObject>> |
|
| 38 | - */ |
|
| 39 | - private $objects = array(); |
|
| 33 | + /** |
|
| 34 | + * An array of fetched object, accessible via table name and primary key. |
|
| 35 | + * If the primary key is split on several columns, access is done by an array of columns, serialized. |
|
| 36 | + * |
|
| 37 | + * @var array<string, array<string, TDBMObject>> |
|
| 38 | + */ |
|
| 39 | + private $objects = array(); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * Sets an object in the storage. |
|
| 43 | - * |
|
| 44 | - * @param string $tableName |
|
| 45 | - * @param string $id |
|
| 46 | - * @param TDBMObject $dbRow |
|
| 47 | - */ |
|
| 48 | - public function set($tableName, $id, DbRow $dbRow) |
|
| 49 | - { |
|
| 50 | - $this->objects[$tableName][$id] = $dbRow; |
|
| 51 | - } |
|
| 41 | + /** |
|
| 42 | + * Sets an object in the storage. |
|
| 43 | + * |
|
| 44 | + * @param string $tableName |
|
| 45 | + * @param string $id |
|
| 46 | + * @param TDBMObject $dbRow |
|
| 47 | + */ |
|
| 48 | + public function set($tableName, $id, DbRow $dbRow) |
|
| 49 | + { |
|
| 50 | + $this->objects[$tableName][$id] = $dbRow; |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Checks if an object is in the storage. |
|
| 55 | - * |
|
| 56 | - * @param string $tableName |
|
| 57 | - * @param string $id |
|
| 58 | - * |
|
| 59 | - * @return bool |
|
| 60 | - */ |
|
| 61 | - public function has($tableName, $id) |
|
| 62 | - { |
|
| 63 | - return isset($this->objects[$tableName][$id]); |
|
| 64 | - } |
|
| 53 | + /** |
|
| 54 | + * Checks if an object is in the storage. |
|
| 55 | + * |
|
| 56 | + * @param string $tableName |
|
| 57 | + * @param string $id |
|
| 58 | + * |
|
| 59 | + * @return bool |
|
| 60 | + */ |
|
| 61 | + public function has($tableName, $id) |
|
| 62 | + { |
|
| 63 | + return isset($this->objects[$tableName][$id]); |
|
| 64 | + } |
|
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Returns an object from the storage (or null if no object is set). |
|
| 68 | - * |
|
| 69 | - * @param string $tableName |
|
| 70 | - * @param string $id |
|
| 71 | - * |
|
| 72 | - * @return DbRow |
|
| 73 | - */ |
|
| 74 | - public function get($tableName, $id) |
|
| 75 | - { |
|
| 76 | - if (isset($this->objects[$tableName][$id])) { |
|
| 77 | - return $this->objects[$tableName][$id]; |
|
| 78 | - } else { |
|
| 79 | - return; |
|
| 80 | - } |
|
| 81 | - } |
|
| 66 | + /** |
|
| 67 | + * Returns an object from the storage (or null if no object is set). |
|
| 68 | + * |
|
| 69 | + * @param string $tableName |
|
| 70 | + * @param string $id |
|
| 71 | + * |
|
| 72 | + * @return DbRow |
|
| 73 | + */ |
|
| 74 | + public function get($tableName, $id) |
|
| 75 | + { |
|
| 76 | + if (isset($this->objects[$tableName][$id])) { |
|
| 77 | + return $this->objects[$tableName][$id]; |
|
| 78 | + } else { |
|
| 79 | + return; |
|
| 80 | + } |
|
| 81 | + } |
|
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * Removes an object from the storage. |
|
| 85 | - * |
|
| 86 | - * @param string $tableName |
|
| 87 | - * @param string $id |
|
| 88 | - */ |
|
| 89 | - public function remove($tableName, $id) |
|
| 90 | - { |
|
| 91 | - unset($this->objects[$tableName][$id]); |
|
| 92 | - } |
|
| 83 | + /** |
|
| 84 | + * Removes an object from the storage. |
|
| 85 | + * |
|
| 86 | + * @param string $tableName |
|
| 87 | + * @param string $id |
|
| 88 | + */ |
|
| 89 | + public function remove($tableName, $id) |
|
| 90 | + { |
|
| 91 | + unset($this->objects[$tableName][$id]); |
|
| 92 | + } |
|
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Applies the callback to all objects. |
|
| 96 | - * |
|
| 97 | - * @param callable $callback |
|
| 98 | - */ |
|
| 99 | - public function apply(callable $callback) |
|
| 100 | - { |
|
| 101 | - foreach ($this->objects as $tableName => $table) { |
|
| 102 | - foreach ($table as $id => $obj) { |
|
| 103 | - $callback($obj, $tableName, $id); |
|
| 104 | - } |
|
| 105 | - } |
|
| 106 | - } |
|
| 94 | + /** |
|
| 95 | + * Applies the callback to all objects. |
|
| 96 | + * |
|
| 97 | + * @param callable $callback |
|
| 98 | + */ |
|
| 99 | + public function apply(callable $callback) |
|
| 100 | + { |
|
| 101 | + foreach ($this->objects as $tableName => $table) { |
|
| 102 | + foreach ($table as $id => $obj) { |
|
| 103 | + $callback($obj, $tableName, $id); |
|
| 104 | + } |
|
| 105 | + } |
|
| 106 | + } |
|
| 107 | 107 | } |
@@ -8,7 +8,7 @@ |
||
| 8 | 8 | <input type="hidden" id="selfedit" name="selfedit" value="<?php echo plainstring_to_htmlprotected($this->selfedit) ?>" /> |
| 9 | 9 | |
| 10 | 10 | <?php if (!$this->autoloadDetected) { |
| 11 | - ?> |
|
| 11 | + ?> |
|
| 12 | 12 | <div class="alert">Warning! TDBM could not detect the autoload section of your composer.json file. |
| 13 | 13 | Unless you are developing your own autoload system, you should configure <strong>composer.json</strong> to <a href="http://getcomposer.org/doc/01-basic-usage.md#autoloading" target="_blank">define a source directory and a root namespace using PSR-0</a>.</div> |
| 14 | 14 | <?php |
@@ -18,148 +18,148 @@ |
||
| 18 | 18 | */ |
| 19 | 19 | class TdbmController extends AbstractMoufInstanceController |
| 20 | 20 | { |
| 21 | - /** |
|
| 22 | - * @var HtmlBlock |
|
| 23 | - */ |
|
| 24 | - public $content; |
|
| 25 | - |
|
| 26 | - protected $daoNamespace; |
|
| 27 | - protected $beanNamespace; |
|
| 28 | - protected $daoFactoryName; |
|
| 29 | - protected $daoFactoryInstanceName; |
|
| 30 | - protected $autoloadDetected; |
|
| 31 | - protected $storeInUtc; |
|
| 32 | - protected $useCustomComposer; |
|
| 33 | - |
|
| 34 | - /** |
|
| 35 | - * Admin page used to display the DAO generation form. |
|
| 36 | - * |
|
| 37 | - * @Action |
|
| 38 | - */ |
|
| 39 | - public function defaultAction($name, $selfedit = 'false') |
|
| 40 | - { |
|
| 41 | - $this->initController($name, $selfedit); |
|
| 42 | - |
|
| 43 | - // Fill variables |
|
| 44 | - if ($this->moufManager->getVariable('tdbmDefaultSourceDirectory_'.$name) != null) { |
|
| 45 | - $this->daoNamespace = $this->moufManager->getVariable('tdbmDefaultDaoNamespace_'.$name); |
|
| 46 | - $this->beanNamespace = $this->moufManager->getVariable('tdbmDefaultBeanNamespace_'.$name); |
|
| 47 | - $this->daoFactoryName = $this->moufManager->getVariable('tdbmDefaultDaoFactoryName_'.$name); |
|
| 48 | - $this->daoFactoryInstanceName = $this->moufManager->getVariable('tdbmDefaultDaoFactoryInstanceName_'.$name); |
|
| 49 | - $this->storeInUtc = $this->moufManager->getVariable('tdbmDefaultStoreInUtc_'.$name); |
|
| 50 | - $this->useCustomComposer = $this->moufManager->getVariable('tdbmDefaultUseCustomComposer_'.$name); |
|
| 51 | - $this->composerFile = $this->moufManager->getVariable('tdbmDefaultComposerFile_'.$name); |
|
| 52 | - } else { |
|
| 53 | - $this->daoNamespace = $this->moufManager->getVariable('tdbmDefaultDaoNamespace'); |
|
| 54 | - $this->beanNamespace = $this->moufManager->getVariable('tdbmDefaultBeanNamespace'); |
|
| 55 | - $this->daoFactoryName = $this->moufManager->getVariable('tdbmDefaultDaoFactoryName'); |
|
| 56 | - $this->daoFactoryInstanceName = $this->moufManager->getVariable('tdbmDefaultDaoFactoryInstanceName'); |
|
| 57 | - $this->storeInUtc = $this->moufManager->getVariable('tdbmDefaultStoreInUtc'); |
|
| 58 | - $this->useCustomComposer = $this->moufManager->getVariable('tdbmDefaultUseCustomComposer'); |
|
| 59 | - $this->composerFile = $this->moufManager->getVariable('tdbmDefaultComposerFile'); |
|
| 60 | - } |
|
| 61 | - |
|
| 62 | - if ($this->daoNamespace == null && $this->beanNamespace == null) { |
|
| 63 | - $classNameMapper = ClassNameMapper::createFromComposerFile(__DIR__.'/../../../../../../../../composer.json'); |
|
| 64 | - |
|
| 65 | - $autoloadNamespaces = $classNameMapper->getManagedNamespaces(); |
|
| 66 | - if ($autoloadNamespaces) { |
|
| 67 | - $this->autoloadDetected = true; |
|
| 68 | - $rootNamespace = $autoloadNamespaces[0]; |
|
| 69 | - $this->daoNamespace = $rootNamespace.'Dao'; |
|
| 70 | - $this->beanNamespace = $rootNamespace.'Dao\\Bean'; |
|
| 71 | - } else { |
|
| 72 | - $this->autoloadDetected = false; |
|
| 73 | - $this->daoNamespace = 'YourApplication\\Dao'; |
|
| 74 | - $this->beanNamespace = 'YourApplication\\Dao\\Bean'; |
|
| 75 | - } |
|
| 76 | - } else { |
|
| 77 | - $this->autoloadDetected = true; |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - $this->content->addFile(__DIR__.'/../../../../views/tdbmGenerate.php', $this); |
|
| 81 | - $this->template->toHtml(); |
|
| 82 | - } |
|
| 83 | - |
|
| 84 | - /** |
|
| 85 | - * This action generates the DAOs and Beans for the TDBM service passed in parameter. |
|
| 86 | - * |
|
| 87 | - * @Action |
|
| 88 | - * |
|
| 89 | - * @param string $name |
|
| 90 | - * @param bool $selfedit |
|
| 91 | - */ |
|
| 92 | - public function generate($name, $daonamespace, $beannamespace, $daofactoryclassname, $daofactoryinstancename, $storeInUtc = 0, $selfedit = 'false', $useCustomComposer = false, $composerFile = '') |
|
| 93 | - { |
|
| 94 | - $this->initController($name, $selfedit); |
|
| 95 | - |
|
| 96 | - self::generateDaos($this->moufManager, $name, $daonamespace, $beannamespace, $daofactoryclassname, $daofactoryinstancename, $selfedit, $storeInUtc, $useCustomComposer, $composerFile); |
|
| 97 | - |
|
| 98 | - // TODO: better: we should redirect to a screen that list the number of DAOs generated, etc... |
|
| 99 | - header('Location: '.ROOT_URL.'ajaxinstance/?name='.urlencode($name).'&selfedit='.$selfedit); |
|
| 100 | - } |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * This function generates the DAOs and Beans for the TDBM service passed in parameter. |
|
| 104 | - * |
|
| 105 | - * @param MoufManager $moufManager |
|
| 106 | - * @param string $name |
|
| 107 | - * @param string $daonamespace |
|
| 108 | - * @param string $beannamespace |
|
| 109 | - * @param string $daofactoryclassname |
|
| 110 | - * @param string $daofactoryinstancename |
|
| 111 | - * @param string $selfedit |
|
| 112 | - * @param bool $storeInUtc |
|
| 113 | - * |
|
| 114 | - * @throws \Mouf\MoufException |
|
| 115 | - */ |
|
| 116 | - public static function generateDaos(MoufManager $moufManager, $name, $daonamespace, $beannamespace, $daofactoryclassname, $daofactoryinstancename, $selfedit = 'false', $storeInUtc = null, $useCustomComposer = null, $composerFile = null) |
|
| 117 | - { |
|
| 118 | - $moufManager->setVariable('tdbmDefaultDaoNamespace_'.$name, $daonamespace); |
|
| 119 | - $moufManager->setVariable('tdbmDefaultBeanNamespace_'.$name, $beannamespace); |
|
| 120 | - $moufManager->setVariable('tdbmDefaultDaoFactoryName_'.$name, $daofactoryclassname); |
|
| 121 | - $moufManager->setVariable('tdbmDefaultDaoFactoryInstanceName_'.$name, $daofactoryinstancename); |
|
| 122 | - $moufManager->setVariable('tdbmDefaultStoreInUtc_'.$name, $storeInUtc); |
|
| 123 | - $moufManager->setVariable('tdbmDefaultUseCustomComposer_'.$name, $useCustomComposer); |
|
| 124 | - $moufManager->setVariable('tdbmDefaultComposerFile_'.$name, $composerFile); |
|
| 125 | - |
|
| 126 | - // In case of instance renaming, let's use the last used settings |
|
| 127 | - $moufManager->setVariable('tdbmDefaultDaoNamespace', $daonamespace); |
|
| 128 | - $moufManager->setVariable('tdbmDefaultBeanNamespace', $beannamespace); |
|
| 129 | - $moufManager->setVariable('tdbmDefaultDaoFactoryName', $daofactoryclassname); |
|
| 130 | - $moufManager->setVariable('tdbmDefaultDaoFactoryInstanceName', $daofactoryinstancename); |
|
| 131 | - $moufManager->setVariable('tdbmDefaultStoreInUtc', $storeInUtc); |
|
| 132 | - $moufManager->setVariable('tdbmDefaultUseCustomComposer', $useCustomComposer); |
|
| 133 | - $moufManager->setVariable('tdbmDefaultComposerFile', $composerFile); |
|
| 134 | - |
|
| 135 | - // Remove first and last slash in namespace. |
|
| 136 | - $daonamespace = trim($daonamespace, '\\'); |
|
| 137 | - $beannamespace = trim($beannamespace, '\\'); |
|
| 138 | - |
|
| 139 | - $tdbmService = new InstanceProxy($name); |
|
| 140 | - /* @var $tdbmService TDBMService */ |
|
| 141 | - $tables = $tdbmService->generateAllDaosAndBeans($daofactoryclassname, $daonamespace, $beannamespace, $storeInUtc, ($useCustomComposer ? $composerFile : null)); |
|
| 142 | - |
|
| 143 | - $moufManager->declareComponent($daofactoryinstancename, $daonamespace.'\\Generated\\'.$daofactoryclassname, false, MoufManager::DECLARE_ON_EXIST_KEEP_INCOMING_LINKS); |
|
| 144 | - |
|
| 145 | - $tableToBeanMap = []; |
|
| 146 | - |
|
| 147 | - //$tdbmServiceDescriptor = $moufManager->getInstanceDescriptor('tdbmService'); |
|
| 148 | - |
|
| 149 | - foreach ($tables as $table) { |
|
| 150 | - $daoName = TDBMDaoGenerator::getDaoNameFromTableName($table); |
|
| 151 | - |
|
| 152 | - $instanceName = TDBMDaoGenerator::toVariableName($daoName); |
|
| 153 | - if (!$moufManager->instanceExists($instanceName)) { |
|
| 154 | - $moufManager->declareComponent($instanceName, $daonamespace.'\\'.$daoName); |
|
| 155 | - } |
|
| 156 | - $moufManager->setParameterViaConstructor($instanceName, 0, $name, 'object'); |
|
| 157 | - $moufManager->bindComponentViaSetter($daofactoryinstancename, 'set'.$daoName, $instanceName); |
|
| 158 | - |
|
| 159 | - $tableToBeanMap[$table] = $beannamespace.'\\'.TDBMDaoGenerator::getBeanNameFromTableName($table); |
|
| 160 | - } |
|
| 161 | - $tdbmServiceDescriptor = $moufManager->getInstanceDescriptor($name); |
|
| 162 | - $tdbmServiceDescriptor->getSetterProperty('setTableToBeanMap')->setValue($tableToBeanMap); |
|
| 163 | - $moufManager->rewriteMouf(); |
|
| 164 | - } |
|
| 21 | + /** |
|
| 22 | + * @var HtmlBlock |
|
| 23 | + */ |
|
| 24 | + public $content; |
|
| 25 | + |
|
| 26 | + protected $daoNamespace; |
|
| 27 | + protected $beanNamespace; |
|
| 28 | + protected $daoFactoryName; |
|
| 29 | + protected $daoFactoryInstanceName; |
|
| 30 | + protected $autoloadDetected; |
|
| 31 | + protected $storeInUtc; |
|
| 32 | + protected $useCustomComposer; |
|
| 33 | + |
|
| 34 | + /** |
|
| 35 | + * Admin page used to display the DAO generation form. |
|
| 36 | + * |
|
| 37 | + * @Action |
|
| 38 | + */ |
|
| 39 | + public function defaultAction($name, $selfedit = 'false') |
|
| 40 | + { |
|
| 41 | + $this->initController($name, $selfedit); |
|
| 42 | + |
|
| 43 | + // Fill variables |
|
| 44 | + if ($this->moufManager->getVariable('tdbmDefaultSourceDirectory_'.$name) != null) { |
|
| 45 | + $this->daoNamespace = $this->moufManager->getVariable('tdbmDefaultDaoNamespace_'.$name); |
|
| 46 | + $this->beanNamespace = $this->moufManager->getVariable('tdbmDefaultBeanNamespace_'.$name); |
|
| 47 | + $this->daoFactoryName = $this->moufManager->getVariable('tdbmDefaultDaoFactoryName_'.$name); |
|
| 48 | + $this->daoFactoryInstanceName = $this->moufManager->getVariable('tdbmDefaultDaoFactoryInstanceName_'.$name); |
|
| 49 | + $this->storeInUtc = $this->moufManager->getVariable('tdbmDefaultStoreInUtc_'.$name); |
|
| 50 | + $this->useCustomComposer = $this->moufManager->getVariable('tdbmDefaultUseCustomComposer_'.$name); |
|
| 51 | + $this->composerFile = $this->moufManager->getVariable('tdbmDefaultComposerFile_'.$name); |
|
| 52 | + } else { |
|
| 53 | + $this->daoNamespace = $this->moufManager->getVariable('tdbmDefaultDaoNamespace'); |
|
| 54 | + $this->beanNamespace = $this->moufManager->getVariable('tdbmDefaultBeanNamespace'); |
|
| 55 | + $this->daoFactoryName = $this->moufManager->getVariable('tdbmDefaultDaoFactoryName'); |
|
| 56 | + $this->daoFactoryInstanceName = $this->moufManager->getVariable('tdbmDefaultDaoFactoryInstanceName'); |
|
| 57 | + $this->storeInUtc = $this->moufManager->getVariable('tdbmDefaultStoreInUtc'); |
|
| 58 | + $this->useCustomComposer = $this->moufManager->getVariable('tdbmDefaultUseCustomComposer'); |
|
| 59 | + $this->composerFile = $this->moufManager->getVariable('tdbmDefaultComposerFile'); |
|
| 60 | + } |
|
| 61 | + |
|
| 62 | + if ($this->daoNamespace == null && $this->beanNamespace == null) { |
|
| 63 | + $classNameMapper = ClassNameMapper::createFromComposerFile(__DIR__.'/../../../../../../../../composer.json'); |
|
| 64 | + |
|
| 65 | + $autoloadNamespaces = $classNameMapper->getManagedNamespaces(); |
|
| 66 | + if ($autoloadNamespaces) { |
|
| 67 | + $this->autoloadDetected = true; |
|
| 68 | + $rootNamespace = $autoloadNamespaces[0]; |
|
| 69 | + $this->daoNamespace = $rootNamespace.'Dao'; |
|
| 70 | + $this->beanNamespace = $rootNamespace.'Dao\\Bean'; |
|
| 71 | + } else { |
|
| 72 | + $this->autoloadDetected = false; |
|
| 73 | + $this->daoNamespace = 'YourApplication\\Dao'; |
|
| 74 | + $this->beanNamespace = 'YourApplication\\Dao\\Bean'; |
|
| 75 | + } |
|
| 76 | + } else { |
|
| 77 | + $this->autoloadDetected = true; |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + $this->content->addFile(__DIR__.'/../../../../views/tdbmGenerate.php', $this); |
|
| 81 | + $this->template->toHtml(); |
|
| 82 | + } |
|
| 83 | + |
|
| 84 | + /** |
|
| 85 | + * This action generates the DAOs and Beans for the TDBM service passed in parameter. |
|
| 86 | + * |
|
| 87 | + * @Action |
|
| 88 | + * |
|
| 89 | + * @param string $name |
|
| 90 | + * @param bool $selfedit |
|
| 91 | + */ |
|
| 92 | + public function generate($name, $daonamespace, $beannamespace, $daofactoryclassname, $daofactoryinstancename, $storeInUtc = 0, $selfedit = 'false', $useCustomComposer = false, $composerFile = '') |
|
| 93 | + { |
|
| 94 | + $this->initController($name, $selfedit); |
|
| 95 | + |
|
| 96 | + self::generateDaos($this->moufManager, $name, $daonamespace, $beannamespace, $daofactoryclassname, $daofactoryinstancename, $selfedit, $storeInUtc, $useCustomComposer, $composerFile); |
|
| 97 | + |
|
| 98 | + // TODO: better: we should redirect to a screen that list the number of DAOs generated, etc... |
|
| 99 | + header('Location: '.ROOT_URL.'ajaxinstance/?name='.urlencode($name).'&selfedit='.$selfedit); |
|
| 100 | + } |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * This function generates the DAOs and Beans for the TDBM service passed in parameter. |
|
| 104 | + * |
|
| 105 | + * @param MoufManager $moufManager |
|
| 106 | + * @param string $name |
|
| 107 | + * @param string $daonamespace |
|
| 108 | + * @param string $beannamespace |
|
| 109 | + * @param string $daofactoryclassname |
|
| 110 | + * @param string $daofactoryinstancename |
|
| 111 | + * @param string $selfedit |
|
| 112 | + * @param bool $storeInUtc |
|
| 113 | + * |
|
| 114 | + * @throws \Mouf\MoufException |
|
| 115 | + */ |
|
| 116 | + public static function generateDaos(MoufManager $moufManager, $name, $daonamespace, $beannamespace, $daofactoryclassname, $daofactoryinstancename, $selfedit = 'false', $storeInUtc = null, $useCustomComposer = null, $composerFile = null) |
|
| 117 | + { |
|
| 118 | + $moufManager->setVariable('tdbmDefaultDaoNamespace_'.$name, $daonamespace); |
|
| 119 | + $moufManager->setVariable('tdbmDefaultBeanNamespace_'.$name, $beannamespace); |
|
| 120 | + $moufManager->setVariable('tdbmDefaultDaoFactoryName_'.$name, $daofactoryclassname); |
|
| 121 | + $moufManager->setVariable('tdbmDefaultDaoFactoryInstanceName_'.$name, $daofactoryinstancename); |
|
| 122 | + $moufManager->setVariable('tdbmDefaultStoreInUtc_'.$name, $storeInUtc); |
|
| 123 | + $moufManager->setVariable('tdbmDefaultUseCustomComposer_'.$name, $useCustomComposer); |
|
| 124 | + $moufManager->setVariable('tdbmDefaultComposerFile_'.$name, $composerFile); |
|
| 125 | + |
|
| 126 | + // In case of instance renaming, let's use the last used settings |
|
| 127 | + $moufManager->setVariable('tdbmDefaultDaoNamespace', $daonamespace); |
|
| 128 | + $moufManager->setVariable('tdbmDefaultBeanNamespace', $beannamespace); |
|
| 129 | + $moufManager->setVariable('tdbmDefaultDaoFactoryName', $daofactoryclassname); |
|
| 130 | + $moufManager->setVariable('tdbmDefaultDaoFactoryInstanceName', $daofactoryinstancename); |
|
| 131 | + $moufManager->setVariable('tdbmDefaultStoreInUtc', $storeInUtc); |
|
| 132 | + $moufManager->setVariable('tdbmDefaultUseCustomComposer', $useCustomComposer); |
|
| 133 | + $moufManager->setVariable('tdbmDefaultComposerFile', $composerFile); |
|
| 134 | + |
|
| 135 | + // Remove first and last slash in namespace. |
|
| 136 | + $daonamespace = trim($daonamespace, '\\'); |
|
| 137 | + $beannamespace = trim($beannamespace, '\\'); |
|
| 138 | + |
|
| 139 | + $tdbmService = new InstanceProxy($name); |
|
| 140 | + /* @var $tdbmService TDBMService */ |
|
| 141 | + $tables = $tdbmService->generateAllDaosAndBeans($daofactoryclassname, $daonamespace, $beannamespace, $storeInUtc, ($useCustomComposer ? $composerFile : null)); |
|
| 142 | + |
|
| 143 | + $moufManager->declareComponent($daofactoryinstancename, $daonamespace.'\\Generated\\'.$daofactoryclassname, false, MoufManager::DECLARE_ON_EXIST_KEEP_INCOMING_LINKS); |
|
| 144 | + |
|
| 145 | + $tableToBeanMap = []; |
|
| 146 | + |
|
| 147 | + //$tdbmServiceDescriptor = $moufManager->getInstanceDescriptor('tdbmService'); |
|
| 148 | + |
|
| 149 | + foreach ($tables as $table) { |
|
| 150 | + $daoName = TDBMDaoGenerator::getDaoNameFromTableName($table); |
|
| 151 | + |
|
| 152 | + $instanceName = TDBMDaoGenerator::toVariableName($daoName); |
|
| 153 | + if (!$moufManager->instanceExists($instanceName)) { |
|
| 154 | + $moufManager->declareComponent($instanceName, $daonamespace.'\\'.$daoName); |
|
| 155 | + } |
|
| 156 | + $moufManager->setParameterViaConstructor($instanceName, 0, $name, 'object'); |
|
| 157 | + $moufManager->bindComponentViaSetter($daofactoryinstancename, 'set'.$daoName, $instanceName); |
|
| 158 | + |
|
| 159 | + $tableToBeanMap[$table] = $beannamespace.'\\'.TDBMDaoGenerator::getBeanNameFromTableName($table); |
|
| 160 | + } |
|
| 161 | + $tdbmServiceDescriptor = $moufManager->getInstanceDescriptor($name); |
|
| 162 | + $tdbmServiceDescriptor->getSetterProperty('setTableToBeanMap')->setValue($tableToBeanMap); |
|
| 163 | + $moufManager->rewriteMouf(); |
|
| 164 | + } |
|
| 165 | 165 | } |
@@ -9,131 +9,131 @@ |
||
| 9 | 9 | */ |
| 10 | 10 | abstract class AbstractBeanPropertyDescriptor |
| 11 | 11 | { |
| 12 | - /** |
|
| 13 | - * @var Table |
|
| 14 | - */ |
|
| 15 | - protected $table; |
|
| 16 | - |
|
| 17 | - /** |
|
| 18 | - * Whether to use the more complex name in case of conflict. |
|
| 19 | - * |
|
| 20 | - * @var bool |
|
| 21 | - */ |
|
| 22 | - protected $alternativeName = false; |
|
| 23 | - |
|
| 24 | - /** |
|
| 25 | - * @param Table $table |
|
| 26 | - */ |
|
| 27 | - public function __construct(Table $table) |
|
| 28 | - { |
|
| 29 | - $this->table = $table; |
|
| 30 | - } |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Use the more complex name in case of conflict. |
|
| 34 | - */ |
|
| 35 | - public function useAlternativeName() |
|
| 36 | - { |
|
| 37 | - $this->alternativeName = true; |
|
| 38 | - } |
|
| 39 | - |
|
| 40 | - /** |
|
| 41 | - * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
| 42 | - * |
|
| 43 | - * @return null|string |
|
| 44 | - */ |
|
| 45 | - abstract public function getClassName(); |
|
| 46 | - |
|
| 47 | - /** |
|
| 48 | - * Returns the param annotation for this property (useful for constructor). |
|
| 49 | - * |
|
| 50 | - * @return string |
|
| 51 | - */ |
|
| 52 | - abstract public function getParamAnnotation(); |
|
| 53 | - |
|
| 54 | - public function getVariableName() |
|
| 55 | - { |
|
| 56 | - return '$'.$this->getLowerCamelCaseName(); |
|
| 57 | - } |
|
| 58 | - |
|
| 59 | - public function getLowerCamelCaseName() |
|
| 60 | - { |
|
| 61 | - return TDBMDaoGenerator::toVariableName($this->getUpperCamelCaseName()); |
|
| 62 | - } |
|
| 63 | - |
|
| 64 | - abstract public function getUpperCamelCaseName(); |
|
| 65 | - |
|
| 66 | - public function getSetterName() |
|
| 67 | - { |
|
| 68 | - return 'set'.$this->getUpperCamelCaseName(); |
|
| 69 | - } |
|
| 70 | - |
|
| 71 | - public function getGetterName() |
|
| 72 | - { |
|
| 73 | - return 'get'.$this->getUpperCamelCaseName(); |
|
| 74 | - } |
|
| 75 | - |
|
| 76 | - /** |
|
| 77 | - * Returns the PHP code used in the ben constructor for this property. |
|
| 78 | - * |
|
| 79 | - * @return string |
|
| 80 | - */ |
|
| 81 | - public function getConstructorAssignCode() |
|
| 82 | - { |
|
| 83 | - $str = ' $this->%s(%s);'; |
|
| 84 | - |
|
| 85 | - return sprintf($str, $this->getSetterName(), $this->getVariableName()); |
|
| 86 | - } |
|
| 87 | - |
|
| 88 | - /** |
|
| 89 | - * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
| 90 | - * |
|
| 91 | - * @return bool |
|
| 92 | - */ |
|
| 93 | - abstract public function isCompulsory(); |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * Returns true if the property has a default value. |
|
| 97 | - * |
|
| 98 | - * @return bool |
|
| 99 | - */ |
|
| 100 | - abstract public function hasDefault(); |
|
| 101 | - |
|
| 102 | - /** |
|
| 103 | - * Returns the code that assigns a value to its default value. |
|
| 104 | - * |
|
| 105 | - * @return string |
|
| 106 | - * |
|
| 107 | - * @throws \TDBMException |
|
| 108 | - */ |
|
| 109 | - abstract public function assignToDefaultCode(); |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * Returns true if the property is the primary key. |
|
| 113 | - * |
|
| 114 | - * @return bool |
|
| 115 | - */ |
|
| 116 | - abstract public function isPrimaryKey(); |
|
| 117 | - |
|
| 118 | - /** |
|
| 119 | - * @return Table |
|
| 120 | - */ |
|
| 121 | - public function getTable() |
|
| 122 | - { |
|
| 123 | - return $this->table; |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - /** |
|
| 127 | - * Returns the PHP code for getters and setters. |
|
| 128 | - * |
|
| 129 | - * @return string |
|
| 130 | - */ |
|
| 131 | - abstract public function getGetterSetterCode(); |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Returns the part of code useful when doing json serialization. |
|
| 135 | - * |
|
| 136 | - * @return string |
|
| 137 | - */ |
|
| 138 | - abstract public function getJsonSerializeCode(); |
|
| 12 | + /** |
|
| 13 | + * @var Table |
|
| 14 | + */ |
|
| 15 | + protected $table; |
|
| 16 | + |
|
| 17 | + /** |
|
| 18 | + * Whether to use the more complex name in case of conflict. |
|
| 19 | + * |
|
| 20 | + * @var bool |
|
| 21 | + */ |
|
| 22 | + protected $alternativeName = false; |
|
| 23 | + |
|
| 24 | + /** |
|
| 25 | + * @param Table $table |
|
| 26 | + */ |
|
| 27 | + public function __construct(Table $table) |
|
| 28 | + { |
|
| 29 | + $this->table = $table; |
|
| 30 | + } |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Use the more complex name in case of conflict. |
|
| 34 | + */ |
|
| 35 | + public function useAlternativeName() |
|
| 36 | + { |
|
| 37 | + $this->alternativeName = true; |
|
| 38 | + } |
|
| 39 | + |
|
| 40 | + /** |
|
| 41 | + * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
| 42 | + * |
|
| 43 | + * @return null|string |
|
| 44 | + */ |
|
| 45 | + abstract public function getClassName(); |
|
| 46 | + |
|
| 47 | + /** |
|
| 48 | + * Returns the param annotation for this property (useful for constructor). |
|
| 49 | + * |
|
| 50 | + * @return string |
|
| 51 | + */ |
|
| 52 | + abstract public function getParamAnnotation(); |
|
| 53 | + |
|
| 54 | + public function getVariableName() |
|
| 55 | + { |
|
| 56 | + return '$'.$this->getLowerCamelCaseName(); |
|
| 57 | + } |
|
| 58 | + |
|
| 59 | + public function getLowerCamelCaseName() |
|
| 60 | + { |
|
| 61 | + return TDBMDaoGenerator::toVariableName($this->getUpperCamelCaseName()); |
|
| 62 | + } |
|
| 63 | + |
|
| 64 | + abstract public function getUpperCamelCaseName(); |
|
| 65 | + |
|
| 66 | + public function getSetterName() |
|
| 67 | + { |
|
| 68 | + return 'set'.$this->getUpperCamelCaseName(); |
|
| 69 | + } |
|
| 70 | + |
|
| 71 | + public function getGetterName() |
|
| 72 | + { |
|
| 73 | + return 'get'.$this->getUpperCamelCaseName(); |
|
| 74 | + } |
|
| 75 | + |
|
| 76 | + /** |
|
| 77 | + * Returns the PHP code used in the ben constructor for this property. |
|
| 78 | + * |
|
| 79 | + * @return string |
|
| 80 | + */ |
|
| 81 | + public function getConstructorAssignCode() |
|
| 82 | + { |
|
| 83 | + $str = ' $this->%s(%s);'; |
|
| 84 | + |
|
| 85 | + return sprintf($str, $this->getSetterName(), $this->getVariableName()); |
|
| 86 | + } |
|
| 87 | + |
|
| 88 | + /** |
|
| 89 | + * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
| 90 | + * |
|
| 91 | + * @return bool |
|
| 92 | + */ |
|
| 93 | + abstract public function isCompulsory(); |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * Returns true if the property has a default value. |
|
| 97 | + * |
|
| 98 | + * @return bool |
|
| 99 | + */ |
|
| 100 | + abstract public function hasDefault(); |
|
| 101 | + |
|
| 102 | + /** |
|
| 103 | + * Returns the code that assigns a value to its default value. |
|
| 104 | + * |
|
| 105 | + * @return string |
|
| 106 | + * |
|
| 107 | + * @throws \TDBMException |
|
| 108 | + */ |
|
| 109 | + abstract public function assignToDefaultCode(); |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * Returns true if the property is the primary key. |
|
| 113 | + * |
|
| 114 | + * @return bool |
|
| 115 | + */ |
|
| 116 | + abstract public function isPrimaryKey(); |
|
| 117 | + |
|
| 118 | + /** |
|
| 119 | + * @return Table |
|
| 120 | + */ |
|
| 121 | + public function getTable() |
|
| 122 | + { |
|
| 123 | + return $this->table; |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + /** |
|
| 127 | + * Returns the PHP code for getters and setters. |
|
| 128 | + * |
|
| 129 | + * @return string |
|
| 130 | + */ |
|
| 131 | + abstract public function getGetterSetterCode(); |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Returns the part of code useful when doing json serialization. |
|
| 135 | + * |
|
| 136 | + * @return string |
|
| 137 | + */ |
|
| 138 | + abstract public function getJsonSerializeCode(); |
|
| 139 | 139 | } |
@@ -12,156 +12,156 @@ discard block |
||
| 12 | 12 | */ |
| 13 | 13 | class ObjectBeanPropertyDescriptor extends AbstractBeanPropertyDescriptor |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * @var ForeignKeyConstraint |
|
| 17 | - */ |
|
| 18 | - private $foreignKey; |
|
| 19 | - |
|
| 20 | - /** |
|
| 21 | - * @var SchemaAnalyzer |
|
| 22 | - */ |
|
| 23 | - private $schemaAnalyzer; |
|
| 24 | - |
|
| 25 | - public function __construct(Table $table, ForeignKeyConstraint $foreignKey, SchemaAnalyzer $schemaAnalyzer) |
|
| 26 | - { |
|
| 27 | - parent::__construct($table); |
|
| 28 | - $this->foreignKey = $foreignKey; |
|
| 29 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
| 30 | - } |
|
| 31 | - |
|
| 32 | - /** |
|
| 33 | - * Returns the foreignkey the column is part of, if any. null otherwise. |
|
| 34 | - * |
|
| 35 | - * @return ForeignKeyConstraint|null |
|
| 36 | - */ |
|
| 37 | - public function getForeignKey() |
|
| 38 | - { |
|
| 39 | - return $this->foreignKey; |
|
| 40 | - } |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
| 44 | - * |
|
| 45 | - * @return null|string |
|
| 46 | - */ |
|
| 47 | - public function getClassName() |
|
| 48 | - { |
|
| 49 | - return TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName()); |
|
| 50 | - } |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * Returns the param annotation for this property (useful for constructor). |
|
| 54 | - * |
|
| 55 | - * @return string |
|
| 56 | - */ |
|
| 57 | - public function getParamAnnotation() |
|
| 58 | - { |
|
| 59 | - $str = ' * @param %s %s'; |
|
| 60 | - |
|
| 61 | - return sprintf($str, $this->getClassName(), $this->getVariableName()); |
|
| 62 | - } |
|
| 63 | - |
|
| 64 | - public function getUpperCamelCaseName() |
|
| 65 | - { |
|
| 66 | - // First, are there many column or only one? |
|
| 67 | - // If one column, we name the setter after it. Otherwise, we name the setter after the table name |
|
| 68 | - if (count($this->foreignKey->getLocalColumns()) > 1) { |
|
| 69 | - $name = TDBMDaoGenerator::toSingular(TDBMDaoGenerator::toCamelCase($this->foreignKey->getForeignTableName())); |
|
| 70 | - if ($this->alternativeName) { |
|
| 71 | - $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $this->foreignKey->getLocalColumns()); |
|
| 72 | - |
|
| 73 | - $name .= 'By'.implode('And', $camelizedColumns); |
|
| 74 | - } |
|
| 75 | - } else { |
|
| 76 | - $column = $this->foreignKey->getLocalColumns()[0]; |
|
| 77 | - // Let's remove any _id or id_. |
|
| 78 | - if (strpos(strtolower($column), 'id_') === 0) { |
|
| 79 | - $column = substr($column, 3); |
|
| 80 | - } |
|
| 81 | - if (strrpos(strtolower($column), '_id') === strlen($column) - 3) { |
|
| 82 | - $column = substr($column, 0, strlen($column) - 3); |
|
| 83 | - } |
|
| 84 | - $name = TDBMDaoGenerator::toCamelCase($column); |
|
| 85 | - if ($this->alternativeName) { |
|
| 86 | - $name .= 'Object'; |
|
| 87 | - } |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - return $name; |
|
| 91 | - } |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
| 95 | - * |
|
| 96 | - * @return bool |
|
| 97 | - */ |
|
| 98 | - public function isCompulsory() |
|
| 99 | - { |
|
| 100 | - // Are all columns nullable? |
|
| 101 | - $localColumnNames = $this->foreignKey->getLocalColumns(); |
|
| 102 | - |
|
| 103 | - foreach ($localColumnNames as $name) { |
|
| 104 | - $column = $this->table->getColumn($name); |
|
| 105 | - if ($column->getNotnull()) { |
|
| 106 | - return true; |
|
| 107 | - } |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - return false; |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * Returns true if the property has a default value. |
|
| 115 | - * |
|
| 116 | - * @return bool |
|
| 117 | - */ |
|
| 118 | - public function hasDefault() |
|
| 119 | - { |
|
| 120 | - return false; |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * Returns the code that assigns a value to its default value. |
|
| 125 | - * |
|
| 126 | - * @return string |
|
| 127 | - * |
|
| 128 | - * @throws \TDBMException |
|
| 129 | - */ |
|
| 130 | - public function assignToDefaultCode() |
|
| 131 | - { |
|
| 132 | - throw new \TDBMException('Foreign key based properties cannot be assigned a default value.'); |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - /** |
|
| 136 | - * Returns true if the property is the primary key. |
|
| 137 | - * |
|
| 138 | - * @return bool |
|
| 139 | - */ |
|
| 140 | - public function isPrimaryKey() |
|
| 141 | - { |
|
| 142 | - $fkColumns = $this->foreignKey->getLocalColumns(); |
|
| 143 | - sort($fkColumns); |
|
| 144 | - |
|
| 145 | - $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
| 146 | - sort($pkColumns); |
|
| 147 | - |
|
| 148 | - return $fkColumns == $pkColumns; |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - /** |
|
| 152 | - * Returns the PHP code for getters and setters. |
|
| 153 | - * |
|
| 154 | - * @return string |
|
| 155 | - */ |
|
| 156 | - public function getGetterSetterCode() |
|
| 157 | - { |
|
| 158 | - $tableName = $this->table->getName(); |
|
| 159 | - $getterName = $this->getGetterName(); |
|
| 160 | - $setterName = $this->getSetterName(); |
|
| 161 | - |
|
| 162 | - $referencedBeanName = TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName()); |
|
| 163 | - |
|
| 164 | - $str = ' /** |
|
| 15 | + /** |
|
| 16 | + * @var ForeignKeyConstraint |
|
| 17 | + */ |
|
| 18 | + private $foreignKey; |
|
| 19 | + |
|
| 20 | + /** |
|
| 21 | + * @var SchemaAnalyzer |
|
| 22 | + */ |
|
| 23 | + private $schemaAnalyzer; |
|
| 24 | + |
|
| 25 | + public function __construct(Table $table, ForeignKeyConstraint $foreignKey, SchemaAnalyzer $schemaAnalyzer) |
|
| 26 | + { |
|
| 27 | + parent::__construct($table); |
|
| 28 | + $this->foreignKey = $foreignKey; |
|
| 29 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
| 30 | + } |
|
| 31 | + |
|
| 32 | + /** |
|
| 33 | + * Returns the foreignkey the column is part of, if any. null otherwise. |
|
| 34 | + * |
|
| 35 | + * @return ForeignKeyConstraint|null |
|
| 36 | + */ |
|
| 37 | + public function getForeignKey() |
|
| 38 | + { |
|
| 39 | + return $this->foreignKey; |
|
| 40 | + } |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * Returns the name of the class linked to this property or null if this is not a foreign key. |
|
| 44 | + * |
|
| 45 | + * @return null|string |
|
| 46 | + */ |
|
| 47 | + public function getClassName() |
|
| 48 | + { |
|
| 49 | + return TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName()); |
|
| 50 | + } |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * Returns the param annotation for this property (useful for constructor). |
|
| 54 | + * |
|
| 55 | + * @return string |
|
| 56 | + */ |
|
| 57 | + public function getParamAnnotation() |
|
| 58 | + { |
|
| 59 | + $str = ' * @param %s %s'; |
|
| 60 | + |
|
| 61 | + return sprintf($str, $this->getClassName(), $this->getVariableName()); |
|
| 62 | + } |
|
| 63 | + |
|
| 64 | + public function getUpperCamelCaseName() |
|
| 65 | + { |
|
| 66 | + // First, are there many column or only one? |
|
| 67 | + // If one column, we name the setter after it. Otherwise, we name the setter after the table name |
|
| 68 | + if (count($this->foreignKey->getLocalColumns()) > 1) { |
|
| 69 | + $name = TDBMDaoGenerator::toSingular(TDBMDaoGenerator::toCamelCase($this->foreignKey->getForeignTableName())); |
|
| 70 | + if ($this->alternativeName) { |
|
| 71 | + $camelizedColumns = array_map(['Mouf\\Database\\TDBM\\Utils\\TDBMDaoGenerator', 'toCamelCase'], $this->foreignKey->getLocalColumns()); |
|
| 72 | + |
|
| 73 | + $name .= 'By'.implode('And', $camelizedColumns); |
|
| 74 | + } |
|
| 75 | + } else { |
|
| 76 | + $column = $this->foreignKey->getLocalColumns()[0]; |
|
| 77 | + // Let's remove any _id or id_. |
|
| 78 | + if (strpos(strtolower($column), 'id_') === 0) { |
|
| 79 | + $column = substr($column, 3); |
|
| 80 | + } |
|
| 81 | + if (strrpos(strtolower($column), '_id') === strlen($column) - 3) { |
|
| 82 | + $column = substr($column, 0, strlen($column) - 3); |
|
| 83 | + } |
|
| 84 | + $name = TDBMDaoGenerator::toCamelCase($column); |
|
| 85 | + if ($this->alternativeName) { |
|
| 86 | + $name .= 'Object'; |
|
| 87 | + } |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + return $name; |
|
| 91 | + } |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * Returns true if the property is compulsory (and therefore should be fetched in the constructor). |
|
| 95 | + * |
|
| 96 | + * @return bool |
|
| 97 | + */ |
|
| 98 | + public function isCompulsory() |
|
| 99 | + { |
|
| 100 | + // Are all columns nullable? |
|
| 101 | + $localColumnNames = $this->foreignKey->getLocalColumns(); |
|
| 102 | + |
|
| 103 | + foreach ($localColumnNames as $name) { |
|
| 104 | + $column = $this->table->getColumn($name); |
|
| 105 | + if ($column->getNotnull()) { |
|
| 106 | + return true; |
|
| 107 | + } |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + return false; |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * Returns true if the property has a default value. |
|
| 115 | + * |
|
| 116 | + * @return bool |
|
| 117 | + */ |
|
| 118 | + public function hasDefault() |
|
| 119 | + { |
|
| 120 | + return false; |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * Returns the code that assigns a value to its default value. |
|
| 125 | + * |
|
| 126 | + * @return string |
|
| 127 | + * |
|
| 128 | + * @throws \TDBMException |
|
| 129 | + */ |
|
| 130 | + public function assignToDefaultCode() |
|
| 131 | + { |
|
| 132 | + throw new \TDBMException('Foreign key based properties cannot be assigned a default value.'); |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + /** |
|
| 136 | + * Returns true if the property is the primary key. |
|
| 137 | + * |
|
| 138 | + * @return bool |
|
| 139 | + */ |
|
| 140 | + public function isPrimaryKey() |
|
| 141 | + { |
|
| 142 | + $fkColumns = $this->foreignKey->getLocalColumns(); |
|
| 143 | + sort($fkColumns); |
|
| 144 | + |
|
| 145 | + $pkColumns = $this->table->getPrimaryKeyColumns(); |
|
| 146 | + sort($pkColumns); |
|
| 147 | + |
|
| 148 | + return $fkColumns == $pkColumns; |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + /** |
|
| 152 | + * Returns the PHP code for getters and setters. |
|
| 153 | + * |
|
| 154 | + * @return string |
|
| 155 | + */ |
|
| 156 | + public function getGetterSetterCode() |
|
| 157 | + { |
|
| 158 | + $tableName = $this->table->getName(); |
|
| 159 | + $getterName = $this->getGetterName(); |
|
| 160 | + $setterName = $this->getSetterName(); |
|
| 161 | + |
|
| 162 | + $referencedBeanName = TDBMDaoGenerator::getBeanNameFromTableName($this->foreignKey->getForeignTableName()); |
|
| 163 | + |
|
| 164 | + $str = ' /** |
|
| 165 | 165 | * Returns the '.$referencedBeanName.' object bound to this object via the '.implode(' and ', $this->foreignKey->getLocalColumns()).' column. |
| 166 | 166 | * |
| 167 | 167 | * @return '.$referencedBeanName.' |
@@ -181,19 +181,19 @@ discard block |
||
| 181 | 181 | |
| 182 | 182 | '; |
| 183 | 183 | |
| 184 | - return $str; |
|
| 185 | - } |
|
| 186 | - |
|
| 187 | - /** |
|
| 188 | - * Returns the part of code useful when doing json serialization. |
|
| 189 | - * |
|
| 190 | - * @return string |
|
| 191 | - */ |
|
| 192 | - public function getJsonSerializeCode() |
|
| 193 | - { |
|
| 194 | - return ' if (!$stopRecursion) { |
|
| 184 | + return $str; |
|
| 185 | + } |
|
| 186 | + |
|
| 187 | + /** |
|
| 188 | + * Returns the part of code useful when doing json serialization. |
|
| 189 | + * |
|
| 190 | + * @return string |
|
| 191 | + */ |
|
| 192 | + public function getJsonSerializeCode() |
|
| 193 | + { |
|
| 194 | + return ' if (!$stopRecursion) { |
|
| 195 | 195 | $array['.var_export($this->getLowerCamelCaseName(), true).'] = $this->'.$this->getGetterName().'()->jsonSerialize(true); |
| 196 | 196 | } |
| 197 | 197 | '; |
| 198 | - } |
|
| 198 | + } |
|
| 199 | 199 | } |