RedirectResult - Code Metrics - Inspection of "Query whether or not a header already exists befor..." - appserver-io/routlt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#43)

by Tim

created 2017-09-13 20:18 UTC

RedirectResult A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	35
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	2
c	1
b	0
f	0
lcom	0
cbo	2
dl	0
loc	35
rs	10

1 Method

Rating	Name	Duplication	Size	Complexity
A	process()	0	16	2

<?php

/**
 * AppserverIo\Routlt\Results\RedirectResult
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author     Tim Wagner <[email protected]>
 * @copyright  2015 TechDivision GmbH <[email protected]>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       http://github.com/appserver-io/routlt
 * @link       http://www.appserver.io
 */

namespace AppserverIo\Routlt\Results;

use AppserverIo\Psr\HttpMessage\Protocol;
use AppserverIo\Psr\Servlet\ServletRequestInterface;
use AppserverIo\Psr\Servlet\ServletResponseInterface;

/**
 * Result implementation that supports action based default headers and encoding.
 *
 * @author     Tim Wagner <[email protected]>
 * @copyright  2015 TechDivision GmbH <[email protected]>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       http://github.com/appserver-io/routlt
 * @link       http://www.appserver.io
 */
class RedirectResult implements ResultInterface
{

    /**
     * Trait proving basic result functionality.
     *
     * @var \AppserverIo\Routlt\Results\ResultTrait
     */
    use ResultTrait;


    /**
     * Processes an action result by dispatching the configured servlet.
     *
     * @param \AppserverIo\Psr\Servlet\ServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\ServletResponseInterface $servletResponse The response sent back to the client
     *
     * @return void
     */
    public function process(ServletRequestInterface $servletRequest, ServletResponseInterface $servletResponse)
    {

        // initialize the location we want to redirect to
        $result = $this->getResult();

        // add the base modifier, if necessary
        if ($baseModifier = $servletRequest->getBaseModifier()) {
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.
    }
}
            $result = $baseModifier . $result;
        }

        // stop processing the request and redirect to the URL
        $servletRequest->setDispatched(true);
        $servletResponse->setStatusCode(307);
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.
    }
}
        $servletResponse->addHeader(Protocol::HEADER_LOCATION, $result);
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.
    }
}
    }
}


Pull Request — master (#43)

RedirectResult A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			/**
4			* AppserverIo\Routlt\Results\RedirectResult
5			*
6			* NOTICE OF LICENSE
7			*
8			* This source file is subject to the Open Software License (OSL 3.0)
9			* that is available through the world-wide-web at this URL:
10			* http://opensource.org/licenses/osl-3.0.php
11			*
12			* PHP version 5
13			*
14			* @author Tim Wagner <[email protected]>
15			* @copyright 2015 TechDivision GmbH <[email protected]>
16			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17			* @link http://github.com/appserver-io/routlt
18			* @link http://www.appserver.io
19			*/
20
21			namespace AppserverIo\Routlt\Results;
22
23			use AppserverIo\Psr\HttpMessage\Protocol;
24			use AppserverIo\Psr\Servlet\ServletRequestInterface;
25			use AppserverIo\Psr\Servlet\ServletResponseInterface;
26
27			/**
28			* Result implementation that supports action based default headers and encoding.
29			*
30			* @author Tim Wagner <[email protected]>
31			* @copyright 2015 TechDivision GmbH <[email protected]>
32			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
33			* @link http://github.com/appserver-io/routlt
34			* @link http://www.appserver.io
35			*/
36			class RedirectResult implements ResultInterface
37			{
38
39			/**
40			* Trait proving basic result functionality.
41			*
42			* @var \AppserverIo\Routlt\Results\ResultTrait
43			*/
44			use ResultTrait;
			0 ignored issues – show Deprecated Code introduced 2017-09-13 20:24 UTC by Report Bug Copy Issue Report The trait `AppserverIo\Routlt\Results\ResultTrait` has been deprecated with message: Since 2.0.0-alpha5, use AppserverIo\Routlt\Results\RawResult instead This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
45
46			/**
47			* Processes an action result by dispatching the configured servlet.
48			*
49			* @param \AppserverIo\Psr\Servlet\ServletRequestInterface $servletRequest The request instance
50			* @param \AppserverIo\Psr\Servlet\ServletResponseInterface $servletResponse The response sent back to the client
51			*
52			* @return void
53			*/
54			public function process(ServletRequestInterface $servletRequest, ServletResponseInterface $servletResponse)
55			{
56
57			// initialize the location we want to redirect to
58			$result = $this->getResult();
59
60			// add the base modifier, if necessary
61			if ($baseModifier = $servletRequest->getBaseModifier()) {
			0 ignored issues – show Bug introduced 2017-09-13 20:24 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `AppserverIo\Psr\Servlet\ServletRequestInterface` as the method `getBaseModifier()` does only exist in the following implementations of said interface: `AppserverIo\Psr\Servlet\...tpServletRequestWrapper`. 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...
62			$result = $baseModifier . $result;
63			}
64
65			// stop processing the request and redirect to the URL
66			$servletRequest->setDispatched(true);
67			$servletResponse->setStatusCode(307);
			0 ignored issues – show Bug introduced 2017-09-13 20:24 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `AppserverIo\Psr\Servlet\ServletResponseInterface` as the method `setStatusCode()` does only exist in the following implementations of said interface: `AppserverIo\Psr\Servlet\...pServletResponseWrapper`. 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...
68			$servletResponse->addHeader(Protocol::HEADER_LOCATION, $result);
			0 ignored issues – show Bug introduced 2017-09-13 20:24 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `AppserverIo\Psr\Servlet\ServletResponseInterface` as the method `addHeader()` does only exist in the following implementations of said interface: `AppserverIo\Psr\Servlet\...pServletResponseWrapper`. 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...
69			}
70			}
71

appserver-io / routlt

Pull Request — master (#43)

RedirectResult A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like