ServletDispatcherResult::getName() - Code Metrics - Inspection of "Merge pull request #43 from wagnert/master" - appserver-io/routlt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dea6f9...493a70 )

by Tim

created 2017-09-14 18:24 UTC

ServletDispatcherResult::getName() A

↳ Parent: ServletDispatcherResult::process()

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

/**
 * AppserverIo\Routlt\Results\ServletDispatcherResult
 *
 * 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\Routlt\Util\ServletContextAware;
use AppserverIo\Psr\Servlet\ServletContextInterface;
use AppserverIo\Psr\Servlet\ServletRequestInterface;
use AppserverIo\Psr\Servlet\ServletResponseInterface;

/**
 * Result implementation that dispatches another servlet.
 *
 * @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 ServletDispatcherResult implements ResultInterface, ServletContextAware
{

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

    /**
     * The servlet context instance.
     *
     * @param \AppserverIo\Psr\Servlet\ServletContextInterface
     */
    protected $servletContext;

    /**
     * Sets the actual servlet context instance.
     *
     * @param \AppserverIo\Psr\Servlet\ServletContextInterface $servletContext The servlet context instance
     *
     * @return void
     */
    public function setServletContext(ServletContextInterface $servletContext)
    {
        $this->servletContext = $servletContext;
    }

    /**
     * Returns the servlet context instance.
     *
     * @return \AppserverIo\Psr\Servlet\ServletContextInterface The servlet context instance
    */
    public function getServletContext()
    {
        return $this->servletContext;
    }

    /**
     * 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 variables for the path and the query string
        $path = null;
        $query = null;

        // load result and session-ID
        extract(parse_url($this->getResult()));


        // initialize the request URI
        if (!empty($path)) {
            $servletRequest->setRequestUri($path);

        }

        // initialize the query string
        if (!empty($query)) {
            $servletRequest->setQueryString($query);

        }

        // prepare the request with the new data
        $servletRequest->prepare();


        // load the servlet path and session-ID
        $servletPath = $servletRequest->getServletPath();
        $sessionId = $servletRequest->getProposedSessionId();
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.
    }
}

        // load and process the servlet
        $servlet = $this->getServletContext()->lookup($servletPath, $sessionId);

        $servlet->service($servletRequest, $servletResponse);
    }
}


1			<?php
2
3			/**
4			* AppserverIo\Routlt\Results\ServletDispatcherResult
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\Routlt\Util\ServletContextAware;
24			use AppserverIo\Psr\Servlet\ServletContextInterface;
25			use AppserverIo\Psr\Servlet\ServletRequestInterface;
26			use AppserverIo\Psr\Servlet\ServletResponseInterface;
27
28			/**
29			* Result implementation that dispatches another servlet.
30			*
31			* @author Tim Wagner <[email protected]>
32			* @copyright 2015 TechDivision GmbH <[email protected]>
33			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
34			* @link http://github.com/appserver-io/routlt
35			* @link http://www.appserver.io
36			*/
37			class ServletDispatcherResult implements ResultInterface, ServletContextAware
38			{
39
40			/**
41			* Trait proving basic result functionality.
42			*
43			* @var \AppserverIo\Routlt\Results\ResultTrait
44			*/
45			use ResultTrait;
46
47			/**
48			* The servlet context instance.
49			*
50			* @param \AppserverIo\Psr\Servlet\ServletContextInterface
51			*/
52			protected $servletContext;
53
54			/**
55			* Sets the actual servlet context instance.
56			*
57			* @param \AppserverIo\Psr\Servlet\ServletContextInterface $servletContext The servlet context instance
58			*
59			* @return void
60			*/
61			public function setServletContext(ServletContextInterface $servletContext)
62			{
63			$this->servletContext = $servletContext;
64			}
65
66			/**
67			* Returns the servlet context instance.
68			*
69			* @return \AppserverIo\Psr\Servlet\ServletContextInterface The servlet context instance
70			*/
71			public function getServletContext()
72			{
73			return $this->servletContext;
74			}
75
76			/**
77			* Processes an action result by dispatching the configured servlet.
78			*
79			* @param \AppserverIo\Psr\Servlet\ServletRequestInterface $servletRequest The request instance
80			* @param \AppserverIo\Psr\Servlet\ServletResponseInterface $servletResponse The response sent back to the client
81			*
82			* @return void
83			*/
84			public function process(ServletRequestInterface $servletRequest, ServletResponseInterface $servletResponse)
85			{
86
87			// initialize the variables for the path and the query string
88			$path = null;
89			$query = null;
90
91			// load result and session-ID
92			extract(parse_url($this->getResult()));
			0 ignored issues – show Bug introduced 2016-01-23 14:30 UTC by Report Bug Copy Issue Report `parse_url($this->getResult())` cannot be passed to `extract()` as the parameter `$var_array` expects a reference. Loading history...
93
94			// initialize the request URI
95			if (!empty($path)) {
96			$servletRequest->setRequestUri($path);
			0 ignored issues – show Bug introduced 2016-12-01 18:36 UTC by Report Bug Copy Issue Report The method `setRequestUri()` does not seem to exist on `object<AppserverIo\Psr\S...ervletRequestInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
97			}
98
99			// initialize the query string
100			if (!empty($query)) {
101			$servletRequest->setQueryString($query);
			0 ignored issues – show Bug introduced 2016-12-01 18:36 UTC by Report Bug Copy Issue Report The method `setQueryString()` does not seem to exist on `object<AppserverIo\Psr\S...ervletRequestInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
102			}
103
104			// prepare the request with the new data
105			$servletRequest->prepare();
			0 ignored issues – show Bug introduced 2016-12-01 18:36 UTC by Report Bug Copy Issue Report The method `prepare()` does not seem to exist on `object<AppserverIo\Psr\S...ervletRequestInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
106
107			// load the servlet path and session-ID
108			$servletPath = $servletRequest->getServletPath();
109			$sessionId = $servletRequest->getProposedSessionId();
			0 ignored issues – show Bug introduced 2016-12-01 18:36 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 `getProposedSessionId()` 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...
110
111			// load and process the servlet
112			$servlet = $this->getServletContext()->lookup($servletPath, $sessionId);
			0 ignored issues – show Bug introduced 2016-12-01 18:36 UTC by Report Bug Copy Issue Report The method `lookup()` does not seem to exist on `object<AppserverIo\Psr\S...ervletContextInterface>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
113			$servlet->service($servletRequest, $servletResponse);
114			}
115			}
116

appserver-io / routlt

Push — master ( dea6f9...493a70 )

ServletDispatcherResult::getName() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like