DH\NavigationBundle\Provider\AbstractFactory

Complexity

Total Complexity

4

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	createProvider()	0	7	1
A	validate()	0	15	2
A	configureOptionResolver()	0	2	1

<?php

namespace DH\NavigationBundle\Provider;

use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * An abstract factory that makes it easier to implement new factories. A class that extend the AbstractFactory
 * should override AbstractFactory::configureOptionResolver().
 *
 * @author Tobias Nyholm <tobias.nyholm@gmail.com>
 */
abstract class AbstractFactory implements ProviderFactoryInterface
{
    abstract protected function getProvider(array $config): ProviderInterface;

    /**
     * {@inheritdoc}
     */
    public function createProvider(array $options = []): ProviderInterface
    {
        $resolver = new OptionsResolver();
        static::configureOptionResolver($resolver);
        $config = $resolver->resolve($options);

        return $this->getProvider($config);
    }

    /**
     * {@inheritdoc}
     */
    public static function validate(array $options, $providerName): void
    {
        $resolver = new OptionsResolver();
        static::configureOptionResolver($resolver);

        try {
            $resolver->resolve($options);
        } catch (\Exception $e) {
            $message = sprintf(
                'Error while configure provider "%s". Verify your configuration. %s',
                $providerName,
                $e->getMessage()
            );

            throw new InvalidConfigurationException($message, $e->getCode(), $e);
        }
    }

    /**
     * By default we do not have any options to configure.
     * A factory should override this function and configure the options resolver.
     */
    protected static function configureOptionResolver(OptionsResolver $resolver): void

The parameter $resolver is not used and could be removed.

    {
    }
}