Jaxon\Ui\Dialog\Library\DialogLibraryManager

Complexity

Total Complexity

23

Size/Duplication

Total Lines	233
Duplicated Lines	0 %

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getMessageLibrary()	0	4	3
A	__construct()	0	6	1
A	setModalLibrary()	0	9	2
A	setQuestionLibrary()	0	9	2
A	setNextLibrary()	0	3	1
A	registerLibrary()	0	28	5
A	getModalLibrary()	0	4	3
A	getLibraries()	0	5	1
A	getQuestionLibrary()	0	4	3
A	setMessageLibrary()	0	9	2

<?php

/**
 * DialogLibraryManager.php - Shows alert and confirm dialogs
 *
 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright 2019 Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

namespace Jaxon\Ui\Dialog\Library;

use Jaxon\Di\Container;
use Jaxon\Exception\SetupException;
use Jaxon\Ui\Dialog\MessageInterface;
use Jaxon\Ui\Dialog\ModalInterface;
use Jaxon\Ui\Dialog\QuestionInterface;
use Jaxon\Utils\Translation\Translator;

use function array_map;
use function class_implements;
use function in_array;

class DialogLibraryManager

Missing doc comment for class DialogLibraryManager

{
    /**
     * @var Container
     */
    private $di;

Expected 1 blank line(s) before first member var; 0 found

    /**
     * @var array
     */
    protected $aLibraries = [];

    /**
     * @var array
     */
    protected $aQuestionLibraries = [];

    /**
     * @var array
     */
    protected $aMessageLibraries = [];

    /**
     * @var array
     */
    protected $aModalLibraries = [];

    /**
     * The QuestionInterface class name
     *
     * @var string
     */
    private $sQuestionLibrary = '';

    /**
     * The MessageInterface class name
     *
     * @var string
     */
    private $sMessageLibrary = '';

    /**
     * The ModalInterface class name
     *
     * @var string
     */
    private $sModalLibrary = '';

    /**
     * The name of the library to use for the next call.
     * This is used to override the default library.
     *
     * @var string
     */
    protected $sNextLibrary = '';

    /**
     * Default javascript alert library
     *
     * @var AlertLibrary
     */
    private $xAlertLibrary;

    /**
     * @var Translator
     */
    private $xTranslator;

    /**
     * The constructor
     *
     * @param Container $di

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param Translator $xTranslator

Missing parameter comment

     */
    public function __construct(Container $di, Translator $xTranslator)

Expected 2 blank lines before function; 1 found

    {
        $this->di = $di;

Equals sign not aligned with surrounding assignments; expected 10 spaces but found 1 space

        $this->xTranslator = $xTranslator;
        // Library for javascript confirm and alert functions.
        $this->xAlertLibrary = new AlertLibrary();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Register a javascript dialog library adapter.
     *
     * @param string $sClassName

Missing parameter comment

     * @param string $sName

Missing parameter comment

     *
     * @return void
     * @throws SetupException
     */
    public function registerLibrary(string $sClassName, string $sName)
    {
        $bIsUsed = false;

Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

        $aInterfaces = class_implements($sClassName);
        if(in_array(QuestionInterface::class, $aInterfaces))
        {
            $this->aQuestionLibraries[$sName] = $sClassName;
            $bIsUsed = true;

Equals sign not aligned with surrounding assignments; expected 26 spaces but found 1 space

        }
        if(in_array(MessageInterface::class, $aInterfaces))
        {
            $this->aMessageLibraries[$sName] = $sClassName;
            $bIsUsed = true;

Equals sign not aligned with surrounding assignments; expected 25 spaces but found 1 space

        }
        if(in_array(ModalInterface::class, $aInterfaces))
        {
            $this->aModalLibraries[$sName] = $sClassName;
            $bIsUsed = true;

Equals sign not aligned with surrounding assignments; expected 23 spaces but found 1 space

        }

        if(!$bIsUsed)
        {
            // The class is invalid.
            $sMessage = $this->xTranslator->trans('errors.register.invalid', ['name' => $sClassName]);
            throw new SetupException($sMessage);
        }
        $this->aLibraries[] = $sClassName;
        $this->di->registerDialogLibrary($sClassName);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the library class instances
     *
     * @return array
     */
    public function getLibraries(): array
    {
        return array_map(function($sClassName) {
            return $this->di->g($sClassName);
        }, $this->aLibraries);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set the QuestionInterface library
     *
     * @param string $sLibraryName The QuestionInterface library name
     *
     * @return void
     * @throws SetupException
     */
    public function setQuestionLibrary(string $sLibraryName)
    {
        if(!isset($this->aQuestionLibraries[$sLibraryName]))
        {
            $sMessage = $this->xTranslator->trans('errors.dialog.library',
                ['type' => 'question', 'name' => $sLibraryName]);
            throw new SetupException($sMessage);
        }
        $this->sQuestionLibrary = $sLibraryName;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the QuestionInterface library
     *
     * @return QuestionInterface
     */
    public function getQuestionLibrary(): QuestionInterface
    {
        $sLibraryName = $this->sNextLibrary ?: $this->sQuestionLibrary;
        return ($sLibraryName) ? $this->di->g($this->aQuestionLibraries[$sLibraryName]) : $this->xAlertLibrary;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set MessageInterface library
     *
     * @param string $sLibraryName The MessageInterface library name
     *
     * @return void
     * @throws SetupException
     */
    public function setMessageLibrary(string $sLibraryName)
    {
        if(!isset($this->aMessageLibraries[$sLibraryName]))
        {
            $sMessage = $this->xTranslator->trans('errors.dialog.library',
                ['type' => 'message', 'name' => $sLibraryName]);
            throw new SetupException($sMessage);
        }
        $this->sMessageLibrary = $sLibraryName;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the MessageInterface library
     *
     * @return MessageInterface
     */
    public function getMessageLibrary(): MessageInterface
    {
        $sLibraryName = $this->sNextLibrary ?: $this->sMessageLibrary;
        return ($sLibraryName) ? $this->di->g($this->aMessageLibraries[$sLibraryName]) : $this->xAlertLibrary;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set the ModalInterface library
     *
     * @param string $sLibraryName The ModalInterface library name
     *
     * @return void
     * @throws SetupException
     */
    public function setModalLibrary(string $sLibraryName)
    {
        if(!isset($this->aModalLibraries[$sLibraryName]))
        {
            $sMessage = $this->xTranslator->trans('errors.dialog.library',
                ['type' => 'modal', 'name' => $sLibraryName]);
            throw new SetupException($sMessage);
        }
        $this->sModalLibrary = $sLibraryName;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the ModalInterface library
     *
     * @return ModalInterface
     */
    public function getModalLibrary(): ?ModalInterface
    {
        $sLibraryName = $this->sNextLibrary ?: $this->sModalLibrary;
        return ($sLibraryName) ? $this->di->g($this->aModalLibraries[$sLibraryName]) : null;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set the name of the library to use for the next call
     *
     * @param string $sNextLibrary

Missing parameter comment

     *
     * @return void
     */
    public function setNextLibrary(string $sNextLibrary): void
    {
        $this->sNextLibrary = $sNextLibrary;
    }

Expected 2 blank lines after function; 0 found

}