NilPortugues\Api\JsonApi\Server\Actions\Traits\RequestTrait

Complexity

Total Complexity

16

Size/Duplication

Total Lines	120
Duplicated Lines	30 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	6
Bugs	1	Features	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getQueryParamsErrors()	0	4	1
A	hasValidQueryParams()	0	7	1
A	validateFieldsQueryParams()	18	18	4
A	getPropertiesFromMapping()	0	9	1
A	addInvalidParameterMemberErrorsToErrorBag()	0	8	2
A	addInvalidParameterErrorsToErrorBag()	0	8	3
A	validateIncludeQueryParamsTypes()	18	18	4

<?php
/**
 * Author: Nil Portugués Calderó <contact@nilportugues.com>
 * Date: 11/14/15
 * Time: 11:46 AM.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace NilPortugues\Api\JsonApi\Server\Actions\Traits;

use NilPortugues\Api\JsonApi\Http\Request\Parameters\Fields;
use NilPortugues\Api\JsonApi\Http\Request\Parameters\Included;
use NilPortugues\Api\JsonApi\JsonApiSerializer;
use NilPortugues\Api\JsonApi\Server\Errors\InvalidParameterError;
use NilPortugues\Api\JsonApi\Server\Errors\InvalidParameterMemberError;
use NilPortugues\Api\Mapping\Mapping;

/**
 * Class RequestTrait.
 */
trait RequestTrait
{
    /**
     * @var \NilPortugues\Api\JsonApi\Server\Errors\Error[]
     */
    protected $queryParamErrorBag = [];

    /**
     * @return \NilPortugues\Api\JsonApi\Server\Errors\Error[]
     */
    protected function getQueryParamsErrors()
    {
        return $this->queryParamErrorBag;
    }

    /**
     * @param JsonApiSerializer $serializer
     * @param Fields            $fields
     * @param Included          $included
     *
     * @return bool
     */
    protected function hasValidQueryParams(JsonApiSerializer $serializer, Fields $fields, Included $included)
    {
        $this->validateFieldsQueryParams($serializer, $fields, 'Fields');
        $this->validateIncludeQueryParamsTypes($serializer, $included, 'Include');

        return empty($this->queryParamErrorBag);
    }

    /**
     * @param JsonApiSerializer $serializer
     * @param Fields            $fields
     * @param string            $paramName
     */
    protected function validateFieldsQueryParams(JsonApiSerializer $serializer, Fields $fields, $paramName)

This method seems to be duplicated in your project.

    {
        if (false === $fields->isEmpty()) {
            $validateFields = $fields->types();

            foreach ($validateFields as $key => $field) {
                $mapping = $serializer->getTransformer()->getMappingByAlias($field);
                if (null !== $mapping) {
                    $properties = $this->getPropertiesFromMapping($mapping);
                    $invalidProperties = array_diff($fields->members($field), $properties);
                    $this->addInvalidParameterMemberErrorsToErrorBag($invalidProperties, $paramName, $field);
                    unset($validateFields[$key]);
                }
            }

            $this->addInvalidParameterErrorsToErrorBag($paramName, $validateFields);
        }
    }

    /**
     * @param Mapping $mapping
     *
     * @return array
     */
    protected function getPropertiesFromMapping(Mapping $mapping)
    {
        $properties = array_merge(
            array_combine($mapping->getProperties(), $mapping->getProperties()),
            $mapping->getAliasedProperties()
        );

        return $properties;
    }

    /**
     * @param array  $invalidProperties
     * @param string $paramName
     * @param string $field
     */
    protected function addInvalidParameterMemberErrorsToErrorBag(array $invalidProperties, $paramName, $field)
    {
        foreach ($invalidProperties as $extraField) {
            $this->queryParamErrorBag[] = new InvalidParameterMemberError($extraField, $field, strtolower(
                $paramName
            ));
        }
    }

    /**
     * @param string $paramName
     * @param array  $validateFields
     */
    protected function addInvalidParameterErrorsToErrorBag($paramName, array &$validateFields)
    {
        if (false === empty($validateFields)) {
            foreach ($validateFields as $field) {
                $this->queryParamErrorBag[] = new InvalidParameterError($field, strtolower($paramName));
            }
        }
    }

    /**
     * @param JsonApiSerializer $serializer
     * @param Included          $included
     * @param string            $paramName
     */
    protected function validateIncludeQueryParamsTypes(JsonApiSerializer $serializer, Included $included, $paramName)

This method seems to be duplicated in your project.

    {
        if (false === $included->isEmpty()) {
            $validateFields = array_keys($included->get());

            foreach ($validateFields as $key => $field) {
                $mapping = $serializer->getTransformer()->getMappingByAlias($field);
                if (null !== $mapping) {
                    $properties = $this->getPropertiesFromMapping($mapping);
                    $invalidProperties = array_diff($included->get()[$field], $properties);
                    $this->addInvalidParameterMemberErrorsToErrorBag($invalidProperties, $paramName, $field);
                    unset($validateFields[$key]);
                }
            }

            $this->addInvalidParameterErrorsToErrorBag($paramName, $validateFields);
        }
    }
}