@@ -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 |
@@ -11,58 +11,58 @@ |
||
11 | 11 | class MoufDiListener implements GeneratorListenerInterface |
12 | 12 | { |
13 | 13 | |
14 | - /** |
|
15 | - * @param ConfigurationInterface $configuration |
|
16 | - * @param BeanDescriptorInterface[] $beanDescriptors |
|
17 | - */ |
|
18 | - public function onGenerate(ConfigurationInterface $configuration, array $beanDescriptors): void |
|
19 | - { |
|
20 | - // Let's generate the needed instance in Mouf. |
|
21 | - $moufManager = MoufManager::getMoufManager(); |
|
14 | + /** |
|
15 | + * @param ConfigurationInterface $configuration |
|
16 | + * @param BeanDescriptorInterface[] $beanDescriptors |
|
17 | + */ |
|
18 | + public function onGenerate(ConfigurationInterface $configuration, array $beanDescriptors): void |
|
19 | + { |
|
20 | + // Let's generate the needed instance in Mouf. |
|
21 | + $moufManager = MoufManager::getMoufManager(); |
|
22 | 22 | |
23 | - $daoFactoryInstanceName = null; |
|
24 | - if ($configuration instanceof MoufConfiguration) { |
|
25 | - $daoFactoryInstanceName = $configuration->getDaoFactoryInstanceName(); |
|
26 | - $daoFactoryClassName = $configuration->getDaoNamespace().'\\Generated\\'.$configuration->getNamingStrategy()->getDaoFactoryClassName(); |
|
27 | - $moufManager->declareComponent($daoFactoryInstanceName, $daoFactoryClassName, false, MoufManager::DECLARE_ON_EXIST_KEEP_INCOMING_LINKS); |
|
28 | - } |
|
23 | + $daoFactoryInstanceName = null; |
|
24 | + if ($configuration instanceof MoufConfiguration) { |
|
25 | + $daoFactoryInstanceName = $configuration->getDaoFactoryInstanceName(); |
|
26 | + $daoFactoryClassName = $configuration->getDaoNamespace().'\\Generated\\'.$configuration->getNamingStrategy()->getDaoFactoryClassName(); |
|
27 | + $moufManager->declareComponent($daoFactoryInstanceName, $daoFactoryClassName, false, MoufManager::DECLARE_ON_EXIST_KEEP_INCOMING_LINKS); |
|
28 | + } |
|
29 | 29 | |
30 | - $tdbmServiceInstanceName = $this->getTdbmInstanceName($configuration); |
|
30 | + $tdbmServiceInstanceName = $this->getTdbmInstanceName($configuration); |
|
31 | 31 | |
32 | - foreach ($beanDescriptors as $beanDescriptor) { |
|
33 | - $daoName = $beanDescriptor->getDaoClassName(); |
|
32 | + foreach ($beanDescriptors as $beanDescriptor) { |
|
33 | + $daoName = $beanDescriptor->getDaoClassName(); |
|
34 | 34 | |
35 | - $instanceName = TDBMDaoGenerator::toVariableName($daoName); |
|
36 | - if (!$moufManager->instanceExists($instanceName)) { |
|
37 | - $moufManager->declareComponent($instanceName, $configuration->getDaoNamespace().'\\'.$daoName); |
|
38 | - } |
|
39 | - $moufManager->setParameterViaConstructor($instanceName, 0, $tdbmServiceInstanceName, 'object'); |
|
40 | - if ($daoFactoryInstanceName !== null) { |
|
41 | - $moufManager->bindComponentViaSetter($daoFactoryInstanceName, 'set'.$daoName, $instanceName); |
|
42 | - } |
|
43 | - } |
|
35 | + $instanceName = TDBMDaoGenerator::toVariableName($daoName); |
|
36 | + if (!$moufManager->instanceExists($instanceName)) { |
|
37 | + $moufManager->declareComponent($instanceName, $configuration->getDaoNamespace().'\\'.$daoName); |
|
38 | + } |
|
39 | + $moufManager->setParameterViaConstructor($instanceName, 0, $tdbmServiceInstanceName, 'object'); |
|
40 | + if ($daoFactoryInstanceName !== null) { |
|
41 | + $moufManager->bindComponentViaSetter($daoFactoryInstanceName, 'set'.$daoName, $instanceName); |
|
42 | + } |
|
43 | + } |
|
44 | 44 | |
45 | - $moufManager->rewriteMouf(); |
|
46 | - } |
|
45 | + $moufManager->rewriteMouf(); |
|
46 | + } |
|
47 | 47 | |
48 | - private function getTdbmInstanceName(ConfigurationInterface $configuration) : string |
|
49 | - { |
|
50 | - $moufManager = MoufManager::getMoufManager(); |
|
48 | + private function getTdbmInstanceName(ConfigurationInterface $configuration) : string |
|
49 | + { |
|
50 | + $moufManager = MoufManager::getMoufManager(); |
|
51 | 51 | |
52 | - $configurationInstanceName = $moufManager->findInstanceName($configuration); |
|
53 | - if (!$configurationInstanceName) { |
|
54 | - throw new \TDBMException('Could not find TDBM instance for configuration object.'); |
|
55 | - } |
|
52 | + $configurationInstanceName = $moufManager->findInstanceName($configuration); |
|
53 | + if (!$configurationInstanceName) { |
|
54 | + throw new \TDBMException('Could not find TDBM instance for configuration object.'); |
|
55 | + } |
|
56 | 56 | |
57 | - // Let's find the configuration |
|
58 | - $tdbmServicesNames = $moufManager->findInstances(TDBMService::class); |
|
57 | + // Let's find the configuration |
|
58 | + $tdbmServicesNames = $moufManager->findInstances(TDBMService::class); |
|
59 | 59 | |
60 | - foreach ($tdbmServicesNames as $name) { |
|
61 | - if ($moufManager->getInstanceDescriptor($name)->getConstructorArgumentProperty('configuration')->getValue()->getName() === $configurationInstanceName) { |
|
62 | - return $name; |
|
63 | - } |
|
64 | - } |
|
60 | + foreach ($tdbmServicesNames as $name) { |
|
61 | + if ($moufManager->getInstanceDescriptor($name)->getConstructorArgumentProperty('configuration')->getValue()->getName() === $configurationInstanceName) { |
|
62 | + return $name; |
|
63 | + } |
|
64 | + } |
|
65 | 65 | |
66 | - throw new \TDBMException('Could not find TDBMService instance.'); |
|
67 | - } |
|
66 | + throw new \TDBMException('Could not find TDBMService instance.'); |
|
67 | + } |
|
68 | 68 | } |
@@ -39,7 +39,7 @@ |
||
39 | 39 | $alteredConf = new AlteredConfiguration($this->configuration); |
40 | 40 | |
41 | 41 | |
42 | - $loggers = [ new ConsoleLogger($output) ]; |
|
42 | + $loggers = [new ConsoleLogger($output)]; |
|
43 | 43 | |
44 | 44 | $logger = $alteredConf->getLogger(); |
45 | 45 | if ($logger) { |
@@ -12,48 +12,48 @@ |
||
12 | 12 | class GenerateCommand extends Command |
13 | 13 | { |
14 | 14 | |
15 | - /** |
|
16 | - * @var ConfigurationInterface |
|
17 | - */ |
|
18 | - private $configuration; |
|
15 | + /** |
|
16 | + * @var ConfigurationInterface |
|
17 | + */ |
|
18 | + private $configuration; |
|
19 | 19 | |
20 | - public function __construct(ConfigurationInterface $configuration) |
|
21 | - { |
|
22 | - parent::__construct(); |
|
23 | - $this->configuration = $configuration; |
|
24 | - } |
|
20 | + public function __construct(ConfigurationInterface $configuration) |
|
21 | + { |
|
22 | + parent::__construct(); |
|
23 | + $this->configuration = $configuration; |
|
24 | + } |
|
25 | 25 | |
26 | - protected function configure() |
|
27 | - { |
|
28 | - $this->setName('tdbm:generate') |
|
29 | - ->setDescription('Generates DAOs and beans.') |
|
30 | - ->setHelp('Use this command to generate or regenerate the DAOs and beans for your project.') |
|
31 | - ; |
|
32 | - } |
|
26 | + protected function configure() |
|
27 | + { |
|
28 | + $this->setName('tdbm:generate') |
|
29 | + ->setDescription('Generates DAOs and beans.') |
|
30 | + ->setHelp('Use this command to generate or regenerate the DAOs and beans for your project.') |
|
31 | + ; |
|
32 | + } |
|
33 | 33 | |
34 | - protected function execute(InputInterface $input, OutputInterface $output) |
|
35 | - { |
|
36 | - // TODO: externalize composer.json file for autoloading (no more parameters for generateAllDaosAndBeans) |
|
34 | + protected function execute(InputInterface $input, OutputInterface $output) |
|
35 | + { |
|
36 | + // TODO: externalize composer.json file for autoloading (no more parameters for generateAllDaosAndBeans) |
|
37 | 37 | |
38 | - $alteredConf = new AlteredConfiguration($this->configuration); |
|
38 | + $alteredConf = new AlteredConfiguration($this->configuration); |
|
39 | 39 | |
40 | 40 | |
41 | - $loggers = [ new ConsoleLogger($output) ]; |
|
41 | + $loggers = [ new ConsoleLogger($output) ]; |
|
42 | 42 | |
43 | - $logger = $alteredConf->getLogger(); |
|
44 | - if ($logger) { |
|
45 | - $loggers[] = $logger; |
|
46 | - } |
|
43 | + $logger = $alteredConf->getLogger(); |
|
44 | + if ($logger) { |
|
45 | + $loggers[] = $logger; |
|
46 | + } |
|
47 | 47 | |
48 | - $multiLogger = new MultiLogger($loggers); |
|
48 | + $multiLogger = new MultiLogger($loggers); |
|
49 | 49 | |
50 | - $alteredConf->setLogger($multiLogger); |
|
50 | + $alteredConf->setLogger($multiLogger); |
|
51 | 51 | |
52 | - $multiLogger->notice('Starting regenerating DAOs and beans'); |
|
52 | + $multiLogger->notice('Starting regenerating DAOs and beans'); |
|
53 | 53 | |
54 | - $tdbmService = new TDBMService($this->configuration); |
|
55 | - $tdbmService->generateAllDaosAndBeans(); |
|
54 | + $tdbmService = new TDBMService($this->configuration); |
|
55 | + $tdbmService->generateAllDaosAndBeans(); |
|
56 | 56 | |
57 | - $multiLogger->notice('Finished regenerating DAOs and beans'); |
|
58 | - } |
|
57 | + $multiLogger->notice('Finished regenerating DAOs and beans'); |
|
58 | + } |
|
59 | 59 | } |
@@ -135,7 +135,7 @@ |
||
135 | 135 | /** |
136 | 136 | * @return LoggerInterface |
137 | 137 | */ |
138 | - public function getLogger(): ?LoggerInterface |
|
138 | + public function getLogger(): ? LoggerInterface |
|
139 | 139 | { |
140 | 140 | return $this->logger; |
141 | 141 | } |
@@ -17,165 +17,165 @@ |
||
17 | 17 | class Configuration implements ConfigurationInterface |
18 | 18 | { |
19 | 19 | |
20 | - /** |
|
21 | - * @var string |
|
22 | - */ |
|
23 | - private $beanNamespace; |
|
24 | - /** |
|
25 | - * @var string |
|
26 | - */ |
|
27 | - private $daoNamespace; |
|
28 | - /** |
|
29 | - * @var Connection |
|
30 | - */ |
|
31 | - private $connection; |
|
32 | - /** |
|
33 | - * @var Cache |
|
34 | - */ |
|
35 | - private $cache; |
|
36 | - /** |
|
37 | - * @var SchemaAnalyzer |
|
38 | - */ |
|
39 | - private $schemaAnalyzer; |
|
40 | - /** |
|
41 | - * @var LoggerInterface |
|
42 | - */ |
|
43 | - private $logger; |
|
44 | - /** |
|
45 | - * @var GeneratorListenerInterface |
|
46 | - */ |
|
47 | - private $generatorEventDispatcher; |
|
48 | - /** |
|
49 | - * @var NamingStrategyInterface |
|
50 | - */ |
|
51 | - private $namingStrategy; |
|
52 | - /** |
|
53 | - * @var PathFinderInterface |
|
54 | - */ |
|
55 | - private $pathFinder; |
|
56 | - |
|
57 | - /** |
|
58 | - * @param string $beanNamespace The namespace hosting the beans |
|
59 | - * @param string $daoNamespace The namespace hosting the DAOs |
|
60 | - * @param Connection $connection The connection to the database |
|
61 | - * @param Cache|null $cache The Doctrine cache to store database metadata |
|
62 | - * @param SchemaAnalyzer|null $schemaAnalyzer The schema analyzer that will be used to find shortest paths... Will be automatically created if not passed |
|
63 | - * @param LoggerInterface|null $logger The logger |
|
64 | - * @param GeneratorListenerInterface[] $generatorListeners A list of listeners that will be triggered when beans/daos are generated |
|
65 | - */ |
|
66 | - public function __construct(string $beanNamespace, string $daoNamespace, Connection $connection, NamingStrategyInterface $namingStrategy, Cache $cache = null, SchemaAnalyzer $schemaAnalyzer = null, LoggerInterface $logger = null, array $generatorListeners = []) |
|
67 | - { |
|
68 | - $this->beanNamespace = rtrim($beanNamespace, '\\'); |
|
69 | - $this->daoNamespace = rtrim($daoNamespace, '\\'); |
|
70 | - $this->connection = $connection; |
|
71 | - $this->namingStrategy = $namingStrategy; |
|
72 | - if ($cache !== null) { |
|
73 | - $this->cache = $cache; |
|
74 | - } else { |
|
75 | - $this->cache = new VoidCache(); |
|
76 | - } |
|
77 | - if ($schemaAnalyzer !== null) { |
|
78 | - $this->schemaAnalyzer = $schemaAnalyzer; |
|
79 | - } else { |
|
80 | - $this->schemaAnalyzer = new SchemaAnalyzer($this->connection->getSchemaManager(), $this->cache, $this->getConnectionUniqueId()); |
|
81 | - } |
|
82 | - $this->logger = $logger; |
|
83 | - $this->generatorEventDispatcher = new GeneratorEventDispatcher($generatorListeners); |
|
84 | - $this->pathFinder = new PathFinder(); |
|
85 | - } |
|
86 | - |
|
87 | - /** |
|
88 | - * @return string |
|
89 | - */ |
|
90 | - public function getBeanNamespace(): string |
|
91 | - { |
|
92 | - return $this->beanNamespace; |
|
93 | - } |
|
94 | - |
|
95 | - /** |
|
96 | - * @return string |
|
97 | - */ |
|
98 | - public function getDaoNamespace(): string |
|
99 | - { |
|
100 | - return $this->daoNamespace; |
|
101 | - } |
|
102 | - |
|
103 | - /** |
|
104 | - * @return Connection |
|
105 | - */ |
|
106 | - public function getConnection(): Connection |
|
107 | - { |
|
108 | - return $this->connection; |
|
109 | - } |
|
110 | - |
|
111 | - /** |
|
112 | - * @return NamingStrategyInterface |
|
113 | - */ |
|
114 | - public function getNamingStrategy(): NamingStrategyInterface |
|
115 | - { |
|
116 | - return $this->namingStrategy; |
|
117 | - } |
|
118 | - |
|
119 | - /** |
|
120 | - * @return Cache |
|
121 | - */ |
|
122 | - public function getCache(): Cache |
|
123 | - { |
|
124 | - return $this->cache; |
|
125 | - } |
|
126 | - |
|
127 | - /** |
|
128 | - * @return SchemaAnalyzer |
|
129 | - */ |
|
130 | - public function getSchemaAnalyzer(): SchemaAnalyzer |
|
131 | - { |
|
132 | - return $this->schemaAnalyzer; |
|
133 | - } |
|
134 | - |
|
135 | - /** |
|
136 | - * @return LoggerInterface |
|
137 | - */ |
|
138 | - public function getLogger(): ?LoggerInterface |
|
139 | - { |
|
140 | - return $this->logger; |
|
141 | - } |
|
142 | - |
|
143 | - /** |
|
144 | - * @return GeneratorListenerInterface |
|
145 | - */ |
|
146 | - public function getGeneratorEventDispatcher(): GeneratorListenerInterface |
|
147 | - { |
|
148 | - return $this->generatorEventDispatcher; |
|
149 | - } |
|
150 | - |
|
151 | - |
|
152 | - |
|
153 | - /** |
|
154 | - * Creates a unique cache key for the current connection. |
|
155 | - * |
|
156 | - * @return string |
|
157 | - */ |
|
158 | - private function getConnectionUniqueId(): string |
|
159 | - { |
|
160 | - return hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName()); |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * Returns a class able to find the place of a PHP file based on the class name. |
|
165 | - * Useful to find the path where DAOs and beans should be written to. |
|
166 | - * |
|
167 | - * @return PathFinderInterface |
|
168 | - */ |
|
169 | - public function getPathFinder(): PathFinderInterface |
|
170 | - { |
|
171 | - return $this->pathFinder; |
|
172 | - } |
|
173 | - |
|
174 | - /** |
|
175 | - * @param PathFinderInterface $pathFinder |
|
176 | - */ |
|
177 | - public function setPathFinder(PathFinderInterface $pathFinder) |
|
178 | - { |
|
179 | - $this->pathFinder = $pathFinder; |
|
180 | - } |
|
20 | + /** |
|
21 | + * @var string |
|
22 | + */ |
|
23 | + private $beanNamespace; |
|
24 | + /** |
|
25 | + * @var string |
|
26 | + */ |
|
27 | + private $daoNamespace; |
|
28 | + /** |
|
29 | + * @var Connection |
|
30 | + */ |
|
31 | + private $connection; |
|
32 | + /** |
|
33 | + * @var Cache |
|
34 | + */ |
|
35 | + private $cache; |
|
36 | + /** |
|
37 | + * @var SchemaAnalyzer |
|
38 | + */ |
|
39 | + private $schemaAnalyzer; |
|
40 | + /** |
|
41 | + * @var LoggerInterface |
|
42 | + */ |
|
43 | + private $logger; |
|
44 | + /** |
|
45 | + * @var GeneratorListenerInterface |
|
46 | + */ |
|
47 | + private $generatorEventDispatcher; |
|
48 | + /** |
|
49 | + * @var NamingStrategyInterface |
|
50 | + */ |
|
51 | + private $namingStrategy; |
|
52 | + /** |
|
53 | + * @var PathFinderInterface |
|
54 | + */ |
|
55 | + private $pathFinder; |
|
56 | + |
|
57 | + /** |
|
58 | + * @param string $beanNamespace The namespace hosting the beans |
|
59 | + * @param string $daoNamespace The namespace hosting the DAOs |
|
60 | + * @param Connection $connection The connection to the database |
|
61 | + * @param Cache|null $cache The Doctrine cache to store database metadata |
|
62 | + * @param SchemaAnalyzer|null $schemaAnalyzer The schema analyzer that will be used to find shortest paths... Will be automatically created if not passed |
|
63 | + * @param LoggerInterface|null $logger The logger |
|
64 | + * @param GeneratorListenerInterface[] $generatorListeners A list of listeners that will be triggered when beans/daos are generated |
|
65 | + */ |
|
66 | + public function __construct(string $beanNamespace, string $daoNamespace, Connection $connection, NamingStrategyInterface $namingStrategy, Cache $cache = null, SchemaAnalyzer $schemaAnalyzer = null, LoggerInterface $logger = null, array $generatorListeners = []) |
|
67 | + { |
|
68 | + $this->beanNamespace = rtrim($beanNamespace, '\\'); |
|
69 | + $this->daoNamespace = rtrim($daoNamespace, '\\'); |
|
70 | + $this->connection = $connection; |
|
71 | + $this->namingStrategy = $namingStrategy; |
|
72 | + if ($cache !== null) { |
|
73 | + $this->cache = $cache; |
|
74 | + } else { |
|
75 | + $this->cache = new VoidCache(); |
|
76 | + } |
|
77 | + if ($schemaAnalyzer !== null) { |
|
78 | + $this->schemaAnalyzer = $schemaAnalyzer; |
|
79 | + } else { |
|
80 | + $this->schemaAnalyzer = new SchemaAnalyzer($this->connection->getSchemaManager(), $this->cache, $this->getConnectionUniqueId()); |
|
81 | + } |
|
82 | + $this->logger = $logger; |
|
83 | + $this->generatorEventDispatcher = new GeneratorEventDispatcher($generatorListeners); |
|
84 | + $this->pathFinder = new PathFinder(); |
|
85 | + } |
|
86 | + |
|
87 | + /** |
|
88 | + * @return string |
|
89 | + */ |
|
90 | + public function getBeanNamespace(): string |
|
91 | + { |
|
92 | + return $this->beanNamespace; |
|
93 | + } |
|
94 | + |
|
95 | + /** |
|
96 | + * @return string |
|
97 | + */ |
|
98 | + public function getDaoNamespace(): string |
|
99 | + { |
|
100 | + return $this->daoNamespace; |
|
101 | + } |
|
102 | + |
|
103 | + /** |
|
104 | + * @return Connection |
|
105 | + */ |
|
106 | + public function getConnection(): Connection |
|
107 | + { |
|
108 | + return $this->connection; |
|
109 | + } |
|
110 | + |
|
111 | + /** |
|
112 | + * @return NamingStrategyInterface |
|
113 | + */ |
|
114 | + public function getNamingStrategy(): NamingStrategyInterface |
|
115 | + { |
|
116 | + return $this->namingStrategy; |
|
117 | + } |
|
118 | + |
|
119 | + /** |
|
120 | + * @return Cache |
|
121 | + */ |
|
122 | + public function getCache(): Cache |
|
123 | + { |
|
124 | + return $this->cache; |
|
125 | + } |
|
126 | + |
|
127 | + /** |
|
128 | + * @return SchemaAnalyzer |
|
129 | + */ |
|
130 | + public function getSchemaAnalyzer(): SchemaAnalyzer |
|
131 | + { |
|
132 | + return $this->schemaAnalyzer; |
|
133 | + } |
|
134 | + |
|
135 | + /** |
|
136 | + * @return LoggerInterface |
|
137 | + */ |
|
138 | + public function getLogger(): ?LoggerInterface |
|
139 | + { |
|
140 | + return $this->logger; |
|
141 | + } |
|
142 | + |
|
143 | + /** |
|
144 | + * @return GeneratorListenerInterface |
|
145 | + */ |
|
146 | + public function getGeneratorEventDispatcher(): GeneratorListenerInterface |
|
147 | + { |
|
148 | + return $this->generatorEventDispatcher; |
|
149 | + } |
|
150 | + |
|
151 | + |
|
152 | + |
|
153 | + /** |
|
154 | + * Creates a unique cache key for the current connection. |
|
155 | + * |
|
156 | + * @return string |
|
157 | + */ |
|
158 | + private function getConnectionUniqueId(): string |
|
159 | + { |
|
160 | + return hash('md4', $this->connection->getHost().'-'.$this->connection->getPort().'-'.$this->connection->getDatabase().'-'.$this->connection->getDriver()->getName()); |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * Returns a class able to find the place of a PHP file based on the class name. |
|
165 | + * Useful to find the path where DAOs and beans should be written to. |
|
166 | + * |
|
167 | + * @return PathFinderInterface |
|
168 | + */ |
|
169 | + public function getPathFinder(): PathFinderInterface |
|
170 | + { |
|
171 | + return $this->pathFinder; |
|
172 | + } |
|
173 | + |
|
174 | + /** |
|
175 | + * @param PathFinderInterface $pathFinder |
|
176 | + */ |
|
177 | + public function setPathFinder(PathFinderInterface $pathFinder) |
|
178 | + { |
|
179 | + $this->pathFinder = $pathFinder; |
|
180 | + } |
|
181 | 181 | } |
@@ -5,12 +5,12 @@ |
||
5 | 5 | |
6 | 6 | interface PathFinderInterface |
7 | 7 | { |
8 | - /** |
|
9 | - * Returns the path of a class file given the fully qualified class name. |
|
10 | - * |
|
11 | - * @param string $className |
|
12 | - * @return \SplFileInfo |
|
13 | - * @throws NoPathFoundException |
|
14 | - */ |
|
15 | - public function getPath(string $className) : \SplFileInfo; |
|
8 | + /** |
|
9 | + * Returns the path of a class file given the fully qualified class name. |
|
10 | + * |
|
11 | + * @param string $className |
|
12 | + * @return \SplFileInfo |
|
13 | + * @throws NoPathFoundException |
|
14 | + */ |
|
15 | + public function getPath(string $className) : \SplFileInfo; |
|
16 | 16 | } |
@@ -10,8 +10,8 @@ |
||
10 | 10 | */ |
11 | 11 | class NoPathFoundException extends TDBMException |
12 | 12 | { |
13 | - public static function create(string $className) |
|
14 | - { |
|
15 | - return new self(sprintf('Could not find a path where class %s would be autoloadable. Maybe consider editing your composer.json autoload section accordingly.', $className)); |
|
16 | - } |
|
13 | + public static function create(string $className) |
|
14 | + { |
|
15 | + return new self(sprintf('Could not find a path where class %s would be autoloadable. Maybe consider editing your composer.json autoload section accordingly.', $className)); |
|
16 | + } |
|
17 | 17 | } |
@@ -20,103 +20,103 @@ |
||
20 | 20 | */ |
21 | 21 | class AlteredConfiguration implements ConfigurationInterface |
22 | 22 | { |
23 | - /** |
|
24 | - * @var ConfigurationInterface |
|
25 | - */ |
|
26 | - private $configuration; |
|
27 | - |
|
28 | - /** |
|
29 | - * @var LoggerInterface |
|
30 | - */ |
|
31 | - private $logger; |
|
32 | - |
|
33 | - public function __construct(ConfigurationInterface $configuration) |
|
34 | - { |
|
35 | - $this->configuration = $configuration; |
|
36 | - $this->logger = $configuration->getLogger(); |
|
37 | - } |
|
38 | - |
|
39 | - |
|
40 | - /** |
|
41 | - * @return string |
|
42 | - */ |
|
43 | - public function getBeanNamespace(): string |
|
44 | - { |
|
45 | - return $this->configuration->getBeanNamespace(); |
|
46 | - } |
|
47 | - |
|
48 | - /** |
|
49 | - * @return string |
|
50 | - */ |
|
51 | - public function getDaoNamespace(): string |
|
52 | - { |
|
53 | - return $this->configuration->getDaoNamespace(); |
|
54 | - } |
|
55 | - |
|
56 | - /** |
|
57 | - * @return Connection |
|
58 | - */ |
|
59 | - public function getConnection(): Connection |
|
60 | - { |
|
61 | - return $this->configuration->getConnection(); |
|
62 | - } |
|
63 | - |
|
64 | - /** |
|
65 | - * @return Cache |
|
66 | - */ |
|
67 | - public function getCache(): Cache |
|
68 | - { |
|
69 | - return $this->configuration->getCache(); |
|
70 | - } |
|
71 | - |
|
72 | - /** |
|
73 | - * @return NamingStrategyInterface |
|
74 | - */ |
|
75 | - public function getNamingStrategy(): NamingStrategyInterface |
|
76 | - { |
|
77 | - return $this->configuration->getNamingStrategy(); |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * @return SchemaAnalyzer |
|
82 | - */ |
|
83 | - public function getSchemaAnalyzer(): SchemaAnalyzer |
|
84 | - { |
|
85 | - return $this->configuration->getSchemaAnalyzer(); |
|
86 | - } |
|
87 | - |
|
88 | - /** |
|
89 | - * @return LoggerInterface |
|
90 | - */ |
|
91 | - public function getLogger(): ?LoggerInterface |
|
92 | - { |
|
93 | - return $this->logger; |
|
94 | - } |
|
95 | - |
|
96 | - /** |
|
97 | - * @return GeneratorListenerInterface |
|
98 | - */ |
|
99 | - public function getGeneratorEventDispatcher(): GeneratorListenerInterface |
|
100 | - { |
|
101 | - return $this->configuration->getGeneratorEventDispatcher(); |
|
102 | - } |
|
103 | - |
|
104 | - /** |
|
105 | - * @param LoggerInterface $logger |
|
106 | - */ |
|
107 | - public function setLogger(LoggerInterface $logger) |
|
108 | - { |
|
109 | - $this->logger = $logger; |
|
110 | - } |
|
111 | - |
|
112 | - /** |
|
113 | - * Returns a class able to find the place of a PHP file based on the class name. |
|
114 | - * Useful to find the path where DAOs and beans should be written to. |
|
115 | - * |
|
116 | - * @return PathFinderInterface |
|
117 | - */ |
|
118 | - public function getPathFinder(): PathFinderInterface |
|
119 | - { |
|
120 | - return $this->configuration->getPathFinder(); |
|
121 | - } |
|
23 | + /** |
|
24 | + * @var ConfigurationInterface |
|
25 | + */ |
|
26 | + private $configuration; |
|
27 | + |
|
28 | + /** |
|
29 | + * @var LoggerInterface |
|
30 | + */ |
|
31 | + private $logger; |
|
32 | + |
|
33 | + public function __construct(ConfigurationInterface $configuration) |
|
34 | + { |
|
35 | + $this->configuration = $configuration; |
|
36 | + $this->logger = $configuration->getLogger(); |
|
37 | + } |
|
38 | + |
|
39 | + |
|
40 | + /** |
|
41 | + * @return string |
|
42 | + */ |
|
43 | + public function getBeanNamespace(): string |
|
44 | + { |
|
45 | + return $this->configuration->getBeanNamespace(); |
|
46 | + } |
|
47 | + |
|
48 | + /** |
|
49 | + * @return string |
|
50 | + */ |
|
51 | + public function getDaoNamespace(): string |
|
52 | + { |
|
53 | + return $this->configuration->getDaoNamespace(); |
|
54 | + } |
|
55 | + |
|
56 | + /** |
|
57 | + * @return Connection |
|
58 | + */ |
|
59 | + public function getConnection(): Connection |
|
60 | + { |
|
61 | + return $this->configuration->getConnection(); |
|
62 | + } |
|
63 | + |
|
64 | + /** |
|
65 | + * @return Cache |
|
66 | + */ |
|
67 | + public function getCache(): Cache |
|
68 | + { |
|
69 | + return $this->configuration->getCache(); |
|
70 | + } |
|
71 | + |
|
72 | + /** |
|
73 | + * @return NamingStrategyInterface |
|
74 | + */ |
|
75 | + public function getNamingStrategy(): NamingStrategyInterface |
|
76 | + { |
|
77 | + return $this->configuration->getNamingStrategy(); |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * @return SchemaAnalyzer |
|
82 | + */ |
|
83 | + public function getSchemaAnalyzer(): SchemaAnalyzer |
|
84 | + { |
|
85 | + return $this->configuration->getSchemaAnalyzer(); |
|
86 | + } |
|
87 | + |
|
88 | + /** |
|
89 | + * @return LoggerInterface |
|
90 | + */ |
|
91 | + public function getLogger(): ?LoggerInterface |
|
92 | + { |
|
93 | + return $this->logger; |
|
94 | + } |
|
95 | + |
|
96 | + /** |
|
97 | + * @return GeneratorListenerInterface |
|
98 | + */ |
|
99 | + public function getGeneratorEventDispatcher(): GeneratorListenerInterface |
|
100 | + { |
|
101 | + return $this->configuration->getGeneratorEventDispatcher(); |
|
102 | + } |
|
103 | + |
|
104 | + /** |
|
105 | + * @param LoggerInterface $logger |
|
106 | + */ |
|
107 | + public function setLogger(LoggerInterface $logger) |
|
108 | + { |
|
109 | + $this->logger = $logger; |
|
110 | + } |
|
111 | + |
|
112 | + /** |
|
113 | + * Returns a class able to find the place of a PHP file based on the class name. |
|
114 | + * Useful to find the path where DAOs and beans should be written to. |
|
115 | + * |
|
116 | + * @return PathFinderInterface |
|
117 | + */ |
|
118 | + public function getPathFinder(): PathFinderInterface |
|
119 | + { |
|
120 | + return $this->configuration->getPathFinder(); |
|
121 | + } |
|
122 | 122 | } |
@@ -135,7 +135,7 @@ |
||
135 | 135 | /** |
136 | 136 | * @return LoggerInterface |
137 | 137 | */ |
138 | - public function getLogger(): ?LoggerInterface |
|
138 | + public function getLogger(): ? LoggerInterface |
|
139 | 139 | { |
140 | 140 | return $this->logger; |
141 | 141 | } |
@@ -5,58 +5,58 @@ |
||
5 | 5 | |
6 | 6 | class PathFinder implements PathFinderInterface |
7 | 7 | { |
8 | - /** |
|
9 | - * @var string |
|
10 | - */ |
|
11 | - private $composerFile; |
|
12 | - |
|
13 | - /** |
|
14 | - * @var string |
|
15 | - */ |
|
16 | - private $rootPath; |
|
17 | - |
|
18 | - /** |
|
19 | - * @var bool |
|
20 | - */ |
|
21 | - private $useAutoloadDev; |
|
22 | - |
|
23 | - /** |
|
24 | - * @var ClassNameMapper |
|
25 | - */ |
|
26 | - private $classNameMapper; |
|
27 | - |
|
28 | - public function __construct(string $composerFile = null, string $rootPath = null, bool $useAutoloadDev = false) |
|
29 | - { |
|
30 | - $this->composerFile = $composerFile; |
|
31 | - $this->useAutoloadDev = $useAutoloadDev; |
|
32 | - if ($rootPath === null) { |
|
33 | - $this->rootPath = dirname(__DIR__, 9); |
|
34 | - } else { |
|
35 | - $this->rootPath = $rootPath; |
|
36 | - } |
|
37 | - } |
|
38 | - |
|
39 | - private function getClassNameMapper() : ClassNameMapper |
|
40 | - { |
|
41 | - if ($this->classNameMapper === null) { |
|
42 | - $this->classNameMapper = ClassNameMapper::createFromComposerFile($this->composerFile, $this->rootPath, $this->useAutoloadDev); |
|
43 | - } |
|
44 | - return $this->classNameMapper; |
|
45 | - } |
|
46 | - |
|
47 | - /** |
|
48 | - * Returns the path of a class file given the fully qualified class name. |
|
49 | - * |
|
50 | - * @param string $className |
|
51 | - * @return \SplFileInfo |
|
52 | - * @throws NoPathFoundException |
|
53 | - */ |
|
54 | - public function getPath(string $className): \SplFileInfo |
|
55 | - { |
|
56 | - $paths = $this->getClassNameMapper()->getPossibleFileNames($className); |
|
57 | - if (empty($paths)) { |
|
58 | - throw NoPathFoundException::create($className); |
|
59 | - } |
|
60 | - return new \SplFileInfo($this->rootPath.'/'.$paths[0]); |
|
61 | - } |
|
8 | + /** |
|
9 | + * @var string |
|
10 | + */ |
|
11 | + private $composerFile; |
|
12 | + |
|
13 | + /** |
|
14 | + * @var string |
|
15 | + */ |
|
16 | + private $rootPath; |
|
17 | + |
|
18 | + /** |
|
19 | + * @var bool |
|
20 | + */ |
|
21 | + private $useAutoloadDev; |
|
22 | + |
|
23 | + /** |
|
24 | + * @var ClassNameMapper |
|
25 | + */ |
|
26 | + private $classNameMapper; |
|
27 | + |
|
28 | + public function __construct(string $composerFile = null, string $rootPath = null, bool $useAutoloadDev = false) |
|
29 | + { |
|
30 | + $this->composerFile = $composerFile; |
|
31 | + $this->useAutoloadDev = $useAutoloadDev; |
|
32 | + if ($rootPath === null) { |
|
33 | + $this->rootPath = dirname(__DIR__, 9); |
|
34 | + } else { |
|
35 | + $this->rootPath = $rootPath; |
|
36 | + } |
|
37 | + } |
|
38 | + |
|
39 | + private function getClassNameMapper() : ClassNameMapper |
|
40 | + { |
|
41 | + if ($this->classNameMapper === null) { |
|
42 | + $this->classNameMapper = ClassNameMapper::createFromComposerFile($this->composerFile, $this->rootPath, $this->useAutoloadDev); |
|
43 | + } |
|
44 | + return $this->classNameMapper; |
|
45 | + } |
|
46 | + |
|
47 | + /** |
|
48 | + * Returns the path of a class file given the fully qualified class name. |
|
49 | + * |
|
50 | + * @param string $className |
|
51 | + * @return \SplFileInfo |
|
52 | + * @throws NoPathFoundException |
|
53 | + */ |
|
54 | + public function getPath(string $className): \SplFileInfo |
|
55 | + { |
|
56 | + $paths = $this->getClassNameMapper()->getPossibleFileNames($className); |
|
57 | + if (empty($paths)) { |
|
58 | + throw NoPathFoundException::create($className); |
|
59 | + } |
|
60 | + return new \SplFileInfo($this->rootPath.'/'.$paths[0]); |
|
61 | + } |
|
62 | 62 | } |
@@ -7,193 +7,193 @@ |
||
7 | 7 | |
8 | 8 | class DefaultNamingStrategy implements NamingStrategyInterface |
9 | 9 | { |
10 | - private $beanPrefix = ''; |
|
11 | - private $beanSuffix = ''; |
|
12 | - private $baseBeanPrefix = 'Abstract'; |
|
13 | - private $baseBeanSuffix = ''; |
|
14 | - private $daoPrefix = ''; |
|
15 | - private $daoSuffix = 'Dao'; |
|
16 | - private $baseDaoPrefix = 'Abstract'; |
|
17 | - private $baseDaoSuffix = 'Dao'; |
|
18 | - private $exceptions = []; |
|
19 | - |
|
20 | - /** |
|
21 | - * Sets the string prefix to any bean class name. |
|
22 | - * |
|
23 | - * @param string $beanPrefix |
|
24 | - */ |
|
25 | - public function setBeanPrefix(string $beanPrefix) |
|
26 | - { |
|
27 | - $this->beanPrefix = $beanPrefix; |
|
28 | - } |
|
29 | - |
|
30 | - /** |
|
31 | - * Sets the string suffix to any bean class name. |
|
32 | - * |
|
33 | - * @param string $beanSuffix |
|
34 | - */ |
|
35 | - public function setBeanSuffix(string $beanSuffix) |
|
36 | - { |
|
37 | - $this->beanSuffix = $beanSuffix; |
|
38 | - } |
|
39 | - |
|
40 | - /** |
|
41 | - * Sets the string prefix to any base bean class name. |
|
42 | - * |
|
43 | - * @param string $baseBeanPrefix |
|
44 | - */ |
|
45 | - public function setBaseBeanPrefix(string $baseBeanPrefix) |
|
46 | - { |
|
47 | - $this->baseBeanPrefix = $baseBeanPrefix; |
|
48 | - } |
|
49 | - |
|
50 | - /** |
|
51 | - * Sets the string suffix to any base bean class name. |
|
52 | - * |
|
53 | - * @param string $baseBeanSuffix |
|
54 | - */ |
|
55 | - public function setBaseBeanSuffix(string $baseBeanSuffix) |
|
56 | - { |
|
57 | - $this->baseBeanSuffix = $baseBeanSuffix; |
|
58 | - } |
|
59 | - |
|
60 | - /** |
|
61 | - * Sets the string prefix to any DAO class name. |
|
62 | - * |
|
63 | - * @param string $daoPrefix |
|
64 | - */ |
|
65 | - public function setDaoPrefix(string $daoPrefix) |
|
66 | - { |
|
67 | - $this->daoPrefix = $daoPrefix; |
|
68 | - } |
|
69 | - |
|
70 | - /** |
|
71 | - * Sets the string suffix to any DAO class name. |
|
72 | - * |
|
73 | - * @param string $daoSuffix |
|
74 | - */ |
|
75 | - public function setDaoSuffix(string $daoSuffix) |
|
76 | - { |
|
77 | - $this->daoSuffix = $daoSuffix; |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * Sets the string prefix to any base DAO class name. |
|
82 | - * |
|
83 | - * @param string $baseDaoPrefix |
|
84 | - */ |
|
85 | - public function setBaseDaoPrefix(string $baseDaoPrefix) |
|
86 | - { |
|
87 | - $this->baseDaoPrefix = $baseDaoPrefix; |
|
88 | - } |
|
89 | - |
|
90 | - /** |
|
91 | - * Sets the string suffix to any base DAO class name. |
|
92 | - * |
|
93 | - * @param string $baseDaoSuffix |
|
94 | - */ |
|
95 | - public function setBaseDaoSuffix(string $baseDaoSuffix) |
|
96 | - { |
|
97 | - $this->baseDaoSuffix = $baseDaoSuffix; |
|
98 | - } |
|
99 | - |
|
100 | - |
|
101 | - /** |
|
102 | - * Returns the bean class name from the table name (excluding the namespace). |
|
103 | - * |
|
104 | - * @param string $tableName |
|
105 | - * @return string |
|
106 | - */ |
|
107 | - public function getBeanClassName(string $tableName): string |
|
108 | - { |
|
109 | - return $this->beanPrefix.$this->toSingularCamelCase($tableName).$this->beanSuffix; |
|
110 | - } |
|
111 | - |
|
112 | - /** |
|
113 | - * Returns the base bean class name from the table name (excluding the namespace). |
|
114 | - * |
|
115 | - * @param string $tableName |
|
116 | - * @return string |
|
117 | - */ |
|
118 | - public function getBaseBeanClassName(string $tableName): string |
|
119 | - { |
|
120 | - return $this->baseBeanPrefix.$this->toSingularCamelCase($tableName).$this->baseBeanSuffix; |
|
121 | - } |
|
122 | - |
|
123 | - /** |
|
124 | - * Returns the name of the DAO class from the table name (excluding the namespace). |
|
125 | - * |
|
126 | - * @param string $tableName |
|
127 | - * @return string |
|
128 | - */ |
|
129 | - public function getDaoClassName(string $tableName): string |
|
130 | - { |
|
131 | - return $this->daoPrefix.$this->toSingularCamelCase($tableName).$this->daoSuffix; |
|
132 | - } |
|
133 | - |
|
134 | - /** |
|
135 | - * Returns the name of the base DAO class from the table name (excluding the namespace). |
|
136 | - * |
|
137 | - * @param string $tableName |
|
138 | - * @return string |
|
139 | - */ |
|
140 | - public function getBaseDaoClassName(string $tableName): string |
|
141 | - { |
|
142 | - return $this->baseDaoPrefix.$this->toSingularCamelCase($tableName).$this->baseDaoSuffix; |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * Tries to put string to the singular form (if it is plural) and camel case form. |
|
147 | - * We assume the table names are in english. |
|
148 | - * |
|
149 | - * @param $str string |
|
150 | - * |
|
151 | - * @return string |
|
152 | - */ |
|
153 | - private function toSingularCamelCase(string $str): string |
|
154 | - { |
|
155 | - // Let's first check if this is not in the exceptions directory. |
|
156 | - if (isset($this->exceptions[$str])) { |
|
157 | - return $this->exceptions[$str]; |
|
158 | - } |
|
159 | - |
|
160 | - $tokens = preg_split("/[_ ]+/", $str); |
|
161 | - $tokens = array_map([Inflector::class, 'singularize'], $tokens); |
|
162 | - |
|
163 | - $str = ''; |
|
164 | - foreach ($tokens as $token) { |
|
165 | - $str .= ucfirst(Inflector::singularize($token)); |
|
166 | - } |
|
167 | - |
|
168 | - return $str; |
|
169 | - } |
|
170 | - |
|
171 | - /** |
|
172 | - * Returns the class name for the DAO factory. |
|
173 | - * |
|
174 | - * @return string |
|
175 | - */ |
|
176 | - public function getDaoFactoryClassName(): string |
|
177 | - { |
|
178 | - return 'DaoFactory'; |
|
179 | - } |
|
180 | - |
|
181 | - /** |
|
182 | - * Sets exceptions in the naming of classes. |
|
183 | - * The key is the name of the table, the value the "base" name of beans and DAOs. |
|
184 | - * |
|
185 | - * This is very useful for dealing with plural to singular translations in non english table names. |
|
186 | - * |
|
187 | - * For instance if you are dealing with a table containing horses in French ("chevaux" that has a singular "cheval"): |
|
188 | - * |
|
189 | - * [ |
|
190 | - * "chevaux" => "Cheval" |
|
191 | - * ] |
|
192 | - * |
|
193 | - * @param array<string,string> $exceptions |
|
194 | - */ |
|
195 | - public function setExceptions(array $exceptions) |
|
196 | - { |
|
197 | - $this->exceptions = $exceptions; |
|
198 | - } |
|
10 | + private $beanPrefix = ''; |
|
11 | + private $beanSuffix = ''; |
|
12 | + private $baseBeanPrefix = 'Abstract'; |
|
13 | + private $baseBeanSuffix = ''; |
|
14 | + private $daoPrefix = ''; |
|
15 | + private $daoSuffix = 'Dao'; |
|
16 | + private $baseDaoPrefix = 'Abstract'; |
|
17 | + private $baseDaoSuffix = 'Dao'; |
|
18 | + private $exceptions = []; |
|
19 | + |
|
20 | + /** |
|
21 | + * Sets the string prefix to any bean class name. |
|
22 | + * |
|
23 | + * @param string $beanPrefix |
|
24 | + */ |
|
25 | + public function setBeanPrefix(string $beanPrefix) |
|
26 | + { |
|
27 | + $this->beanPrefix = $beanPrefix; |
|
28 | + } |
|
29 | + |
|
30 | + /** |
|
31 | + * Sets the string suffix to any bean class name. |
|
32 | + * |
|
33 | + * @param string $beanSuffix |
|
34 | + */ |
|
35 | + public function setBeanSuffix(string $beanSuffix) |
|
36 | + { |
|
37 | + $this->beanSuffix = $beanSuffix; |
|
38 | + } |
|
39 | + |
|
40 | + /** |
|
41 | + * Sets the string prefix to any base bean class name. |
|
42 | + * |
|
43 | + * @param string $baseBeanPrefix |
|
44 | + */ |
|
45 | + public function setBaseBeanPrefix(string $baseBeanPrefix) |
|
46 | + { |
|
47 | + $this->baseBeanPrefix = $baseBeanPrefix; |
|
48 | + } |
|
49 | + |
|
50 | + /** |
|
51 | + * Sets the string suffix to any base bean class name. |
|
52 | + * |
|
53 | + * @param string $baseBeanSuffix |
|
54 | + */ |
|
55 | + public function setBaseBeanSuffix(string $baseBeanSuffix) |
|
56 | + { |
|
57 | + $this->baseBeanSuffix = $baseBeanSuffix; |
|
58 | + } |
|
59 | + |
|
60 | + /** |
|
61 | + * Sets the string prefix to any DAO class name. |
|
62 | + * |
|
63 | + * @param string $daoPrefix |
|
64 | + */ |
|
65 | + public function setDaoPrefix(string $daoPrefix) |
|
66 | + { |
|
67 | + $this->daoPrefix = $daoPrefix; |
|
68 | + } |
|
69 | + |
|
70 | + /** |
|
71 | + * Sets the string suffix to any DAO class name. |
|
72 | + * |
|
73 | + * @param string $daoSuffix |
|
74 | + */ |
|
75 | + public function setDaoSuffix(string $daoSuffix) |
|
76 | + { |
|
77 | + $this->daoSuffix = $daoSuffix; |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * Sets the string prefix to any base DAO class name. |
|
82 | + * |
|
83 | + * @param string $baseDaoPrefix |
|
84 | + */ |
|
85 | + public function setBaseDaoPrefix(string $baseDaoPrefix) |
|
86 | + { |
|
87 | + $this->baseDaoPrefix = $baseDaoPrefix; |
|
88 | + } |
|
89 | + |
|
90 | + /** |
|
91 | + * Sets the string suffix to any base DAO class name. |
|
92 | + * |
|
93 | + * @param string $baseDaoSuffix |
|
94 | + */ |
|
95 | + public function setBaseDaoSuffix(string $baseDaoSuffix) |
|
96 | + { |
|
97 | + $this->baseDaoSuffix = $baseDaoSuffix; |
|
98 | + } |
|
99 | + |
|
100 | + |
|
101 | + /** |
|
102 | + * Returns the bean class name from the table name (excluding the namespace). |
|
103 | + * |
|
104 | + * @param string $tableName |
|
105 | + * @return string |
|
106 | + */ |
|
107 | + public function getBeanClassName(string $tableName): string |
|
108 | + { |
|
109 | + return $this->beanPrefix.$this->toSingularCamelCase($tableName).$this->beanSuffix; |
|
110 | + } |
|
111 | + |
|
112 | + /** |
|
113 | + * Returns the base bean class name from the table name (excluding the namespace). |
|
114 | + * |
|
115 | + * @param string $tableName |
|
116 | + * @return string |
|
117 | + */ |
|
118 | + public function getBaseBeanClassName(string $tableName): string |
|
119 | + { |
|
120 | + return $this->baseBeanPrefix.$this->toSingularCamelCase($tableName).$this->baseBeanSuffix; |
|
121 | + } |
|
122 | + |
|
123 | + /** |
|
124 | + * Returns the name of the DAO class from the table name (excluding the namespace). |
|
125 | + * |
|
126 | + * @param string $tableName |
|
127 | + * @return string |
|
128 | + */ |
|
129 | + public function getDaoClassName(string $tableName): string |
|
130 | + { |
|
131 | + return $this->daoPrefix.$this->toSingularCamelCase($tableName).$this->daoSuffix; |
|
132 | + } |
|
133 | + |
|
134 | + /** |
|
135 | + * Returns the name of the base DAO class from the table name (excluding the namespace). |
|
136 | + * |
|
137 | + * @param string $tableName |
|
138 | + * @return string |
|
139 | + */ |
|
140 | + public function getBaseDaoClassName(string $tableName): string |
|
141 | + { |
|
142 | + return $this->baseDaoPrefix.$this->toSingularCamelCase($tableName).$this->baseDaoSuffix; |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * Tries to put string to the singular form (if it is plural) and camel case form. |
|
147 | + * We assume the table names are in english. |
|
148 | + * |
|
149 | + * @param $str string |
|
150 | + * |
|
151 | + * @return string |
|
152 | + */ |
|
153 | + private function toSingularCamelCase(string $str): string |
|
154 | + { |
|
155 | + // Let's first check if this is not in the exceptions directory. |
|
156 | + if (isset($this->exceptions[$str])) { |
|
157 | + return $this->exceptions[$str]; |
|
158 | + } |
|
159 | + |
|
160 | + $tokens = preg_split("/[_ ]+/", $str); |
|
161 | + $tokens = array_map([Inflector::class, 'singularize'], $tokens); |
|
162 | + |
|
163 | + $str = ''; |
|
164 | + foreach ($tokens as $token) { |
|
165 | + $str .= ucfirst(Inflector::singularize($token)); |
|
166 | + } |
|
167 | + |
|
168 | + return $str; |
|
169 | + } |
|
170 | + |
|
171 | + /** |
|
172 | + * Returns the class name for the DAO factory. |
|
173 | + * |
|
174 | + * @return string |
|
175 | + */ |
|
176 | + public function getDaoFactoryClassName(): string |
|
177 | + { |
|
178 | + return 'DaoFactory'; |
|
179 | + } |
|
180 | + |
|
181 | + /** |
|
182 | + * Sets exceptions in the naming of classes. |
|
183 | + * The key is the name of the table, the value the "base" name of beans and DAOs. |
|
184 | + * |
|
185 | + * This is very useful for dealing with plural to singular translations in non english table names. |
|
186 | + * |
|
187 | + * For instance if you are dealing with a table containing horses in French ("chevaux" that has a singular "cheval"): |
|
188 | + * |
|
189 | + * [ |
|
190 | + * "chevaux" => "Cheval" |
|
191 | + * ] |
|
192 | + * |
|
193 | + * @param array<string,string> $exceptions |
|
194 | + */ |
|
195 | + public function setExceptions(array $exceptions) |
|
196 | + { |
|
197 | + $this->exceptions = $exceptions; |
|
198 | + } |
|
199 | 199 | } |