FriendsOfSymfony /
FOSRestBundle
Complex classes like FOSRestExtension 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 FOSRestExtension, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 30 | class FOSRestExtension extends Extension |
||
| 31 | { |
||
| 32 | /** |
||
| 33 | * {@inheritdoc} |
||
| 34 | */ |
||
| 35 | 10 | public function getConfiguration(array $config, ContainerBuilder $container): Configuration |
|
| 39 | |||
| 40 | 51 | public function load(array $configs, ContainerBuilder $container): void |
|
| 41 | { |
||
| 42 | 51 | $configuration = new Configuration($container->getParameter('kernel.debug')); |
|
| 43 | 51 | $config = $this->processConfiguration($configuration, $configs); |
|
| 44 | |||
| 45 | 46 | $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); |
|
| 46 | 46 | $loader->load('view.xml'); |
|
| 47 | 46 | $loader->load('routing.xml'); |
|
| 48 | 46 | $loader->load('request.xml'); |
|
| 49 | 46 | $loader->load('serializer.xml'); |
|
| 50 | |||
| 51 | 46 | $container->getDefinition('fos_rest.routing.loader.controller')->addArgument($config['routing_loader']['default_format']); |
|
| 52 | |||
| 53 | 46 | $container->getDefinition('fos_rest.routing.loader.yaml_collection')->replaceArgument(4, $config['routing_loader']['default_format']); |
|
| 54 | 46 | $container->getDefinition('fos_rest.routing.loader.xml_collection')->replaceArgument(4, $config['routing_loader']['default_format']); |
|
| 55 | |||
| 56 | 46 | $container->getDefinition('fos_rest.routing.loader.yaml_collection')->replaceArgument(2, $config['routing_loader']['include_format']); |
|
| 57 | 46 | $container->getDefinition('fos_rest.routing.loader.xml_collection')->replaceArgument(2, $config['routing_loader']['include_format']); |
|
| 58 | 46 | $container->getDefinition('fos_rest.routing.loader.reader.action')->replaceArgument(3, $config['routing_loader']['include_format']); |
|
| 59 | 46 | $container->getDefinition('fos_rest.routing.loader.reader.action')->replaceArgument(5, $config['routing_loader']['prefix_methods']); |
|
| 60 | |||
| 61 | 46 | foreach ($config['service'] as $key => $service) { |
|
| 62 | 46 | if ('validator' === $service && empty($config['body_converter']['validate'])) { |
|
| 63 | 45 | continue; |
|
| 64 | } |
||
| 65 | |||
| 66 | 46 | if (null !== $service) { |
|
| 67 | 46 | if ('view_handler' === $key) { |
|
| 68 | 46 | $container->setAlias('fos_rest.'.$key, new Alias($service, true)); |
|
| 69 | } else { |
||
| 70 | 46 | $container->setAlias('fos_rest.'.$key, $service); |
|
| 71 | } |
||
| 72 | } |
||
| 73 | } |
||
| 74 | |||
| 75 | 46 | $this->loadForm($config, $loader, $container); |
|
| 76 | 46 | $this->loadException($config, $loader, $container); |
|
| 77 | 46 | $this->loadBodyConverter($config, $loader, $container); |
|
| 78 | 46 | $this->loadView($config, $loader, $container); |
|
| 79 | |||
| 80 | 46 | $this->loadBodyListener($config, $loader, $container); |
|
| 81 | 46 | $this->loadFormatListener($config, $loader, $container); |
|
| 82 | 46 | $this->loadVersioning($config, $loader, $container); |
|
| 83 | 46 | $this->loadParamFetcherListener($config, $loader, $container); |
|
| 84 | 46 | $this->loadAllowedMethodsListener($config, $loader, $container); |
|
| 85 | 46 | $this->loadAccessDeniedListener($config, $loader, $container); |
|
| 86 | 46 | $this->loadZoneMatcherListener($config, $loader, $container); |
|
| 87 | |||
| 88 | // Needs RequestBodyParamConverter and View Handler loaded. |
||
| 89 | 46 | $this->loadSerializer($config, $container); |
|
| 90 | 46 | } |
|
| 91 | |||
| 92 | 46 | private function loadForm(array $config, XmlFileLoader $loader, ContainerBuilder $container): void |
|
| 93 | { |
||
| 94 | 46 | if (!empty($config['disable_csrf_role'])) { |
|
| 95 | $loader->load('forms.xml'); |
||
| 96 | |||
| 97 | $definition = $container->getDefinition('fos_rest.form.extension.csrf_disable'); |
||
| 98 | $definition->replaceArgument(1, $config['disable_csrf_role']); |
||
| 99 | $definition->addTag('form.type_extension', ['extended_type' => FormType::class]); |
||
| 100 | } |
||
| 101 | 46 | } |
|
| 102 | |||
| 103 | 46 | private function loadAccessDeniedListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void |
|
| 104 | { |
||
| 105 | 46 | if ($config['access_denied_listener']['enabled'] && !empty($config['access_denied_listener']['formats'])) { |
|
| 106 | $loader->load('access_denied_listener.xml'); |
||
| 107 | |||
| 108 | $service = $container->getDefinition('fos_rest.access_denied_listener'); |
||
| 109 | |||
| 110 | if (!empty($config['access_denied_listener']['service'])) { |
||
| 111 | $service->clearTag('kernel.event_subscriber'); |
||
| 112 | } |
||
| 113 | |||
| 114 | $service->replaceArgument(0, $config['access_denied_listener']['formats']); |
||
| 115 | $service->replaceArgument(1, $config['unauthorized_challenge']); |
||
| 116 | } |
||
| 117 | 46 | } |
|
| 118 | |||
| 119 | 46 | private function loadAllowedMethodsListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void |
|
| 120 | { |
||
| 121 | 46 | if ($config['allowed_methods_listener']['enabled']) { |
|
| 122 | 1 | if (!empty($config['allowed_methods_listener']['service'])) { |
|
| 123 | $service = $container->getDefinition('fos_rest.allowed_methods_listener'); |
||
| 124 | $service->clearTag('kernel.event_listener'); |
||
| 125 | } |
||
| 126 | |||
| 127 | 1 | $loader->load('allowed_methods_listener.xml'); |
|
| 128 | |||
| 129 | 1 | $container->getDefinition('fos_rest.allowed_methods_loader')->replaceArgument(1, $config['cache_dir']); |
|
| 130 | } |
||
| 131 | 46 | } |
|
| 132 | |||
| 133 | 46 | private function loadBodyListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void |
|
| 134 | { |
||
| 135 | 46 | if ($config['body_listener']['enabled']) { |
|
| 136 | 45 | $loader->load('body_listener.xml'); |
|
| 137 | |||
| 138 | 45 | $service = $container->getDefinition('fos_rest.body_listener'); |
|
| 139 | |||
| 140 | 45 | if (!empty($config['body_listener']['service'])) { |
|
| 141 | $service->clearTag('kernel.event_listener'); |
||
| 142 | } |
||
| 143 | |||
| 144 | 45 | $service->replaceArgument(1, $config['body_listener']['throw_exception_on_unsupported_content_type']); |
|
| 145 | 45 | $service->addMethodCall('setDefaultFormat', array($config['body_listener']['default_format'])); |
|
| 146 | |||
| 147 | 45 | $container->getDefinition('fos_rest.decoder_provider')->replaceArgument(1, $config['body_listener']['decoders']); |
|
| 148 | |||
| 149 | 45 | $decoderServicesMap = array(); |
|
| 150 | |||
| 151 | 45 | foreach ($config['body_listener']['decoders'] as $id) { |
|
| 152 | 45 | $decoderServicesMap[$id] = new Reference($id); |
|
| 153 | } |
||
| 154 | |||
| 155 | 45 | $decodersServiceLocator = ServiceLocatorTagPass::register($container, $decoderServicesMap); |
|
| 156 | 45 | $container->getDefinition('fos_rest.decoder_provider')->replaceArgument(0, $decodersServiceLocator); |
|
| 157 | |||
| 158 | 45 | $arrayNormalizer = $config['body_listener']['array_normalizer']; |
|
| 159 | |||
| 160 | 45 | if (null !== $arrayNormalizer['service']) { |
|
| 161 | 3 | $bodyListener = $container->getDefinition('fos_rest.body_listener'); |
|
| 162 | 3 | $bodyListener->addArgument(new Reference($arrayNormalizer['service'])); |
|
| 163 | 3 | $bodyListener->addArgument($arrayNormalizer['forms']); |
|
| 164 | } |
||
| 165 | } |
||
| 166 | 46 | } |
|
| 167 | |||
| 168 | 46 | private function loadFormatListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void |
|
| 169 | { |
||
| 170 | 46 | if ($config['format_listener']['enabled'] && !empty($config['format_listener']['rules'])) { |
|
| 171 | 3 | $loader->load('format_listener.xml'); |
|
| 172 | |||
| 173 | 3 | if (!empty($config['format_listener']['service'])) { |
|
| 174 | $service = $container->getDefinition('fos_rest.format_listener'); |
||
| 175 | $service->clearTag('kernel.event_listener'); |
||
| 176 | } |
||
| 177 | |||
| 178 | 3 | $container->setParameter( |
|
| 179 | 3 | 'fos_rest.format_listener.rules', |
|
| 180 | 3 | $config['format_listener']['rules'] |
|
| 181 | ); |
||
| 182 | } |
||
| 183 | 46 | } |
|
| 184 | |||
| 185 | 46 | private function loadVersioning(array $config, XmlFileLoader $loader, ContainerBuilder $container): void |
|
| 186 | { |
||
| 187 | 46 | if (!empty($config['versioning']['enabled'])) { |
|
| 188 | $loader->load('versioning.xml'); |
||
| 189 | |||
| 190 | $versionListener = $container->getDefinition('fos_rest.versioning.listener'); |
||
| 191 | $versionListener->replaceArgument(1, $config['versioning']['default_version']); |
||
| 192 | |||
| 193 | $resolvers = []; |
||
| 194 | if ($config['versioning']['resolvers']['query']['enabled']) { |
||
| 195 | $resolvers['query'] = $container->getDefinition('fos_rest.versioning.query_parameter_resolver'); |
||
| 196 | $resolvers['query']->replaceArgument(0, $config['versioning']['resolvers']['query']['parameter_name']); |
||
| 197 | } |
||
| 198 | if ($config['versioning']['resolvers']['custom_header']['enabled']) { |
||
| 199 | $resolvers['custom_header'] = $container->getDefinition('fos_rest.versioning.header_resolver'); |
||
| 200 | $resolvers['custom_header']->replaceArgument(0, $config['versioning']['resolvers']['custom_header']['header_name']); |
||
| 201 | } |
||
| 202 | if ($config['versioning']['resolvers']['media_type']['enabled']) { |
||
| 203 | $resolvers['media_type'] = $container->getDefinition('fos_rest.versioning.media_type_resolver'); |
||
| 204 | $resolvers['media_type']->replaceArgument(0, $config['versioning']['resolvers']['media_type']['regex']); |
||
| 205 | } |
||
| 206 | |||
| 207 | $chainResolver = $container->getDefinition('fos_rest.versioning.chain_resolver'); |
||
| 208 | foreach ($config['versioning']['guessing_order'] as $resolver) { |
||
| 209 | if (isset($resolvers[$resolver])) { |
||
| 210 | $chainResolver->addMethodCall('addResolver', [$resolvers[$resolver]]); |
||
| 211 | } |
||
| 212 | } |
||
| 213 | } |
||
| 214 | 46 | } |
|
| 215 | |||
| 216 | 46 | private function loadParamFetcherListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void |
|
| 217 | { |
||
| 218 | 46 | if ($config['param_fetcher_listener']['enabled']) { |
|
| 219 | 3 | if (!class_exists(Constraint::class)) { |
|
| 220 | throw new \LogicException('Enabling the fos_rest.param_fetcher_listener option when the Symfony Validator component is not installed is not supported. Try installing the symfony/validator package.'); |
||
| 221 | } |
||
| 222 | |||
| 223 | 3 | $loader->load('param_fetcher_listener.xml'); |
|
| 224 | |||
| 225 | 3 | if (!empty($config['param_fetcher_listener']['service'])) { |
|
| 226 | $service = $container->getDefinition('fos_rest.param_fetcher_listener'); |
||
| 227 | $service->clearTag('kernel.event_listener'); |
||
| 228 | } |
||
| 229 | |||
| 230 | 3 | if ($config['param_fetcher_listener']['force']) { |
|
| 231 | 1 | $container->getDefinition('fos_rest.param_fetcher_listener')->replaceArgument(1, true); |
|
| 232 | } |
||
| 233 | } |
||
| 234 | 46 | } |
|
| 235 | |||
| 236 | 46 | private function loadBodyConverter(array $config, XmlFileLoader $loader, ContainerBuilder $container): void |
|
| 237 | { |
||
| 238 | 46 | if (!$this->isConfigEnabled($container, $config['body_converter'])) { |
|
| 239 | 42 | return; |
|
| 240 | } |
||
| 241 | |||
| 242 | 4 | $loader->load('request_body_param_converter.xml'); |
|
| 243 | |||
| 244 | 4 | if (!empty($config['body_converter']['validation_errors_argument'])) { |
|
| 245 | 4 | $container->getDefinition('fos_rest.converter.request_body')->replaceArgument(4, $config['body_converter']['validation_errors_argument']); |
|
| 246 | } |
||
| 247 | 4 | } |
|
| 248 | |||
| 249 | 46 | private function loadView(array $config, XmlFileLoader $loader, ContainerBuilder $container): void |
|
| 250 | { |
||
| 251 | 46 | if (!empty($config['view']['jsonp_handler'])) { |
|
| 252 | 1 | $handler = new ChildDefinition($config['service']['view_handler']); |
|
| 253 | 1 | $handler->setPublic(true); |
|
| 254 | |||
| 255 | 1 | $jsonpHandler = new Reference('fos_rest.view_handler.jsonp'); |
|
| 256 | 1 | $handler->addMethodCall('registerHandler', ['jsonp', [$jsonpHandler, 'createResponse']]); |
|
| 257 | 1 | $container->setDefinition('fos_rest.view_handler', $handler); |
|
| 258 | |||
| 259 | 1 | $container->getDefinition('fos_rest.view_handler.jsonp')->replaceArgument(0, $config['view']['jsonp_handler']['callback_param']); |
|
| 260 | |||
| 261 | 1 | if (empty($config['view']['mime_types']['jsonp'])) { |
|
| 262 | 1 | $config['view']['mime_types']['jsonp'] = $config['view']['jsonp_handler']['mime_type']; |
|
| 263 | } |
||
| 264 | } |
||
| 265 | |||
| 266 | 46 | if ($config['view']['mime_types']['enabled']) { |
|
| 267 | 1 | $loader->load('mime_type_listener.xml'); |
|
| 268 | |||
| 269 | 1 | if (!empty($config['mime_type_listener']['service'])) { |
|
| 270 | $service = $container->getDefinition('fos_rest.mime_type_listener'); |
||
| 271 | $service->clearTag('kernel.event_listener'); |
||
| 272 | } |
||
| 273 | |||
| 274 | 1 | $container->getDefinition('fos_rest.mime_type_listener')->replaceArgument(0, $config['view']['mime_types']['formats']); |
|
| 275 | } |
||
| 276 | |||
| 277 | 46 | if ($config['view']['view_response_listener']['enabled']) { |
|
| 278 | 5 | $loader->load('view_response_listener.xml'); |
|
| 279 | 5 | $service = $container->getDefinition('fos_rest.view_response_listener'); |
|
| 280 | |||
| 281 | 5 | if (!empty($config['view_response_listener']['service'])) { |
|
| 282 | $service->clearTag('kernel.event_listener'); |
||
| 283 | } |
||
| 284 | |||
| 285 | 5 | $service->replaceArgument(1, $config['view']['view_response_listener']['force']); |
|
| 286 | } |
||
| 287 | |||
| 288 | 46 | $formats = []; |
|
| 289 | 46 | foreach ($config['view']['formats'] as $format => $enabled) { |
|
| 290 | 46 | if ($enabled) { |
|
| 291 | 46 | $formats[$format] = false; |
|
| 292 | } |
||
| 293 | } |
||
| 294 | |||
| 295 | 46 | $container->getDefinition('fos_rest.routing.loader.yaml_collection')->replaceArgument(3, $formats); |
|
| 296 | 46 | $container->getDefinition('fos_rest.routing.loader.xml_collection')->replaceArgument(3, $formats); |
|
| 297 | 46 | $container->getDefinition('fos_rest.routing.loader.reader.action')->replaceArgument(4, $formats); |
|
| 298 | |||
| 299 | 46 | if (!is_numeric($config['view']['failed_validation'])) { |
|
| 300 | $config['view']['failed_validation'] = constant(sprintf('%s::%s', Response::class, $config['view']['failed_validation'])); |
||
| 301 | } |
||
| 302 | |||
| 303 | 46 | if (!is_numeric($config['view']['empty_content'])) { |
|
| 304 | $config['view']['empty_content'] = constant(sprintf('%s::%s', Response::class, $config['view']['empty_content'])); |
||
| 305 | } |
||
| 306 | |||
| 307 | 46 | $defaultViewHandler = $container->getDefinition('fos_rest.view_handler.default'); |
|
| 308 | 46 | $defaultViewHandler->setFactory([ViewHandler::class, 'create']); |
|
| 309 | 46 | $defaultViewHandler->setArguments([ |
|
| 310 | 46 | new Reference('fos_rest.router'), |
|
| 311 | 46 | new Reference('fos_rest.serializer'), |
|
| 312 | 46 | new Reference('request_stack'), |
|
| 313 | 46 | $formats, |
|
| 314 | 46 | $config['view']['failed_validation'], |
|
| 315 | 46 | $config['view']['empty_content'], |
|
| 316 | 46 | $config['view']['serialize_null'], |
|
| 317 | ]); |
||
| 318 | 46 | } |
|
| 319 | |||
| 320 | 46 | private function loadException(array $config, XmlFileLoader $loader, ContainerBuilder $container): void |
|
| 345 | |||
| 346 | 46 | private function loadSerializer(array $config, ContainerBuilder $container): void |
|
| 347 | { |
||
| 348 | 46 | $bodyConverter = $container->hasDefinition('fos_rest.converter.request_body') ? $container->getDefinition('fos_rest.converter.request_body') : null; |
|
| 349 | 46 | $viewHandler = $container->getDefinition('fos_rest.view_handler.default'); |
|
| 350 | 46 | $options = array(); |
|
| 351 | |||
| 352 | 46 | if (!empty($config['serializer']['version'])) { |
|
| 353 | if ($bodyConverter) { |
||
| 354 | $bodyConverter->replaceArgument(2, $config['serializer']['version']); |
||
| 355 | } |
||
| 356 | $options['exclusionStrategyVersion'] = $config['serializer']['version']; |
||
| 357 | } |
||
| 358 | |||
| 359 | 46 | if (!empty($config['serializer']['groups'])) { |
|
| 360 | if ($bodyConverter) { |
||
| 361 | $bodyConverter->replaceArgument(1, $config['serializer']['groups']); |
||
| 362 | } |
||
| 363 | $options['exclusionStrategyGroups'] = $config['serializer']['groups']; |
||
| 364 | } |
||
| 365 | |||
| 366 | 46 | $options['serializeNullStrategy'] = $config['serializer']['serialize_null']; |
|
| 367 | 46 | $viewHandler->addArgument($options); |
|
| 368 | 46 | } |
|
| 369 | |||
| 370 | 46 | private function loadZoneMatcherListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void |
|
| 389 | |||
| 390 | 1 | private function createZoneRequestMatcher(ContainerBuilder $container, ?string $path = null, ?string $host = null, array $methods = array(), array $ips = null): Reference |
|
| 391 | { |
||
| 392 | 1 | if ($methods) { |
|
|
|
|||
| 393 | $methods = array_map('strtoupper', (array) $methods); |
||
| 394 | } |
||
| 395 | |||
| 396 | 1 | $serialized = serialize(array($path, $host, $methods, $ips)); |
|
| 397 | 1 | $id = 'fos_rest.zone_request_matcher.'.md5($serialized).sha1($serialized); |
|
| 398 | |||
| 412 | } |
||
| 413 |
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)or! empty(...)instead.