DriverFactory::__invoke() - Code Metrics - doctrine/DoctrineModule - Measure and Improve Code Quality continuously with Scrutinizer

DriverFactory::__invoke() A
last analyzed 2020-06-16 07:36 UTC

↳ Parent: DriverFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace DoctrineModule\Service;

use Doctrine\Common\Annotations;
use Doctrine\Persistence\Mapping\Driver\DefaultFileLocator;
use Doctrine\Persistence\Mapping\Driver\FileDriver;
use Doctrine\Persistence\Mapping\Driver\MappingDriver;
use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
use DoctrineModule\Options\Driver as DriverOptions;
use Interop\Container\ContainerInterface;
use InvalidArgumentException;
use Laminas\ServiceManager\ServiceLocatorInterface;
use function class_exists;
use function get_class;
use function interface_exists;
use function is_array;
use function is_subclass_of;
use function sprintf;

/**
 * MappingDriver ServiceManager factory
 *
 * @link    http://www.doctrine-project.org/
 */
class DriverFactory extends AbstractFactory
{
    /**
     * {@inheritDoc}
     *
     * @return MappingDriver
     */
    public function __invoke(ContainerInterface $container, $requestedName, ?array $options = null)
    {
        $options = $this->getOptions($container, 'driver');

        return $this->createDriver($container, $options);

    }

    /**
     * {@inheritDoc}
     *
     * @return MappingDriver
     */
    public function createService(ServiceLocatorInterface $container)
    {
        return $this($container, MappingDriver::class);
    }

    public function getOptionsClass() : string
    {
        return 'DoctrineModule\Options\Driver';
    }

    /**
     * @throws InvalidArgumentException
     */
    protected function createDriver(ContainerInterface $container, DriverOptions $options) : MappingDriver
    {
        $class = $options->getClass();

        if (! $class) {
            throw new InvalidArgumentException('Drivers must specify a class');
        }

        if (! class_exists($class)) {
            throw new InvalidArgumentException(sprintf('Driver with type "%s" could not be found', $class));
        }

        // Not all drivers (DriverChain) require paths.
        $paths = $options->getPaths();

        // Special options for AnnotationDrivers.
        if ($class === 'Doctrine\Persistence\Mapping\Driver\AnnotationDriver'
            || is_subclass_of($class, 'Doctrine\Persistence\Mapping\Driver\AnnotationDriver')
        ) {
            $reader = new Annotations\AnnotationReader();
            $reader = new Annotations\CachedReader(
                new Annotations\IndexedReader($reader),
                $container->get($options->getCache())
            );
            $driver = new $class($reader, $paths);
        } else {
            $driver = new $class($paths);
        }

        if ($options->getExtension() && $driver instanceof FileDriver) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $locator = $driver->getLocator();

            if (get_class($locator) !== 'Doctrine\Persistence\Mapping\Driver\DefaultFileLocator') {
                throw new InvalidArgumentException(
                    sprintf(
                        'Discovered file locator for driver of type "%s" is an instance of "%s". This factory '
                        . 'supports only the DefaultFileLocator when an extension is set for the file locator',
                        get_class($driver),
                        get_class($locator)
                    )
                );
            }

            $driver->setLocator(new DefaultFileLocator($locator->getPaths(), $options->getExtension()));
        }

        // Extra post-create options for DriverChain.
        if ($driver instanceof MappingDriverChain && $options->getDrivers()) {
            $drivers = $options->getDrivers();

            if (! is_array($drivers)) {
                $drivers = [$drivers];
            }

            foreach ($drivers as $namespace => $driverName) {
                if ($driverName === null) {
                    continue;
                }

                $options = $this->getOptions($container, 'driver', $driverName);
                $driver->addDriver($this->createDriver($container, $options), $namespace);

            }
        }

        return $driver;
    }
}

interface_exists(MappingDriver::class);


