RequestTrait::failedValidation() - Code Metrics - Inspection of "use the new `check` function from the requests cla..." - Porto-SAP/Hello-API - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d7caaf...048f0c )

by Mahmoud

created 2017-02-28 19:01 UTC

RequestTrait::failedValidation() A

↳ Parent: RequestTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace App\Ship\Parents\Requests;

use App\Containers\Authorization\Traits\AuthorizationTrait;
use App\Ship\Engine\Traits\HashIdTrait;
use App\Ship\Features\Exceptions\ValidationFailedException;
use Illuminate\Contracts\Validation\Validator;
use Illuminate\Foundation\Http\FormRequest as LaravelFormRequest;

/**
 * Class RequestTrait
 *
 * @author  Mahmoud Zalt  <[email protected]>
 */
trait RequestTrait
{

    /**
     * Overriding this function to modify the any user input before
     * applying the validation rules.
     *
     * @return  array
     */
    public function all()
    {
        $requestData = parent::all();

        $requestData = $this->applyValidationRulesToUrlParams($requestData);

        $requestData = $this->decodeHashedIdsBeforeApplyingValidationRules($requestData);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        return $requestData;
    }

    /**
     * Overriding this function to throw a custom
     * exception instead of the default Laravel exception.
     *
     * @param \Illuminate\Contracts\Validation\Validator $validator
     *
     * @return mixed|void
     */
    public function failedValidation(Validator $validator)
    {
        throw new ValidationFailedException($validator->getMessageBag());
    }


    /**
     * Used from the `authorize` function if the Request class.
     * To call functions and compare their bool responses to determine
     * if the user can proceed with the request or not.
     *
     * @param array $functions
     *
     * @return  bool
     */
    protected function check(array $functions)
    {
        $orIndicator = '|';
        $returns = [];

        // iterate all functions in the array
        foreach ($functions as $function) {

            // in case the value doesn't contains a separator (single function per key)
            if (!strpos($function, $orIndicator)) {
                // simply call the single function and store the response.
                $returns[] = $this->{$function}();
            } else {
                // in case the value contains a separator (multiple functions per key)
                $orReturns = [];

                // iterate over each function in the key
                foreach (explode($orIndicator, $function) as $orFunction) {
                    // dynamically call each function
                    $orReturns[] = $this->{$orFunction}();
                }

                // if in_array returned `true` means at least one function returned `true` thus return `true` to allow access.
                // if in_array returned `false` means no function returned `true` thus return `false` to prevent access.
                // return single boolean for all the functions found inside the same key.
                $returns[] = in_array(true, $orReturns) ? true : false;
            }
        }

        // if in_array returned `true` means a function returned `false` thus return `false` to prevent access.
        // if in_array returned `false` means all functions returned `true` thus return `true` to allow access.
        // return the final boolean
        return in_array(false, $returns) ? false : true;
    }

    /**
     * apply validation rules to the ID's in the URL, since Laravel
     * doesn't validate them by default!
     *
     * Now you can use validation riles like this: `'id' => 'required|integer|exists:items,id'`
     *
     * @param array $requestData
     *
     * @return  array
     */
    private function applyValidationRulesToUrlParams(Array $requestData)
    {
        if (isset($this->urlParameters) && !empty($this->urlParameters)) {
            foreach ($this->urlParameters as $param) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
                $requestData[$param] = $this->route($param);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
        }

        return $requestData;
    }

    /**
     * @param $user
     *
     * @return  array
     */
    private function hasAnyPermissionAccess($user)

    {
        if (!array_key_exists('permissions', $this->access) || !$this->access['permissions']) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            return [];
        }

        $permissions = explode('|', $this->access['permissions']);

        $hasAccess = array_map(function ($permission) use ($user) {
            // Note: internal return
            return $user->hasPermissionTo($permission);
        }, $permissions);

        return $hasAccess;
    }

    /**
     * @param $user
     *
     * @return  array
     */
    private function hasAnyRoleAccess($user)

    {
        if (!array_key_exists('roles', $this->access) || !$this->access['roles']) {
            return [];
        }

        $roles = explode('|', $this->access['roles']);

        $hasAccess = array_map(function ($role) use ($user) {
            // Note: internal return
            return $user->hasRole($role);
        }, $roles);

        return $hasAccess;
    }
}


