DefaultControllerMethodsTrait::defaultUpdateInRelationshipHandler() - Code Metrics - Inspection of "Add resource ID param to validate relationship met..." - limoncello-php-dist/flute - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 6173d9...210649 )

by Neomerx
created 2018-07-26 14:09 UTC
defaultUpdateInRelationshipHandler() A

↳ Parent: DefaultControllerMethodsTrait
Complexity

Conditions	2
Paths	2
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	20
CRAP Score	2
Importance

Changes
Metric	Value
dl	0
loc	43
ccs	20
cts	20
cp	1
rs	9.232
c	0
b	0
f	0
cc	2
nc	2
nop	17
crap	2
How to fix Many Parameters

<?php namespace Limoncello\Flute\Http\Traits;

/**
 * Copyright 2015-2018 [email protected]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use Closure;
use Limoncello\Contracts\Application\ModelInterface;
use Limoncello\Contracts\Data\ModelSchemaInfoInterface;
use Limoncello\Contracts\Data\RelationshipTypes;
use Limoncello\Contracts\L10n\FormatterFactoryInterface;
use Limoncello\Contracts\Settings\SettingsProviderInterface;
use Limoncello\Flute\Contracts\Api\CrudInterface;
use Limoncello\Flute\Contracts\Encoder\EncoderInterface;
use Limoncello\Flute\Contracts\FactoryInterface;
use Limoncello\Flute\Contracts\Http\Query\ParametersMapperInterface;
use Limoncello\Flute\Contracts\Models\PaginatedDataInterface;
use Limoncello\Flute\Contracts\Schema\JsonSchemasInterface;
use Limoncello\Flute\Contracts\Schema\SchemaInterface;
use Limoncello\Flute\Contracts\Validation\FormRulesInterface;
use Limoncello\Flute\Contracts\Validation\FormValidatorFactoryInterface;
use Limoncello\Flute\Contracts\Validation\FormValidatorInterface;
use Limoncello\Flute\Contracts\Validation\JsonApiDataRulesInterface;
use Limoncello\Flute\Contracts\Validation\JsonApiDataValidatingParserInterface;
use Limoncello\Flute\Contracts\Validation\JsonApiParserFactoryInterface;
use Limoncello\Flute\Contracts\Validation\JsonApiQueryRulesInterface;
use Limoncello\Flute\Contracts\Validation\JsonApiQueryValidatingParserInterface;
use Limoncello\Flute\Http\Responses;
use Limoncello\Flute\Package\FluteSettings as S;
use Limoncello\Flute\Resources\Messages\En\Generic;
use Limoncello\Flute\Validation\JsonApi\Rules\DefaultQueryValidationRules;
use Neomerx\JsonApi\Contracts\Document\DocumentInterface as DI;
use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
use Neomerx\JsonApi\Contracts\Http\Headers\MediaTypeInterface;
use Neomerx\JsonApi\Contracts\Http\ResponsesInterface;
use Neomerx\JsonApi\Encoder\Parameters\EncodingParameters;
use Neomerx\JsonApi\Exceptions\JsonApiException;
use Neomerx\JsonApi\Http\Headers\MediaType;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\ContainerInterface;
use Psr\Container\NotFoundExceptionInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\UriInterface;

/**
 * @package Limoncello\Flute
 */
trait DefaultControllerMethodsTrait
{
    /** @noinspection PhpTooManyParametersInspection
     * @param array                                 $queryParams
     * @param UriInterface                          $requestUri
     * @param JsonApiQueryValidatingParserInterface $queryParser
     * @param ParametersMapperInterface             $mapper
     * @param CrudInterface                         $crud
     * @param SettingsProviderInterface             $provider
     * @param JsonSchemasInterface                  $jsonSchemas
     * @param EncoderInterface                      $encoder
     *
     * @return ResponseInterface
     */
    protected static function defaultIndexHandler(
        array $queryParams,
        UriInterface $requestUri,
        JsonApiQueryValidatingParserInterface $queryParser,
        ParametersMapperInterface $mapper,
        CrudInterface $crud,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder
    ): ResponseInterface {
        $queryParser->parse(null, $queryParams);

        $models = $mapper->applyQueryParameters($queryParser, $crud)->index();

        $encParams = self::defaultCreateEncodingParameters($queryParser);
        $responses = static::defaultCreateResponses($requestUri, $provider, $jsonSchemas, $encoder, $encParams);
        $response  = ($models->getData()) === null ?
            $responses->getCodeResponse(404) : $responses->getContentResponse($models);

        return $response;
    }

