PaginatorFactoryAbstract::setCreationOptions() - Code Metrics - Inspection of "Merge branch 'release/0.24' into develop" - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( eea809...baa707 )

unknown

created 2016-03-08 18:02 UTC

PaginatorFactoryAbstract::setCreationOptions() A

↳ Parent: PaginatorFactoryAbstract

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php
/**
 * YAWIK
 *
 * @filesource
 * @copyright (c) 2013 - 2016 Cross Solution (http://cross-solution.de)
 * @license   MIT
 * @author    [email protected]
 */

namespace Core\Paginator;

use Core\Repository\RepositoryService;
use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\MutableCreationOptionsInterface;
use Zend\ServiceManager\ServiceLocatorInterface;
use Zend\Paginator\Paginator;

/**
 * Class PaginatorFactoryAbstract
 * @package Core\Paginator
 */
abstract class PaginatorFactoryAbstract implements FactoryInterface, MutableCreationOptionsInterface

{

    protected $options = [];

    /**
     * Set creation options
     *
     * @param  array $options
     *
     * @return void
     */
    public function setCreationOptions(array $options)
    {
        $this->options = $options;
    }


    /**
     * @param ServiceLocatorInterface $serviceLocator
     * @return mixed|Paginator
     */
    public function createService(ServiceLocatorInterface $serviceLocator)
    {
        /* @var PaginatorService $serviceLocator */
        /* @var RepositoryService $repositories */
        $repositories   = $serviceLocator->getServiceLocator()->get('repositories');
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.
    }
}
        $repository     = $repositories->get($this->getRepository());
        $queryBuilder   = $repository->createQueryBuilder();
        $filter         = $serviceLocator->getServiceLocator()->get('filterManager')->get($this->getFilter());
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.
    }
}
        $adapter       = new \Core\Paginator\Adapter\DoctrineMongoLateCursor($queryBuilder, $filter, $this->options);
        $service        = new Paginator($adapter);

        $this->setCreationOptions([]);
        return $service;
    }

    /**
     * pagination service name
     *
     * @return string
     */
    abstract protected function getFilter();

    /**
     * repository name
     *
     * @return string
     */
    abstract protected function getRepository();
}

1			<?php
2			/**
3			* YAWIK
4			*
5			* @filesource
6			* @copyright (c) 2013 - 2016 Cross Solution (http://cross-solution.de)
7			* @license MIT
8			* @author [email protected]
9			*/
10
11			namespace Core\Paginator;
12
13			use Core\Repository\RepositoryService;
14			use Zend\ServiceManager\FactoryInterface;
15			use Zend\ServiceManager\MutableCreationOptionsInterface;
16			use Zend\ServiceManager\ServiceLocatorInterface;
17			use Zend\Paginator\Paginator;
18
19			/**
20			* Class PaginatorFactoryAbstract
21			* @package Core\Paginator
22			*/
23			abstract class PaginatorFactoryAbstract implements FactoryInterface, MutableCreationOptionsInterface
			0 ignored issues – show Coding Style introduced 2015-11-30 11:54 UTC by Report Bug Copy Issue Report `PaginatorFactoryAbstract` does not seem to conform to the naming convention (`^Abstract\|Factory$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
24			{
25
26			protected $options = [];
27
28			/**
29			* Set creation options
30			*
31			* @param array $options
32			*
33			* @return void
34			*/
35			public function setCreationOptions(array $options)
36			{
37			$this->options = $options;
38			}
39
40
41			/**
42			* @param ServiceLocatorInterface $serviceLocator
43			* @return mixed\|Paginator
44			*/
45			public function createService(ServiceLocatorInterface $serviceLocator)
46			{
47			/* @var PaginatorService $serviceLocator */
48			/* @var RepositoryService $repositories */
49			$repositories = $serviceLocator->getServiceLocator()->get('repositories');
			0 ignored issues – show Bug introduced 2016-03-08 18:24 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: `Acl\Assertion\AssertionManager`, `Core\Mail\MailService`, `Core\Paginator\PaginatorService`, `Zend\Barcode\ObjectPluginManager`, `Zend\Barcode\RendererPluginManager`, `Zend\Cache\PatternPluginManager`, `Zend\Cache\Storage\AdapterPluginManager`, `Zend\Cache\Storage\PluginManager`, `Zend\Config\ReaderPluginManager`, `Zend\Config\WriterPluginManager`, `Zend\Feed\Reader\ExtensionPluginManager`, `Zend\Feed\Writer\ExtensionPluginManager`, `Zend\File\Transfer\Adapter\FilterPluginManager`, `Zend\Filter\FilterPluginManager`, `Zend\Form\FormElementManager`, `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\Mail\Protocol\SmtpPluginManager`, `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\Tag\Cloud\DecoratorPluginManager`, `Zend\Text\Table\DecoratorManager`, `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...
50			$repository = $repositories->get($this->getRepository());
51			$queryBuilder = $repository->createQueryBuilder();
52			$filter = $serviceLocator->getServiceLocator()->get('filterManager')->get($this->getFilter());
			0 ignored issues – show Bug introduced 2016-03-08 18:24 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: `Acl\Assertion\AssertionManager`, `Core\Mail\MailService`, `Core\Paginator\PaginatorService`, `Zend\Barcode\ObjectPluginManager`, `Zend\Barcode\RendererPluginManager`, `Zend\Cache\PatternPluginManager`, `Zend\Cache\Storage\AdapterPluginManager`, `Zend\Cache\Storage\PluginManager`, `Zend\Config\ReaderPluginManager`, `Zend\Config\WriterPluginManager`, `Zend\Feed\Reader\ExtensionPluginManager`, `Zend\Feed\Writer\ExtensionPluginManager`, `Zend\File\Transfer\Adapter\FilterPluginManager`, `Zend\Filter\FilterPluginManager`, `Zend\Form\FormElementManager`, `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\Mail\Protocol\SmtpPluginManager`, `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\Tag\Cloud\DecoratorPluginManager`, `Zend\Text\Table\DecoratorManager`, `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...
53			$adapter = new \Core\Paginator\Adapter\DoctrineMongoLateCursor($queryBuilder, $filter, $this->options);
54			$service = new Paginator($adapter);
55
56			$this->setCreationOptions([]);
57			return $service;
58			}
59
60			/**
61			* pagination service name
62			*
63			* @return string
64			*/
65			abstract protected function getFilter();
66
67			/**
68			* repository name
69			*
70			* @return string
71			*/
72			abstract protected function getRepository();
73			}

cross-solution / YAWIK

Push — develop ( eea809...baa707 )

PaginatorFactoryAbstract::setCreationOptions() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like