Configuration::setPersistentCollectionGenerator() - Code Metrics - doctrine/mongodb-odm - Measure and Improve Code Quality continuously with Scrutinizer

Configuration::setPersistentCollectionGenerator() A
last analyzed 2020-05-19 11:59 UTC

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	3
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB;

use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\Common\Cache\Cache;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadataFactory;
use Doctrine\ODM\MongoDB\Mapping\Driver\AnnotationDriver;
use Doctrine\ODM\MongoDB\PersistentCollection\DefaultPersistentCollectionFactory;
use Doctrine\ODM\MongoDB\PersistentCollection\DefaultPersistentCollectionGenerator;
use Doctrine\ODM\MongoDB\PersistentCollection\PersistentCollectionFactory;
use Doctrine\ODM\MongoDB\PersistentCollection\PersistentCollectionGenerator;
use Doctrine\ODM\MongoDB\Proxy\FileLocator;
use Doctrine\ODM\MongoDB\Repository\DefaultGridFSRepository;
use Doctrine\ODM\MongoDB\Repository\DefaultRepositoryFactory;
use Doctrine\ODM\MongoDB\Repository\DocumentRepository;
use Doctrine\ODM\MongoDB\Repository\GridFSRepository;
use Doctrine\ODM\MongoDB\Repository\RepositoryFactory;
use Doctrine\Persistence\Mapping\Driver\MappingDriver;
use Doctrine\Persistence\ObjectRepository;
use InvalidArgumentException;
use ProxyManager\Configuration as ProxyManagerConfiguration;
use ProxyManager\Factory\LazyLoadingGhostFactory;
use ProxyManager\GeneratorStrategy\EvaluatingGeneratorStrategy;
use ProxyManager\GeneratorStrategy\FileWriterGeneratorStrategy;
use ReflectionClass;
use function interface_exists;
use function trim;

/**
 * Configuration class for the DocumentManager. When setting up your DocumentManager
 * you can optionally specify an instance of this class as the second argument.
 * If you do not pass a configuration object, a blank one will be created for you.
 *
 *     <?php
 *
 *     $config = new Configuration();
 *     $dm = DocumentManager::create(new Connection(), $config);
 */
class Configuration
{
    /**
     * Never autogenerate a proxy/hydrator/persistent collection and rely that
     * it was generated by some process before deployment. Copied from
     * \Doctrine\Common\Proxy\AbstractProxyFactory.
     */
    public const AUTOGENERATE_NEVER = 0;

    /**
     * Always generates a new proxy/hydrator/persistent collection in every request.
     *
     * This is only sane during development.
     * Copied from \Doctrine\Common\Proxy\AbstractProxyFactory.
     */
    public const AUTOGENERATE_ALWAYS = 1;

    /**
     * Autogenerate the proxy/hydrator/persistent collection class when the file does not exist.
     *
     * This strategy causes a file exists call whenever any proxy/hydrator is used the
     * first time in a request. Copied from \Doctrine\Common\Proxy\AbstractProxyFactory.
     */
    public const AUTOGENERATE_FILE_NOT_EXISTS = 2;

    /**
     * Generate the proxy/hydrator/persistent collection classes using eval().
     *
     * This strategy is only sane for development.
     * Copied from \Doctrine\Common\Proxy\AbstractProxyFactory.
     */
    public const AUTOGENERATE_EVAL = 3;

    /**
     * Array of attributes for this configuration instance.
     *
     * @var array
     */
    private $attributes = [];

    /** @var ProxyManagerConfiguration */
    private $proxyManagerConfiguration;

    /** @var int */
    private $autoGenerateProxyClasses = self::AUTOGENERATE_EVAL;

    public function __construct()
    {
        $this->proxyManagerConfiguration = new ProxyManagerConfiguration();
        $this->setAutoGenerateProxyClasses(self::AUTOGENERATE_FILE_NOT_EXISTS);
    }

    /**
     * Adds a namespace under a certain alias.
     */
    public function addDocumentNamespace(string $alias, string $namespace) : void
    {
        $this->attributes['documentNamespaces'][$alias] = $namespace;
    }

