WriteTokenToCookie::setCookieService() - Code Metrics - Inspection of "Update phpunit/phpunit requirement from 4.8.* to 4..." - JouwWeb/JwPersistentUser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#14)

unknown

created 2020-02-18 10:45 UTC

WriteTokenToCookie::setCookieService() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
ccs	0
cts	0
cp	0
cc	1
eloc	3
nc	1
nop	1
crap	2

<?php

namespace JwPersistentUser\Listener;

use Interop\Container\ContainerInterface;
use JwPersistentUser\Service\CookieService;
use JwPersistentUser\Service\RememberMeService;
use Zend\EventManager\SharedEventManagerInterface;
use Zend\Http\Request;
use Zend\Http\Response;
use Zend\Stdlib\RequestInterface;
use Zend\Stdlib\ResponseInterface;
use ZfcUser\Authentication\Adapter\AdapterChainEvent;

class WriteTokenToCookie
{
    protected $sharedListeners = [];

    /**
     * @var ContainerInterface
     */
    protected $serviceLocator;

    public function __construct(ContainerInterface $serviceLocator)
    {
        $this->serviceLocator = $serviceLocator;
    }

    public function attachShared(SharedEventManagerInterface $events)
    {
        $events->attach(
            'ZfcUser\Authentication\Adapter\AdapterChain',
            'authenticate.success',
            [$this, 'authenticate']
        );

        $events->attach(
            'ZfcUser\Authentication\Adapter\AdapterChain',
            'logout',
            [$this, 'logout']
        );
    }

    public function detachShared(SharedEventManagerInterface $events)
    {
        foreach ($this->sharedListeners as $key => $handle) {
            if ($events->detach($handle[0], $handle[1])) {
                unset($this->sharedListeners[$key]);
            }
        }
    }

    public function authenticate(AdapterChainEvent $e)
    {
        if (!$this->isValidRequestAndResponse()) {
            return;
        }

        $serieToken = $this->getRememberMeService()->createNew($e->getIdentity());

        $this->getCookieService()->writeSerie($this->getResponse(), $serieToken);

    }

    public function logout(AdapterChainEvent $e)

    {
        if (!$this->isValidRequestAndResponse()) {
            return;
        }

        $serieToken = $this->getCookieService()->read($this->getRequest(), $this->getResponse());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if ($serieToken) {
            $this->getRememberMeService()->removeSerie($serieToken->getUserId(), $serieToken->getSerie());
        }

        $this->getCookieService()->writeNull($this->getResponse());

    }

    /**
     * @return bool
     */
    protected function isValidRequestAndResponse()
    {
        return $this->getRequest() instanceof Request
            && $this->getResponse() instanceof Response;
    }

    /**
     * @return RememberMeService
     */
    public function getRememberMeService()
    {
        return $this->serviceLocator->get('JwPersistentUser\Service\RememberMe');
    }

    /**
     * @return ResponseInterface
     */
    public function getResponse()
    {
        return $this->serviceLocator->get('Response');
    }

    /**
     * @return RequestInterface
     */
    public function getRequest()
    {
        return $this->serviceLocator->get('Request');
    }

    /**
     * @return CookieService
     */
    public function getCookieService()
    {
        return $this->serviceLocator->get('JwPersistentUser\Service\Cookie');
    }
}