    /** @noinspection PhpTooManyParametersInspection
     * @param string                                $index
     * @param array                                 $queryParams
     * @param UriInterface                          $requestUri
     * @param JsonApiQueryValidatingParserInterface $queryParser
     * @param ParametersMapperInterface             $mapper
     * @param CrudInterface                         $crud
     * @param SettingsProviderInterface             $provider
     * @param JsonSchemasInterface                  $jsonSchemas
     * @param EncoderInterface                      $encoder
     *
     * @return ResponseInterface
     */
    protected static function defaultReadHandler(
        string $index,
        array $queryParams,
        UriInterface $requestUri,
        JsonApiQueryValidatingParserInterface $queryParser,
        ParametersMapperInterface $mapper,
        CrudInterface $crud,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder
    ): ResponseInterface {
        $queryParser->parse($index, $queryParams);
        $validatedIndex = $queryParser->getIdentity();

        $model = $mapper->applyQueryParameters($queryParser, $crud)->read($validatedIndex);
        assert(!($model instanceof PaginatedDataInterface));

        $encParams = self::defaultCreateEncodingParameters($queryParser);
        $responses = static::defaultCreateResponses($requestUri, $provider, $jsonSchemas, $encoder, $encParams);
        $response  = $model === null ?
            $responses->getCodeResponse(404) : $responses->getContentResponse($model);

        return $response;
    }

    /** @noinspection PhpTooManyParametersInspection
     * @param string                                $index
     * @param Closure                               $apiHandler
     * @param array                                 $queryParams
     * @param UriInterface                          $requestUri
     * @param JsonApiQueryValidatingParserInterface $queryParser
     * @param ParametersMapperInterface             $mapper
     * @param CrudInterface                         $crud
     * @param SettingsProviderInterface             $provider
     * @param JsonSchemasInterface                  $jsonSchemas
     * @param EncoderInterface                      $encoder
     *
     * @return ResponseInterface
     *
     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
     */
    protected static function defaultReadRelationshipWithClosureHandler(
        string $index,
        Closure $apiHandler,
        array $queryParams,
        UriInterface $requestUri,
        JsonApiQueryValidatingParserInterface $queryParser,
        ParametersMapperInterface $mapper,
        CrudInterface $crud,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder
    ): ResponseInterface {
        $queryParser->parse($index, $queryParams);
        $mapper->applyQueryParameters($queryParser, $crud);

        $relData = call_user_func($apiHandler);

        $encParams = self::defaultCreateEncodingParameters($queryParser);
        $responses = static::defaultCreateResponses($requestUri, $provider, $jsonSchemas, $encoder, $encParams);

        $noData   = $relData === null || ($relData instanceof PaginatedDataInterface && $relData->getData() === null);
        $response = $noData === true ? $responses->getCodeResponse(404) : $responses->getContentResponse($relData);

        return $response;
    }

    /** @noinspection PhpTooManyParametersInspection
     * @param string                                $index
     * @param Closure                               $apiHandler
     * @param array                                 $queryParams
     * @param UriInterface                          $requestUri
     * @param JsonApiQueryValidatingParserInterface $queryParser
     * @param ParametersMapperInterface             $mapper
     * @param CrudInterface                         $crud
     * @param SettingsProviderInterface             $provider
     * @param JsonSchemasInterface                  $jsonSchemas
     * @param EncoderInterface                      $encoder
     *
     * @return ResponseInterface
     *
     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
     */
    protected static function defaultReadRelationshipIdentifiersWithClosureHandler(
        string $index,
        Closure $apiHandler,
        array $queryParams,
        UriInterface $requestUri,
        JsonApiQueryValidatingParserInterface $queryParser,
        ParametersMapperInterface $mapper,
        CrudInterface $crud,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder
    ): ResponseInterface {
        $queryParser->parse($index, $queryParams);
        $mapper->applyQueryParameters($queryParser, $crud);

        $relData = call_user_func($apiHandler);

        $encParams = self::defaultCreateEncodingParameters($queryParser);
        $responses = static::defaultCreateResponses($requestUri, $provider, $jsonSchemas, $encoder, $encParams);

        $noData   = $relData === null || ($relData instanceof PaginatedDataInterface && $relData->getData() === null);
        $response = $noData === true ? $responses->getCodeResponse(404) : $responses->getIdentifiersResponse($relData);

        return $response;
    }

