nijens / openapi-bundle

src/DependencyInjection/Configuration.php

<?php

declare(strict_types=1);

/*
 * This file is part of the OpenapiBundle package.
 *
 * (c) Niels Nijens <nijens.niels@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Nijens\OpenapiBundle\DependencyInjection;

use Nijens\OpenapiBundle\ExceptionHandling\Exception\InvalidContentTypeProblemException;
use Nijens\OpenapiBundle\ExceptionHandling\Exception\InvalidRequestBodyProblemException;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\HttpFoundation\Response;

/**
 * Validates and merges configuration from the configuration files.
 *
 * @author Niels Nijens <nijens.niels@gmail.com>
 */
class Configuration implements ConfigurationInterface
{
    public const BUNDLE_NAME = 'nijens/openapi-bundle';

    public const DEFAULT_EXCEPTION_HANDLING_EXCEPTIONS = [
        InvalidContentTypeProblemException::class => [
            'status_code' => Response::HTTP_UNSUPPORTED_MEDIA_TYPE,
            'title' => 'The content type is not supported.',
        ],
        InvalidRequestBodyProblemException::class => [
            'status_code' => Response::HTTP_BAD_REQUEST,
            'title' => 'The request body contains errors.',
        ],
    ];

    public function getConfigTreeBuilder(): TreeBuilder
    {
        $treeBuilder = new TreeBuilder('nijens_openapi');
        $rootNode = $treeBuilder->getRootNode();

        $this->addRoutingSection($rootNode);
        $this->addValidationSection($rootNode);
        $this->addExceptionsSection($rootNode);

        return $treeBuilder;
    }

    private function addRoutingSection(ArrayNodeDefinition $rootNode): void
    {
        $rootNode->children()
            ->arrayNode('routing')
                ->addDefaultsIfNotSet()
                ->children()
                    ->booleanNode('operation_id_as_route_name')
                        ->info('Toggle using the path item operation ID from the OpenAPI documents as route name.')
                        ->defaultFalse()
                        ->end()
                    ->end()

The method end() does not exist on Symfony\Component\Config\Definition\Builder\NodeParentInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Symfony\Component\Config\Definition\Builder\TreeBuilder. Are you sure you never get one of those?

                ->end()
            ->end();
    }

    private function addValidationSection(ArrayNodeDefinition $rootNode): void
    {
        $rootNode->children()
            ->arrayNode('validation')
                ->treatTrueLike(['enabled' => true])
                ->treatFalseLike(['enabled' => false])
                ->addDefaultsIfNotSet()
                ->children()
                    ->booleanNode('enabled')
                        ->info(
                            'Set to true to enable the new request validation component.'.PHP_EOL.
                            'Set to false to disable request validation provided by this bundle.'
                        )
                        ->defaultTrue()
                        ->end()
                    ->booleanNode('parameter_validation')

The method booleanNode() does not exist on Symfony\Component\Config\Definition\Builder\NodeParentInterface. It seems like you code against a sub-type of Symfony\Component\Config\Definition\Builder\NodeParentInterface such as Symfony\Component\Config\Definition\Builder\NodeBuilder.

                        ->info('Enables the experimental query parameter request validation.')
                        ->defaultFalse()
                        ->end()
                    ->end()
                ->end()
            ->end();
    }

    private function addExceptionsSection(ArrayNodeDefinition $rootNode): void
    {
        $rootNode->children()
            ->arrayNode('exception_handling')
                ->treatTrueLike(['enabled' => true])
                ->treatFalseLike(['enabled' => false])
                ->addDefaultsIfNotSet()
                ->children()
                    ->booleanNode('enabled')
                        ->info(
                            'Set to true to enable the new serialization-based exception handling.'.PHP_EOL.
                            'Set to false to disable exception handling provided by this bundle.'
                        )
                        ->defaultTrue()
                        ->end()
                    ->arrayNode('exceptions')
                        ->useAttributeAsKey('class')
                        ->arrayPrototype()
                            ->children()
                                ->scalarNode('class')
                                    ->info('The fully qualified class name of the exception.')
                                    ->cannotBeEmpty()
                                    ->end()
                                ->integerNode('status_code')
                                    ->info('The HTTP status code that must be sent when this exception occurs.')
                                    ->isRequired()
                                    ->min(100)
                                    ->max(999)
                                    ->end()
                                ->scalarNode('type_uri')
                                    ->info('The RFC 7807 URI reference that identifies the problem type. It will be sent with the response.')
                                    ->cannotBeEmpty()
                                    ->defaultValue('about:blank')
                                    ->end()
                                ->scalarNode('title')
                                    ->info('The RFC 7807 title that summarizes the problem type in human-readable language. It will be sent with the response.')
                                    ->cannotBeEmpty()
                                    ->defaultValue('An error occurred.')
                                    ->end()
                                ->booleanNode('add_instance_uri')
                                    ->defaultFalse()
                                    ->end()
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end();
    }
}