Responder::toResponse() - Code Metrics - Inspection of "Responder implements Responsable." - bright-components/responders - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#11)

by Clayton

created 2018-11-01 20:12 UTC

Responder::toResponse() A

↳ Parent: Responder

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace BrightComponents\Responder;

use Illuminate\Http\Request;
use DevMarketer\LaraFlash\LaraFlash;
use Illuminate\Contracts\Support\Responsable;
use BrightComponents\Common\Payloads\AbstractPayload;

abstract class Responder implements Responsable
{
    /**
     * The response payload.
     *
     * @var mixed
     */
    protected $payload;

    /**
     * Laraflash for flashing to session.
     *
     * @var \DevMarketer\LaraFlash\LaraFlash
     */
    protected $flash;

    /**
     * Construct a new base Responder.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \DevMarketer\LaraFlash\LaraFlash  $flash
     */
    public function __construct(Request $request, LaraFlash $flash)

    {
        $this->request = $request;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->flash = $flash;
    }

    /**
     * Create an HTTP response that represents the object.
     *
     * @param  \Illuminate\Http\Request  $request
     *
     * @return \Illuminate\Http\Response
     */
    public function toResponse($request)
    {
        return $this->respond();
    }

    /**
     * Send a response.
     *
     * @return mixed
     */
    abstract public function respond();

    /**
     * Add the payload to the response.
     *
     * @param  mixed  $payload
     *
     * @return $this
     */
    public function withPayload($payload)
    {
        $this->payload = $payload instanceof AbstractPayload ? $payload->getData() : $payload;
if ($x instanceof DoesNotExist) {
    // Do something.
}

        return $this;
    }

    /**
     * Add the request to the response.
     *
     * @param  \Illuminate\Http\Request  $request
     *
     * @return $this
     */
    public function withRequest(Request $request)

    {
        $this->request = $request;

        return $this;
    }

    /**
     * Flash data to the session.
     *
     * @param  string $key
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param  mixed  $value
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    protected function flash($message, array $options = [])
    {
        return $this->flash->add($message, $options);
    }
}


1			<?php
2
3			namespace BrightComponents\Responder;
4
5			use Illuminate\Http\Request;
6			use DevMarketer\LaraFlash\LaraFlash;
7			use Illuminate\Contracts\Support\Responsable;
8			use BrightComponents\Common\Payloads\AbstractPayload;
9
10			abstract class Responder implements Responsable
11			{
12			/**
13			* The response payload.
14			*
15			* @var mixed
16			*/
17			protected $payload;
18
19			/**
20			* Laraflash for flashing to session.
21			*
22			* @var \DevMarketer\LaraFlash\LaraFlash
23			*/
24			protected $flash;
25
26			/**
27			* Construct a new base Responder.
28			*
29			* @param \Illuminate\Http\Request $request
30			* @param \DevMarketer\LaraFlash\LaraFlash $flash
31			*/
32			public function __construct(Request $request, LaraFlash $flash)
			0 ignored issues – show Bug introduced 2018-07-04 03:57 UTC by Report Bug Copy Issue Report You have injected the Request via parameter `$request`. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via `getCurrentRequest()`. Loading history...
33			{
34			$this->request = $request;
			0 ignored issues – show Bug introduced 2018-07-04 03:57 UTC by Report Bug Copy Issue Report The property `request` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
35			$this->flash = $flash;
36			}
37
38			/**
39			* Create an HTTP response that represents the object.
40			*
41			* @param \Illuminate\Http\Request $request
42			*
43			* @return \Illuminate\Http\Response
44			*/
45			public function toResponse($request)
46			{
47			return $this->respond();
48			}
49
50			/**
51			* Send a response.
52			*
53			* @return mixed
54			*/
55			abstract public function respond();
56
57			/**
58			* Add the payload to the response.
59			*
60			* @param mixed $payload
61			*
62			* @return $this
63			*/
64			public function withPayload($payload)
65			{
66			$this->payload = $payload instanceof AbstractPayload ? $payload->getData() : $payload;
			0 ignored issues – show Bug introduced 2018-07-04 03:57 UTC by Report Bug Copy Issue Report The class `BrightComponents\Common\Payloads\AbstractPayload` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
67
68			return $this;
69			}
70
71			/**
72			* Add the request to the response.
73			*
74			* @param \Illuminate\Http\Request $request
75			*
76			* @return $this
77			*/
78			public function withRequest(Request $request)
			0 ignored issues – show Bug introduced 2018-07-04 03:57 UTC by Report Bug Copy Issue Report You have injected the Request via parameter `$request`. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via `getCurrentRequest()`. Loading history...
79			{
80			$this->request = $request;
81
82			return $this;
83			}
84
85			/**
86			* Flash data to the session.
87			*
88			* @param string $key
			0 ignored issues – show Bug introduced 2018-05-25 18:24 UTC by Report Bug Copy Issue Report There is no parameter named `$key`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
89			* @param mixed $value
			0 ignored issues – show Bug introduced 2018-05-25 18:24 UTC by Report Bug Copy Issue Report There is no parameter named `$value`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
90			*/
91			protected function flash($message, array $options = [])
92			{
93			return $this->flash->add($message, $options);
94			}
95			}
96

bright-components / responders

Pull Request — master (#11)

Responder::toResponse() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like