    /** @noinspection PhpTooManyParametersInspection
     * @param UriInterface                         $requestUri
     * @param string                               $requestBody
     * @param string                               $schemaClass
     * @param ModelSchemaInfoInterface             $schemaInfo
     * @param JsonApiDataValidatingParserInterface $validator
     * @param CrudInterface                        $crud
     * @param SettingsProviderInterface            $provider
     * @param JsonSchemasInterface                 $jsonSchemas
     * @param EncoderInterface                     $encoder
     * @param FactoryInterface                     $errorFactory
     * @param FormatterFactoryInterface            $formatterFactory
     *
     * @return ResponseInterface
     *
     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
     */
    protected static function defaultCreateHandler(
        UriInterface $requestUri,
        string $requestBody,
        string $schemaClass,
        ModelSchemaInfoInterface $schemaInfo,
        JsonApiDataValidatingParserInterface $validator,
        CrudInterface $crud,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder,
        FactoryInterface $errorFactory,
        FormatterFactoryInterface $formatterFactory
    ): ResponseInterface {
        // some of the users want to reuse default `create` but have a custom part for responses
        // to meet this requirement it is split into two parts.
        $index = static::defaultCreate(
            $requestBody,
            $schemaClass,
            $schemaInfo,
            $validator,
            $crud,
            $errorFactory,
            $formatterFactory
        );

        return static::defaultCreateResponse($index, $requestUri, $crud, $provider, $jsonSchemas, $encoder);
    }

    /**
     * @param string                               $requestBody
     * @param string                               $schemaClass
     * @param ModelSchemaInfoInterface             $schemaInfo
     * @param JsonApiDataValidatingParserInterface $validator
     * @param CrudInterface                        $crud
     * @param FactoryInterface                     $errorFactory
     * @param FormatterFactoryInterface            $formatterFactory
     *
     * @return ResponseInterface

     */
    protected static function defaultCreate(
        string $requestBody,
        string $schemaClass,
        ModelSchemaInfoInterface $schemaInfo,
        JsonApiDataValidatingParserInterface $validator,
        CrudInterface $crud,
        FactoryInterface $errorFactory,
        FormatterFactoryInterface $formatterFactory
    ): string {
        $jsonData = static::readJsonFromRequest($requestBody, $errorFactory, $formatterFactory);
        $captures = $validator->assert($jsonData)->getJsonApiCaptures();

        list ($index, $attributes, $toMany) = static::mapSchemaDataToModelData($captures, $schemaClass, $schemaInfo);

        $index = $crud->create($index, $attributes, $toMany);

        return $index;
    }

    /**
     * @param string                    $index
     * @param UriInterface              $requestUri
     * @param CrudInterface             $crud
     * @param SettingsProviderInterface $provider
     * @param JsonSchemasInterface      $jsonSchemas
     * @param EncoderInterface          $encoder
     *
     * @return ResponseInterface
     */
    protected static function defaultCreateResponse(
        string $index,
        UriInterface $requestUri,
        CrudInterface $crud,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder
    ): ResponseInterface {
        $model = $crud->read($index);
        assert($model !== null && !($model instanceof PaginatedDataInterface));

        $encParams = null;
        $responses = static::defaultCreateResponses($requestUri, $provider, $jsonSchemas, $encoder, $encParams);
        $response  = $responses->getCreatedResponse($model);

        return $response;
    }

    /** @noinspection PhpTooManyParametersInspection
     * @param string                               $index
     * @param UriInterface                         $requestUri
     * @param string                               $requestBody
     * @param string                               $schemaClass
     * @param ModelSchemaInfoInterface             $schemaInfo
     * @param JsonApiDataValidatingParserInterface $validator
     * @param CrudInterface                        $crud
     * @param SettingsProviderInterface            $provider
     * @param JsonSchemasInterface                 $jsonSchemas
     * @param EncoderInterface                     $encoder
     * @param FactoryInterface                     $errorFactory
     * @param FormatterFactoryInterface            $formatterFactory
     * @param string                               $messagesNamespace
     * @param string                               $errorMessage
     *
     * @return ResponseInterface
     *
     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
     */
    protected static function defaultUpdateHandler(
        string $index,
        UriInterface $requestUri,
        string $requestBody,
        string $schemaClass,
        ModelSchemaInfoInterface $schemaInfo,
        JsonApiDataValidatingParserInterface $validator,
        CrudInterface $crud,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder,
        FactoryInterface $errorFactory,
        FormatterFactoryInterface $formatterFactory,
        string $messagesNamespace = S::GENERIC_NAMESPACE,
        string $errorMessage = Generic::MSG_ERR_INVALID_ELEMENT
    ): ResponseInterface {
        // some of the users want to reuse default `update` but have a custom part for responses
        // to meet this requirement it is split into two parts.
        $updated = static::defaultUpdate(
            $index,
            $requestBody,
            $schemaClass,
            $schemaInfo,
            $validator,
            $crud,
            $errorFactory,
            $formatterFactory,
            $messagesNamespace,
            $errorMessage
        );

        return static::defaultUpdateResponse($updated, $index, $requestUri, $crud, $provider, $jsonSchemas, $encoder);
    }

    /** @noinspection PhpTooManyParametersInspection
     * @param string                               $index
     * @param string                               $requestBody
     * @param string                               $schemaClass
     * @param ModelSchemaInfoInterface             $schemaInfo
     * @param JsonApiDataValidatingParserInterface $validator
     * @param CrudInterface                        $crud
     * @param FactoryInterface                     $errorFactory
     * @param FormatterFactoryInterface            $formatterFactory
     * @param string                               $messagesNamespace
     * @param string                               $errorMessage
     *
     * @return int
     *
     * @SuppressWarnings(PHPMD.ElseExpression)
     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
     */
    protected static function defaultUpdate(
        string $index,
        string $requestBody,
        string $schemaClass,
        ModelSchemaInfoInterface $schemaInfo,
        JsonApiDataValidatingParserInterface $validator,
        CrudInterface $crud,
        FactoryInterface $errorFactory,
        FormatterFactoryInterface $formatterFactory,
        string $messagesNamespace = S::GENERIC_NAMESPACE,
        string $errorMessage = Generic::MSG_ERR_INVALID_ELEMENT
    ): int {
        $jsonData = static::readJsonFromRequest($requestBody, $errorFactory, $formatterFactory);
        // check that index in data and URL are identical
        $indexValue = $jsonData[DI::KEYWORD_DATA][DI::KEYWORD_ID] ?? null;
        if (empty($indexValue) === false) {
            if ($indexValue !== $index) {
                $errors    = $errorFactory->createErrorCollection();
                $formatter = $formatterFactory->createFormatter($messagesNamespace);
                $errors->addDataIdError($formatter->formatMessage($errorMessage));

                throw new JsonApiException($errors);
            }
        } else {
            // put the index to data for our convenience
            $jsonData[DI::KEYWORD_DATA][DI::KEYWORD_ID] = $index;
        }
        // validate the data
        $captures = $validator->assert($jsonData)->getJsonApiCaptures();

        list ($index, $attributes, $toMany) = static::mapSchemaDataToModelData($captures, $schemaClass, $schemaInfo);

        $updated = $crud->update($index, $attributes, $toMany);

        return $updated;
    }

    /**
     * @param int                       $updated
     * @param string                    $index
     * @param UriInterface              $requestUri
     * @param CrudInterface             $crud
     * @param SettingsProviderInterface $provider
     * @param JsonSchemasInterface      $jsonSchemas
     * @param EncoderInterface          $encoder
     *
     * @return ResponseInterface
     *
     * @SuppressWarnings(PHPMD.ElseExpression)
     */
    protected static function defaultUpdateResponse(
        int $updated,
        string $index,
        UriInterface $requestUri,
        CrudInterface $crud,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder
    ): ResponseInterface {
        $encParams = null;
        $responses = static::defaultCreateResponses($requestUri, $provider, $jsonSchemas, $encoder, $encParams);
        if ($updated > 0 && ($model = $crud->read($index)) !== null) {
            assert(!($model instanceof PaginatedDataInterface));
            $response = $responses->getContentResponse($model);
        } else {
            $response = $responses->getCodeResponse(404);
        }

        return $response;
    }