1		<?php
2
3		namespace App\Ship\Parents\Requests;
4
5		use App\Containers\Authorization\Traits\AuthorizationTrait;
6		use App\Ship\Engine\Traits\HashIdTrait;
7		use App\Ship\Features\Exceptions\ValidationFailedException;
8		use Illuminate\Contracts\Validation\Validator;
9		use Illuminate\Foundation\Http\FormRequest as LaravelFormRequest;
10
11		/**
12		* Class RequestTrait
13		*
14		* @author Mahmoud Zalt <[email protected]>
15		*/
16		trait RequestTrait
17		{
18
19		/**
20		* Overriding this function to modify the any user input before
21		* applying the validation rules.
22		*
23		* @return array
24		*/
25		public function all()
26		{
27		$requestData = parent::all();
28
29		$requestData = $this->applyValidationRulesToUrlParams($requestData);
30
31		$requestData = $this->decodeHashedIdsBeforeApplyingValidationRules($requestData);
		0 ignored issues – show Bug introduced 2017-02-28 19:05 UTC by Report Bug Copy Issue Report It seems like `decodeHashedIdsBeforeApplyingValidationRules()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
32
33		return $requestData;
34		}
35
36		/**
37		* Overriding this function to throw a custom
38		* exception instead of the default Laravel exception.
39		*
40		* @param \Illuminate\Contracts\Validation\Validator $validator
41		*
42		* @return mixed\|void
43		*/
44		public function failedValidation(Validator $validator)
45		{
46		throw new ValidationFailedException($validator->getMessageBag());
47		}
48
49
50		/**
51		* Used from the `authorize` function if the Request class.
52		* To call functions and compare their bool responses to determine
53		* if the user can proceed with the request or not.
54		*
55		* @param array $functions
56		*
57		* @return bool
58		*/
59		protected function check(array $functions)
60		{
61		$orIndicator = '\|';
62		$returns = [];
63
64		// iterate all functions in the array
65		foreach ($functions as $function) {
66
67		// in case the value doesn't contains a separator (single function per key)
68		if (!strpos($function, $orIndicator)) {
69		// simply call the single function and store the response.
70		$returns[] = $this->{$function}();
71		} else {
72		// in case the value contains a separator (multiple functions per key)
73		$orReturns = [];
74
75		// iterate over each function in the key
76		foreach (explode($orIndicator, $function) as $orFunction) {
77		// dynamically call each function
78		$orReturns[] = $this->{$orFunction}();
79		}
80
81		// if in_array returned `true` means at least one function returned `true` thus return `true` to allow access.
82		// if in_array returned `false` means no function returned `true` thus return `false` to prevent access.
83		// return single boolean for all the functions found inside the same key.
84		$returns[] = in_array(true, $orReturns) ? true : false;
85		}
86		}
87
88		// if in_array returned `true` means a function returned `false` thus return `false` to prevent access.
89		// if in_array returned `false` means all functions returned `true` thus return `true` to allow access.
90		// return the final boolean
91		return in_array(false, $returns) ? false : true;
92		}
93
94		/**
95		* apply validation rules to the ID's in the URL, since Laravel
96		* doesn't validate them by default!
97		*
98		* Now you can use validation riles like this: `'id' => 'required\|integer\|exists:items,id'`
99		*
100		* @param array $requestData
101		*
102		* @return array
103		*/
104		private function applyValidationRulesToUrlParams(Array $requestData)
105		{
106		if (isset($this->urlParameters) && !empty($this->urlParameters)) {
107		foreach ($this->urlParameters as $param) {
		0 ignored issues – show Bug introduced 2017-02-28 19:05 UTC by Report Bug Copy Issue Report The property `urlParameters` 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...
108		$requestData[$param] = $this->route($param);
		0 ignored issues – show Bug introduced 2017-02-28 19:05 UTC by Report Bug Copy Issue Report It seems like `route()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
109		}
110		}
111
112		return $requestData;
113		}
114
115		/**
116		* @param $user
117		*
118		* @return array
119		*/
120	View Code Duplication	private function hasAnyPermissionAccess($user)
		0 ignored issues – show Duplication introduced 2017-02-28 19:05 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
121		{
122		if (!array_key_exists('permissions', $this->access) \|\| !$this->access['permissions']) {
		0 ignored issues – show Bug introduced 2017-02-28 19:05 UTC by Report Bug Copy Issue Report The property `access` 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...
123		return [];
124		}
125
126		$permissions = explode('\|', $this->access['permissions']);
127
128		$hasAccess = array_map(function ($permission) use ($user) {
129		// Note: internal return
130		return $user->hasPermissionTo($permission);
131		}, $permissions);
132
133		return $hasAccess;
134		}
135
136		/**
137		* @param $user
138		*
139		* @return array
140		*/
141	View Code Duplication	private function hasAnyRoleAccess($user)
		0 ignored issues – show Duplication introduced 2017-02-28 19:05 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
142		{
143		if (!array_key_exists('roles', $this->access) \|\| !$this->access['roles']) {
144		return [];
145		}
146
147		$roles = explode('\|', $this->access['roles']);
148
149		$hasAccess = array_map(function ($role) use ($user) {
150		// Note: internal return
151		return $user->hasRole($role);
152		}, $roles);
153
154		return $hasAccess;
155		}
156		}
157

Porto-SAP / Hello-API

Push — master ( d7caaf...048f0c )

RequestTrait::failedValidation() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like