1		<?php
2
3		declare(strict_types=1);
4
5		namespace DoctrineModule\Service;
6
7		use Doctrine\Common\Annotations;
8		use Doctrine\Persistence\Mapping\Driver\DefaultFileLocator;
9		use Doctrine\Persistence\Mapping\Driver\FileDriver;
10		use Doctrine\Persistence\Mapping\Driver\MappingDriver;
11		use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
12		use DoctrineModule\Options\Driver as DriverOptions;
13		use Interop\Container\ContainerInterface;
14		use InvalidArgumentException;
15		use Laminas\ServiceManager\ServiceLocatorInterface;
16		use function class_exists;
17		use function get_class;
18		use function interface_exists;
19		use function is_array;
20		use function is_subclass_of;
21		use function sprintf;
22
23		/**
24		* MappingDriver ServiceManager factory
25		*
26		* @link http://www.doctrine-project.org/
27		*/
28		class DriverFactory extends AbstractFactory
29		{
30		/**
31		* {@inheritDoc}
32		*
33		* @return MappingDriver
34		*/
35	2	public function __invoke(ContainerInterface $container, $requestedName, ?array $options = null)
36		{
37	2	$options = $this->getOptions($container, 'driver');
38
39	2	return $this->createDriver($container, $options);
		0 ignored issues – show Compatibility introduced 2020-02-17 19:20 UTC by Report Bug Copy Issue Report `$options` of type `object<Laminas\Stdlib\AbstractOptions>` is not a sub-type of `object<DoctrineModule\Options\Driver>`. It seems like you assume a child class of the class `Laminas\Stdlib\AbstractOptions` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
40		}
41
42		/**
43		* {@inheritDoc}
44		*
45		* @return MappingDriver
46		*/
47	2	public function createService(ServiceLocatorInterface $container)
48		{
49	2	return $this($container, MappingDriver::class);
50		}
51
52	2	public function getOptionsClass() : string
53		{
54	2	return 'DoctrineModule\Options\Driver';
55		}
56
57		/**
58		* @throws InvalidArgumentException
59		*/
60	2	protected function createDriver(ContainerInterface $container, DriverOptions $options) : MappingDriver
61		{
62	2	$class = $options->getClass();
63
64	2	if (! $class) {
65		throw new InvalidArgumentException('Drivers must specify a class');
66		}
67
68	2	if (! class_exists($class)) {
69		throw new InvalidArgumentException(sprintf('Driver with type "%s" could not be found', $class));
70		}
71
72		// Not all drivers (DriverChain) require paths.
73	2	$paths = $options->getPaths();
74
75		// Special options for AnnotationDrivers.
76	2	if ($class === 'Doctrine\Persistence\Mapping\Driver\AnnotationDriver'
77	2	\|\| is_subclass_of($class, 'Doctrine\Persistence\Mapping\Driver\AnnotationDriver')
78		) {
79		$reader = new Annotations\AnnotationReader();
80		$reader = new Annotations\CachedReader(
81		new Annotations\IndexedReader($reader),
82		$container->get($options->getCache())
83		);
84		$driver = new $class($reader, $paths);
85		} else {
86	2	$driver = new $class($paths);
87		}
88
89	2	if ($options->getExtension() && $driver instanceof FileDriver) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 12:23 UTC by Report Bug Copy Issue Report The expression `$options->getExtension()` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
90		$locator = $driver->getLocator();
91
92		if (get_class($locator) !== 'Doctrine\Persistence\Mapping\Driver\DefaultFileLocator') {
93		throw new InvalidArgumentException(
94		sprintf(
95		'Discovered file locator for driver of type "%s" is an instance of "%s". This factory '
96		. 'supports only the DefaultFileLocator when an extension is set for the file locator',
97		get_class($driver),
98		get_class($locator)
99		)
100		);
101		}
102
103		$driver->setLocator(new DefaultFileLocator($locator->getPaths(), $options->getExtension()));
104		}
105
106		// Extra post-create options for DriverChain.
107	2	if ($driver instanceof MappingDriverChain && $options->getDrivers()) {
108	1	$drivers = $options->getDrivers();
109
110	1	if (! is_array($drivers)) {
111		$drivers = [$drivers];
112		}
113
114	1	foreach ($drivers as $namespace => $driverName) {
115	1	if ($driverName === null) {
116	1	continue;
117		}
118
119	1	$options = $this->getOptions($container, 'driver', $driverName);
120	1	$driver->addDriver($this->createDriver($container, $options), $namespace);
		0 ignored issues – show Compatibility introduced 2020-01-07 07:00 UTC by Report Bug Copy Issue Report `$options` of type `object<Laminas\Stdlib\AbstractOptions>` is not a sub-type of `object<DoctrineModule\Options\Driver>`. It seems like you assume a child class of the class `Laminas\Stdlib\AbstractOptions` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
121		}
122		}
123
124	2	return $driver;
125		}
126		}
127
128		interface_exists(MappingDriver::class);
129

doctrine / DoctrineModule

DriverFactory::__invoke() A last analyzed 2020-06-16 07:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DriverFactory::__invoke() A
last analyzed 2020-06-16 07:36 UTC