Complex classes like Configuration often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Configuration, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
55 | class Configuration extends \Doctrine\DBAL\Configuration |
||
56 | { |
||
57 | /** |
||
58 | * Sets the directory where Doctrine generates any necessary proxy class files. |
||
59 | * |
||
60 | * @param string $dir |
||
61 | * |
||
62 | * @return void |
||
63 | */ |
||
64 | 2391 | public function setProxyDir($dir) |
|
68 | |||
69 | /** |
||
70 | * Gets the directory where Doctrine generates any necessary proxy class files. |
||
71 | * |
||
72 | * @return string|null |
||
73 | */ |
||
74 | 2387 | public function getProxyDir() |
|
80 | |||
81 | /** |
||
82 | * Gets the strategy for automatically generating proxy classes. |
||
83 | * |
||
84 | * @return int Possible values are constants of Doctrine\Common\Proxy\AbstractProxyFactory. |
||
85 | */ |
||
86 | 2389 | public function getAutoGenerateProxyClasses() |
|
92 | |||
93 | /** |
||
94 | * Sets the strategy for automatically generating proxy classes. |
||
95 | * |
||
96 | * @param boolean|int $autoGenerate Possible values are constants of Doctrine\Common\Proxy\AbstractProxyFactory. |
||
97 | * True is converted to AUTOGENERATE_ALWAYS, false to AUTOGENERATE_NEVER. |
||
98 | * |
||
99 | * @return void |
||
100 | */ |
||
101 | 15 | public function setAutoGenerateProxyClasses($autoGenerate) |
|
105 | |||
106 | /** |
||
107 | * Gets the namespace where proxy classes reside. |
||
108 | * |
||
109 | * @return string|null |
||
110 | */ |
||
111 | 2386 | public function getProxyNamespace() |
|
117 | |||
118 | /** |
||
119 | * Sets the namespace where proxy classes reside. |
||
120 | * |
||
121 | * @param string $ns |
||
122 | * |
||
123 | * @return void |
||
124 | */ |
||
125 | 2391 | public function setProxyNamespace($ns) |
|
129 | |||
130 | /** |
||
131 | * Sets the cache driver implementation that is used for metadata caching. |
||
132 | * |
||
133 | * @param MappingDriver $driverImpl |
||
134 | * |
||
135 | * @return void |
||
136 | * |
||
137 | * @todo Force parameter to be a Closure to ensure lazy evaluation |
||
138 | * (as soon as a metadata cache is in effect, the driver never needs to initialize). |
||
139 | */ |
||
140 | 2390 | public function setMetadataDriverImpl(MappingDriver $driverImpl) |
|
144 | |||
145 | /** |
||
146 | * Adds a new default annotation driver with a correctly configured annotation reader. If $useSimpleAnnotationReader |
||
147 | * is true, the notation `@Entity` will work, otherwise, the notation `@ORM\Entity` will be supported. |
||
148 | * |
||
149 | * @param array $paths |
||
150 | * @param bool $useSimpleAnnotationReader |
||
151 | * |
||
152 | * @return AnnotationDriver |
||
153 | */ |
||
154 | 2366 | public function newDefaultAnnotationDriver($paths = [], $useSimpleAnnotationReader = true) |
|
172 | |||
173 | /** |
||
174 | * Adds a namespace under a certain alias. |
||
175 | * |
||
176 | * @param string $alias |
||
177 | * @param string $namespace |
||
178 | * |
||
179 | * @return void |
||
180 | */ |
||
181 | 8 | public function addEntityNamespace($alias, $namespace) |
|
185 | |||
186 | /** |
||
187 | * Resolves a registered namespace alias to the full namespace. |
||
188 | * |
||
189 | * @param string $entityNamespaceAlias |
||
190 | * |
||
191 | * @return string |
||
192 | * |
||
193 | * @throws ORMException |
||
194 | */ |
||
195 | 13 | public function getEntityNamespace($entityNamespaceAlias) |
|
203 | |||
204 | /** |
||
205 | * Sets the entity alias map. |
||
206 | * |
||
207 | * @param array $entityNamespaces |
||
208 | * |
||
209 | * @return void |
||
210 | */ |
||
211 | 97 | public function setEntityNamespaces(array $entityNamespaces) |
|
215 | |||
216 | /** |
||
217 | * Retrieves the list of registered entity namespace aliases. |
||
218 | * |
||
219 | * @return array |
||
220 | */ |
||
221 | 1 | public function getEntityNamespaces() |
|
225 | |||
226 | /** |
||
227 | * Gets the cache driver implementation that is used for the mapping metadata. |
||
228 | * |
||
229 | * @return MappingDriver|null |
||
230 | * |
||
231 | * @throws ORMException |
||
232 | */ |
||
233 | 1522 | public function getMetadataDriverImpl() |
|
239 | |||
240 | /** |
||
241 | * Gets the cache driver implementation that is used for the query cache (SQL cache). |
||
242 | * |
||
243 | * @return \Doctrine\Common\Cache\Cache|null |
||
244 | */ |
||
245 | 578 | public function getQueryCacheImpl() |
|
251 | |||
252 | /** |
||
253 | * Sets the cache driver implementation that is used for the query cache (SQL cache). |
||
254 | * |
||
255 | * @param \Doctrine\Common\Cache\Cache $cacheImpl |
||
256 | * |
||
257 | * @return void |
||
258 | */ |
||
259 | 2327 | public function setQueryCacheImpl(CacheDriver $cacheImpl) |
|
263 | |||
264 | /** |
||
265 | * Gets the cache driver implementation that is used for the hydration cache (SQL cache). |
||
266 | * |
||
267 | * @return \Doctrine\Common\Cache\Cache|null |
||
268 | */ |
||
269 | 1 | public function getHydrationCacheImpl() |
|
275 | |||
276 | /** |
||
277 | * Sets the cache driver implementation that is used for the hydration cache (SQL cache). |
||
278 | * |
||
279 | * @param \Doctrine\Common\Cache\Cache $cacheImpl |
||
280 | * |
||
281 | * @return void |
||
282 | */ |
||
283 | 1 | public function setHydrationCacheImpl(CacheDriver $cacheImpl) |
|
287 | |||
288 | /** |
||
289 | * Gets the cache driver implementation that is used for metadata caching. |
||
290 | * |
||
291 | * @return \Doctrine\Common\Cache\Cache|null |
||
292 | */ |
||
293 | 2393 | public function getMetadataCacheImpl() |
|
299 | |||
300 | /** |
||
301 | * Sets the cache driver implementation that is used for metadata caching. |
||
302 | * |
||
303 | * @param \Doctrine\Common\Cache\Cache $cacheImpl |
||
304 | * |
||
305 | * @return void |
||
306 | */ |
||
307 | 2327 | public function setMetadataCacheImpl(CacheDriver $cacheImpl) |
|
311 | |||
312 | /** |
||
313 | * Adds a named DQL query to the configuration. |
||
314 | * |
||
315 | * @param string $name The name of the query. |
||
316 | * @param string $dql The DQL query string. |
||
317 | * |
||
318 | * @return void |
||
319 | */ |
||
320 | 1 | public function addNamedQuery($name, $dql) |
|
324 | |||
325 | /** |
||
326 | * Gets a previously registered named DQL query. |
||
327 | * |
||
328 | * @param string $name The name of the query. |
||
329 | * |
||
330 | * @return string The DQL query. |
||
331 | * |
||
332 | * @throws ORMException |
||
333 | */ |
||
334 | 1 | public function getNamedQuery($name) |
|
342 | |||
343 | /** |
||
344 | * Adds a named native query to the configuration. |
||
345 | * |
||
346 | * @param string $name The name of the query. |
||
347 | * @param string $sql The native SQL query string. |
||
348 | * @param Query\ResultSetMapping $rsm The ResultSetMapping used for the results of the SQL query. |
||
349 | * |
||
350 | * @return void |
||
351 | */ |
||
352 | 1 | public function addNamedNativeQuery($name, $sql, Query\ResultSetMapping $rsm) |
|
356 | |||
357 | /** |
||
358 | * Gets the components of a previously registered named native query. |
||
359 | * |
||
360 | * @param string $name The name of the query. |
||
361 | * |
||
362 | * @return array A tuple with the first element being the SQL string and the second |
||
363 | * element being the ResultSetMapping. |
||
364 | * |
||
365 | * @throws ORMException |
||
366 | */ |
||
367 | 1 | public function getNamedNativeQuery($name) |
|
375 | |||
376 | /** |
||
377 | * Ensures that this Configuration instance contains settings that are |
||
378 | * suitable for a production environment. |
||
379 | * |
||
380 | * @return void |
||
381 | * |
||
382 | * @throws ORMException If a configuration setting has a value that is not |
||
383 | * suitable for a production environment. |
||
384 | */ |
||
385 | 8 | public function ensureProductionSettings() |
|
411 | |||
412 | /** |
||
413 | * Registers a custom DQL function that produces a string value. |
||
414 | * Such a function can then be used in any DQL statement in any place where string |
||
415 | * functions are allowed. |
||
416 | * |
||
417 | * DQL function names are case-insensitive. |
||
418 | * |
||
419 | * @param string $name Function name. |
||
420 | * @param string|callable $className Class name or a callable that returns the function. |
||
421 | * |
||
422 | * @return void |
||
423 | */ |
||
424 | 4 | public function addCustomStringFunction($name, $className) |
|
428 | |||
429 | /** |
||
430 | * Gets the implementation class name of a registered custom string DQL function. |
||
431 | * |
||
432 | * @param string $name |
||
433 | * |
||
434 | * @return string|null |
||
435 | */ |
||
436 | 142 | public function getCustomStringFunction($name) |
|
444 | |||
445 | /** |
||
446 | * Sets a map of custom DQL string functions. |
||
447 | * |
||
448 | * Keys must be function names and values the FQCN of the implementing class. |
||
449 | * The function names will be case-insensitive in DQL. |
||
450 | * |
||
451 | * Any previously added string functions are discarded. |
||
452 | * |
||
453 | * @param array $functions The map of custom DQL string functions. |
||
454 | * |
||
455 | * @return void |
||
456 | */ |
||
457 | 1 | public function setCustomStringFunctions(array $functions) |
|
463 | |||
464 | /** |
||
465 | * Registers a custom DQL function that produces a numeric value. |
||
466 | * Such a function can then be used in any DQL statement in any place where numeric |
||
467 | * functions are allowed. |
||
468 | * |
||
469 | * DQL function names are case-insensitive. |
||
470 | * |
||
471 | * @param string $name Function name. |
||
472 | * @param string|callable $className Class name or a callable that returns the function. |
||
473 | * |
||
474 | * @return void |
||
475 | */ |
||
476 | 3 | public function addCustomNumericFunction($name, $className) |
|
480 | |||
481 | /** |
||
482 | * Gets the implementation class name of a registered custom numeric DQL function. |
||
483 | * |
||
484 | * @param string $name |
||
485 | * |
||
486 | * @return string|null |
||
487 | */ |
||
488 | 140 | public function getCustomNumericFunction($name) |
|
496 | |||
497 | /** |
||
498 | * Sets a map of custom DQL numeric functions. |
||
499 | * |
||
500 | * Keys must be function names and values the FQCN of the implementing class. |
||
501 | * The function names will be case-insensitive in DQL. |
||
502 | * |
||
503 | * Any previously added numeric functions are discarded. |
||
504 | * |
||
505 | * @param array $functions The map of custom DQL numeric functions. |
||
506 | * |
||
507 | * @return void |
||
508 | */ |
||
509 | 2 | public function setCustomNumericFunctions(array $functions) |
|
515 | |||
516 | /** |
||
517 | * Registers a custom DQL function that produces a date/time value. |
||
518 | * Such a function can then be used in any DQL statement in any place where date/time |
||
519 | * functions are allowed. |
||
520 | * |
||
521 | * DQL function names are case-insensitive. |
||
522 | * |
||
523 | * @param string $name Function name. |
||
524 | * @param string|callable $className Class name or a callable that returns the function. |
||
525 | * |
||
526 | * @return void |
||
527 | */ |
||
528 | 1 | public function addCustomDatetimeFunction($name, $className) |
|
532 | |||
533 | /** |
||
534 | * Gets the implementation class name of a registered custom date/time DQL function. |
||
535 | * |
||
536 | * @param string $name |
||
537 | * |
||
538 | * @return string|null |
||
539 | */ |
||
540 | 138 | public function getCustomDatetimeFunction($name) |
|
548 | |||
549 | /** |
||
550 | * Sets a map of custom DQL date/time functions. |
||
551 | * |
||
552 | * Keys must be function names and values the FQCN of the implementing class. |
||
553 | * The function names will be case-insensitive in DQL. |
||
554 | * |
||
555 | * Any previously added date/time functions are discarded. |
||
556 | * |
||
557 | * @param array $functions The map of custom DQL date/time functions. |
||
558 | * |
||
559 | * @return void |
||
560 | */ |
||
561 | 1 | public function setCustomDatetimeFunctions(array $functions) |
|
567 | |||
568 | /** |
||
569 | * Sets the custom hydrator modes in one pass. |
||
570 | * |
||
571 | * @param array $modes An array of ($modeName => $hydrator). |
||
572 | * |
||
573 | * @return void |
||
574 | */ |
||
575 | 1 | public function setCustomHydrationModes($modes) |
|
583 | |||
584 | /** |
||
585 | * Gets the hydrator class for the given hydration mode name. |
||
586 | * |
||
587 | * @param string $modeName The hydration mode name. |
||
588 | * |
||
589 | * @return string|null The hydrator class name. |
||
590 | */ |
||
591 | 3 | public function getCustomHydrationMode($modeName) |
|
597 | |||
598 | /** |
||
599 | * Adds a custom hydration mode. |
||
600 | * |
||
601 | * @param string $modeName The hydration mode name. |
||
602 | * @param string $hydrator The hydrator class name. |
||
603 | * |
||
604 | * @return void |
||
605 | */ |
||
606 | 3 | public function addCustomHydrationMode($modeName, $hydrator) |
|
610 | |||
611 | /** |
||
612 | * Sets a class metadata factory. |
||
613 | * |
||
614 | * @param string $cmfName |
||
615 | * |
||
616 | * @return void |
||
617 | */ |
||
618 | 1 | public function setClassMetadataFactoryName($cmfName) |
|
622 | |||
623 | /** |
||
624 | * @return string |
||
625 | */ |
||
626 | 2385 | public function getClassMetadataFactoryName() |
|
634 | |||
635 | /** |
||
636 | * Adds a filter to the list of possible filters. |
||
637 | * |
||
638 | * @param string $name The name of the filter. |
||
639 | * @param string $className The class name of the filter. |
||
640 | */ |
||
641 | 46 | public function addFilter($name, $className) |
|
645 | |||
646 | /** |
||
647 | * Gets the class name for a given filter name. |
||
648 | * |
||
649 | * @param string $name The name of the filter. |
||
650 | * |
||
651 | * @return string The class name of the filter, or null if it is not |
||
652 | * defined. |
||
653 | */ |
||
654 | 45 | public function getFilterClassName($name) |
|
660 | |||
661 | /** |
||
662 | * Sets default repository class. |
||
663 | * |
||
664 | * @since 2.2 |
||
665 | * |
||
666 | * @param string $className |
||
667 | * |
||
668 | * @return void |
||
669 | * |
||
670 | * @throws ORMException If not is a \Doctrine\Common\Persistence\ObjectRepository |
||
671 | */ |
||
672 | 3 | public function setDefaultRepositoryClassName($className) |
|
682 | |||
683 | /** |
||
684 | * Get default repository class. |
||
685 | * |
||
686 | * @since 2.2 |
||
687 | * |
||
688 | * @return string |
||
689 | */ |
||
690 | 150 | public function getDefaultRepositoryClassName() |
|
696 | |||
697 | /** |
||
698 | * Sets naming strategy. |
||
699 | * |
||
700 | * @since 2.3 |
||
701 | * |
||
702 | * @param NamingStrategy $namingStrategy |
||
703 | * |
||
704 | * @return void |
||
705 | */ |
||
706 | 7 | public function setNamingStrategy(NamingStrategy $namingStrategy) |
|
710 | |||
711 | /** |
||
712 | * Gets naming strategy.. |
||
713 | * |
||
714 | * @since 2.3 |
||
715 | * |
||
716 | * @return NamingStrategy |
||
717 | */ |
||
718 | 449 | public function getNamingStrategy() |
|
726 | |||
727 | /** |
||
728 | * Sets quote strategy. |
||
729 | * |
||
730 | * @since 2.3 |
||
731 | * |
||
732 | * @param \Doctrine\ORM\Mapping\QuoteStrategy $quoteStrategy |
||
733 | * |
||
734 | * @return void |
||
735 | */ |
||
736 | 2 | public function setQuoteStrategy(QuoteStrategy $quoteStrategy) |
|
740 | |||
741 | /** |
||
742 | * Gets quote strategy. |
||
743 | * |
||
744 | * @since 2.3 |
||
745 | * |
||
746 | * @return \Doctrine\ORM\Mapping\QuoteStrategy |
||
747 | */ |
||
748 | 1638 | public function getQuoteStrategy() |
|
756 | |||
757 | /** |
||
758 | * Set the entity listener resolver. |
||
759 | * |
||
760 | * @since 2.4 |
||
761 | * @param \Doctrine\ORM\Mapping\EntityListenerResolver $resolver |
||
762 | */ |
||
763 | 1 | public function setEntityListenerResolver(EntityListenerResolver $resolver) |
|
767 | |||
768 | /** |
||
769 | * Get the entity listener resolver. |
||
770 | * |
||
771 | * @since 2.4 |
||
772 | * @return \Doctrine\ORM\Mapping\EntityListenerResolver |
||
773 | */ |
||
774 | 2385 | public function getEntityListenerResolver() |
|
782 | |||
783 | /** |
||
784 | * Set the entity repository factory. |
||
785 | * |
||
786 | * @since 2.4 |
||
787 | * @param \Doctrine\ORM\Repository\RepositoryFactory $repositoryFactory |
||
788 | */ |
||
789 | public function setRepositoryFactory(RepositoryFactory $repositoryFactory) |
||
793 | |||
794 | /** |
||
795 | * Get the entity repository factory. |
||
796 | * |
||
797 | * @since 2.4 |
||
798 | * @return \Doctrine\ORM\Repository\RepositoryFactory |
||
799 | */ |
||
800 | 2384 | public function getRepositoryFactory() |
|
806 | |||
807 | /** |
||
808 | * @since 2.5 |
||
809 | * |
||
810 | * @return boolean |
||
811 | */ |
||
812 | 2385 | public function isSecondLevelCacheEnabled() |
|
818 | |||
819 | /** |
||
820 | * @since 2.5 |
||
821 | * |
||
822 | * @param boolean $flag |
||
823 | * |
||
824 | * @return void |
||
825 | */ |
||
826 | 282 | public function setSecondLevelCacheEnabled($flag = true) |
|
830 | |||
831 | /** |
||
832 | * @since 2.5 |
||
833 | * |
||
834 | * @param \Doctrine\ORM\Cache\CacheConfiguration $cacheConfig |
||
835 | * |
||
836 | * @return void |
||
837 | */ |
||
838 | 283 | public function setSecondLevelCacheConfiguration(CacheConfiguration $cacheConfig) |
|
842 | |||
843 | /** |
||
844 | * @since 2.5 |
||
845 | * |
||
846 | * @return \Doctrine\ORM\Cache\CacheConfiguration|null |
||
847 | */ |
||
848 | 283 | public function getSecondLevelCacheConfiguration() |
|
858 | |||
859 | /** |
||
860 | * Returns query hints, which will be applied to every query in application |
||
861 | * |
||
862 | * @since 2.5 |
||
863 | * |
||
864 | * @return array |
||
865 | */ |
||
866 | 955 | public function getDefaultQueryHints() |
|
870 | |||
871 | /** |
||
872 | * Sets array of query hints, which will be applied to every query in application |
||
873 | * |
||
874 | * @since 2.5 |
||
875 | * |
||
876 | * @param array $defaultQueryHints |
||
877 | */ |
||
878 | 1 | public function setDefaultQueryHints(array $defaultQueryHints) |
|
882 | |||
883 | /** |
||
884 | * Gets the value of a default query hint. If the hint name is not recognized, FALSE is returned. |
||
885 | * |
||
886 | * @since 2.5 |
||
887 | * |
||
888 | * @param string $name The name of the hint. |
||
889 | * |
||
890 | * @return mixed The value of the hint or FALSE, if the hint name is not recognized. |
||
891 | */ |
||
892 | public function getDefaultQueryHint($name) |
||
898 | |||
899 | /** |
||
900 | * Sets a default query hint. If the hint name is not recognized, it is silently ignored. |
||
901 | * |
||
902 | * @since 2.5 |
||
903 | * |
||
904 | * @param string $name The name of the hint. |
||
905 | * @param mixed $value The value of the hint. |
||
906 | */ |
||
907 | 1 | public function setDefaultQueryHint($name, $value) |
|
911 | } |
||
912 |
It seems like the type of the argument is not accepted by the function/method which you are calling.
In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.
We suggest to add an explicit type cast like in the following example: