JsonResult - Code Metrics - appserver-io/routlt - Measure and Improve Code Quality continuously with Scrutinizer

JsonResult A
last analyzed 2019-11-13 16:06 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

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

1 Method

Rating	Name	Duplication	Size	Complexity
A	process()	0	19	3

<?php

/**
 * AppserverIo\Routlt\Results\JsonResult
 *
 * 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\Http\HttpProtocol;
use AppserverIo\Routlt\Annotations\Result;
use AppserverIo\Routlt\Util\ValidationAware;
use AppserverIo\Psr\Servlet\ServletRequestInterface;
use AppserverIo\Psr\Servlet\ServletResponseInterface;

/**
 * Result implementation that JSON encodes the response body.
 *
 * @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
 * @deprecated Since 2.0.0-alpha5, use AppserverIo\Routlt\Results\RawResult instead
 *
 * @Result(shared=false)
 */
class JsonResult extends AbstractResult
{

    /**
     * The key for the data that has to be JSON encoded.
     *
     * @var string
     */
    const DATA = 'json-result.data';

    /**
     * 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)
    {

        // load the action instance
        $action = $this->getAction();

        // query whether the action contains errors or not
        if ($action instanceof ValidationAware && $action->hasErrors()) {
            $content = $action->getErrors();
        } else {
            $content = $servletRequest->getAttribute(JsonResult::DATA);

        }

        // add the header for the JSON content type
        $servletResponse->addHeader(HttpProtocol::HEADER_CONTENT_TYPE, 'application/json');
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.
    }
}

        // append the JSON encoded content to the servlet response
        $servletResponse->appendBodyStream(json_encode($content));
    }
}


1			<?php
2
3			/**
4			* AppserverIo\Routlt\Results\JsonResult
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\Http\HttpProtocol;
24			use AppserverIo\Routlt\Annotations\Result;
25			use AppserverIo\Routlt\Util\ValidationAware;
26			use AppserverIo\Psr\Servlet\ServletRequestInterface;
27			use AppserverIo\Psr\Servlet\ServletResponseInterface;
28
29			/**
30			* Result implementation that JSON encodes the response body.
31			*
32			* @author Tim Wagner <[email protected]>
33			* @copyright 2015 TechDivision GmbH <[email protected]>
34			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
35			* @link http://github.com/appserver-io/routlt
36			* @link http://www.appserver.io
37			* @deprecated Since 2.0.0-alpha5, use AppserverIo\Routlt\Results\RawResult instead
38			*
39			* @Result(shared=false)
40			*/
41			class JsonResult extends AbstractResult
42			{
43
44			/**
45			* The key for the data that has to be JSON encoded.
46			*
47			* @var string
48			*/
49			const DATA = 'json-result.data';
50
51			/**
52			* Processes an action result by dispatching the configured servlet.
53			*
54			* @param \AppserverIo\Psr\Servlet\ServletRequestInterface $servletRequest The request instance
55			* @param \AppserverIo\Psr\Servlet\ServletResponseInterface $servletResponse The response sent back to the client
56			*
57			* @return void
58			*/
59			public function process(ServletRequestInterface $servletRequest, ServletResponseInterface $servletResponse)
60			{
61
62			// load the action instance
63			$action = $this->getAction();
64
65			// query whether the action contains errors or not
66			if ($action instanceof ValidationAware && $action->hasErrors()) {
67			$content = $action->getErrors();
68			} else {
69			$content = $servletRequest->getAttribute(JsonResult::DATA);
			0 ignored issues – show Bug introduced 2016-12-01 18:36 UTC by Report Bug Copy Issue Report The method `getAttribute()` 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...
70			}
71
72			// add the header for the JSON content type
73			$servletResponse->addHeader(HttpProtocol::HEADER_CONTENT_TYPE, 'application/json');
			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\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...
74
75			// append the JSON encoded content to the servlet response
76			$servletResponse->appendBodyStream(json_encode($content));
77			}
78			}
79

appserver-io / routlt

JsonResult A last analyzed 2019-11-13 16:06 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

Available Fixes

Duplication Side-by-Side

Filter issues like

JsonResult A
last analyzed 2019-11-13 16:06 UTC