    /**
     * @param string                                $index
     * @param UriInterface                          $requestUri
     * @param JsonApiQueryValidatingParserInterface $queryParser
     * @param CrudInterface                         $crud
     * @param SettingsProviderInterface             $provider
     * @param JsonSchemasInterface                  $jsonSchemas
     * @param EncoderInterface                      $encoder
     *
     * @return ResponseInterface
     */
    protected static function defaultDeleteHandler(
        string $index,
        UriInterface $requestUri,
        JsonApiQueryValidatingParserInterface $queryParser,
        CrudInterface $crud,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder
    ): ResponseInterface {
        $validatedIndex = $queryParser->parse($index)->getIdentity();
        $crud->remove($validatedIndex);

        $encParams = null;
        $responses = static::defaultCreateResponses($requestUri, $provider, $jsonSchemas, $encoder, $encParams);
        $response  = $responses->getCodeResponse(204);

        return $response;
    }

    /** @noinspection PhpTooManyParametersInspection
     * @param string                                $index
     * @param string                                $jsonRelName
     * @param string                                $modelRelName
     * @param UriInterface                          $requestUri
     * @param string                                $requestBody
     * @param string                                $schemaClass
     * @param ModelSchemaInfoInterface              $schemaInfo
     * @param JsonApiQueryValidatingParserInterface $queryParser
     * @param JsonApiDataValidatingParserInterface  $dataValidator
     * @param CrudInterface                         $parentCrud
     * @param SettingsProviderInterface             $provider
     * @param JsonSchemasInterface                  $jsonSchemas
     * @param EncoderInterface                      $encoder
     * @param FactoryInterface                      $errorFactory
     * @param FormatterFactoryInterface             $formatterFactory
     *
     * @return ResponseInterface
     *
     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
     */
    protected static function defaultAddInRelationshipHandler(
        string $index,
        string $jsonRelName,
        string $modelRelName,
        UriInterface $requestUri,
        string $requestBody,
        string $schemaClass,
        ModelSchemaInfoInterface $schemaInfo,
        JsonApiQueryValidatingParserInterface $queryParser,
        JsonApiDataValidatingParserInterface $dataValidator,
        CrudInterface $parentCrud,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder,
        FactoryInterface $errorFactory,
        FormatterFactoryInterface $formatterFactory
    ): ResponseInterface {
        /** @var SchemaInterface $schemaClass */
        assert(array_key_exists(SchemaInterface::class, class_implements($schemaClass)) === true);
        $modelClass = $schemaClass::MODEL;
        assert($schemaInfo->hasRelationship($modelClass, $modelRelName));
        assert($schemaInfo->getRelationshipType($modelClass, $modelRelName) === RelationshipTypes::BELONGS_TO_MANY);

        $jsonData = static::readJsonFromRequest($requestBody, $errorFactory, $formatterFactory);
        $captures = $dataValidator->assertRelationship($index, $jsonRelName, $jsonData)->getJsonApiCaptures();
        $relIds   = $captures[$jsonRelName];

        $validatedIndex = $queryParser->parse($index)->getIdentity();
        $parentCrud->createInBelongsToManyRelationship($validatedIndex, $modelRelName, $relIds);

        $encParams = null;
        $responses = static::defaultCreateResponses($requestUri, $provider, $jsonSchemas, $encoder, $encParams);
        $response  = $responses->getCodeResponse(204);

        return $response;
    }

    /** @noinspection PhpTooManyParametersInspection
     * @param string                                $index
     * @param string                                $jsonRelName
     * @param string                                $modelRelName
     * @param UriInterface                          $requestUri
     * @param string                                $requestBody
     * @param string                                $schemaClass
     * @param ModelSchemaInfoInterface              $schemaInfo
     * @param JsonApiQueryValidatingParserInterface $queryParser
     * @param JsonApiDataValidatingParserInterface  $dataValidator
     * @param CrudInterface                         $parentCrud
     * @param SettingsProviderInterface             $provider
     * @param JsonSchemasInterface                  $jsonSchemas
     * @param EncoderInterface                      $encoder
     * @param FactoryInterface                      $errorFactory
     * @param FormatterFactoryInterface             $formatterFactory
     *
     * @return ResponseInterface
     *
     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
     */
    protected static function defaultDeleteInRelationshipHandler(
        string $index,
        string $jsonRelName,
        string $modelRelName,
        UriInterface $requestUri,
        string $requestBody,
        string $schemaClass,
        ModelSchemaInfoInterface $schemaInfo,
        JsonApiQueryValidatingParserInterface $queryParser,
        JsonApiDataValidatingParserInterface $dataValidator,
        CrudInterface $parentCrud,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder,
        FactoryInterface $errorFactory,
        FormatterFactoryInterface $formatterFactory
    ): ResponseInterface {
        /** @var SchemaInterface $schemaClass */
        assert(array_key_exists(SchemaInterface::class, class_implements($schemaClass)) === true);
        $modelClass = $schemaClass::MODEL;
        assert($schemaInfo->hasRelationship($modelClass, $modelRelName));
        assert($schemaInfo->getRelationshipType($modelClass, $modelRelName) === RelationshipTypes::BELONGS_TO_MANY);

        $jsonData = static::readJsonFromRequest($requestBody, $errorFactory, $formatterFactory);
        $captures = $dataValidator->assertRelationship($index, $jsonRelName, $jsonData)->getJsonApiCaptures();
        $relIds   = $captures[$jsonRelName];

        $validatedIndex = $queryParser->parse($index)->getIdentity();
        $parentCrud->removeInBelongsToManyRelationship($validatedIndex, $modelRelName, $relIds);

        $encParams = null;
        $responses = static::defaultCreateResponses($requestUri, $provider, $jsonSchemas, $encoder, $encParams);
        $response  = $responses->getCodeResponse(204);

        return $response;
    }

    /** @noinspection PhpTooManyParametersInspection
     * @param string                                $index
     * @param string                                $jsonRelName
     * @param string                                $modelRelName
     * @param UriInterface                          $requestUri
     * @param string                                $requestBody
     * @param string                                $schemaClass
     * @param ModelSchemaInfoInterface              $schemaInfo
     * @param JsonApiQueryValidatingParserInterface $queryParser
     * @param JsonApiDataValidatingParserInterface  $dataValidator
     * @param CrudInterface                         $crud
     * @param SettingsProviderInterface             $provider
     * @param JsonSchemasInterface                  $jsonSchemas
     * @param EncoderInterface                      $encoder
     * @param FactoryInterface                      $errorFactory
     * @param FormatterFactoryInterface             $formatterFactory
     *
     * @return ResponseInterface
     *
     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
     */
    protected static function defaultReplaceInRelationship(
        string $index,
        string $jsonRelName,
        string $modelRelName,
        UriInterface $requestUri,
        string $requestBody,
        string $schemaClass,
        ModelSchemaInfoInterface $schemaInfo,
        JsonApiQueryValidatingParserInterface $queryParser,
        JsonApiDataValidatingParserInterface $dataValidator,
        CrudInterface $crud,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder,
        FactoryInterface $errorFactory,
        FormatterFactoryInterface $formatterFactory
    ): ResponseInterface {
        /** @var SchemaInterface $schemaClass */
        assert(array_key_exists(SchemaInterface::class, class_implements($schemaClass)) === true);
        $modelClass = $schemaClass::MODEL;
        assert($schemaInfo->hasRelationship($modelClass, $modelRelName));
        assert(
            ($type =$schemaInfo->getRelationshipType($modelClass, $modelRelName)) === RelationshipTypes::BELONGS_TO ||
            $type === RelationshipTypes::BELONGS_TO_MANY
        );

        $jsonData = static::readJsonFromRequest($requestBody, $errorFactory, $formatterFactory);
        $captures = $dataValidator->assertRelationship($index, $jsonRelName, $jsonData)->getJsonApiCaptures();

        // If we are here then we have something in 'data' section.

        $validatedIndex = $queryParser->parse($index)->getIdentity();
        list (, $attributes, $toMany) = static::mapSchemaDataToModelData($captures, $schemaClass, $schemaInfo);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $updated = $crud->update($validatedIndex, $attributes, $toMany);

        return static::defaultUpdateResponse($updated, $index, $requestUri, $crud, $provider, $jsonSchemas, $encoder);
    }

