FOSRestExtension::createZoneRequestMatcher() - Code Metrics - Inspection of "remove no longer needed legacy compat layers" - FriendsOfSymfony/FOSRestBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#2141)

by Christian

created 2020-03-25 18:54 UTC

FOSRestExtension::createZoneRequestMatcher() A

↳ Parent: FOSRestExtension

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	4.0119

Importance

Changes

Metric	Value
dl	0
loc	22
ccs	10
cts	11
cp	0.9091
rs	9.568
c	0
b	0
f	0
cc	4
nc	4
nop	5
crap	4.0119

<?php

/*
 * This file is part of the FOSRestBundle package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\RestBundle\DependencyInjection;

use FOS\RestBundle\View\ViewHandler;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\Alias;
use Symfony\Component\DependencyInjection\ChildDefinition;
use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\Form\Extension\Core\Type\FormType;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
use Symfony\Component\Validator\Constraint;

/**
 * @internal
 */
class FOSRestExtension extends Extension
{
    /**
     * {@inheritdoc}
     */
    public function getConfiguration(array $config, ContainerBuilder $container): Configuration
    {
        return new Configuration($container->getParameter('kernel.debug'));
    }

    public function load(array $configs, ContainerBuilder $container): void
    {
        $configuration = new Configuration($container->getParameter('kernel.debug'));
        $config = $this->processConfiguration($configuration, $configs);

        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
        $loader->load('view.xml');
        $loader->load('routing.xml');
        $loader->load('request.xml');
        $loader->load('serializer.xml');

        $container->getDefinition('fos_rest.routing.loader.controller')->addArgument($config['routing_loader']['default_format']);

        $container->getDefinition('fos_rest.routing.loader.yaml_collection')->replaceArgument(4, $config['routing_loader']['default_format']);
        $container->getDefinition('fos_rest.routing.loader.xml_collection')->replaceArgument(4, $config['routing_loader']['default_format']);

        $container->getDefinition('fos_rest.routing.loader.yaml_collection')->replaceArgument(2, $config['routing_loader']['include_format']);
        $container->getDefinition('fos_rest.routing.loader.xml_collection')->replaceArgument(2, $config['routing_loader']['include_format']);
        $container->getDefinition('fos_rest.routing.loader.reader.action')->replaceArgument(3, $config['routing_loader']['include_format']);
        $container->getDefinition('fos_rest.routing.loader.reader.action')->replaceArgument(5, $config['routing_loader']['prefix_methods']);

        foreach ($config['service'] as $key => $service) {
            if ('validator' === $service && empty($config['body_converter']['validate'])) {
                continue;
            }

            if (null !== $service) {
                if ('view_handler' === $key) {
                    $container->setAlias('fos_rest.'.$key, new Alias($service, true));
                } else {
                    $container->setAlias('fos_rest.'.$key, $service);
                }
            }
        }

        $this->loadForm($config, $loader, $container);
        $this->loadException($config, $loader, $container);
        $this->loadBodyConverter($config, $loader, $container);
        $this->loadView($config, $loader, $container);

        $this->loadBodyListener($config, $loader, $container);
        $this->loadFormatListener($config, $loader, $container);
        $this->loadVersioning($config, $loader, $container);
        $this->loadParamFetcherListener($config, $loader, $container);
        $this->loadAllowedMethodsListener($config, $loader, $container);
        $this->loadAccessDeniedListener($config, $loader, $container);
        $this->loadZoneMatcherListener($config, $loader, $container);

        // Needs RequestBodyParamConverter and View Handler loaded.
        $this->loadSerializer($config, $container);
    }

    private function loadForm(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
    {
        if (!empty($config['disable_csrf_role'])) {
            $loader->load('forms.xml');

            $definition = $container->getDefinition('fos_rest.form.extension.csrf_disable');
            $definition->replaceArgument(1, $config['disable_csrf_role']);
            $definition->addTag('form.type_extension', ['extended_type' => FormType::class]);
        }
    }

    private function loadAccessDeniedListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
    {
        if ($config['access_denied_listener']['enabled'] && !empty($config['access_denied_listener']['formats'])) {
            $loader->load('access_denied_listener.xml');

            $service = $container->getDefinition('fos_rest.access_denied_listener');

            if (!empty($config['access_denied_listener']['service'])) {
                $service->clearTag('kernel.event_subscriber');
            }

            $service->replaceArgument(0, $config['access_denied_listener']['formats']);
            $service->replaceArgument(1, $config['unauthorized_challenge']);
        }
    }

    private function loadAllowedMethodsListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
    {
        if ($config['allowed_methods_listener']['enabled']) {
            if (!empty($config['allowed_methods_listener']['service'])) {
                $service = $container->getDefinition('fos_rest.allowed_methods_listener');
                $service->clearTag('kernel.event_listener');
            }

            $loader->load('allowed_methods_listener.xml');

            $container->getDefinition('fos_rest.allowed_methods_loader')->replaceArgument(1, $config['cache_dir']);
        }
    }

    private function loadBodyListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
    {
        if ($config['body_listener']['enabled']) {
            $loader->load('body_listener.xml');

            $service = $container->getDefinition('fos_rest.body_listener');

            if (!empty($config['body_listener']['service'])) {
                $service->clearTag('kernel.event_listener');
            }

            $service->replaceArgument(1, $config['body_listener']['throw_exception_on_unsupported_content_type']);
            $service->addMethodCall('setDefaultFormat', array($config['body_listener']['default_format']));

            $container->getDefinition('fos_rest.decoder_provider')->replaceArgument(1, $config['body_listener']['decoders']);

            $decoderServicesMap = array();

            foreach ($config['body_listener']['decoders'] as $id) {
                $decoderServicesMap[$id] = new Reference($id);
            }

            $decodersServiceLocator = ServiceLocatorTagPass::register($container, $decoderServicesMap);
            $container->getDefinition('fos_rest.decoder_provider')->replaceArgument(0, $decodersServiceLocator);

            $arrayNormalizer = $config['body_listener']['array_normalizer'];

            if (null !== $arrayNormalizer['service']) {
                $bodyListener = $container->getDefinition('fos_rest.body_listener');
                $bodyListener->addArgument(new Reference($arrayNormalizer['service']));
                $bodyListener->addArgument($arrayNormalizer['forms']);
            }
        }
    }

    private function loadFormatListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
    {
        if ($config['format_listener']['enabled'] && !empty($config['format_listener']['rules'])) {
            $loader->load('format_listener.xml');

            if (!empty($config['format_listener']['service'])) {
                $service = $container->getDefinition('fos_rest.format_listener');
                $service->clearTag('kernel.event_listener');
            }

            $container->setParameter(
                'fos_rest.format_listener.rules',
                $config['format_listener']['rules']
            );
        }
    }

    private function loadVersioning(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
    {
        if (!empty($config['versioning']['enabled'])) {
            $loader->load('versioning.xml');

            $versionListener = $container->getDefinition('fos_rest.versioning.listener');
            $versionListener->replaceArgument(1, $config['versioning']['default_version']);

            $resolvers = [];
            if ($config['versioning']['resolvers']['query']['enabled']) {
                $resolvers['query'] = $container->getDefinition('fos_rest.versioning.query_parameter_resolver');
                $resolvers['query']->replaceArgument(0, $config['versioning']['resolvers']['query']['parameter_name']);
            }
            if ($config['versioning']['resolvers']['custom_header']['enabled']) {
                $resolvers['custom_header'] = $container->getDefinition('fos_rest.versioning.header_resolver');
                $resolvers['custom_header']->replaceArgument(0, $config['versioning']['resolvers']['custom_header']['header_name']);
            }
            if ($config['versioning']['resolvers']['media_type']['enabled']) {
                $resolvers['media_type'] = $container->getDefinition('fos_rest.versioning.media_type_resolver');
                $resolvers['media_type']->replaceArgument(0, $config['versioning']['resolvers']['media_type']['regex']);
            }

            $chainResolver = $container->getDefinition('fos_rest.versioning.chain_resolver');
            foreach ($config['versioning']['guessing_order'] as $resolver) {
                if (isset($resolvers[$resolver])) {
                    $chainResolver->addMethodCall('addResolver', [$resolvers[$resolver]]);
                }
            }
        }
    }

    private function loadParamFetcherListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
    {
        if ($config['param_fetcher_listener']['enabled']) {
            if (!class_exists(Constraint::class)) {
                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.');
            }

            $loader->load('param_fetcher_listener.xml');

            if (!empty($config['param_fetcher_listener']['service'])) {
                $service = $container->getDefinition('fos_rest.param_fetcher_listener');
                $service->clearTag('kernel.event_listener');
            }

            if ($config['param_fetcher_listener']['force']) {
                $container->getDefinition('fos_rest.param_fetcher_listener')->replaceArgument(1, true);
            }
        }
    }

    private function loadBodyConverter(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
    {
        if (!$this->isConfigEnabled($container, $config['body_converter'])) {
            return;
        }

        $loader->load('request_body_param_converter.xml');

        if (!empty($config['body_converter']['validation_errors_argument'])) {
            $container->getDefinition('fos_rest.converter.request_body')->replaceArgument(4, $config['body_converter']['validation_errors_argument']);
        }
    }

    private function loadView(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
    {
        if (!empty($config['view']['jsonp_handler'])) {
            $handler = new ChildDefinition($config['service']['view_handler']);
            $handler->setPublic(true);

            $jsonpHandler = new Reference('fos_rest.view_handler.jsonp');
            $handler->addMethodCall('registerHandler', ['jsonp', [$jsonpHandler, 'createResponse']]);
            $container->setDefinition('fos_rest.view_handler', $handler);

            $container->getDefinition('fos_rest.view_handler.jsonp')->replaceArgument(0, $config['view']['jsonp_handler']['callback_param']);

            if (empty($config['view']['mime_types']['jsonp'])) {
                $config['view']['mime_types']['jsonp'] = $config['view']['jsonp_handler']['mime_type'];
            }
        }

        if ($config['view']['mime_types']['enabled']) {
            $loader->load('mime_type_listener.xml');

            if (!empty($config['mime_type_listener']['service'])) {
                $service = $container->getDefinition('fos_rest.mime_type_listener');
                $service->clearTag('kernel.event_listener');
            }

            $container->getDefinition('fos_rest.mime_type_listener')->replaceArgument(0, $config['view']['mime_types']['formats']);
        }

        if ($config['view']['view_response_listener']['enabled']) {
            $loader->load('view_response_listener.xml');
            $service = $container->getDefinition('fos_rest.view_response_listener');

            if (!empty($config['view_response_listener']['service'])) {
                $service->clearTag('kernel.event_listener');
            }

            $service->replaceArgument(1, $config['view']['view_response_listener']['force']);
        }

        $formats = [];
        foreach ($config['view']['formats'] as $format => $enabled) {
            if ($enabled) {
                $formats[$format] = false;
            }
        }

        $container->getDefinition('fos_rest.routing.loader.yaml_collection')->replaceArgument(3, $formats);
        $container->getDefinition('fos_rest.routing.loader.xml_collection')->replaceArgument(3, $formats);
        $container->getDefinition('fos_rest.routing.loader.reader.action')->replaceArgument(4, $formats);

        if (!is_numeric($config['view']['failed_validation'])) {
            $config['view']['failed_validation'] = constant(sprintf('%s::%s', Response::class, $config['view']['failed_validation']));
        }

        if (!is_numeric($config['view']['empty_content'])) {
            $config['view']['empty_content'] = constant(sprintf('%s::%s', Response::class, $config['view']['empty_content']));
        }

        $defaultViewHandler = $container->getDefinition('fos_rest.view_handler.default');
        $defaultViewHandler->setFactory([ViewHandler::class, 'create']);
        $defaultViewHandler->setArguments([
            new Reference('fos_rest.router'),
            new Reference('fos_rest.serializer'),
            new Reference('request_stack'),
            $formats,
            $config['view']['failed_validation'],
            $config['view']['empty_content'],
            $config['view']['serialize_null'],
        ]);
    }

    private function loadException(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
    {
        if ($config['exception']['enabled']) {
            $loader->load('exception_listener.xml');

            if (!empty($config['exception']['service'])) {
                $service = $container->getDefinition('fos_rest.exception_listener');
                $service->clearTag('kernel.event_subscriber');
            }

            $container->getDefinition('fos_rest.exception_listener')->replaceArgument(0, $config['exception']['exception_controller']);

            $container->getDefinition('fos_rest.exception.codes_map')
                ->replaceArgument(0, $config['exception']['codes']);
            $container->getDefinition('fos_rest.exception.messages_map')
                ->replaceArgument(0, $config['exception']['messages']);

            $container->getDefinition('fos_rest.exception.controller')
                ->replaceArgument(2, $config['exception']['debug']);
            $container->getDefinition('fos_rest.serializer.exception_normalizer.jms')
                ->replaceArgument(1, $config['exception']['debug']);
            $container->getDefinition('fos_rest.serializer.exception_normalizer.symfony')
                ->replaceArgument(1, $config['exception']['debug']);
        }
    }

    private function loadSerializer(array $config, ContainerBuilder $container): void
    {
        $bodyConverter = $container->hasDefinition('fos_rest.converter.request_body') ? $container->getDefinition('fos_rest.converter.request_body') : null;
        $viewHandler = $container->getDefinition('fos_rest.view_handler.default');
        $options = array();

        if (!empty($config['serializer']['version'])) {
            if ($bodyConverter) {
                $bodyConverter->replaceArgument(2, $config['serializer']['version']);
            }
            $options['exclusionStrategyVersion'] = $config['serializer']['version'];
        }

        if (!empty($config['serializer']['groups'])) {
            if ($bodyConverter) {
                $bodyConverter->replaceArgument(1, $config['serializer']['groups']);
            }
            $options['exclusionStrategyGroups'] = $config['serializer']['groups'];
        }

        $options['serializeNullStrategy'] = $config['serializer']['serialize_null'];
        $viewHandler->addArgument($options);
    }

    private function loadZoneMatcherListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
    {
        if (!empty($config['zone'])) {
            $loader->load('zone_matcher_listener.xml');
            $zoneMatcherListener = $container->getDefinition('fos_rest.zone_matcher_listener');

            foreach ($config['zone'] as $zone) {
                $matcher = $this->createZoneRequestMatcher(
                    $container,
                    $zone['path'],
                    $zone['host'],
                    $zone['methods'],
                    $zone['ips']
                );

                $zoneMatcherListener->addMethodCall('addRequestMatcher', array($matcher));
            }
        }
    }

    private function createZoneRequestMatcher(ContainerBuilder $container, ?string $path = null, ?string $host = null, array $methods = array(), array $ips = null): Reference
    {
        if ($methods) {

            $methods = array_map('strtoupper', (array) $methods);
        }

        $serialized = serialize(array($path, $host, $methods, $ips));
        $id = 'fos_rest.zone_request_matcher.'.md5($serialized).sha1($serialized);

        // only add arguments that are necessary
        $arguments = array($path, $host, $methods, $ips);
        while (count($arguments) > 0 && !end($arguments)) {
            array_pop($arguments);
        }

        $container
            ->setDefinition($id, new ChildDefinition('fos_rest.zone_request_matcher'))
            ->setArguments($arguments)
        ;

        return new Reference($id);
    }
}


1		<?php
2
3		/*
4		* This file is part of the FOSRestBundle package.
5		*
6		* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace FOS\RestBundle\DependencyInjection;
13
14		use FOS\RestBundle\View\ViewHandler;
15		use Symfony\Component\Config\FileLocator;
16		use Symfony\Component\DependencyInjection\Alias;
17		use Symfony\Component\DependencyInjection\ChildDefinition;
18		use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
19		use Symfony\Component\DependencyInjection\ContainerBuilder;
20		use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
21		use Symfony\Component\DependencyInjection\Reference;
22		use Symfony\Component\Form\Extension\Core\Type\FormType;
23		use Symfony\Component\HttpFoundation\Response;
24		use Symfony\Component\HttpKernel\DependencyInjection\Extension;
25		use Symfony\Component\Validator\Constraint;
26
27		/**
28		* @internal
29		*/
30		class FOSRestExtension extends Extension
31		{
32		/**
33		* {@inheritdoc}
34		*/
35	10	public function getConfiguration(array $config, ContainerBuilder $container): Configuration
36		{
37	10	return new Configuration($container->getParameter('kernel.debug'));
38		}
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
321		{
322	46	if ($config['exception']['enabled']) {
323	41	$loader->load('exception_listener.xml');
324
325	41	if (!empty($config['exception']['service'])) {
326		$service = $container->getDefinition('fos_rest.exception_listener');
327		$service->clearTag('kernel.event_subscriber');
328		}
329
330	41	$container->getDefinition('fos_rest.exception_listener')->replaceArgument(0, $config['exception']['exception_controller']);
331
332	41	$container->getDefinition('fos_rest.exception.codes_map')
333	41	->replaceArgument(0, $config['exception']['codes']);
334	41	$container->getDefinition('fos_rest.exception.messages_map')
335	41	->replaceArgument(0, $config['exception']['messages']);
336
337	41	$container->getDefinition('fos_rest.exception.controller')
338	41	->replaceArgument(2, $config['exception']['debug']);
339	41	$container->getDefinition('fos_rest.serializer.exception_normalizer.jms')
340	41	->replaceArgument(1, $config['exception']['debug']);
341	41	$container->getDefinition('fos_rest.serializer.exception_normalizer.symfony')
342	41	->replaceArgument(1, $config['exception']['debug']);
343		}
344	46	}
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
371		{
372	46	if (!empty($config['zone'])) {
373	1	$loader->load('zone_matcher_listener.xml');
374	1	$zoneMatcherListener = $container->getDefinition('fos_rest.zone_matcher_listener');
375
376	1	foreach ($config['zone'] as $zone) {
377	1	$matcher = $this->createZoneRequestMatcher(
378	1	$container,
379	1	$zone['path'],
380	1	$zone['host'],
381	1	$zone['methods'],
382	1	$zone['ips']
383		);
384
385	1	$zoneMatcherListener->addMethodCall('addRequestMatcher', array($matcher));
386		}
387		}
388	46	}
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) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-21 09:45 UTC by Report Bug Copy Issue Report The expression `$methods` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. 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. Loading history...
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
399		// only add arguments that are necessary
400	1	$arguments = array($path, $host, $methods, $ips);
401	1	while (count($arguments) > 0 && !end($arguments)) {
402	1	array_pop($arguments);
403		}
404
405		$container
406	1	->setDefinition($id, new ChildDefinition('fos_rest.zone_request_matcher'))
407	1	->setArguments($arguments)
408		;
409
410	1	return new Reference($id);
411		}
412		}
413

FriendsOfSymfony / FOSRestBundle

Pull Request — master (#2141)

FOSRestExtension::createZoneRequestMatcher() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like