DoctrineORMModule\Options\Configuration

Complexity

Total Complexity

65

Size/Duplication

Total Lines	714
Duplicated Lines	0 %

Coupling/Cohesion

Components	10
Dependencies	3

Test Coverage

Coverage

89.8%

Importance

Changes

0

<?php
 * Configuration options for an ORM Configuration
 *
 * @link    http://www.doctrine-project.org/
 */
class Configuration extends DBALConfiguration
{
    /**
     * Set the cache key for the metadata cache. Cache key
     * is assembled as "doctrine.cache.{key}" and pulled from
     * service locator.
     */
    protected string $metadataCache = 'array';

This code did not parse for me. Apparently, there is an error somewhere around this line:

Syntax error, unexpected T_STRING, expecting T_FUNCTION or T_CONST

    /**
     * Set the cache key for the query cache. Cache key
     * is assembled as "doctrine.cache.{key}" and pulled from
     * service locator.
     */
    protected string $queryCache = 'array';

    /**
     * Set the cache key for the result cache. Cache key
     * is assembled as "doctrine.cache.{key}" and pulled from
     * service locator.
     */
    protected string $resultCache = 'array';

    /**
     * Set the cache key for the hydration cache. Cache key
     * is assembled as "doctrine.cache.{key}" and pulled from
     * service locator.
     */
    protected string $hydrationCache = 'array';

    /**
     * Set the driver key for the metadata driver. Driver key
     * is assembled as "doctrine.driver.{key}" and pulled from
     * service locator.
     */
    protected string $driver = 'orm_default';

    /**
     * Automatic generation of proxies (disable for production!)
     */
    protected bool $generateProxies = true;

    /**
     * Proxy directory.
     */
    protected string $proxyDir = 'data';

    /**
     * Proxy namespace.
     */
    protected string $proxyNamespace = 'DoctrineORMModule\Proxy';

    /**
     * Entity alias map.
     *
     * @var array
     */
    protected array $entityNamespaces = [];

    /**
     * Keys must be function names and values the FQCN of the implementing class.
     * The function names will be case-insensitive in DQL.
     *
     * @var array
     */
    protected array $datetimeFunctions = [];

    /**
     * Keys must be function names and values the FQCN of the implementing class.
     * The function names will be case-insensitive in DQL.
     *
     * @var array
     */
    protected array $stringFunctions = [];

    /**
     * Keys must be function names and values the FQCN of the implementing class.
     * The function names will be case-insensitive in DQL.
     *
     * @var array
     */
    protected array $numericFunctions = [];

    /**
     * Keys must be the name of the custom filter and the value must be
     * the class name for the custom filter.
     *
     * @var array
     */
    protected array $filters = [];

    /**
     * Keys must be the name of the query and values the DQL query string.
     *
     * @var array
     */
    protected array $namedQueries = [];

    /**
     * Keys must be the name of the query and the value is an array containing
     * the keys 'sql' for native SQL query string and 'rsm' for the Query\ResultSetMapping.
     *
     * @var array
     */
    protected array $namedNativeQueries = [];

    /**
     * Keys must be the name of the custom hydration method and the value must be
     * the class name for the custom hydrator
     *
     * @var array
     */
    protected array $customHydrationModes = [];

    /**
     * Naming strategy or name of the naming strategy service to be set in ORM
     * configuration (if any)
     *
     * @var string|NamingStrategy|null
     */
    protected $namingStrategy;

    /**
     * Quote strategy or name of the quote strategy service to be set in ORM
     * configuration (if any)
     *
     * @var string|QuoteStrategy|null
     */
    protected $quoteStrategy;

    /**
     * Default repository class
     */
    protected ?string $defaultRepositoryClassName = null;

    /**
     * Repository factory or name of the repository factory service to be set in ORM
     * configuration (if any)
     *
     * @var string|RepositoryFactory|null
     */
    protected $repositoryFactory;

    /**
     * Class name of MetaData factory to be set in ORM.
     * The entityManager will create a new instance on construction.
     */
    protected ?string $classMetadataFactoryName = null;

    /**
     * Entity listener resolver or service name of the entity listener resolver
     * to be set in ORM configuration (if any)
     *
     * @link http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html
     *
     * @var string|EntityListenerResolver|null
     */
    protected $entityListenerResolver;

    /**
     * Configuration for second level cache
     *
     * @link http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/second-level-cache.html
     */
    protected ?SecondLevelCacheConfiguration $secondLevelCache = null;

    /**
     * Configuration option for the filter schema assets expression
     */
    protected ?string $filterSchemaAssetsExpression = null;

    /**
     * @param  array $datetimeFunctions
     */
    public function setDatetimeFunctions(array $datetimeFunctions) : self
    {
        $this->datetimeFunctions = $datetimeFunctions;

        return $this;
    }

    /**
     * @return array
     */
    public function getDatetimeFunctions() : array
    {
        return $this->datetimeFunctions;
    }

    public function setDriver(string $driver) : self
    {
        $this->driver = $driver;

        return $this;
    }

    public function getDriver() : string
    {
        return "doctrine.driver.{$this->driver}";
    }

    /**
     * @param  array $entityNamespaces
     */
    public function setEntityNamespaces(array $entityNamespaces) : self
    {
        $this->entityNamespaces = $entityNamespaces;

        return $this;
    }

    /**
     * @return array
     */
    public function getEntityNamespaces() : array
    {
        return $this->entityNamespaces;
    }

    public function setGenerateProxies(bool $generateProxies) : self
    {
        $this->generateProxies = $generateProxies;

        return $this;
    }

    public function getGenerateProxies() : bool
    {
        return $this->generateProxies;
    }

    public function setMetadataCache(string $metadataCache) : self
    {
        $this->metadataCache = $metadataCache;

        return $this;
    }

    public function getMetadataCache() : string
    {
        return "doctrine.cache.{$this->metadataCache}";
    }

    public function setResultCache(string $resultCache) : self
    {
        $this->resultCache = $resultCache;

        return $this;
    }

    public function getResultCache() : string
    {
        return "doctrine.cache.{$this->resultCache}";
    }

    public function setHydrationCache(string $hydrationCache) : self
    {
        $this->hydrationCache = $hydrationCache;

        return $this;
    }

    public function getHydrationCache() : string
    {
        return "doctrine.cache.{$this->hydrationCache}";
    }

    /**
     * @param  array $namedNativeQueries
     */
    public function setNamedNativeQueries(array $namedNativeQueries) : self
    {
        $this->namedNativeQueries = $namedNativeQueries;

        return $this;
    }

    /**
     * @return array
     */
    public function getNamedNativeQueries() : array
    {
        return $this->namedNativeQueries;
    }

    /**
     * @param  array $namedQueries
     */
    public function setNamedQueries(array $namedQueries) : self
    {
        $this->namedQueries = $namedQueries;

        return $this;
    }

    /**
     * @return array
     */
    public function getNamedQueries() : array
    {
        return $this->namedQueries;
    }

    /**
     * @param  array $numericFunctions
     */
    public function setNumericFunctions(array $numericFunctions) : self
    {
        $this->numericFunctions = $numericFunctions;

        return $this;
    }

    /**
     * @return array
     */
    public function getNumericFunctions() : array
    {
        return $this->numericFunctions;
    }

    /**
     * @param  array $filters
     */
    public function setFilters(array $filters) : self
    {
        $this->filters = $filters;

        return $this;
    }

    /**
     * @return array
     */
    public function getFilters() : array
    {
        return $this->filters;
    }

    public function setProxyDir(string $proxyDir) : self
    {
        $this->proxyDir = $proxyDir;

        return $this;
    }

    public function getProxyDir() : string
    {
        return $this->proxyDir;
    }

    public function setProxyNamespace(string $proxyNamespace) : self
    {
        $this->proxyNamespace = $proxyNamespace;

        return $this;
    }

    public function getProxyNamespace() : string
    {
        return $this->proxyNamespace;
    }

    public function setQueryCache(string $queryCache) : self
    {
        $this->queryCache = $queryCache;

        return $this;
    }

    public function getQueryCache() : string
    {
        return "doctrine.cache.{$this->queryCache}";
    }

    /**
     * @param  array $stringFunctions
     */
    public function setStringFunctions(array $stringFunctions) : self
    {
        $this->stringFunctions = $stringFunctions;

        return $this;
    }

    /**
     * @return array
     */
    public function getStringFunctions() : array
    {
        return $this->stringFunctions;
    }

    /**
     * @param  array $modes
     */
    public function setCustomHydrationModes(array $modes) : self
    {
        $this->customHydrationModes = $modes;

        return $this;
    }

    /**
     * @return array
     */
    public function getCustomHydrationModes() : array
    {
        return $this->customHydrationModes;
    }

    /**
     * @param string|NamingStrategy|null $namingStrategy
     *
     * @throws InvalidArgumentException   when the provided naming strategy does not fit the expected type
     */
    public function setNamingStrategy($namingStrategy) : self
    {
        if ($namingStrategy === null
            || is_string($namingStrategy)
            || $namingStrategy instanceof NamingStrategy
        ) {
            $this->namingStrategy = $namingStrategy;

            return $this;
        }

        throw new InvalidArgumentException(
            sprintf(
                'namingStrategy must be either a string, a Doctrine\ORM\Mapping\NamingStrategy '
                . 'instance or null, %s given',
                is_object($namingStrategy) ? get_class($namingStrategy) : gettype($namingStrategy)
            )
        );
    }

