Module - Code Metrics - JouwWeb/JwPersistentUser - Measure and Improve Code Quality continuously with Scrutinizer

Module A
last analyzed 2020-04-10 07:19 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

Metric	Value
wmc	3
lcom	0
cbo	3
dl	0
loc	40
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	getConfig()	4	1
A	onBootstrap()	18	1
A	getAutoloaderConfig()	10	1

<?php

namespace JwPersistentUser;

use JwPersistentUser\Listener\WriteTokenToCookie;
use JwPersistentUser\Service\CookieAuthenticationService;
use Zend\EventManager\EventInterface;
use Zend\EventManager\EventManager;
use Zend\ModuleManager\Feature;
use Zend\ServiceManager\ServiceManager;

class Module implements
    Feature\ConfigProviderInterface,
    Feature\BootstrapListenerInterface,
    Feature\AutoloaderProviderInterface
{
    public function getConfig()
    {
        return include __DIR__ . '/config/module.config.php';
    }

    public function onBootstrap(EventInterface $e)
    {
        /** @var EventManager $em */
        $em = $e->getApplication()->getEventManager();
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 ServiceManager $sm */
        $sm = $e->getApplication()->getServiceManager();
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.
    }
}

        $request = $e->getApplication()->getRequest();
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.
    }
}
        $response = $e->getApplication()->getResponse();
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.
    }
}

        // Try to login from Cookie if applicable
        $service = new CookieAuthenticationService($sm);
        $service->setEventManager(new EventManager($em->getSharedManager()));
        $service->loginFrom($request, $response);

        (new WriteTokenToCookie($sm))->attachShared($em->getSharedManager());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    public function getAutoloaderConfig()
    {
        return [
            'Zend\Loader\StandardAutoloader' => [
                'namespaces' => [
                    __NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__,
                ],
            ],
        ];
    }
}


1			<?php
2
3			namespace JwPersistentUser;
4
5			use JwPersistentUser\Listener\WriteTokenToCookie;
6			use JwPersistentUser\Service\CookieAuthenticationService;
7			use Zend\EventManager\EventInterface;
8			use Zend\EventManager\EventManager;
9			use Zend\ModuleManager\Feature;
10			use Zend\ServiceManager\ServiceManager;
11
12			class Module implements
13			Feature\ConfigProviderInterface,
14			Feature\BootstrapListenerInterface,
15			Feature\AutoloaderProviderInterface
16			{
17			public function getConfig()
18			{
19			return include __DIR__ . '/config/module.config.php';
20			}
21
22			public function onBootstrap(EventInterface $e)
23			{
24			/** @var EventManager $em */
25			$em = $e->getApplication()->getEventManager();
			0 ignored issues – show Bug introduced 2016-01-29 11:30 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\EventManager\EventInterface` as the method `getApplication()` does only exist in the following implementations of said interface: `Zend\Mvc\MvcEvent`. 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...
26
27			/** @var ServiceManager $sm */
28			$sm = $e->getApplication()->getServiceManager();
			0 ignored issues – show Bug introduced 2017-07-14 21:49 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\EventManager\EventInterface` as the method `getApplication()` does only exist in the following implementations of said interface: `Zend\Mvc\MvcEvent`. 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...
29
30			$request = $e->getApplication()->getRequest();
			0 ignored issues – show Bug introduced 2016-01-29 11:30 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\EventManager\EventInterface` as the method `getApplication()` does only exist in the following implementations of said interface: `Zend\Mvc\MvcEvent`. 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...
31			$response = $e->getApplication()->getResponse();
			0 ignored issues – show Bug introduced 2016-01-29 11:30 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\EventManager\EventInterface` as the method `getApplication()` does only exist in the following implementations of said interface: `Zend\Mvc\MvcEvent`. 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...
32
33			// Try to login from Cookie if applicable
34			$service = new CookieAuthenticationService($sm);
35			$service->setEventManager(new EventManager($em->getSharedManager()));
36			$service->loginFrom($request, $response);
37
38			(new WriteTokenToCookie($sm))->attachShared($em->getSharedManager());
			0 ignored issues – show Bug introduced 2020-02-18 10:58 UTC by Report Bug Copy Issue Report It seems like `$em->getSharedManager()` can be `null`; however, `attachShared()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
39			}
40
41			public function getAutoloaderConfig()
42			{
43			return [
44			'Zend\Loader\StandardAutoloader' => [
45			'namespaces' => [
46			__NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__,
47			],
48			],
49			];
50			}
51			}
52

JouwWeb / JwPersistentUser

Module A last analyzed 2020-04-10 07:19 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

Module A
last analyzed 2020-04-10 07:19 UTC