Surfnet\StepupMiddleware\ApiBundle\Request\CommandValueResolver

Complexity

Total Complexity

15

Size/Duplication

Total Lines	72
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	assertIsValidCommandStructure()	0	24	9
B	resolve()	0	38	6

<?php

/**
 * Copyright 2014 SURFnet bv
 *
 * 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.
 */

Missing @link tag in file comment

namespace Surfnet\StepupMiddleware\ApiBundle\Request;

use Surfnet\StepupMiddleware\ApiBundle\Exception\BadCommandRequestException;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\AbstractCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\Command;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;

class CommandValueResolver implements ValueResolverInterface

Missing doc comment for class CommandValueResolver

{
    /**

Parameter $request should have a doc-comment as per coding-style.

Parameter $argument should have a doc-comment as per coding-style.

     * @return AbstractCommand[]
     */
    public function resolve(Request $request, ArgumentMetadata $argument): iterable
    {
        $argumentType = $argument->getType();
        if (!$argumentType
            || (!is_subclass_of($argumentType, Command::class, true) && Command::class !== $argumentType)
        ) {
            return [];
        }

        $data = json_decode($request->getContent(), true);

        $this->assertIsValidCommandStructure($data);

        $commandNameParts = [];
        $found = preg_match('~^(\w+):([\w\\.]+)$~', (string)$data['command']['name'], $commandNameParts);
        if ($found !== 1) {
            $message = sprintf('Command does not have a valid command name %s', (string)$data['command']['name']);
            throw new BadCommandRequestException(
                [$message],
                $message,
            );
        }
        $commandClassName = sprintf(
            'Surfnet\StepupMiddleware\CommandHandlingBundle\%s\Command\%sCommand',
            $commandNameParts[1],
            str_replace('.', '\\', $commandNameParts[2]),
        );

        /** @var AbstractCommand $command */

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

        $command = new $commandClassName;
        $command->UUID = (string)$data['command']['uuid'];

        foreach ((array)$data['command']['payload'] as $property => $value) {
            $properlyCasedProperty = lcfirst(str_replace(' ', '', ucwords(str_replace('_', ' ', (string)$property))));
            $command->$properlyCasedProperty = $value;
        }

        return [$command];
    }

    /**

Parameter $data should have a doc-comment as per coding-style.

     * @throws BadCommandRequestException
     */

Missing @return tag in function comment

    private function assertIsValidCommandStructure(mixed $data): void

Private method name "CommandValueResolver::assertIsValidCommandStructure" must be prefixed with an underscore

    {
        if (!is_array($data)) {
            $type = gettype($data);

            throw new BadCommandRequestException(
                [sprintf('Command is not valid: body must be a JSON object, but is of type %s', $type)],
            );
        }

        if (!isset($data['command'])) {
            throw new BadCommandRequestException(["Required parameter 'command' is not set."]);
        }

        if (!isset($data['command']['name']) || !is_string($data['command']['name'])) {
            throw new BadCommandRequestException(["Required command parameter 'name' is not set or not a string."]);
        }

        if (!isset($data['command']['uuid']) || !is_string($data['command']['uuid'])) {
            throw new BadCommandRequestException(["Required command parameter 'uuid' is not set or not a string."]);
        }

        if (!isset($data['command']['payload']) || !is_array($data['command']['payload'])) {
            throw new BadCommandRequestException(["Required command parameter 'payload' is not set or not an object."]);
        }
    }
}