    /**
     * @param ContainerInterface $container
     * @param string             $rulesClass
     *
     * @return JsonApiQueryValidatingParserInterface
     *
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
    protected static function defaultCreateQueryParser(
        ContainerInterface $container,
        string $rulesClass = DefaultQueryValidationRules::class
    ): JsonApiQueryValidatingParserInterface {
        static::assertClassImplements($rulesClass, JsonApiQueryRulesInterface::class);

        /** @var JsonApiParserFactoryInterface $factory */
        $factory   = $container->get(JsonApiParserFactoryInterface::class);
        $validator = $factory->createQueryParser($rulesClass);

        return $validator;
    }

    /**
     * @param ContainerInterface $container
     * @param string             $rulesClass
     *
     * @return JsonApiDataValidatingParserInterface
     *
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
    protected static function defaultCreateDataParser(
        ContainerInterface $container,
        string $rulesClass
    ): JsonApiDataValidatingParserInterface {
        static::assertClassImplements($rulesClass, JsonApiDataRulesInterface::class);

        /** @var JsonApiParserFactoryInterface $factory */
        $factory   = $container->get(JsonApiParserFactoryInterface::class);
        $validator = $factory->createDataParser($rulesClass);

        return $validator;
    }

    /**
     * @param ContainerInterface $container
     * @param string             $rulesClass
     *
     * @return FormValidatorInterface
     *
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
    protected static function defaultCreateFormValidator(
        ContainerInterface $container,
        string $rulesClass
    ): FormValidatorInterface {
        static::assertClassImplements($rulesClass, FormRulesInterface::class);

        /** @var FormValidatorFactoryInterface $factory */
        $factory   = $container->get(FormValidatorFactoryInterface::class);
        $validator = $factory->createValidator($rulesClass);

        return $validator;
    }

    /**
     * @param ContainerInterface $container
     * @param string             $schemaClass
     *
     * @return ParametersMapperInterface
     *
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
    protected static function defaultCreateParameterMapper(
        ContainerInterface $container,
        string $schemaClass
    ): ParametersMapperInterface {
        static::assertClassImplements($schemaClass, SchemaInterface::class);

        /** @var SchemaInterface $schemaClass */
        $jsonResourceType = $schemaClass::TYPE;

        /** @var ParametersMapperInterface $mapper */
        $mapper = $container->get(ParametersMapperInterface::class);
        $mapper->selectRootSchemaByResourceType($jsonResourceType);

        return $mapper;
    }

    /**
     * @param JsonApiQueryValidatingParserInterface $queryParser
     *
     * @return EncodingParametersInterface
     */
    protected static function defaultCreateEncodingParameters(
        JsonApiQueryValidatingParserInterface $queryParser
    ): EncodingParametersInterface {
        return new EncodingParameters(
            $queryParser->hasIncludes() === true ? array_keys($queryParser->getIncludes()) : null,
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $queryParser->hasFields() === true ? $queryParser->getFields() : null
        );
    }

    /**
     * @param ContainerInterface $container
     * @param string|null        $class
     *
     * @return CrudInterface
     *
     * @throws ContainerExceptionInterface
     * @throws NotFoundExceptionInterface
     */
    protected static function defaultCreateApi(ContainerInterface $container, string $class): CrudInterface
    {
        static::assertClassImplements($class, CrudInterface::class);

        /** @var FactoryInterface $factory */
        $factory = $container->get(FactoryInterface::class);
        $api     = $factory->createApi($class);

        return $api;
    }

    /**
     * @param UriInterface                     $requestUri
     * @param SettingsProviderInterface        $provider
     * @param JsonSchemasInterface             $jsonSchemas
     * @param EncoderInterface                 $encoder
     * @param EncodingParametersInterface|null $parameters
     *
     * @return ResponsesInterface
     */
    protected static function defaultCreateResponses(
        UriInterface $requestUri,
        SettingsProviderInterface $provider,
        JsonSchemasInterface $jsonSchemas,
        EncoderInterface $encoder,
        ?EncodingParametersInterface $parameters
    ): ResponsesInterface {
        $encoder->forOriginalUri($requestUri);
        $settings  = $provider->get(S::class);
        $responses = new Responses(
            new MediaType(MediaTypeInterface::JSON_API_TYPE, MediaTypeInterface::JSON_API_SUB_TYPE),
            $encoder,
            $jsonSchemas,
            $parameters,
            $settings[S::KEY_URI_PREFIX],
            $settings[S::KEY_META]
        );

        return $responses;
    }

    /**
     * Developers can override the method in order to add/remove some data for `create`/`update` inputs.
     *
     * @param string                    $requestBody
     * @param FactoryInterface          $errorFactory
     * @param FormatterFactoryInterface $formatterFactory
     * @param string                    $messagesNamespace
     * @param string                    $errorMessage
     *
     * @return array
     */
    protected static function readJsonFromRequest(
        string $requestBody,
        FactoryInterface $errorFactory,
        FormatterFactoryInterface $formatterFactory,
        string $messagesNamespace = S::GENERIC_NAMESPACE,
        string $errorMessage = Generic::MSG_ERR_INVALID_ELEMENT
    ): array {
        if (empty($requestBody) === true || ($json = json_decode($requestBody, true)) === null) {
            $formatter = $formatterFactory->createFormatter($messagesNamespace);
            $errors    = $errorFactory->createErrorCollection();
            $errors->addDataError($formatter->formatMessage($errorMessage));

            throw new JsonApiException($errors);
        }

        return $json;
    }

    /**
     * Developers can override the method in order to use custom data mapping from a Schema to Model.
     *
     * @param array                    $captures
     * @param string                   $schemaClass
     * @param ModelSchemaInfoInterface $schemaInfo
     *
     * @return array
     */
    protected static function mapSchemaDataToModelData(
        array $captures,
        string $schemaClass,
        ModelSchemaInfoInterface $schemaInfo
    ): array {
        static::assertClassImplements($schemaClass, SchemaInterface::class);

        /** @var SchemaInterface $schemaClass */
        static::assertClassImplements($modelClass = $schemaClass::MODEL, ModelInterface::class);
        /** @var ModelInterface $modelClass */

        $index         = null;
        $fields        = [];
        $toManyIndexes = [];
        foreach ($captures as $name => $value) {
            assert(is_string($name) === true);
            if ($name === DI::KEYWORD_ID) {
                $index = $value;
            } elseif ($schemaClass::hasAttributeMapping($name) === true) {
                $fieldName          = $schemaClass::getAttributeMapping($name);
                $fields[$fieldName] = $value;
            } elseif ($schemaClass::hasRelationshipMapping($name) === true) {
                $modelRelName = $schemaClass::getRelationshipMapping($name);
                $relType      = $schemaInfo->getRelationshipType($modelClass, $modelRelName);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                if ($relType === RelationshipTypes::BELONGS_TO) {
                    $fkName          = $schemaInfo->getForeignKey($modelClass, $modelRelName);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    $fields[$fkName] = $value;
                } elseif ($relType === RelationshipTypes::BELONGS_TO_MANY) {
                    $toManyIndexes[$modelRelName] = $value;
                }
            }
        }

        $result = [$index, $fields, $toManyIndexes];

        return $result;
    }

    /**
     * @param null|string $value
     *
     * @return void
     */
    private static function assertClassValueDefined(?string $value): void
    {
        assert(empty($value) === false, 'Value should be defined in `' . static::class . '`.');
    }

    /**
     * @param string $class
     * @param string $interface
     *
     * @return void
     */
    private static function assertClassImplements(string $class, string $interface): void
    {
        assert(
            array_key_exists($interface, class_implements($class)) === true,
            "Class `$class` should implement `" . $interface . '` interface.'
        );
    }
}

limoncello-php-dist / flute

Push — master ( 6173d9...210649 )

defaultUpdateInRelationshipHandler() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like