1		<?php
2
3		namespace JwPersistentUser\Listener;
4
5		use Interop\Container\ContainerInterface;
6		use JwPersistentUser\Service\CookieService;
7		use JwPersistentUser\Service\RememberMeService;
8		use Zend\EventManager\SharedEventManagerInterface;
9		use Zend\Http\Request;
10		use Zend\Http\Response;
11		use Zend\Stdlib\RequestInterface;
12		use Zend\Stdlib\ResponseInterface;
13		use ZfcUser\Authentication\Adapter\AdapterChainEvent;
14
15		class WriteTokenToCookie
16		{
17		protected $sharedListeners = [];
18
19		/**
20		* @var ContainerInterface
21		*/
22		protected $serviceLocator;
23
24		public function __construct(ContainerInterface $serviceLocator)
25		{
26		$this->serviceLocator = $serviceLocator;
27		}
28
29		public function attachShared(SharedEventManagerInterface $events)
30		{
31		$events->attach(
32		'ZfcUser\Authentication\Adapter\AdapterChain',
33		'authenticate.success',
34		[$this, 'authenticate']
35		);
36
37		$events->attach(
38		'ZfcUser\Authentication\Adapter\AdapterChain',
39		'logout',
40		[$this, 'logout']
41		);
42		}
43
44		public function detachShared(SharedEventManagerInterface $events)
45		{
46		foreach ($this->sharedListeners as $key => $handle) {
47		if ($events->detach($handle[0], $handle[1])) {
48		unset($this->sharedListeners[$key]);
49		}
50		}
51		}
52
53		public function authenticate(AdapterChainEvent $e)
54		{
55		if (!$this->isValidRequestAndResponse()) {
56		return;
57		}
58
59		$serieToken = $this->getRememberMeService()->createNew($e->getIdentity());
60
61		$this->getCookieService()->writeSerie($this->getResponse(), $serieToken);
		0 ignored issues – show Compatibility introduced 2016-01-29 11:30 UTC by Report Bug Copy Issue Report `$this->getResponse()` of type `object<Zend\Stdlib\ResponseInterface>` is not a sub-type of `object<Zend\Http\Response>`. It seems like you assume a concrete implementation of the interface `Zend\Stdlib\ResponseInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
62		}
63
64		public function logout(AdapterChainEvent $e)
		0 ignored issues – show Unused Code introduced 2020-02-18 10:58 UTC by Report Bug Copy Issue Report The parameter `$e` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
65	3	{
66		if (!$this->isValidRequestAndResponse()) {
67	3	return;
68	2	}
69
70		$serieToken = $this->getCookieService()->read($this->getRequest(), $this->getResponse());
		0 ignored issues – show Compatibility introduced 2016-01-29 11:30 UTC by Report Bug Copy Issue Report `$this->getRequest()` of type `object<Zend\Stdlib\RequestInterface>` is not a sub-type of `object<Zend\Http\Request>`. It seems like you assume a concrete implementation of the interface `Zend\Stdlib\RequestInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history... Documentation introduced 2016-01-29 11:30 UTC by Report Bug Copy Issue Report `$this->getResponse()` is of type `object<Zend\Stdlib\ResponseInterface>`, but the function expects a `null\|object<Zend\Http\Response>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
71	1	if ($serieToken) {
72		$this->getRememberMeService()->removeSerie($serieToken->getUserId(), $serieToken->getSerie());
73	1	}
74	1
75		$this->getCookieService()->writeNull($this->getResponse());
		0 ignored issues – show Compatibility introduced 2016-01-29 11:30 UTC by Report Bug Copy Issue Report `$this->getResponse()` of type `object<Zend\Stdlib\ResponseInterface>` is not a sub-type of `object<Zend\Http\Response>`. It seems like you assume a concrete implementation of the interface `Zend\Stdlib\ResponseInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
76		}
77
78		/**
79	3	* @return bool
80		*/
81	3	protected function isValidRequestAndResponse()
82	2	{
83		return $this->getRequest() instanceof Request
84		&& $this->getResponse() instanceof Response;
85	1	}
86	1
87	1	/**
88	1	* @return RememberMeService
89		*/
90	1	public function getRememberMeService()
91	1	{
92		return $this->serviceLocator->get('JwPersistentUser\Service\RememberMe');
93		}
94
95		/**
96	6	* @return ResponseInterface
97		*/
98	6	public function getResponse()
99	6	{
100		return $this->serviceLocator->get('Response');
101		}
102
103		/**
104		* @return RequestInterface
105		*/
106		public function getRequest()
107		{
108		return $this->serviceLocator->get('Request');
109		}
110
111		/**
112		* @return CookieService
113		*/
114	2	public function getCookieService()
115		{
116	2	return $this->serviceLocator->get('JwPersistentUser\Service\Cookie');
117		}
118		}
119

JouwWeb / JwPersistentUser

Pull Request — master (#14)

WriteTokenToCookie::setCookieService() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like