    /**
     * Resolves a registered namespace alias to the full namespace.
     *
     * @throws MongoDBException
     */
    public function getDocumentNamespace(string $documentNamespaceAlias) : string
    {
        if (! isset($this->attributes['documentNamespaces'][$documentNamespaceAlias])) {
            throw MongoDBException::unknownDocumentNamespace($documentNamespaceAlias);
        }

        return trim($this->attributes['documentNamespaces'][$documentNamespaceAlias], '\\');
    }

    /**
     * Retrieves the list of registered document namespace aliases.
     */
    public function getDocumentNamespaces() : array
    {
        return $this->attributes['documentNamespaces'];
    }

    /**
     * Set the document alias map
     */
    public function setDocumentNamespaces(array $documentNamespaces) : void
    {
        $this->attributes['documentNamespaces'] = $documentNamespaces;
    }

    /**
     * Sets the cache driver implementation that is used for metadata caching.
     *
     * @todo Force parameter to be a Closure to ensure lazy evaluation
     *       (as soon as a metadata cache is in effect, the driver never needs to initialize).
     */
    public function setMetadataDriverImpl(MappingDriver $driverImpl) : void
    {
        $this->attributes['metadataDriverImpl'] = $driverImpl;
    }

    /**
     * Add a new default annotation driver with a correctly configured annotation reader.
     */
    public function newDefaultAnnotationDriver(array $paths = []) : AnnotationDriver
    {
        $reader = new AnnotationReader();

        return new AnnotationDriver($reader, $paths);
    }

    /**
     * Gets the cache driver implementation that is used for the mapping metadata.
     */
    public function getMetadataDriverImpl() : ?MappingDriver
    {
        return $this->attributes['metadataDriverImpl'] ?? null;
    }

    public function getMetadataCacheImpl() : ?Cache
    {
        return $this->attributes['metadataCacheImpl'] ?? null;
    }

    public function setMetadataCacheImpl(Cache $cacheImpl) : void
    {
        $this->attributes['metadataCacheImpl'] = $cacheImpl;
    }

    /**
     * Sets the directory where Doctrine generates any necessary proxy class files.
     */
    public function setProxyDir(string $dir) : void
    {
        $this->getProxyManagerConfiguration()->setProxiesTargetDir($dir);

        // Recreate proxy generator to ensure its path was updated
        if ($this->autoGenerateProxyClasses !== self::AUTOGENERATE_FILE_NOT_EXISTS) {
            return;
        }

        $this->setAutoGenerateProxyClasses($this->autoGenerateProxyClasses);
    }

    /**
     * Gets the directory where Doctrine generates any necessary proxy class files.
     */
    public function getProxyDir() : ?string
    {
        return $this->getProxyManagerConfiguration()->getProxiesTargetDir();
    }

    /**
     * Gets an int flag that indicates whether proxy classes should always be regenerated
     * during each script execution.
     */
    public function getAutoGenerateProxyClasses() : int
    {
        return $this->autoGenerateProxyClasses;
    }

    /**
     * Sets an int flag that indicates whether proxy classes should always be regenerated
     * during each script execution.
     *
     * @throws InvalidArgumentException If an invalid mode was given.
     */
    public function setAutoGenerateProxyClasses(int $mode) : void
    {
        $this->autoGenerateProxyClasses = $mode;
        $proxyManagerConfig             = $this->getProxyManagerConfiguration();

        switch ($mode) {
            case self::AUTOGENERATE_FILE_NOT_EXISTS:
                $proxyManagerConfig->setGeneratorStrategy(new FileWriterGeneratorStrategy(
                    new FileLocator($proxyManagerConfig->getProxiesTargetDir())
                ));

                break;
            case self::AUTOGENERATE_EVAL:
                $proxyManagerConfig->setGeneratorStrategy(new EvaluatingGeneratorStrategy());

                break;
            default:
                throw new InvalidArgumentException('Invalid proxy generation strategy given - only AUTOGENERATE_FILE_NOT_EXISTS and AUTOGENERATE_EVAL are supported.');
        }
    }

    public function getProxyNamespace() : ?string
    {
        return $this->getProxyManagerConfiguration()->getProxiesNamespace();
    }

    public function setProxyNamespace(string $ns) : void
    {
        $this->getProxyManagerConfiguration()->setProxiesNamespace($ns);
    }

