Surfnet\StepupSelfService\SelfServiceBundle\Locale\RequestStackLocaleProvider

Complexity

Total Complexity

6

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	17	4
A	providePreferredLocale()	0	9	2

<?php

declare(strict_types = 1);

/**
 * Copyright 2015 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.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Surfnet\StepupSelfService\SelfServiceBundle\Locale;

use Surfnet\StepupSelfService\SelfServiceBundle\Exception\InvalidArgumentException;
use Surfnet\StepupSelfService\SelfServiceBundle\Locale\PreferredLocaleProvider;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * Fetches the client's preferred locale from the request (specifically from the Accept header), falling back to a
 * default locale if no preferred locale can be determined.
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

final class RequestStackLocaleProvider implements PreferredLocaleProvider
{
    private readonly string $defaultLocale;

Private member variable "defaultLocale" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var string[]
     */
    private $supportedLocales;

Private member variable "supportedLocales" must be prefixed with an underscore

    /**

Missing short description in doc comment

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

     * @param string $defaultLocale

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

Doc comment for parameter $defaultLocale does not match actual variable name $requestStack

     * @param string[] $supportedLocales

Missing parameter comment

Doc comment for parameter $supportedLocales does not match actual variable name $defaultLocale

     */
    public function __construct(
        private readonly RequestStack $requestStack,
        $defaultLocale,
        $supportedLocales
    ) {
        if (!is_string($defaultLocale)) {

The condition is_string($defaultLocale) is always true.

            throw InvalidArgumentException::invalidType('string', 'defaultLocale', $defaultLocale);
        }

        foreach ($supportedLocales as $key => $supportedLocale) {
            if (!is_string($supportedLocale)) {
                $parameterName = sprintf('supportedLocales[%s]', $key);
                throw InvalidArgumentException::invalidType('string', $parameterName, $supportedLocale);
            }
        }
        $this->defaultLocale = $defaultLocale;

The property defaultLocale is declared read-only in Surfnet\StepupSelfService\SelfServiceBundle\Locale\RequestStackLocaleProvider.

        $this->supportedLocales = $supportedLocales;
    }

    public function providePreferredLocale(): string

Missing doc comment for function providePreferredLocale()

    {
        $preferredLocale = $this->requestStack->getCurrentRequest()->getPreferredLanguage($this->supportedLocales);

        if (!$preferredLocale) {
            return $this->defaultLocale;
        }

        return $preferredLocale;
    }
}