RestRequest::getStart() - Code Metrics - R3VoLuT1OneR/laravel-doctrine-rest - Measure and Improve Code Quality continuously with Scrutinizer

RestRequest::getStart() A
last analyzed 2025-05-01 09:57 UTC

↳ Parent: RestRequest

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	5
nc	3
nop	0
dl	0
loc	11
ccs	6
cts	6
cp	1
crap	3
rs	10
c	0
b	0
f	0

<?php namespace Pz\LaravelDoctrine\Rest;

use Illuminate\Validation\ValidationException;
use Pz\Doctrine\Rest\Contracts\RestRequestContract;
use Pz\Doctrine\Rest\Exceptions\RestException;

use Pz\Doctrine\Rest\RestResponse;
use Symfony\Component\HttpFoundation\Response;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Contracts\Validation\Validator;

class RestRequest extends FormRequest implements RestRequestContract
{
    /**
     * @var bool
     */
    protected $isRelationships = false;

    /**
     * @return array
     */
    public function rules()
    {
        return [
            'filter'        => 'sometimes|required',
            'include'       => 'sometimes|required',
            'exclude'       => 'sometimes|required|array',
            'fields'        => 'sometimes|required|array',
            'sort'          => 'sometimes|required|string',

            'page'          => 'sometimes|required|array',
            'page.number'   => 'sometimes|required|numeric',
            'page.size'     => 'sometimes|required|numeric',
            'page.limit'    => 'sometimes|required|numeric',
            'page.offset'   => 'sometimes|required|numeric',
        ];
    }

    /**
     * @param null|bool $value
     *
     * @return bool|null
     */
    public function isRelationships($value = null)
    {
        if ($value !== null) {
            $this->isRelationships = $value;
        }

        return $this->isRelationships;
    }

    /**
     * @return array
     * @throws RestException
     */
    public function getData()
    {
        if ((null === $data = $this->get('data')) || !is_array($data)) {
            throw RestException::missingRootData();
        }

        return $data;
    }

    /**
     * @return array|null
     */
    public function getOrderBy()
    {
        if ($sort = $this->input('sort')) {
            $fields = explode(',', $sort);
            $orderBy = [];

            foreach ($fields as $field) {
                if (empty($field)) continue;

                $direction = 'ASC';
                if ($field[0] === '-') {
                    $field = substr($field, 1);
                    $direction = 'DESC';
                }

                $orderBy[$field] = $direction;
            }

            return $orderBy;
        }

        return null;
    }

    /**
     * @return null|int
     */
    public function getStart()
    {
        if (null !== ($limit = $this->getLimit())) {
            if ($number = $this->input('page.number')) {
                return ($number - 1) * $limit;
            }

            return $this->input('page.offset', 0);
        }

        return null;
    }

    /**
     * @return int|null
     */
    public function getLimit()
    {
        if ($this->has('page')) {
            if ($this->has('page.number')) {
                return $this->input('page.size', static::DEFAULT_LIMIT);
            }

            return $this->input('page.limit', static::DEFAULT_LIMIT);
        }

        return null;
    }

    /**
     * @return \Illuminate\Routing\Route|object|string
     */
    public function getId()
    {
        return $this->route('id');

    }

    /**
     * @return array|null
     */
    public function getExclude()
    {
        return $this->input('exclude');
    }

    /**
     * @return array|null
     */
    public function getInclude()
    {
        $include = @explode(',', $this->input('include'));

        if (!is_array($include)) {

            RestException::invalidInclude();
        }

        return $include;
    }

    public function getFields()
    {
        return $this->input('fields');
    }

    /**
     * @return array|string|null
     */
    public function getFilter()
    {
        return $this->input('filter');
    }

    /**
     * @return bool
     */
    protected function passesAuthorization()
    {
        return true;
    }

    /**
     * @param Validator $validator
     *
     * @throws ValidationException
     */
    protected function failedValidation(Validator $validator)
    {
        $exception = RestException::create(Response::HTTP_UNPROCESSABLE_ENTITY, 'Validation failed');
        foreach ($validator->errors()->getMessages() as $pointer => $messages) {
            foreach ($messages as $message) {
                $exception->errorValidation($pointer, $message);
            }
        }

        throw new ValidationException($validator, RestResponse::exception($exception));
    }
}


