ApiRequestInspector::isIncludeAllowed() - Code Metrics - Inspection of "Merge pull request #22 from okdewit/patch-2" - sarala-io/sarala-laravel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 870cb1...1f9632 )

by Milroy

created 2021-01-13 14:27 UTC

ApiRequestInspector::isIncludeAllowed() A

↳ Parent: ApiRequestInspector

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Sarala\Query;

use Illuminate\Http\Request;
use Illuminate\Support\Str;
use Sarala\Exceptions\UnauthorizedIncludeException;
use Sarala\Http\Requests\ApiRequestAbstract;

class ApiRequestInspector
{
    /** @var ApiRequestAbstract */
    private $request = null;

    public function __construct(array $parameters)
    {
        $this->setRequestReceivedAtApiEndpoint($parameters);
    }

    public function inspect()
    {
        $this->sanitizeIncludes();
    }

    private function setRequestReceivedAtApiEndpoint(array $parameters)
    {
        foreach ($parameters as $parameter) {
            if ($parameter instanceof Request) {
                $this->request = $parameter;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
            }
        }
    }

    private function sanitizeIncludes()
    {
        $this->request->includes()->each(function ($params, $field) {

            if (! $this->isIncludeAllowed($field)) {
                throw new UnauthorizedIncludeException($field, $this->request->allowedIncludes());
            }
        });
    }

    private function isIncludeAllowed($field): bool
    {
        foreach ($this->request->allowedIncludes() as $allowedInclude) {
            if (Str::startsWith($allowedInclude, $field)) {
                return true;
            }
        }

        return false;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Sarala\Query;
6
7			use Illuminate\Http\Request;
8			use Illuminate\Support\Str;
9			use Sarala\Exceptions\UnauthorizedIncludeException;
10			use Sarala\Http\Requests\ApiRequestAbstract;
11
12			class ApiRequestInspector
13			{
14			/** @var ApiRequestAbstract */
15			private $request = null;
16
17			public function __construct(array $parameters)
18			{
19			$this->setRequestReceivedAtApiEndpoint($parameters);
20			}
21
22			public function inspect()
23			{
24			$this->sanitizeIncludes();
25			}
26
27			private function setRequestReceivedAtApiEndpoint(array $parameters)
28			{
29			foreach ($parameters as $parameter) {
30			if ($parameter instanceof Request) {
31			$this->request = $parameter;
			0 ignored issues – show Documentation Bug introduced 2019-01-27 19:30 UTC by Report Bug Copy Issue Report `$parameter` is of type `object<Illuminate\Http\Request>`, but the property `$request` was declared to be of type `object<Sarala\Http\Requests\ApiRequestAbstract>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
32			}
33			}
34			}
35
36			private function sanitizeIncludes()
37			{
38			$this->request->includes()->each(function ($params, $field) {
			0 ignored issues – show Bug introduced 2019-01-17 19:47 UTC by Report Bug Copy Issue Report The method `includes()` does not exist on `Sarala\Http\Requests\ApiRequestAbstract`. Did you maybe mean `allowedIncludes()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
39			if (! $this->isIncludeAllowed($field)) {
40			throw new UnauthorizedIncludeException($field, $this->request->allowedIncludes());
41			}
42			});
43			}
44
45			private function isIncludeAllowed($field): bool
46			{
47			foreach ($this->request->allowedIncludes() as $allowedInclude) {
48			if (Str::startsWith($allowedInclude, $field)) {
49			return true;
50			}
51			}
52
53			return false;
54			}
55			}
56

sarala-io / sarala-laravel

Push — master ( 870cb1...1f9632 )

ApiRequestInspector::isIncludeAllowed() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like