    public function setHydratorDir(string $dir) : void
    {
        $this->attributes['hydratorDir'] = $dir;
    }

    public function getHydratorDir() : ?string
    {
        return $this->attributes['hydratorDir'] ?? null;
    }

    /**
     * Gets an int flag that indicates whether hydrator classes should always be regenerated
     * during each script execution.
     */
    public function getAutoGenerateHydratorClasses() : int
    {
        return $this->attributes['autoGenerateHydratorClasses'] ?? self::AUTOGENERATE_ALWAYS;
    }

    /**
     * Sets an int flag that indicates whether hydrator classes should always be regenerated
     * during each script execution.
     */
    public function setAutoGenerateHydratorClasses(int $mode) : void
    {
        $this->attributes['autoGenerateHydratorClasses'] = $mode;
    }

    public function getHydratorNamespace() : ?string
    {
        return $this->attributes['hydratorNamespace'] ?? null;
    }

    public function setHydratorNamespace(string $ns) : void
    {
        $this->attributes['hydratorNamespace'] = $ns;
    }

    public function setPersistentCollectionDir(string $dir) : void
    {
        $this->attributes['persistentCollectionDir'] = $dir;
    }

    public function getPersistentCollectionDir() : ?string
    {
        return $this->attributes['persistentCollectionDir'] ?? null;
    }

    /**
     * Gets a integer flag that indicates how and when persistent collection
     * classes should be generated.
     */
    public function getAutoGeneratePersistentCollectionClasses() : int
    {
        return $this->attributes['autoGeneratePersistentCollectionClasses'] ?? self::AUTOGENERATE_ALWAYS;
    }

    /**
     * Sets a integer flag that indicates how and when persistent collection
     * classes should be generated.
     */
    public function setAutoGeneratePersistentCollectionClasses(int $mode) : void
    {
        $this->attributes['autoGeneratePersistentCollectionClasses'] = $mode;
    }

    public function getPersistentCollectionNamespace() : ?string
    {
        return $this->attributes['persistentCollectionNamespace'] ?? null;
    }

    public function setPersistentCollectionNamespace(string $ns) : void
    {
        $this->attributes['persistentCollectionNamespace'] = $ns;
    }

    /**
     * Sets the default DB to use for all Documents that do not specify
     * a database.
     */
    public function setDefaultDB(string $defaultDB) : void
    {
        $this->attributes['defaultDB'] = $defaultDB;
    }

    /**
     * Gets the default DB to use for all Documents that do not specify a database.
     */
    public function getDefaultDB() : ?string
    {
        return $this->attributes['defaultDB'] ?? null;
    }

    public function setClassMetadataFactoryName(string $cmfName) : void
    {
        $this->attributes['classMetadataFactoryName'] = $cmfName;
    }

    public function getClassMetadataFactoryName() : string
    {
        if (! isset($this->attributes['classMetadataFactoryName'])) {
            $this->attributes['classMetadataFactoryName'] = ClassMetadataFactory::class;
        }

        return $this->attributes['classMetadataFactoryName'];
    }

    public function getDefaultCommitOptions() : array
    {
        return $this->attributes['defaultCommitOptions'] ?? ['w' => 1];
    }

    public function setDefaultCommitOptions(array $defaultCommitOptions) : void
    {
        $this->attributes['defaultCommitOptions'] = $defaultCommitOptions;
    }

    /**
     * Add a filter to the list of possible filters.
     */
    public function addFilter(string $name, string $className, array $parameters = []) : void
    {
        $this->attributes['filters'][$name] = [
            'class' => $className,
            'parameters' => $parameters,
        ];
    }

    public function getFilterClassName(string $name) : ?string
    {
        return isset($this->attributes['filters'][$name])
            ? $this->attributes['filters'][$name]['class']
            : null;
    }

    public function getFilterParameters(string $name) : array
    {
        return isset($this->attributes['filters'][$name])
            ? $this->attributes['filters'][$name]['parameters']
            : [];
    }

    /**
     * @throws MongoDBException If not is a ObjectRepository.
     */
    public function setDefaultDocumentRepositoryClassName(string $className) : void
    {
        $reflectionClass = new ReflectionClass($className);

        if (! $reflectionClass->implementsInterface(ObjectRepository::class)) {
            throw MongoDBException::invalidDocumentRepository($className);
        }

        $this->attributes['defaultDocumentRepositoryClassName'] = $className;
    }