    /**
     * @return string|NamingStrategy|null
     */
    public function getNamingStrategy()
    {
        return $this->namingStrategy;
    }

    /**
     * @param string|QuoteStrategy|null $quoteStrategy
     *
     * @throws InvalidArgumentException   when the provided quote strategy does not fit the expected type
     */
    public function setQuoteStrategy($quoteStrategy) : self
    {
        if ($quoteStrategy === null
            || is_string($quoteStrategy)
            || $quoteStrategy instanceof QuoteStrategy
        ) {
            $this->quoteStrategy = $quoteStrategy;

            return $this;
        }

        throw new InvalidArgumentException(
            sprintf(
                'quoteStrategy must be either a string, a Doctrine\ORM\Mapping\QuoteStrategy '
                . 'instance or null, %s given',
                is_object($quoteStrategy) ? get_class($quoteStrategy) : gettype($quoteStrategy)
            )
        );
    }

    /**
     * @return string|QuoteStrategy|null
     */
    public function getQuoteStrategy()
    {
        return $this->quoteStrategy;
    }

    /**
     * @param string|RepositoryFactory|null $repositoryFactory
     *
     * @throws InvalidArgumentException   when the provided repository factory does not fit the expected type
     */
    public function setRepositoryFactory($repositoryFactory) : self
    {
        if ($repositoryFactory === null
            || is_string($repositoryFactory)
            || $repositoryFactory instanceof RepositoryFactory
        ) {
            $this->repositoryFactory = $repositoryFactory;

            return $this;
        }

        throw new InvalidArgumentException(
            sprintf(
                'repositoryFactory must be either a string, a Doctrine\ORM\Repository\RepositoryFactory '
                . 'instance or null, %s given',
                is_object($repositoryFactory) ? get_class($repositoryFactory) : gettype($repositoryFactory)
            )
        );
    }

    /**
     * @return string|RepositoryFactory|null
     */
    public function getRepositoryFactory()
    {
        return $this->repositoryFactory;
    }

    /**
     * Set the metadata factory class name to use
     *
     * @see \Doctrine\ORM\Configuration::setClassMetadataFactoryName()
     */
    public function setClassMetadataFactoryName(?string $factoryName) : self
    {
        $this->classMetadataFactoryName = $factoryName;

        return $this;
    }

    public function getClassMetadataFactoryName() : ?string
    {
        return $this->classMetadataFactoryName;
    }

    /**
     * @param string|EntityListenerResolver|null $entityListenerResolver
     *
     * @throws InvalidArgumentException           When the provided entity listener resolver
     *                                            does not fit the expected type
     */
    public function setEntityListenerResolver($entityListenerResolver) : self
    {
        if ($entityListenerResolver === null
            || $entityListenerResolver instanceof EntityListenerResolver
            || is_string($entityListenerResolver)
        ) {
            $this->entityListenerResolver = $entityListenerResolver;

            return $this;
        }

        throw new InvalidArgumentException(sprintf(
            'entityListenerResolver must be either a string, a Doctrine\ORM\Mapping\EntityListenerResolver '
            . 'instance or null, %s given',
            is_object($entityListenerResolver) ? get_class($entityListenerResolver) : gettype($entityListenerResolver)
        ));
    }

    /**
     * @return string|EntityListenerResolver|null
     */
    public function getEntityListenerResolver()
    {
        return $this->entityListenerResolver;
    }

    /**
     * @param  array $secondLevelCache
     */
    public function setSecondLevelCache(array $secondLevelCache) : self
    {
        $this->secondLevelCache = new SecondLevelCacheConfiguration($secondLevelCache);

        return $this;
    }

    public function getSecondLevelCache() : SecondLevelCacheConfiguration
    {
        return $this->secondLevelCache ?: new SecondLevelCacheConfiguration();
    }

    public function setFilterSchemaAssetsExpression(string $filterSchemaAssetsExpression) : self
    {
        $this->filterSchemaAssetsExpression = $filterSchemaAssetsExpression;

        return $this;
    }

    public function getFilterSchemaAssetsExpression() : ?string
    {
        return $this->filterSchemaAssetsExpression;
    }

    /**
     * Sets default repository class.
     */
    public function setDefaultRepositoryClassName(string $className) : self
    {
        $this->defaultRepositoryClassName = (string) $className;

        return $this;
    }

    /**
     * Get default repository class name.
     */
    public function getDefaultRepositoryClassName() : ?string
    {
        return $this->defaultRepositoryClassName;
    }
}