SnippetFactory::__invoke() - Code Metrics - Inspection of "[Core] OptionsAbstratFactory uses as class name,..." - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 7bdff2...e8d178 )

unknown

created 2017-03-10 16:11 UTC

SnippetFactory::__invoke() A

↳ Parent: SnippetFactory

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	7

Duplication

Lines	12
Ratio	100 %

Importance

Changes

Metric	Value
dl	12
loc	12
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	3

<?php
/**
 * YAWIK
 *
 * @filesource
 * @license MIT
 * @copyright  2013 - 2017 Cross Solution <http://cross-solution.de>
 */
  
/** */
namespace Core\Factory\View\Helper;

use Core\View\Helper\Snippet;
use Interop\Container\ContainerInterface;
use Zend\ServiceManager\AbstractPluginManager;
use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

/**
 * Factory for Snippet view helper
 * 
 * @author Mathias Gelhausen <[email protected]>
 * @since 0,29
 */
class SnippetFactory implements FactoryInterface

{

    /**
     * Creates snippet view helper
     *
     * @param ContainerInterface $container
     * @param string             $requestedName
     * @param array              $options

     *
     * @return Snippet
     */
    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
    {
        $config = $container->get('Config');
        $config = isset($config['view_helper_config']['snippets']) ? $config['view_helper_config']['snippets'] : [];

        $events = $container->get('Core/ViewSnippets/Events');

        $helpers = $container->get('ViewHelperManager');
        $partials = $helpers->get('partial');

        return new Snippet($partials, $events, $config);
    }


    /**
     * Creates snippet view helper-
     *
     * @param ServiceLocatorInterface|AbstractPluginManager $serviceLocator
     *
     * @return Snippet
     */
    public function createService(ServiceLocatorInterface $serviceLocator)
    {
        $container = $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.
    }
}

        return $this($container, Snippet::class);
    }
}

1		<?php
2		/**
3		* YAWIK
4		*
5		* @filesource
6		* @license MIT
7		* @copyright 2013 - 2017 Cross Solution <http://cross-solution.de>
8		*/
9
10		/** */
11		namespace Core\Factory\View\Helper;
12
13		use Core\View\Helper\Snippet;
14		use Interop\Container\ContainerInterface;
15		use Zend\ServiceManager\AbstractPluginManager;
16		use Zend\ServiceManager\FactoryInterface;
17		use Zend\ServiceManager\ServiceLocatorInterface;
18
19		/**
20		* Factory for Snippet view helper
21		*
22		* @author Mathias Gelhausen <[email protected]>
23		* @since 0,29
24		*/
25	View Code Duplication	class SnippetFactory implements FactoryInterface
		0 ignored issues – show Duplication introduced 2017-03-10 16:18 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
26		{
27
28		/**
29		* Creates snippet view helper
30		*
31		* @param ContainerInterface $container
32		* @param string $requestedName
33		* @param array $options
		0 ignored issues – show Documentation introduced 2017-03-10 16:18 UTC by Report Bug Copy Issue Report Should the type for parameter `$options` not be `null\|array`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
34		*
35		* @return Snippet
36		*/
37		public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
38		{
39		$config = $container->get('Config');
40		$config = isset($config['view_helper_config']['snippets']) ? $config['view_helper_config']['snippets'] : [];
41
42		$events = $container->get('Core/ViewSnippets/Events');
43
44		$helpers = $container->get('ViewHelperManager');
45		$partials = $helpers->get('partial');
46
47		return new Snippet($partials, $events, $config);
48		}
49
50
51		/**
52		* Creates snippet view helper-
53		*
54		* @param ServiceLocatorInterface\|AbstractPluginManager $serviceLocator
55		*
56		* @return Snippet
57		*/
58		public function createService(ServiceLocatorInterface $serviceLocator)
59		{
60		$container = $serviceLocator->getServiceLocator();
		0 ignored issues – show Bug introduced 2017-03-10 16:18 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\File\Transfer\Adapter\ValidatorPluginManager`, `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\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...
61
62		return $this($container, Snippet::class);
63		}
64		}

cross-solution / YAWIK

Push — develop ( 7bdff2...e8d178 )

SnippetFactory::__invoke() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like