1		<?php namespace Pz\LaravelDoctrine\Rest;
2
3		use Illuminate\Validation\ValidationException;
4		use Pz\Doctrine\Rest\Contracts\RestRequestContract;
5		use Pz\Doctrine\Rest\Exceptions\RestException;
6
7		use Pz\Doctrine\Rest\RestResponse;
8		use Symfony\Component\HttpFoundation\Response;
9		use Illuminate\Foundation\Http\FormRequest;
10		use Illuminate\Contracts\Validation\Validator;
11
12		class RestRequest extends FormRequest implements RestRequestContract
13		{
14		/**
15		* @var bool
16		*/
17		protected $isRelationships = false;
18
19		/**
20		* @return array
21		*/
22	8	public function rules()
23		{
24		return [
25	8	'filter' => 'sometimes\|required',
26		'include' => 'sometimes\|required',
27		'exclude' => 'sometimes\|required\|array',
28		'fields' => 'sometimes\|required\|array',
29		'sort' => 'sometimes\|required\|string',
30
31		'page' => 'sometimes\|required\|array',
32		'page.number' => 'sometimes\|required\|numeric',
33		'page.size' => 'sometimes\|required\|numeric',
34		'page.limit' => 'sometimes\|required\|numeric',
35		'page.offset' => 'sometimes\|required\|numeric',
36		];
37		}
38
39		/**
40		* @param null\|bool $value
41		*
42		* @return bool\|null
43		*/
44	7	public function isRelationships($value = null)
45		{
46	7	if ($value !== null) {
47	1	$this->isRelationships = $value;
48		}
49
50	7	return $this->isRelationships;
51		}
52
53		/**
54		* @return array
55		* @throws RestException
56		*/
57	4	public function getData()
58		{
59	4	if ((null === $data = $this->get('data')) \|\| !is_array($data)) {
60	1	throw RestException::missingRootData();
61		}
62
63	4	return $data;
64		}
65
66		/**
67		* @return array\|null
68		*/
69	4	public function getOrderBy()
70		{
71	4	if ($sort = $this->input('sort')) {
72	1	$fields = explode(',', $sort);
73	1	$orderBy = [];
74
75	1	foreach ($fields as $field) {
76	1	if (empty($field)) continue;
77
78	1	$direction = 'ASC';
79	1	if ($field[0] === '-') {
80	1	$field = substr($field, 1);
81	1	$direction = 'DESC';
82		}
83
84	1	$orderBy[$field] = $direction;
85		}
86
87	1	return $orderBy;
88		}
89
90	4	return null;
91		}
92
93		/**
94		* @return null\|int
95		*/
96	4	public function getStart()
97		{
98	4	if (null !== ($limit = $this->getLimit())) {
99	1	if ($number = $this->input('page.number')) {
100	1	return ($number - 1) * $limit;
101		}
102
103	1	return $this->input('page.offset', 0);
104		}
105
106	4	return null;
107		}
108
109		/**
110		* @return int\|null
111		*/
112	4	public function getLimit()
113		{
114	4	if ($this->has('page')) {
115	1	if ($this->has('page.number')) {
116	1	return $this->input('page.size', static::DEFAULT_LIMIT);
117		}
118
119	1	return $this->input('page.limit', static::DEFAULT_LIMIT);
120		}
121
122	4	return null;
123		}
124
125		/**
126		* @return \Illuminate\Routing\Route\|object\|string
127		*/
128	7	public function getId()
129		{
130	7	return $this->route('id');
		0 ignored issues – show Bug Best Practice introduced 2024-01-10 21:15 UTC by Report Bug Copy Issue Report The expression `return $this->route('id')` also could return the type `Illuminate\Routing\Route\|object\|string` which is incompatible with the return type mandated by `Pz\Doctrine\Rest\Contrac...equestContract::getId()` of `array\|integer`. Loading history...
131		}
132
133		/**
134		* @return array\|null
135		*/
136	7	public function getExclude()
137		{
138	7	return $this->input('exclude');
139		}
140
141		/**
142		* @return array\|null
143		*/
144	7	public function getInclude()
145		{
146	7	$include = @explode(',', $this->input('include'));
147
148	7	if (!is_array($include)) {
		0 ignored issues – show introduced 2019-02-20 15:06 UTC by Report Bug Copy Issue Report The condition `is_array($include)` is always `true`. Loading history...
149		RestException::invalidInclude();
150		}
151
152	7	return $include;
153		}
154
155	7	public function getFields()
156		{
157	7	return $this->input('fields');
158		}
159
160		/**
161		* @return array\|string\|null
162		*/
163	4	public function getFilter()
164		{
165	4	return $this->input('filter');
166		}
167
168		/**
169		* @return bool
170		*/
171	8	protected function passesAuthorization()
172		{
173	8	return true;
174		}
175
176		/**
177		* @param Validator $validator
178		*
179		* @throws ValidationException
180		*/
181		protected function failedValidation(Validator $validator)
182		{
183		$exception = RestException::create(Response::HTTP_UNPROCESSABLE_ENTITY, 'Validation failed');
184		foreach ($validator->errors()->getMessages() as $pointer => $messages) {
185		foreach ($messages as $message) {
186		$exception->errorValidation($pointer, $message);
187		}
188		}
189
190		throw new ValidationException($validator, RestResponse::exception($exception));
191		}
192		}
193

R3VoLuT1OneR / laravel-doctrine-rest

RestRequest::getStart() A last analyzed 2025-05-01 09:57 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

RestRequest::getStart() A
last analyzed 2025-05-01 09:57 UTC