ConfirmationFactory::__invoke() - Code Metrics - Inspection of "[Applications] Add variable '##link##' to the conf..." - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 96e586...d6e286 )

unknown

created 2017-06-07 12:29 UTC

ConfirmationFactory::__invoke() A

↳ Parent: ConfirmationFactory

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

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

use Applications\Mail\Confirmation;
use Applications\Mail\NewApplication;
use Interop\Container\ContainerInterface;
use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\MutableCreationOptionsInterface;
use Zend\ServiceManager\ServiceLocatorInterface;

/**
 * Factory for \Applications\Mail\Confirmation
 * 
 * @author Mathias Gelhausen <[email protected]>
 * @todo write test  
 */
class ConfirmationFactory implements FactoryInterface, MutableCreationOptionsInterface
{
    private $options = [];

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


    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
    {
        $options = $options ?: $this->options;
        $router = $container->get('Router');
        $options['router'] = $router;
        $auth = $container->get('AuthenticationService');
        $user = $auth->getUser();
        $options['user'] = $user;

        $mail   = new Confirmation($options);

        return $mail;
    }
    
    public function createService(ServiceLocatorInterface $serviceLocator)
    {
        $mail = $this($serviceLocator->getServiceLocator(), NewApplication::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.
    }
}
        $this->options = [];

        return $mail;
    }
}


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 Applications\Factory\Mail;
12
13			use Applications\Mail\Confirmation;
14			use Applications\Mail\NewApplication;
15			use Interop\Container\ContainerInterface;
16			use Zend\ServiceManager\FactoryInterface;
17			use Zend\ServiceManager\MutableCreationOptionsInterface;
18			use Zend\ServiceManager\ServiceLocatorInterface;
19
20			/**
21			* Factory for \Applications\Mail\Confirmation
22			*
23			* @author Mathias Gelhausen <[email protected]>
24			* @todo write test
25			*/
26			class ConfirmationFactory implements FactoryInterface, MutableCreationOptionsInterface
27			{
28			private $options = [];
29
30			/**
31			* Set creation options
32			*
33			* @param array $options
34			*
35			* @return void
36			*/
37			public function setCreationOptions(array $options)
38			{
39			$this->options = $options;
40			}
41
42
43			public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
44			{
45			$options = $options ?: $this->options;
46			$router = $container->get('Router');
47			$options['router'] = $router;
48			$auth = $container->get('AuthenticationService');
49			$user = $auth->getUser();
50			$options['user'] = $user;
51
52			$mail = new Confirmation($options);
53
54			return $mail;
55			}
56
57			public function createService(ServiceLocatorInterface $serviceLocator)
58			{
59			$mail = $this($serviceLocator->getServiceLocator(), NewApplication::class);
			0 ignored issues – show Bug introduced 2017-04-27 16:01 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...
60			$this->options = [];
61
62			return $mail;
63			}
64			}
65

cross-solution / YAWIK

Push — develop ( 96e586...d6e286 )

ConfirmationFactory::__invoke() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like