Surfnet\StepupSelfService\SelfServiceBundle\Controller\LocaleController::switchLocaleAction()

Complexity

Conditions	6
Paths	5

Size

Total Lines	51
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	LocaleController::__construct()	0	5	1

<?php

declare(strict_types = 1);

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

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\Controller;

use Psr\Log\LoggerInterface;
use Surfnet\StepupBundle\Command\SwitchLocaleCommand;
use Surfnet\StepupBundle\Form\Type\SwitchLocaleType;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\IdentityService;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Symfony\Component\Routing\Attribute\Route;
use Symfony\Contracts\Translation\TranslatorInterface;

final class LocaleController extends AbstractController

Missing doc comment for class LocaleController

{
    public function __construct(

Missing doc comment for function __construct()

        private readonly LoggerInterface $logger,
        private readonly TranslatorInterface $translator,
        private readonly IdentityService $identityService,
    ) {
    }

    #[Route(
        path: '/switch-locale',
        name: 'ss_switch_locale',
        requirements: ['return-url' => '.+'],
        methods: ['POST']
    )]
    public function switchLocale(Request $request): RedirectResponse

Missing doc comment for function switchLocale()

    {
        $returnUrl = $request->query->get('return-url');

        // Return URLs generated by us always include a path (ie. at least a forward slash)
        // @see https://github.com/symfony/symfony/blob/master/src/Symfony/Component/HttpFoundation/Request.php#L878
        $domain = $request->getSchemeAndHttpHost() . '/';
        if (!str_starts_with($returnUrl, $domain)) {
            $this->logger->error(sprintf(

The opening parenthesis of a multi-line function call should be the last content on the line.

                'Identity "%s" used illegal return-url for redirection after changing locale, aborting request',
                $this->getUser()->getIdentity()->id

The method getIdentity() does not exist on Symfony\Component\Security\Core\User\UserInterface. It seems like you code against a sub-type of Symfony\Component\Security\Core\User\UserInterface such as Surfnet\StepupSelfService\SelfServiceBundle\Security\Authentication\AuthenticatedIdentity.

            ));

For multi-line function calls, the closing parenthesis should be on a new line.

            throw new BadRequestHttpException('Invalid return-url given');
        }

        $this->logger->info('Switching locale...');

        $identity = $this->getUser()->getIdentity();
        if (!$identity) {
            throw new AccessDeniedHttpException('Cannot switch locales when not authenticated');
        }

        $command = new SwitchLocaleCommand();
        $command->identityId = $identity->id;

        $form = $this->createForm(
            SwitchLocaleType::class,
            $command,
            ['route' => 'ss_switch_locale', 'route_parameters' => ['return_url' => $returnUrl]]
        );
        $form->handleRequest($request);

        if (!$form->isSubmitted() || !$form->isValid()) {
            $this->addFlash('error', $this->translator->trans('ss.flash.invalid_switch_locale_form'));
            $this->logger->error('The switch locale form unexpectedly contained invalid data');
            return $this->redirect($returnUrl);
        }

        if (!$this->identityService->switchLocale($command)) {
            $this->addFlash('error', $this->translator->trans('ss.flash.error_while_switching_locale'));
            $this->logger->error('An error occurred while switching locales');
            return $this->redirect($returnUrl);
        }

        $this->logger->info('Successfully switched locale');

        return $this->redirect($returnUrl);
    }
}