Controller::before() - Code Metrics - Inspection of "Run phpstan." - jasny/controller - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( a26426...65249a )

by Arnold

created 2022-10-09 02:33 UTC

Controller::before() A

↳ Parent: Controller

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	0

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes

Metric	Value
eloc	0
c	0
b	0
f	0
dl	0
loc	2
rs	10
ccs	1
cts	1
cp	1
cc	1
nc	1
nop	0
crap	1

<?php
declare(strict_types=1);


namespace Jasny\Controller;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

/**
 * Controller base class
 */

abstract class Controller
{
    use Traits\Base,
        Traits\Header,
        Traits\Output,
        Traits\CheckRequest,
        Traits\CheckResponse,
        Traits\ContentNegotiation,
        Traits\Guarded;

    /**
     * Called before executing the action.
     * @codeCoverageIgnore

     *
     * <code>
     * protected function before()
     * {
     *    if ($this->auth->getUser()->getCredits() <= 0) {
     *        return $this->paymentRequired()->output("Sorry, you're out of credits");
     *    }
     * }
     * </code>
     *
     * @return void|null|ResponseInterface|static
     */
    protected function before()
    {
    }

    /**
     * Called after executing the action.
     * @codeCoverageIgnore

     *
     * @return void|null|ResponseInterface|static
     */
    protected function after()
    {
    }

    /**

     * Get the method name of the action
     */

    protected function getActionMethod(string $action): string
    {
        $sentence = preg_replace('/[\W_]+/', ' ', $action);
        return lcfirst(str_replace(' ', '', ucwords($sentence)));
    }

    /**

     * Invoke the controller.
     */

    public function __invoke(ServerRequestInterface $request, ResponseInterface $response): ResponseInterface
    {
        $this->request = $request;
        $this->response = $response;

        $method = $this->getActionMethod($request->getAttribute('route:action', 'process'));
        $refl = method_exists($this, $method) ? new \ReflectionMethod($this, $method) : null;

        if ($refl === null || !$refl->isPublic() || $refl->isConstructor() || $method === __METHOD__) {
            return $this->notFound()->output('Not found')->getResponse();
        }

        try {
            $args = $this->getFunctionArgs($refl);
        } catch (ParameterException $exception) {
            return $this->badRequest()->output($exception->getMessage())->getResponse();
        }

        $result = $this->guard(new \ReflectionObject($this));
        if ($result !== null) {
            return $result;
        }

        $result = $this->before();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        if ($result !== null) {

            return $result instanceof ResponseInterface ? $result : $this->getResponse();
        }

        $result = $this->guard($refl);
        if ($result !== null) {
            return $result;
        }

        $result = [$this, $method](...$args);

        $response = $this->after() ?? $result;
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

        return $response instanceof ResponseInterface ? $response : $this->getResponse();
    }
}


1		<?php
2		declare(strict_types=1);
		0 ignored issues – show Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Missing file doc comment Loading history...
3
4		namespace Jasny\Controller;
5
6		use Psr\Http\Message\ResponseInterface;
7		use Psr\Http\Message\ServerRequestInterface;
8
9		/**
10		* Controller base class
11		*/
		0 ignored issues – show Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Missing @package tag in class comment Loading history... Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Missing @author tag in class comment Loading history... Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
12		abstract class Controller
13		{
14		use Traits\Base,
15		Traits\Header,
16		Traits\Output,
17		Traits\CheckRequest,
18		Traits\CheckResponse,
19		Traits\ContentNegotiation,
20		Traits\Guarded;
21
22		/**
23		* Called before executing the action.
24		* @codeCoverageIgnore
		0 ignored issues – show Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report There must be exactly one blank line before the tags in a doc comment Loading history...
25		*
26		* <code>
27		* protected function before()
28		* {
29		* if ($this->auth->getUser()->getCredits() <= 0) {
30		* return $this->paymentRequired()->output("Sorry, you're out of credits");
31		* }
32		* }
33		* </code>
34		*
35		* @return void\|null\|ResponseInterface\|static
36		*/
37	2	protected function before()
38		{
39	2	}
40	1
41		/**
42		* Called after executing the action.
43	1	* @codeCoverageIgnore
		0 ignored issues – show Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report There must be exactly one blank line before the tags in a doc comment Loading history...
44		*
45		* @return void\|null\|ResponseInterface\|static
46		*/
47		protected function after()
48		{
49		}
50
51	3	/**
		0 ignored issues – show Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Parameter `$action` should have a doc-comment as per coding-style. Loading history...
52		* Get the method name of the action
53	3	*/
		0 ignored issues – show Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
54	1	protected function getActionMethod(string $action): string
55		{
56		$sentence = preg_replace('/[\W_]+/', ' ', $action);
57	2	return lcfirst(str_replace(' ', '', ucwords($sentence)));
58		}
59
60		/**
		0 ignored issues – show Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Parameter `$request` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Parameter `$response` should have a doc-comment as per coding-style. Loading history...
61		* Invoke the controller.
62		*/
		0 ignored issues – show Coding Style introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Missing @return tag in function comment Loading history...
63		public function __invoke(ServerRequestInterface $request, ResponseInterface $response): ResponseInterface
64		{
65	1	$this->request = $request;
66		$this->response = $response;
67	1
68	1	$method = $this->getActionMethod($request->getAttribute('route:action', 'process'));
69		$refl = method_exists($this, $method) ? new \ReflectionMethod($this, $method) : null;
70
71		if ($refl === null \|\| !$refl->isPublic() \|\| $refl->isConstructor() \|\| $method === __METHOD__) {
72		return $this->notFound()->output('Not found')->getResponse();
73		}
74
75		try {
76		$args = $this->getFunctionArgs($refl);
77		} catch (ParameterException $exception) {
78		return $this->badRequest()->output($exception->getMessage())->getResponse();
79		}
80
81		$result = $this->guard(new \ReflectionObject($this));
82		if ($result !== null) {
83		return $result;
84		}
85	2
86		$result = $this->before();
		1 ignored issue – show Bug introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$result` is correct as `$this->before()` targeting `Jasny\Controller\Controller::before()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
87	2	if ($result !== null) {
		1 ignored issue – show introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report The condition `$result !== null` is always `false`. Loading history...
88	2	return $result instanceof ResponseInterface ? $result : $this->getResponse();
89		}
90	2
91	1	$result = $this->guard($refl);
92		if ($result !== null) {
93		return $result;
94	2	}
95
96	2	$result = [$this, $method](...$args);
97
98		$response = $this->after() ?? $result;
		1 ignored issue – show Bug introduced 2022-10-09 02:47 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->after()` targeting `Jasny\Controller\Controller::after()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
99
100		return $response instanceof ResponseInterface ? $response : $this->getResponse();
101		}
102		}
103

jasny / controller

Push — master ( a26426...65249a )

Controller::before() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like