Surfnet\StepupMiddleware\ApiBundle\Request\ConfigurationInstitutionValueResolver

Complexity

Total Complexity

10

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	getInstitutionFromRequest()	0	17	7
A	resolve()	0	9	3

<?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\Stepup\Configuration\Value\Institution;
use Surfnet\StepupMiddleware\ApiBundle\Exception\BadApiRequestException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;

class ConfigurationInstitutionValueResolver implements ValueResolverInterface

Missing doc comment for class ConfigurationInstitutionValueResolver

{
    public const INSTITUTION = 'institution';

    /**

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

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

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

        return [new Institution($this->getInstitutionFromRequest($request))];
    }

    /**

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

     * @return string
     */
    private function getInstitutionFromRequest(Request $request): string

Private method name "ConfigurationInstitutionValueResolver::getInstitutionFromRequest" must be prefixed with an underscore

    {
        $institution = $request->attributes->get(self::INSTITUTION);
        $request->attributes->remove(self::INSTITUTION);

        if (is_string($institution) && ($institution !== '' && $institution !== '0')) {
            return $institution;
        }

        $institution = $request->query->get(self::INSTITUTION);
        $request->query->remove(self::INSTITUTION);

        if (is_string($institution) && ($institution !== '' && $institution !== '0')) {
            return $institution;
        }

        throw new BadApiRequestException(['This API-call MUST include the institution in the path or query parameters'],);
    }
}