DoctrineObjectHydratorFactory::__invoke() - Code Metrics - Inspection of "Added ServiceManager v3 support" - doctrine/DoctrineORMModule - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#459)

by Vytautas

created 2016-06-28 07:23 UTC

DoctrineObjectHydratorFactory::__invoke() A

↳ Parent: DoctrineObjectHydratorFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license.
 */

namespace DoctrineORMModule\Service;

use DoctrineModule\Stdlib\Hydrator\DoctrineObject;
use Interop\Container\ContainerInterface;
use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

class DoctrineObjectHydratorFactory implements FactoryInterface
{
    /**
     * {@inheritDoc}
     */
    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)

    {
        return new DoctrineObject($container->get('doctrine.entitymanager.orm_default'));
    }

    /**
     * {@inheritDoc}
     */
    public function createService(ServiceLocatorInterface $container)
    {
        return $this($container->getServiceLocator(), DoctrineObject::class);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }
}


1			<?php
2			/*
3			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14			*
15			* This software consists of voluntary contributions made by many individuals
16			* and is licensed under the MIT license.
17			*/
18
19			namespace DoctrineORMModule\Service;
20
21			use DoctrineModule\Stdlib\Hydrator\DoctrineObject;
22			use Interop\Container\ContainerInterface;
23			use Zend\ServiceManager\FactoryInterface;
24			use Zend\ServiceManager\ServiceLocatorInterface;
25
26			class DoctrineObjectHydratorFactory implements FactoryInterface
27			{
28			/**
29			* {@inheritDoc}
30			*/
31			public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
			0 ignored issues – show Unused Code introduced 2016-04-05 14:05 UTC by Report Bug Copy Issue Report The parameter `$requestedName` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-04-05 14:05 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
32			{
33			return new DoctrineObject($container->get('doctrine.entitymanager.orm_default'));
34			}
35
36			/**
37			* {@inheritDoc}
38			*/
39			public function createService(ServiceLocatorInterface $container)
40			{
41			return $this($container->getServiceLocator(), DoctrineObject::class);
			0 ignored issues – show Bug introduced 2016-06-28 07:32 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\ServiceManager\ServiceLocatorInterface` as the method `getServiceLocator()` does only exist in the following implementations of said interface: `Zend\Cache\PatternPluginManager`, `Zend\Cache\Storage\AdapterPluginManager`, `Zend\Cache\Storage\PluginManager`, `Zend\Config\ReaderPluginManager`, `Zend\Config\WriterPluginManager`, `Zend\Filter\FilterPluginManager`, `Zend\Form\FormElementMan...lementManagerV2Polyfill`, `Zend\Form\FormElementMan...lementManagerV3Polyfill`, `Zend\Hydrator\HydratorPluginManager`, `Zend\I18n\Translator\LoaderPluginManager`, `Zend\InputFilter\InputFilterPluginManager`, `Zend\Log\FilterPluginManager`, `Zend\Log\FormatterPluginManager`, `Zend\Log\ProcessorPluginManager`, `Zend\Log\WriterPluginManager`, `Zend\Log\Writer\FilterPluginManager`, `Zend\Log\Writer\FormatterPluginManager`, `Zend\Mvc\Controller\ControllerManager`, `Zend\Mvc\Controller\PluginManager`, `Zend\Mvc\Router\RoutePluginManager`, `Zend\Paginator\AdapterPluginManager`, `Zend\Paginator\ScrollingStylePluginManager`, `Zend\Serializer\AdapterPluginManager`, `Zend\ServiceManager\AbstractPluginManager`, `Zend\Stdlib\Hydrator\HydratorPluginManager`, `Zend\Validator\ValidatorPluginManager`, `Zend\View\HelperPluginManager`, `Zend\View\Helper\Navigation\PluginManager`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
42			}
43			}
44

doctrine / DoctrineORMModule

Pull Request — master (#459)

DoctrineObjectHydratorFactory::__invoke() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like