    public function getDefaultDocumentRepositoryClassName() : string
    {
        return $this->attributes['defaultDocumentRepositoryClassName'] ?? DocumentRepository::class;
    }

    /**
     * @throws MongoDBException If the class does not implement the GridFSRepository interface.
     */
    public function setDefaultGridFSRepositoryClassName(string $className) : void
    {
        $reflectionClass = new ReflectionClass($className);

        if (! $reflectionClass->implementsInterface(GridFSRepository::class)) {
            throw MongoDBException::invalidGridFSRepository($className);
        }

        $this->attributes['defaultGridFSRepositoryClassName'] = $className;
    }

    public function getDefaultGridFSRepositoryClassName() : string
    {
        return $this->attributes['defaultGridFSRepositoryClassName'] ?? DefaultGridFSRepository::class;
    }

    public function setRepositoryFactory(RepositoryFactory $repositoryFactory) : void
    {
        $this->attributes['repositoryFactory'] = $repositoryFactory;
    }

    public function getRepositoryFactory() : RepositoryFactory
    {
        return $this->attributes['repositoryFactory'] ?? new DefaultRepositoryFactory();
    }

    public function setPersistentCollectionFactory(PersistentCollectionFactory $persistentCollectionFactory) : void
    {
        $this->attributes['persistentCollectionFactory'] = $persistentCollectionFactory;
    }

    public function getPersistentCollectionFactory() : PersistentCollectionFactory
    {
        if (! isset($this->attributes['persistentCollectionFactory'])) {
            $this->attributes['persistentCollectionFactory'] = new DefaultPersistentCollectionFactory();
        }

        return $this->attributes['persistentCollectionFactory'];
    }

    public function setPersistentCollectionGenerator(PersistentCollectionGenerator $persistentCollectionGenerator) : void
    {
        $this->attributes['persistentCollectionGenerator'] = $persistentCollectionGenerator;
    }

    public function getPersistentCollectionGenerator() : PersistentCollectionGenerator
    {
        if (! isset($this->attributes['persistentCollectionGenerator'])) {
            if ($this->getPersistentCollectionDir() === null) {
                throw ConfigurationException::persistentCollectionDirMissing();
            }

            if ($this->getPersistentCollectionNamespace() === null) {
                throw ConfigurationException::persistentCollectionNamespaceMissing();
            }

            $this->attributes['persistentCollectionGenerator'] = new DefaultPersistentCollectionGenerator(
                $this->getPersistentCollectionDir(),
                $this->getPersistentCollectionNamespace()
            );
        }

        return $this->attributes['persistentCollectionGenerator'];
    }

    public function buildGhostObjectFactory() : LazyLoadingGhostFactory
    {
        return new LazyLoadingGhostFactory(clone $this->getProxyManagerConfiguration());
    }

    public function getProxyManagerConfiguration() : ProxyManagerConfiguration
    {
        return $this->proxyManagerConfiguration;
    }
}

