ImageControllerFactory::createService() - Code Metrics - svycka/sv-images - Measure and Improve Code Quality continuously with Scrutinizer

ImageControllerFactory::createService() A
last analyzed 2016-04-07 06:56 UTC

↳ Parent: ImageControllerFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	6

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	12
ccs	0
cts	8
cp	0
rs	9.4285
cc	1
eloc	6
nc	1
nop	1
crap	2

<?php

namespace SvImages\Controller\Factory;

use SvImages\Controller\ImageController;
use SvImages\Options\ModuleOptions;
use SvImages\Service\CacheManager;
use SvImages\Service\ImageService;
use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

/**
 * @author Vytautas Stankus <[email protected]>
 * @license MIT
 */
class ImageControllerFactory implements FactoryInterface
{
    /**
     * Create ImageController
     *
     * @param ServiceLocatorInterface $serviceLocator
     * @return ImageController
     */
    public function createService(ServiceLocatorInterface $serviceLocator)
    {
        $sm = $serviceLocator->getServiceLocator();
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.
    }
}
        /** @var ImageService $imageService */
        $imageService = $sm->get(ImageService::class);
        /** @var CacheManager $cacheManager */
        $cacheManager = $sm->get(CacheManager::class);
        /** @var ModuleOptions $options */
        $options = $sm->get(ModuleOptions::class);

        return new ImageController($imageService, $cacheManager, $options);
    }
}


1			<?php
2
3			namespace SvImages\Controller\Factory;
4
5			use SvImages\Controller\ImageController;
6			use SvImages\Options\ModuleOptions;
7			use SvImages\Service\CacheManager;
8			use SvImages\Service\ImageService;
9			use Zend\ServiceManager\FactoryInterface;
10			use Zend\ServiceManager\ServiceLocatorInterface;
11
12			/**
13			* @author Vytautas Stankus <[email protected]>
14			* @license MIT
15			*/
16			class ImageControllerFactory implements FactoryInterface
17			{
18			/**
19			* Create ImageController
20			*
21			* @param ServiceLocatorInterface $serviceLocator
22			* @return ImageController
23			*/
24			public function createService(ServiceLocatorInterface $serviceLocator)
25			{
26			$sm = $serviceLocator->getServiceLocator();
			0 ignored issues – show Bug introduced 2016-04-07 06:56 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: `SvImages\Transformer\TransformersManager`, `Zend\Filter\FilterPluginManager`, `Zend\Form\FormElementManager`, `Zend\Hydrator\HydratorPluginManager`, `Zend\InputFilter\InputFilterPluginManager`, `Zend\Mvc\Controller\ControllerManager`, `Zend\Mvc\Controller\PluginManager`, `Zend\Mvc\Router\RoutePluginManager`, `Zend\ServiceManager\AbstractPluginManager`, `Zend\Stdlib\Hydrator\HydratorPluginManager`, `Zend\Validator\ValidatorPluginManager`. 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...
27			/** @var ImageService $imageService */
28			$imageService = $sm->get(ImageService::class);
29			/** @var CacheManager $cacheManager */
30			$cacheManager = $sm->get(CacheManager::class);
31			/** @var ModuleOptions $options */
32			$options = $sm->get(ModuleOptions::class);
33
34			return new ImageController($imageService, $cacheManager, $options);
35			}
36			}
37

svycka / sv-images

ImageControllerFactory::createService() A last analyzed 2016-04-07 06:56 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

ImageControllerFactory::createService() A
last analyzed 2016-04-07 06:56 UTC