Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
1 | <?php |
||
18 | final class DoctrineDbalServiceProvider implements ServiceProviderInterface |
||
19 | { |
||
20 | /** |
||
21 | * @param Container $container |
||
22 | */ |
||
23 | 3 | public function register(Container $container) |
|
24 | { |
||
25 | 3 | $container['doctrine.dbal.db'] = $this->getDbDefinition($container); |
|
26 | 3 | $container['doctrine.dbal.db.cache_factory.apcu'] = $this->getDbApcuCacheFactoryDefinition($container); |
|
27 | 3 | $container['doctrine.dbal.db.cache_factory.array'] = $this->getDbArrayCacheFactoryDefinition($container); |
|
28 | 3 | $container['doctrine.dbal.db.config'] = $this->getDbConfigDefinition($container); |
|
29 | 3 | $container['doctrine.dbal.db.default_options'] = $this->getDbDefaultOptions(); |
|
30 | 3 | $container['doctrine.dbal.db.event_manager'] = $this->getDbEventManagerDefinition($container); |
|
31 | 3 | $container['doctrine.dbal.dbs'] = $this->getDbsDefinition($container); |
|
32 | 3 | $container['doctrine.dbal.dbs.config'] = $this->getDbsConfigDefinition($container); |
|
33 | 3 | $container['doctrine.dbal.dbs.event_manager'] = $this->getDbsEventManagerDefinition($container); |
|
34 | 3 | $container['doctrine.dbal.dbs.options.initializer'] = $this->getDbsOptionsInitializerDefinition($container); |
|
35 | 3 | $container['doctrine.dbal.types'] = []; |
|
36 | 3 | } |
|
37 | |||
38 | /** |
||
39 | * @param Container $container |
||
40 | * |
||
41 | * @return callable |
||
42 | */ |
||
43 | private function getDbDefinition(Container $container): callable |
||
44 | { |
||
45 | 3 | return function () use ($container) { |
|
46 | 2 | $dbs = $container['doctrine.dbal.dbs']; |
|
47 | |||
48 | 2 | return $dbs[$container['doctrine.dbal.dbs.default']]; |
|
49 | 3 | }; |
|
50 | } |
||
51 | |||
52 | /** |
||
53 | * @param Container $container |
||
54 | * |
||
55 | * @return callable |
||
56 | */ |
||
57 | private function getDbApcuCacheFactoryDefinition(Container $container): callable |
||
58 | { |
||
59 | 3 | return $container->protect(function (array $options) use ($container) { |
|
|
|||
60 | 1 | return new ApcuCache(); |
|
61 | 3 | }); |
|
62 | } |
||
63 | |||
64 | /** |
||
65 | * @param Container $container |
||
66 | * |
||
67 | * @return callable |
||
68 | */ |
||
69 | private function getDbArrayCacheFactoryDefinition(Container $container): callable |
||
70 | { |
||
71 | 3 | return $container->protect(function (array $options) use ($container) { |
|
72 | 1 | return new ArrayCache(); |
|
73 | 3 | }); |
|
74 | } |
||
75 | |||
76 | /** |
||
77 | * @param Container $container |
||
78 | * |
||
79 | * @return callable |
||
80 | */ |
||
81 | private function getDbConfigDefinition(Container $container): callable |
||
82 | { |
||
83 | 3 | return function () use ($container) { |
|
84 | 3 | $dbs = $container['doctrine.dbal.dbs.config']; |
|
85 | |||
86 | 3 | return $dbs[$container['doctrine.dbal.dbs.default']]; |
|
87 | 3 | }; |
|
88 | } |
||
89 | |||
90 | /** |
||
91 | * @return array |
||
92 | */ |
||
93 | 3 | private function getDbDefaultOptions(): array |
|
94 | { |
||
95 | return [ |
||
96 | 3 | 'configuration' => [ |
|
97 | 'auto_commit' => true, |
||
98 | 'cache.result' => 'array', |
||
99 | 'filter_schema_assets_expression' => null, |
||
100 | ], |
||
101 | 'connection' => [ |
||
102 | 'charset' => 'utf8mb4', |
||
103 | 'dbname' => null, |
||
104 | 'driver' => 'pdo_mysql', |
||
105 | 'host' => 'localhost', |
||
106 | 'password' => null, |
||
107 | 'path' => null, |
||
108 | 'port' => 3306, |
||
109 | 'user' => 'root', |
||
110 | ], |
||
111 | ]; |
||
112 | } |
||
113 | |||
114 | /** |
||
115 | * @param Container $container |
||
116 | * |
||
117 | * @return callable |
||
118 | */ |
||
119 | private function getDbEventManagerDefinition(Container $container): callable |
||
120 | { |
||
121 | 3 | return function () use ($container) { |
|
122 | 3 | $dbs = $container['doctrine.dbal.dbs.event_manager']; |
|
123 | |||
124 | 3 | return $dbs[$container['doctrine.dbal.dbs.default']]; |
|
125 | 3 | }; |
|
126 | } |
||
127 | |||
128 | /** |
||
129 | * @param Container $container |
||
130 | * |
||
131 | * @return callable |
||
132 | */ |
||
133 | private function getDbsDefinition(Container $container): callable |
||
134 | { |
||
135 | 3 | return function () use ($container) { |
|
136 | 3 | $container['doctrine.dbal.dbs.options.initializer'](); |
|
137 | |||
138 | 3 | $dbs = new Container(); |
|
139 | 3 | foreach ($container['doctrine.dbal.dbs.options'] as $name => $options) { |
|
140 | 3 | if ($container['doctrine.dbal.dbs.default'] === $name) { |
|
141 | 3 | $config = $container['doctrine.dbal.db.config']; |
|
142 | 3 | $manager = $container['doctrine.dbal.db.event_manager']; |
|
143 | } else { |
||
144 | 1 | $config = $container['doctrine.dbal.dbs.config'][$name]; |
|
145 | 1 | $manager = $container['doctrine.dbal.dbs.event_manager'][$name]; |
|
146 | } |
||
147 | |||
148 | 3 | $dbs[$name] = function () use ($options, $config, $manager) { |
|
149 | 3 | return DriverManager::getConnection($options['connection'], $config, $manager); |
|
150 | 3 | }; |
|
151 | } |
||
152 | |||
153 | 3 | return $dbs; |
|
154 | 3 | }; |
|
155 | } |
||
156 | |||
157 | /** |
||
158 | * @param Container $container |
||
159 | * |
||
160 | * @return callable |
||
161 | */ |
||
162 | private function getDbsConfigDefinition(Container $container): callable |
||
163 | { |
||
164 | 3 | return function () use ($container) { |
|
165 | 3 | $container['doctrine.dbal.dbs.options.initializer'](); |
|
166 | |||
167 | 3 | $addLogger = $container['logger'] ?? false; |
|
168 | |||
169 | 3 | $configs = new Container(); |
|
170 | 3 | foreach ($container['doctrine.dbal.dbs.options'] as $name => $options) { |
|
171 | 3 | $configs[$name] = function () use ($addLogger, $container, $name, $options) { |
|
172 | 3 | $configOptions = $options['configuration']; |
|
173 | |||
174 | 3 | $config = new Configuration(); |
|
175 | |||
176 | 3 | if ($addLogger) { |
|
177 | 2 | $config->setSQLLogger(new DoctrineDbalLogger($container['logger'])); |
|
178 | } |
||
179 | |||
180 | 3 | $config->setResultCacheImpl(static::getCache($container, $configOptions['cache.result'])); |
|
181 | |||
182 | 3 | $config->setFilterSchemaAssetsExpression($configOptions['filter_schema_assets_expression']); |
|
183 | 3 | $config->setAutoCommit($configOptions['auto_commit']); |
|
184 | |||
185 | 3 | return $config; |
|
186 | 3 | }; |
|
187 | } |
||
188 | |||
189 | 3 | return $configs; |
|
190 | 3 | }; |
|
191 | } |
||
192 | |||
193 | /** |
||
194 | * @param Container $container |
||
195 | * |
||
196 | * @return callable |
||
197 | */ |
||
198 | View Code Duplication | private function getDbsEventManagerDefinition(Container $container): callable |
|
213 | |||
214 | /** |
||
215 | * @param Container $container |
||
216 | * |
||
217 | * @return callable |
||
218 | */ |
||
219 | private function getDbsOptionsInitializerDefinition(Container $container): callable |
||
256 | |||
257 | /** |
||
258 | * @param Container $container |
||
259 | * @param string|array $cacheDefinition |
||
260 | * |
||
261 | * @return Cache |
||
262 | * |
||
263 | * @throws \InvalidArgumentException |
||
264 | */ |
||
265 | 3 | public static function getCache(Container $container, $cacheDefinition): Cache |
|
283 | } |
||
284 |
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.