FormRequest - Code Metrics - Inspection of "Cleaning the base form request" - ARCANEDEV/Support - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#18)

by ARCANEDEV

created 2017-04-26 16:30 UTC

FormRequest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

Importance

Changes

Metric	Value
dl	0
loc	68
ccs	0
cts	23
cp	0
rs	10
c	0
b	0
f	0
wmc	6
lcom	0
cbo	2

5 Methods

Rating	Name	Size	Complexity
A	authorize()	4	1
	rules()	1	?
A	prepareForValidation()	6	2
A	response()	6	2
A	formatJsonErrorsResponse()	7	1

<?php namespace Arcanedev\Support;

use Illuminate\Foundation\Http\FormRequest as BaseFormRequest;
use Illuminate\Http\JsonResponse;

/**
 * Class     FormRequest
 *
 * @package  Arcanedev\Support
 * @author   ARCANEDEV <[email protected]>
 */
abstract class FormRequest extends BaseFormRequest
{
    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return false;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    abstract public function rules();

    /**
     * Prepare the data for validation.
     */
    protected function prepareForValidation()
    {
        if (method_exists($this, 'sanitize')) {
            $this->merge($this->sanitize());
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        }
    }

    /**
     * Get the proper failed validation response for the request.
     *
     * @param  array  $errors
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function response(array $errors)
    {
        return $this->expectsJson()
            ? new JsonResponse($this->formatJsonErrorsResponse($errors), 422)
            : parent::response($errors);
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Format the json response.
     *
     * @param  array  $errors
     *
     * @return array
     */
    protected function formatJsonErrorsResponse(array $errors)
    {
        return [
            'code'     => 'validation_failed',
            'messages' => $errors
        ];
    }
}


1			<?php namespace Arcanedev\Support;
2
3			use Illuminate\Foundation\Http\FormRequest as BaseFormRequest;
4			use Illuminate\Http\JsonResponse;
5
6			/**
7			* Class FormRequest
8			*
9			* @package Arcanedev\Support
10			* @author ARCANEDEV <[email protected]>
11			*/
12			abstract class FormRequest extends BaseFormRequest
13			{
14			/* -----------------------------------------------------------------
15			\| Main Methods
16			\| -----------------------------------------------------------------
17			*/
18
19			/**
20			* Determine if the user is authorized to make this request.
21			*
22			* @return bool
23			*/
24			public function authorize()
25			{
26			return false;
27			}
28
29			/**
30			* Get the validation rules that apply to the request.
31			*
32			* @return array
33			*/
34			abstract public function rules();
35
36			/**
37			* Prepare the data for validation.
38			*/
39			protected function prepareForValidation()
40			{
41			if (method_exists($this, 'sanitize')) {
42			$this->merge($this->sanitize());
			0 ignored issues – show Documentation Bug introduced 2017-04-26 16:44 UTC by Report Bug Copy Issue Report The method `sanitize` does not exist on `object<Arcanedev\Support\FormRequest>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
43			}
44			}
45
46			/**
47			* Get the proper failed validation response for the request.
48			*
49			* @param array $errors
50			*
51			* @return \Symfony\Component\HttpFoundation\Response
52			*/
53			public function response(array $errors)
54			{
55			return $this->expectsJson()
56			? new JsonResponse($this->formatJsonErrorsResponse($errors), 422)
57			: parent::response($errors);
58			}
59
60			/* -----------------------------------------------------------------
61			\| Other Methods
62			\| -----------------------------------------------------------------
63			*/
64
65			/**
66			* Format the json response.
67			*
68			* @param array $errors
69			*
70			* @return array
71			*/
72			protected function formatJsonErrorsResponse(array $errors)
73			{
74			return [
75			'code' => 'validation_failed',
76			'messages' => $errors
77			];
78			}
79			}
80

ARCANEDEV / Support

Pull Request — master (#18)

FormRequest A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Duplication Side-by-Side

Filter issues like