Surfnet\StepupSelfService\SamlStepupProviderBundle\Provider\ViewConfig

Complexity

Total Complexity

15

Size/Duplication

Total Lines	218
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	27	1
A	getLogo()	0	4	1
A	getLoa()	0	4	1
A	getTitle()	0	4	1
A	getAlt()	0	4	1
A	getDescription()	0	4	1
A	getButtonUse()	0	4	1
A	getInitiateTitle()	0	4	1
A	getInitiateButton()	0	4	1
A	getExplanation()	0	4	1
A	getAuthnFailed()	0	4	1
A	getPopFailed()	0	4	1
A	getTranslation()	0	17	3

<?php

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

namespace Surfnet\StepupSelfService\SamlStepupProviderBundle\Provider;

use Surfnet\StepupSelfService\SelfServiceBundle\Exception\LogicException;
use Symfony\Component\HttpFoundation\Request;

class ViewConfig
{
    /**
     * @var string
     */
    private $loa;

    /**
     * @var string
     */
    private $logo;

    /**
     * @var array
     */
    private $alt;

    /**
     * @var array
     */
    private $title;

    /**
     * @var array
     */
    private $description;

    /**
     * @var array
     */
    private $buttonUse;

    /**
     * @var array
     */
    private $initiateTitle;

    /**
     * @var array
     */
    private $initiateButton;

    /**
     * @var array
     */
    private $explanation;

    /**
     * @var array
     */
    private $authnFailed;

    /**
     * @var array
     */
    private $popFailed;

    /**
     * @var Request
     */
    private $request;

    /**
     * The arrays are arrays of translated text, indexed on locale.
     *
     * @param Request $request
     * @param string $loa
     * @param string $logo
     * @param array $alt
     * @param array $title
     * @param array $description
     * @param array $buttonUse
     * @param array $initiateTitle
     * @param array $initiateButton
     * @param array $explanation
     * @param array $authnFailed
     * @param array $popFailed
     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
     */
    public function __construct(
        Request $request,

You have injected the Request via parameter $request. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via getCurrentRequest().

        $loa,
        $logo,
        array $alt,
        array $title,
        array $description,
        array $buttonUse,
        array $initiateTitle,
        array $initiateButton,
        array $explanation,
        array $authnFailed,
        array $popFailed
    ) {
        $this->loa = $loa;
        $this->logo = $logo;
        $this->alt = $alt;
        $this->title = $title;
        $this->description = $description;
        $this->buttonUse = $buttonUse;
        $this->initiateTitle = $initiateTitle;
        $this->initiateButton = $initiateButton;
        $this->explanation = $explanation;
        $this->authnFailed = $authnFailed;
        $this->popFailed = $popFailed;
        $this->request = $request;
    }

    /**
     * @return string
     */
    public function getLogo()
    {
        return $this->logo;
    }

    /**
     * @return string
     */
    public function getLoa()
    {
        return $this->loa;
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->getTranslation($this->title);
    }

    /**
     * @return string
     */
    public function getAlt()
    {
        return $this->getTranslation($this->alt);
    }

    /**
     * @return string
     */
    public function getDescription()
    {
        return $this->getTranslation($this->description);
    }

    /**
     * @return string
     */
    public function getButtonUse()
    {
        return $this->getTranslation($this->buttonUse);
    }

    /**
     * @return string
     */
    public function getInitiateTitle()
    {
        return $this->getTranslation($this->initiateTitle);
    }

    /**
     * @return string
     */
    public function getInitiateButton()
    {
        return $this->getTranslation($this->initiateButton);
    }

    /**
     * @return string
     */
    public function getExplanation()
    {
        return $this->getTranslation($this->explanation);
    }

    /**
     * @return string
     */
    public function getAuthnFailed()
    {
        return $this->getTranslation($this->authnFailed);
    }

    /**
     * @return string
     */
    public function getPopFailed()
    {
        return $this->getTranslation($this->popFailed);
    }

    /**
     * @param array $translations
     * @return mixed
     * @throws LogicException
     */
    private function getTranslation(array $translations)
    {
        $currentLocale = $this->request->getLocale();
        if (is_null($currentLocale)) {
            throw new LogicException('The current language is not set');
        }
        if (isset($translations[$currentLocale])) {
            return $translations[$currentLocale];
        }
        throw new LogicException(
            sprintf(
                'The requested translation is not available in this language: %s. Available languages: %s',
                $currentLocale,
                implode(', ', array_keys($translations))
            )
        );
    }
}