Response::getErrorBagForStatusCode()

Completed

Pull Request — master (#82)

by Chris

created 2019-10-17 18:43 UTC

↳ Parent: Response

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	1
ccs	0
cts	0
cp	0
nc	1

<?php

namespace PragmaRX\Google2FALaravel\Support;

use Illuminate\Http\JsonResponse as IlluminateJsonResponse;
use Illuminate\Http\Response as IlluminateHtmlResponse;
use PragmaRX\Google2FALaravel\Events\OneTimePasswordRequested;
use PragmaRX\Google2FALaravel\Events\OneTimePasswordRequested53;
use Symfony\Component\HttpFoundation\Response as SymfonyResponse;

trait Response
{
    /**
     * Make a JSON response.
     *
     * @param $statusCode
     *
     * @return IlluminateJsonResponse
     */
    protected function makeJsonResponse($statusCode)
    {
        return new IlluminateJsonResponse(
            $this->getErrorBagForStatusCode($statusCode),
            $statusCode
        );
    }

    /**
     * Make the status code, to respond accordingly.
     *
     * @return int
     */
    protected function makeStatusCode()
    {
        if ($this->getRequest()->isMethod('get') || ($this->checkOTP() === Constants::OTP_VALID)) {
            return SymfonyResponse::HTTP_OK;
        }
        if ($this->checkOTP() === Constants::OTP_EMPTY) {
            return SymfonyResponse::HTTP_BAD_REQUEST;
        }
        return SymfonyResponse::HTTP_UNPROCESSABLE_ENTITY;
    }

    /**
     * Make a web response.
     *
     * @param $statusCode
     *
     * @return \Illuminate\Http\Response
     */
    protected function makeHtmlResponse($statusCode)
    {
        $view = $this->getView();

        if ($statusCode !== SymfonyResponse::HTTP_OK) {
            $view->withErrors($this->getErrorBagForStatusCode($statusCode));
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        return new IlluminateHtmlResponse($view, $statusCode);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Create a response to request the OTP.
     *
     * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
     */
    public function makeRequestOneTimePasswordResponse()
    {
        event(
            app()->version() < '5.4'
                ? new OneTimePasswordRequested53($this->getUser())
                : new OneTimePasswordRequested($this->getUser())
        );

        $expectJson = app()->version() < '5.4'
            ? $this->getRequest()->wantsJson()
            : $this->getRequest()->expectsJson();

        return $expectJson
            ? $this->makeJsonResponse($this->makeStatusCode())
            : $this->makeHtmlResponse($this->makeStatusCode());
    }

    /**
     * Get the OTP view.
     *
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
     */
    private function getView()
    {
        return view($this->config('view'));
    }

    abstract protected function getErrorBagForStatusCode($statusCode);

    abstract protected function inputHasOneTimePassword();

    abstract public function checkOTP();

    abstract protected function getUser();

    abstract public function getRequest();

    abstract protected function config($string, $children = []);
}


1		<?php
2
3		namespace PragmaRX\Google2FALaravel\Support;
4
5		use Illuminate\Http\JsonResponse as IlluminateJsonResponse;
6		use Illuminate\Http\Response as IlluminateHtmlResponse;
7		use PragmaRX\Google2FALaravel\Events\OneTimePasswordRequested;
8		use PragmaRX\Google2FALaravel\Events\OneTimePasswordRequested53;
9		use Symfony\Component\HttpFoundation\Response as SymfonyResponse;
10
11		trait Response
12		{
13		/**
14		* Make a JSON response.
15		*
16		* @param $statusCode
17		*
18		* @return IlluminateJsonResponse
19		*/
20		protected function makeJsonResponse($statusCode)
21		{
22		return new IlluminateJsonResponse(
23		$this->getErrorBagForStatusCode($statusCode),
24		$statusCode
25		);
26		}
27
28		/**
29		* Make the status code, to respond accordingly.
30		*
31		* @return int
32		*/
33	7	protected function makeStatusCode()
34		{
35	7	if ($this->getRequest()->isMethod('get') \|\| ($this->checkOTP() === Constants::OTP_VALID)) {
36	4	return SymfonyResponse::HTTP_OK;
37		}
38	3	if ($this->checkOTP() === Constants::OTP_EMPTY) {
39	2	return SymfonyResponse::HTTP_BAD_REQUEST;
40		}
41	1	return SymfonyResponse::HTTP_UNPROCESSABLE_ENTITY;
42		}
43
44		/**
45		* Make a web response.
46		*
47		* @param $statusCode
48		*
49		* @return \Illuminate\Http\Response
50		*/
51	7	protected function makeHtmlResponse($statusCode)
52		{
53	7	$view = $this->getView();
54
55	7	if ($statusCode !== SymfonyResponse::HTTP_OK) {
56	3	$view->withErrors($this->getErrorBagForStatusCode($statusCode));
		0 ignored issues – show Bug introduced 2017-06-20 04:40 UTC by Report Bug Copy Issue Report The method `withErrors` does only exist in `Illuminate\View\View`, but not in `Illuminate\Contracts\View\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
57		}
58
59	7	return new IlluminateHtmlResponse($view, $statusCode);
		0 ignored issues – show Documentation introduced 2018-03-08 02:16 UTC by Report Bug Copy Issue Report `$view` is of type `object<Illuminate\View\V...Contracts\View\Factory>`, but the function expects a `string`. 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...
60		}
61
62		/**
63		* Create a response to request the OTP.
64		*
65		* @return \Illuminate\Http\Response\|\Illuminate\Http\JsonResponse
66		*/
67	7	public function makeRequestOneTimePasswordResponse()
68		{
69	7	event(
70	7	app()->version() < '5.4'
71		? new OneTimePasswordRequested53($this->getUser())
72	7	: new OneTimePasswordRequested($this->getUser())
73		);
74
75	7	$expectJson = app()->version() < '5.4'
76		? $this->getRequest()->wantsJson()
77	7	: $this->getRequest()->expectsJson();
78
79	7	return $expectJson
80		? $this->makeJsonResponse($this->makeStatusCode())
81	7	: $this->makeHtmlResponse($this->makeStatusCode());
82		}
83
84		/**
85		* Get the OTP view.
86		*
87		* @return \Illuminate\Contracts\View\Factory\|\Illuminate\View\View
88		*/
89	7	private function getView()
90		{
91	7	return view($this->config('view'));
92		}
93
94		abstract protected function getErrorBagForStatusCode($statusCode);
95
96		abstract protected function inputHasOneTimePassword();
97
98		abstract public function checkOTP();
99
100		abstract protected function getUser();
101
102		abstract public function getRequest();
103
104		abstract protected function config($string, $children = []);
105		}
106

antonioribeiro / google2fa-laravel

Pull Request — master (#82)

Response::getErrorBagForStatusCode()

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like