RealPage\JsonApi\Validation\ValidatesRequests

Complexity

Total Complexity

8

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	rules()	0	7	1
A	messages()	0	8	1
A	errors()	0	4	1
	type()	0	1	?
A	setValidatorFactory()	0	4	1
B	isValid()	0	35	4

<?php

namespace RealPage\JsonApi\Validation;

use Illuminate\Contracts\Validation\Factory;
use Neomerx\JsonApi\Exceptions\ErrorCollection;
use RealPage\JsonApi\Requests\Request;
use Neomerx\JsonApi\Document\Error;

abstract class ValidatesRequests
{
    /** @var ErrorCollection */
    protected $errors;

    /** @var Factory */
    protected $validatorFactory;

    public function isValid(Request $request) : bool
    {
        $this->errors = new ErrorCollection();

        /** @var \Illuminate\Contracts\Validation\Validator $validator */
        $validator = $this->validatorFactory->make($request->json(), $this->rules(), $this->messages());
        if ($validator->fails()) {
            // @todo put this somewhere else, this is getting messy
            // @see https://jsonapi.org/examples/#error-objects-basic
            foreach ($validator->errors()->toArray() as $field => $errorMessages) {

                // get the pointer for an array so we can pinpoint the section
                // of json where the error occurred
                $field = '/'.str_replace('.', '/', $field).'/';

                foreach ($errorMessages as $message) {
                    $this->errors->add(new Error(
                        null,
                        null,
                        422,
                        null,
                        'Invalid Attribute',
                        $message,
                        [
                            'pointer' => $field,
                        ]
                    ));
                }
            }

            return false;
        }

        return true;
    }

    public function rules() : array
    {
        return [
            'data'      => 'required',
            'data.type' => 'required|in:'.$this->type(),
        ];
    }

    public function messages() : array
    {
        return [
            'data.required'      => 'Data is required in a valid json api format.',
            'data.type.required' => 'A valid resource type must be provided.',
            'data.type.in'       => 'The resource type provided does not match the expected type of "'.$this->type().'".',
        ];
    }

    public function errors() : ErrorCollection
    {
        return $this->errors;
    }

    /**
     * The type of entity this request is for.
     */
    abstract public function type() : string;

    public function setValidatorFactory(Factory $factory)
    {
        $this->validatorFactory = $factory;
    }
}