facile-it / mongodb-bundle

src/DependencyInjection/Configuration.php

<?php

namespace Facile\MongoDbBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\NodeBuilder;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

/**
 * Class Configuration.
 *
 * @internal
 */
final class Configuration implements ConfigurationInterface
{
    private const READ_PREFERENCE_VALID_OPTIONS = ['primary', 'primaryPreferred', 'secondary', 'secondaryPreferred', 'nearest'];

    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder(): TreeBuilder
    {
        $treeBuilder = new TreeBuilder('mongo_db_bundle');
        $rootBuilder = \method_exists(TreeBuilder::class, 'getRootNode')
            ? $treeBuilder->getRootNode()
            : $treeBuilder->root('mongo_db_bundle');

The function Symfony\Component\Config\Definition\Builder\TreeBuilder::root() has been deprecated: since Symfony 4.3, pass the root name to the constructor instead

        self::addDataCollection($rootBuilder->children());
        self::addClients($rootBuilder->children());
        self::addConnections($rootBuilder->children());
        self::addDriversOption($rootBuilder->children());

        return $treeBuilder;
    }

    private static function addDataCollection(NodeBuilder $builder): void
    {
        $builder
            ->booleanNode('data_collection')
            ->defaultTrue()
            ->info('Disables Data Collection if needed');
    }

    private static function addClients(NodeBuilder $builder): void
    {
        $clientsBuilder = $builder
            ->arrayNode('clients')
            ->isRequired()
            ->requiresAtLeastOneElement()
            ->useAttributeAsKey('name')
            ->prototype('array')
            ->children();

        self::addClientsHosts($clientsBuilder);

        $clientsBuilder
            ->scalarNode('uri')
            ->defaultNull()
            ->info('Overrides hosts configuration');

        $clientsBuilder
            ->scalarNode('username')
            ->defaultValue('');

        $clientsBuilder
            ->scalarNode('password')
            ->defaultValue('');

        $clientsBuilder
            ->scalarNode('authSource')
            ->defaultNull()
            ->info('Database name associated with the user’s credentials');

        $clientsBuilder
            ->scalarNode('readPreference')
            ->defaultValue('primaryPreferred')
            ->validate()
            ->ifNotInArray(self::READ_PREFERENCE_VALID_OPTIONS)
            ->thenInvalid('Invalid readPreference option %s, must be one of [' . implode(', ', self::READ_PREFERENCE_VALID_OPTIONS) . ']');

        $clientsBuilder
            ->scalarNode('replicaSet')
            ->defaultNull();

        $clientsBuilder
            ->booleanNode('ssl')
            ->defaultFalse();

        $clientsBuilder
            ->integerNode('connectTimeoutMS')
            ->defaultNull();
    }

    private static function addClientsHosts(NodeBuilder $builder): void
    {
        $hostsBuilder = $builder
            ->arrayNode('hosts')
            ->info('Hosts addresses and ports')
            ->prototype('array')
            ->children();

        $hostsBuilder
            ->scalarNode('host')
            ->isRequired();

        $hostsBuilder
            ->integerNode('port')
            ->defaultValue(27017);
    }

    private static function addDriversOption(NodeBuilder $builder): void
    {
        $builder
            ->scalarNode('driverOptions');
    }

    private static function addConnections(NodeBuilder $builder): void
    {
        $connectionBuilder = $builder
            ->arrayNode('connections')
            ->isRequired()
            ->requiresAtLeastOneElement()
            ->useAttributeAsKey('name')
            ->prototype('array')
            ->children();

        $connectionBuilder
            ->scalarNode('client_name')
            ->isRequired()
            ->info('Desired client name');

        $connectionBuilder
            ->scalarNode('database_name')
            ->isRequired()
            ->info('Database name');
    }
}