DialogPlugin::success() - Code Metrics - Inspection of "New tests for the dialogs plugin." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( b34d93...aea763 )

by Thierry
created 2022-04-06 21:23 UTC
DialogPlugin::success() A

↳ Parent: DialogPlugin
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	2
<?php

/**
 * DialogPlugin.php - ModalInterface, message and question dialogs for Jaxon.
 *
 * Show modal, message and question dialogs with various javascript libraries
 * based on user settings.
 *
 * @package jaxon-dialogs

 * @author Thierry Feuzeu <[email protected]>
 * @copyright 2016 Thierry Feuzeu <[email protected]>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-dialogs
 */


namespace Jaxon\Plugin\Response\Dialog;

use Jaxon\Config\ConfigManager;
use Jaxon\Di\Container;
use Jaxon\Plugin\ResponsePlugin;
use Jaxon\Response\Response;
use Jaxon\Ui\Dialog\Library\DialogLibraryManager;
use Jaxon\Ui\Dialog\MessageInterface;
use Jaxon\Ui\Dialog\ModalInterface;

use function array_reduce;
use function trim;

class DialogPlugin extends ResponsePlugin implements ModalInterface, MessageInterface

{
    /**
     * @const The plugin name
     */
    const NAME = 'dialog';

    /**
     * Dependency Injection manager
     *
     * @var Container
     */
    protected $di;

    /**
     * @var DialogLibraryManager
     */
    protected $xLibraryManager;

    /**
     * @var ConfigManager
     */
    protected $xConfigManager;

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

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

     * @param ConfigManager $xConfigManager

     * @param DialogLibraryManager $xLibraryManager

     */
    public function __construct(Container $di, ConfigManager $xConfigManager, DialogLibraryManager $xLibraryManager)

    {
        $this->di = $di;
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->xConfigManager = $xConfigManager;
        $this->xLibraryManager = $xLibraryManager;

        $aLibraries = $this->xConfigManager->getOption('dialogs.libraries', []);
        foreach($aLibraries as $sClassName => $sName)
        {
            $this->registerLibrary($sClassName, $sName);
        }
    }


    /**
     * @inheritDoc
     */

    public function getName(): string
    {
        return self::NAME;
    }


    /**
     * @inheritDoc
     */

    public function getHash(): string
    {
        return '4.0.0'; // The version number is used as hash
    }


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

     * @param string $sName

     *
     * @return void
     */
    public function registerLibrary(string $sClassName, string $sName)
    {
        $this->aLibraries[] = $sName;
        $this->di->registerDialogLibrary($sClassName, $sName);
    }


    /**
     * @return void
     */
    protected function setDefaultLibraries()
    {
        // Set the default modal library
        if(($sName = $this->xConfigManager->getOption('dialogs.default.modal', '')))

        {
            $this->xLibraryManager->setModalLibrary($sName);
        }
        // Set the default message library
        if(($sName = $this->xConfigManager->getOption('dialogs.default.message', '')))

        {
            $this->xLibraryManager->setMessageLibrary($sName);
        }
        // Set the default question library
        if(($sName = $this->xConfigManager->getOption('dialogs.default.question', '')))

        {
            $this->xLibraryManager->setQuestionLibrary($sName);
        }
    }


    /**

     * @inheritDoc
     */

    public function setResponse(Response $xResponse)
    {
        parent::setResponse($xResponse);

        // Hack the setResponse() method, to set the default libraries on each access to this plugin.
        $this->setDefaultLibraries();
        $this->xLibraryManager->setNextLibrary('');
    }


    /**
     * Set the library to use for the next call.
     *
     * @param string $sLibrary The name of the library
     *
     * @return DialogPlugin
     */
    public function with(string $sLibrary): DialogPlugin
    {
        $this->xLibraryManager->setNextLibrary($sLibrary);
        return $this;
    }


    /**
     * Get the library adapter to use for modals.
     *
     * @return ModalInterface|null
     */
    protected function getModalLibrary(): ?ModalInterface
    {
        $xLibrary = $this->xLibraryManager->getModalLibrary();
        $xLibrary->setResponse($this->xResponse);
                   setResponse($this->xResponse);
        return $xLibrary;
    }


    /**
     * Get the library adapter to use for messages.
     *
     * @return MessageInterface|null
     */
    protected function getMessageLibrary(): ?MessageInterface
    {
        $xLibrary = $this->xLibraryManager->getMessageLibrary();
        $xLibrary->setResponse($this->xResponse);
        // By default, always add commands to the response
        $xLibrary->setReturnCode(false);
        return $xLibrary;
    }


    /**
     * @inheritDoc
     */

    public function getJs(): string
    {
        return array_reduce($this->aLibraries, function($sCode, $sName) {
            $xLibrary = $this->di->g($sName);
            return $sCode . $xLibrary->getJs() . "\n\n";
        }, '');
    }


    /**
     * @inheritDoc
     */

    public function getCss(): string
    {
        return array_reduce($this->aLibraries, function($sCode, $sName) {
            $xLibrary = $this->di->g($sName);
            return $sCode . trim($xLibrary->getCss()) . "\n\n";
        }, '');
    }


    /**
     * @inheritDoc
     */

    public function getScript(): string
    {
        // The default scripts need to be set in the js code.
        $this->setDefaultLibraries();
        return array_reduce($this->aLibraries, function($sCode, $sName) {
            $xLibrary = $this->di->g($sName);
            return $sCode . trim($xLibrary->getScript()) . "\n\n";
        }, "jaxon.dialogs = {};\n");
    }


    /**
     * @inheritDoc
     */

    public function getReadyScript(): string
    {
        return array_reduce($this->aLibraries, function($sCode, $sName) {
            $xLibrary = $this->di->g($sName);
            return $sCode . trim($xLibrary->getReadyScript()) . "\n\n";
        }, '');
    }


    /**

     * @inheritDoc
     */

    public function show(string $sTitle, string $sContent, array $aButtons = [], array $aOptions = [])
    {
        $this->getModalLibrary()->show($sTitle, $sContent, $aButtons, $aOptions);
    }


    /**
     * @inheritDoc
     */

    public function hide()
    {
        $this->getModalLibrary()->hide();
    }


    /**

     * @inheritDoc
     */

    public function success(string $sMessage, string $sTitle = ''): string
    {
        return $this->getMessageLibrary()->success($sMessage, $sTitle);
    }


    /**

     * @inheritDoc
     */

    public function info(string $sMessage, string $sTitle = ''): string
    {
        return $this->getMessageLibrary()->info($sMessage, $sTitle);
    }


    /**

     * @inheritDoc
     */

    public function warning(string $sMessage, string $sTitle = ''): string
    {
        return $this->getMessageLibrary()->warning($sMessage, $sTitle);
    }


    /**

     * @inheritDoc
     */

    public function error(string $sMessage, string $sTitle = ''): string
    {
        return $this->getMessageLibrary()->error($sMessage, $sTitle);
    }

}

jaxon-php / jaxon-core

Push — master ( b34d93...aea763 )

DialogPlugin::success() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