interface_exists(MappingDriver::class);


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Doctrine\ODM\MongoDB;
6
7		use Doctrine\Common\Annotations\AnnotationReader;
8		use Doctrine\Common\Cache\Cache;
9		use Doctrine\ODM\MongoDB\Mapping\ClassMetadataFactory;
10		use Doctrine\ODM\MongoDB\Mapping\Driver\AnnotationDriver;
11		use Doctrine\ODM\MongoDB\PersistentCollection\DefaultPersistentCollectionFactory;
12		use Doctrine\ODM\MongoDB\PersistentCollection\DefaultPersistentCollectionGenerator;
13		use Doctrine\ODM\MongoDB\PersistentCollection\PersistentCollectionFactory;
14		use Doctrine\ODM\MongoDB\PersistentCollection\PersistentCollectionGenerator;
15		use Doctrine\ODM\MongoDB\Proxy\FileLocator;
16		use Doctrine\ODM\MongoDB\Repository\DefaultGridFSRepository;
17		use Doctrine\ODM\MongoDB\Repository\DefaultRepositoryFactory;
18		use Doctrine\ODM\MongoDB\Repository\DocumentRepository;
19		use Doctrine\ODM\MongoDB\Repository\GridFSRepository;
20		use Doctrine\ODM\MongoDB\Repository\RepositoryFactory;
21		use Doctrine\Persistence\Mapping\Driver\MappingDriver;
22		use Doctrine\Persistence\ObjectRepository;
23		use InvalidArgumentException;
24		use ProxyManager\Configuration as ProxyManagerConfiguration;
25		use ProxyManager\Factory\LazyLoadingGhostFactory;
26		use ProxyManager\GeneratorStrategy\EvaluatingGeneratorStrategy;
27		use ProxyManager\GeneratorStrategy\FileWriterGeneratorStrategy;
28		use ReflectionClass;
29		use function interface_exists;
30		use function trim;
31
32		/**
33		* Configuration class for the DocumentManager. When setting up your DocumentManager
34		* you can optionally specify an instance of this class as the second argument.
35		* If you do not pass a configuration object, a blank one will be created for you.
36		*
37		* <?php
38		*
39		* $config = new Configuration();
40		* $dm = DocumentManager::create(new Connection(), $config);
41		*/
42		class Configuration
43		{
44		/**
45		* Never autogenerate a proxy/hydrator/persistent collection and rely that
46		* it was generated by some process before deployment. Copied from
47		* \Doctrine\Common\Proxy\AbstractProxyFactory.
48		*/
49		public const AUTOGENERATE_NEVER = 0;
50
51		/**
52		* Always generates a new proxy/hydrator/persistent collection in every request.
53		*
54		* This is only sane during development.
55		* Copied from \Doctrine\Common\Proxy\AbstractProxyFactory.
56		*/
57		public const AUTOGENERATE_ALWAYS = 1;
58
59		/**
60		* Autogenerate the proxy/hydrator/persistent collection class when the file does not exist.
61		*
62		* This strategy causes a file exists call whenever any proxy/hydrator is used the
63		* first time in a request. Copied from \Doctrine\Common\Proxy\AbstractProxyFactory.
64		*/
65		public const AUTOGENERATE_FILE_NOT_EXISTS = 2;
66
67		/**
68		* Generate the proxy/hydrator/persistent collection classes using eval().
69		*
70		* This strategy is only sane for development.
71		* Copied from \Doctrine\Common\Proxy\AbstractProxyFactory.
72		*/
73		public const AUTOGENERATE_EVAL = 3;
74
75		/**
76		* Array of attributes for this configuration instance.
77		*
78		* @var array
79		*/
80		private $attributes = [];
81
82		/** @var ProxyManagerConfiguration */
83		private $proxyManagerConfiguration;
84
85		/** @var int */
86		private $autoGenerateProxyClasses = self::AUTOGENERATE_EVAL;
87
88	1832	public function __construct()
89		{
90	1832	$this->proxyManagerConfiguration = new ProxyManagerConfiguration();
91	1832	$this->setAutoGenerateProxyClasses(self::AUTOGENERATE_FILE_NOT_EXISTS);
92	1832	}
93
94		/**
95		* Adds a namespace under a certain alias.
96		*/
97		public function addDocumentNamespace(string $alias, string $namespace) : void
98		{
99		$this->attributes['documentNamespaces'][$alias] = $namespace;
100		}
101
102		/**
103		* Resolves a registered namespace alias to the full namespace.
104		*
105		* @throws MongoDBException
106		*/
107		public function getDocumentNamespace(string $documentNamespaceAlias) : string
108		{
109		if (! isset($this->attributes['documentNamespaces'][$documentNamespaceAlias])) {
110		throw MongoDBException::unknownDocumentNamespace($documentNamespaceAlias);
111		}
112
113		return trim($this->attributes['documentNamespaces'][$documentNamespaceAlias], '\\');
114		}
115
116		/**
117		* Retrieves the list of registered document namespace aliases.
118		*/
119		public function getDocumentNamespaces() : array
120		{
121		return $this->attributes['documentNamespaces'];
122		}
123
124		/**
125		* Set the document alias map
126		*/
127		public function setDocumentNamespaces(array $documentNamespaces) : void
128		{
129		$this->attributes['documentNamespaces'] = $documentNamespaces;
130		}
131
132		/**
133		* Sets the cache driver implementation that is used for metadata caching.
134		*
135		* @todo Force parameter to be a Closure to ensure lazy evaluation
136		* (as soon as a metadata cache is in effect, the driver never needs to initialize).
137		*/
138	1832	public function setMetadataDriverImpl(MappingDriver $driverImpl) : void
139		{
140	1832	$this->attributes['metadataDriverImpl'] = $driverImpl;
141	1832	}
142
143		/**
144		* Add a new default annotation driver with a correctly configured annotation reader.
145		*/
146		public function newDefaultAnnotationDriver(array $paths = []) : AnnotationDriver
147		{
148		$reader = new AnnotationReader();
149
150		return new AnnotationDriver($reader, $paths);
151		}
152
153		/**
154		* Gets the cache driver implementation that is used for the mapping metadata.
155		*/
156	1606	public function getMetadataDriverImpl() : ?MappingDriver
157		{
158	1606	return $this->attributes['metadataDriverImpl'] ?? null;
159		}
160
161	1832	public function getMetadataCacheImpl() : ?Cache
162		{
163	1832	return $this->attributes['metadataCacheImpl'] ?? null;
164		}
165
166		public function setMetadataCacheImpl(Cache $cacheImpl) : void
167		{
168		$this->attributes['metadataCacheImpl'] = $cacheImpl;
169		}
170
171		/**
172		* Sets the directory where Doctrine generates any necessary proxy class files.
173		*/
174	1832	public function setProxyDir(string $dir) : void
175		{
176	1832	$this->getProxyManagerConfiguration()->setProxiesTargetDir($dir);
177
178		// Recreate proxy generator to ensure its path was updated
179	1832	if ($this->autoGenerateProxyClasses !== self::AUTOGENERATE_FILE_NOT_EXISTS) {
180		return;
181		}
182
183	1832	$this->setAutoGenerateProxyClasses($this->autoGenerateProxyClasses);
184	1832	}
185
186		/**
187		* Gets the directory where Doctrine generates any necessary proxy class files.
188		*/
189		public function getProxyDir() : ?string
190		{
191		return $this->getProxyManagerConfiguration()->getProxiesTargetDir();
192		}
193
194		/**
195		* Gets an int flag that indicates whether proxy classes should always be regenerated
196		* during each script execution.
197		*/
198		public function getAutoGenerateProxyClasses() : int
199		{
200		return $this->autoGenerateProxyClasses;
201		}
202
203		/**
204		* Sets an int flag that indicates whether proxy classes should always be regenerated
205		* during each script execution.
206		*
207		* @throws InvalidArgumentException If an invalid mode was given.
208		*/
209	1832	public function setAutoGenerateProxyClasses(int $mode) : void
210		{
211	1832	$this->autoGenerateProxyClasses = $mode;
212	1832	$proxyManagerConfig = $this->getProxyManagerConfiguration();
213
214		switch ($mode) {
215	1832	case self::AUTOGENERATE_FILE_NOT_EXISTS:
216	1832	$proxyManagerConfig->setGeneratorStrategy(new FileWriterGeneratorStrategy(
217	1832	new FileLocator($proxyManagerConfig->getProxiesTargetDir())
218		));
219
220	1832	break;
221		case self::AUTOGENERATE_EVAL:
222		$proxyManagerConfig->setGeneratorStrategy(new EvaluatingGeneratorStrategy());
223
224		break;
225		default:
226		throw new InvalidArgumentException('Invalid proxy generation strategy given - only AUTOGENERATE_FILE_NOT_EXISTS and AUTOGENERATE_EVAL are supported.');
227		}
228	1832	}
229
230		public function getProxyNamespace() : ?string
231		{
232		return $this->getProxyManagerConfiguration()->getProxiesNamespace();
233		}
234
235	1832	public function setProxyNamespace(string $ns) : void
236		{
237	1832	$this->getProxyManagerConfiguration()->setProxiesNamespace($ns);
238	1832	}
239
240	1832	public function setHydratorDir(string $dir) : void
241		{
242	1832	$this->attributes['hydratorDir'] = $dir;
243	1832	}
244
245	1832	public function getHydratorDir() : ?string
246		{
247	1832	return $this->attributes['hydratorDir'] ?? null;
248		}
249
250		/**
251		* Gets an int flag that indicates whether hydrator classes should always be regenerated
252		* during each script execution.
253		*/
254	1832	public function getAutoGenerateHydratorClasses() : int
255		{
256	1832	return $this->attributes['autoGenerateHydratorClasses'] ?? self::AUTOGENERATE_ALWAYS;
257		}
258
259		/**
260		* Sets an int flag that indicates whether hydrator classes should always be regenerated
261		* during each script execution.
262		*/
263		public function setAutoGenerateHydratorClasses(int $mode) : void
264		{
265		$this->attributes['autoGenerateHydratorClasses'] = $mode;
266		}
267
268	1832	public function getHydratorNamespace() : ?string
269		{
270	1832	return $this->attributes['hydratorNamespace'] ?? null;
271		}
272
273	1832	public function setHydratorNamespace(string $ns) : void
274		{
275	1832	$this->attributes['hydratorNamespace'] = $ns;
276	1832	}
277
278	1832	public function setPersistentCollectionDir(string $dir) : void
279		{
280	1832	$this->attributes['persistentCollectionDir'] = $dir;
281	1832	}
282
283	11	public function getPersistentCollectionDir() : ?string
284		{
285	11	return $this->attributes['persistentCollectionDir'] ?? null;
286		}
287
288		/**
289		* Gets a integer flag that indicates how and when persistent collection
290		* classes should be generated.
291		*/
292	7	public function getAutoGeneratePersistentCollectionClasses() : int
293		{
294	7	return $this->attributes['autoGeneratePersistentCollectionClasses'] ?? self::AUTOGENERATE_ALWAYS;
295		}
296
297		/**
298		* Sets a integer flag that indicates how and when persistent collection
299		* classes should be generated.
300		*/
301		public function setAutoGeneratePersistentCollectionClasses(int $mode) : void
302		{
303		$this->attributes['autoGeneratePersistentCollectionClasses'] = $mode;
304		}
305
306	11	public function getPersistentCollectionNamespace() : ?string
307		{
308	11	return $this->attributes['persistentCollectionNamespace'] ?? null;
309		}
310
311	1832	public function setPersistentCollectionNamespace(string $ns) : void
312		{
313	1832	$this->attributes['persistentCollectionNamespace'] = $ns;
314	1832	}
315
316		/**
317		* Sets the default DB to use for all Documents that do not specify
318		* a database.
319		*/
320	1832	public function setDefaultDB(string $defaultDB) : void
321		{
322	1832	$this->attributes['defaultDB'] = $defaultDB;
323	1832	}
324
325		/**
326		* Gets the default DB to use for all Documents that do not specify a database.
327		*/
328	1490	public function getDefaultDB() : ?string
329		{
330	1490	return $this->attributes['defaultDB'] ?? null;
331		}
332
333		public function setClassMetadataFactoryName(string $cmfName) : void
334		{
335		$this->attributes['classMetadataFactoryName'] = $cmfName;
336		}
337
338	1832	public function getClassMetadataFactoryName() : string
339		{
340	1832	if (! isset($this->attributes['classMetadataFactoryName'])) {
341	1832	$this->attributes['classMetadataFactoryName'] = ClassMetadataFactory::class;
342		}
343
344	1832	return $this->attributes['classMetadataFactoryName'];
345		}
346
347	618	public function getDefaultCommitOptions() : array
348		{
349	618	return $this->attributes['defaultCommitOptions'] ?? ['w' => 1];
350		}
351
352	1	public function setDefaultCommitOptions(array $defaultCommitOptions) : void
353		{
354	1	$this->attributes['defaultCommitOptions'] = $defaultCommitOptions;
355	1	}
356
357		/**
358		* Add a filter to the list of possible filters.
359		*/
360	1832	public function addFilter(string $name, string $className, array $parameters = []) : void
361		{
362	1832	$this->attributes['filters'][$name] = [
363	1832	'class' => $className,
364	1832	'parameters' => $parameters,
365		];
366	1832	}
367
368	24	public function getFilterClassName(string $name) : ?string
369		{
370	24	return isset($this->attributes['filters'][$name])
371	24	? $this->attributes['filters'][$name]['class']
372	24	: null;
373		}
374
375	23	public function getFilterParameters(string $name) : array
376		{
377	23	return isset($this->attributes['filters'][$name])
378	23	? $this->attributes['filters'][$name]['parameters']
379	23	: [];
380		}
381
382		/**
383		* @throws MongoDBException If not is a ObjectRepository.
384		*/
385		public function setDefaultDocumentRepositoryClassName(string $className) : void
386		{
387		$reflectionClass = new ReflectionClass($className);
388
389		if (! $reflectionClass->implementsInterface(ObjectRepository::class)) {
390		throw MongoDBException::invalidDocumentRepository($className);
391		}
392
393		$this->attributes['defaultDocumentRepositoryClassName'] = $className;
394		}
395
396	360	public function getDefaultDocumentRepositoryClassName() : string
397		{
398	360	return $this->attributes['defaultDocumentRepositoryClassName'] ?? DocumentRepository::class;
399		}
400
401		/**
402		* @throws MongoDBException If the class does not implement the GridFSRepository interface.
403		*/
404		public function setDefaultGridFSRepositoryClassName(string $className) : void
405		{
406		$reflectionClass = new ReflectionClass($className);
407
408		if (! $reflectionClass->implementsInterface(GridFSRepository::class)) {
409		throw MongoDBException::invalidGridFSRepository($className);
410		}
411
412		$this->attributes['defaultGridFSRepositoryClassName'] = $className;
413		}
414
415	12	public function getDefaultGridFSRepositoryClassName() : string
416		{
417	12	return $this->attributes['defaultGridFSRepositoryClassName'] ?? DefaultGridFSRepository::class;
418		}
419
420	2	public function setRepositoryFactory(RepositoryFactory $repositoryFactory) : void
421		{
422	2	$this->attributes['repositoryFactory'] = $repositoryFactory;
423	2	}
424
425	1832	public function getRepositoryFactory() : RepositoryFactory
426		{
427	1832	return $this->attributes['repositoryFactory'] ?? new DefaultRepositoryFactory();
428		}
429
430		public function setPersistentCollectionFactory(PersistentCollectionFactory $persistentCollectionFactory) : void
431		{
432		$this->attributes['persistentCollectionFactory'] = $persistentCollectionFactory;
433		}
434
435	439	public function getPersistentCollectionFactory() : PersistentCollectionFactory
436		{
437	439	if (! isset($this->attributes['persistentCollectionFactory'])) {
438	439	$this->attributes['persistentCollectionFactory'] = new DefaultPersistentCollectionFactory();
439		}
440
441	439	return $this->attributes['persistentCollectionFactory'];
442		}
443
444		public function setPersistentCollectionGenerator(PersistentCollectionGenerator $persistentCollectionGenerator) : void
445		{
446		$this->attributes['persistentCollectionGenerator'] = $persistentCollectionGenerator;
447		}
448
449	8	public function getPersistentCollectionGenerator() : PersistentCollectionGenerator
450		{
451	8	if (! isset($this->attributes['persistentCollectionGenerator'])) {
452	8	if ($this->getPersistentCollectionDir() === null) {
453		throw ConfigurationException::persistentCollectionDirMissing();
454		}
455
456	8	if ($this->getPersistentCollectionNamespace() === null) {
457		throw ConfigurationException::persistentCollectionNamespaceMissing();
458		}
459
460	8	$this->attributes['persistentCollectionGenerator'] = new DefaultPersistentCollectionGenerator(
461	8	$this->getPersistentCollectionDir(),
462	8	$this->getPersistentCollectionNamespace()
463		);
464		}
465
466	8	return $this->attributes['persistentCollectionGenerator'];
467		}
468
469	1832	public function buildGhostObjectFactory() : LazyLoadingGhostFactory
470		{
471	1832	return new LazyLoadingGhostFactory(clone $this->getProxyManagerConfiguration());
472		}
473
474	1832	public function getProxyManagerConfiguration() : ProxyManagerConfiguration
475		{
476	1832	return $this->proxyManagerConfiguration;
477		}
478		}
479
480		interface_exists(MappingDriver::class);
481

doctrine / mongodb-odm

Configuration::setPersistentCollectionGenerator() A last analyzed 2020-05-19 11:59 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Configuration::setPersistentCollectionGenerator() A
last analyzed 2020-05-19 11:59 UTC