Jaxon\Plugin\Response\Dialog\DialogPlugin

Complexity

Total Complexity

18

Size/Duplication

Total Lines	224
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	info()	0	5	1
A	getScript()	0	5	1
A	getName()	0	3	1
A	with()	0	4	1
A	error()	0	5	1
A	__construct()	0	3	1
A	getLibraries()	0	7	2
A	success()	0	5	1
A	getCss()	0	5	1
A	show()	0	6	1
A	getReadyScript()	0	5	1
A	getJs()	0	5	1
A	title()	0	3	1
A	setResponse()	0	6	1
A	hide()	0	6	1
A	getHash()	0	4	1
A	warning()	0	5	1

<?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-core

Package name "jaxon-core" is not valid; consider "Jaxoncore" instead

 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright 2016 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-dialogs
 */

PHP version not specified

Missing @category tag in file comment

namespace Jaxon\Plugin\Response\Dialog;

use Jaxon\App\Dialog\Library\DialogLibraryManager;
use Jaxon\App\Dialog\MessageInterface;
use Jaxon\Exception\SetupException;
use Jaxon\Plugin\ResponsePlugin;
use Jaxon\Response\ResponseInterface;

use function array_reduce;
use function trim;

class DialogPlugin extends ResponsePlugin

Missing doc comment for class DialogPlugin

{
    use DialogPluginTrait;

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

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

    /**
     * @var array
     */
    protected $aLibraries = null;

    /**
     * The constructor
     *
     * @param DialogLibraryManager $xLibraryManager

Missing parameter comment

     */
    public function __construct(DialogLibraryManager $xLibraryManager)

Expected 2 blank lines before function; 1 found

    {
        $this->xLibraryManager = $xLibraryManager;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

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

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

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

Expected 2 blank lines after function; 1 found

    /**

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

     * @inheritDoc
     */

Missing @return tag in function comment

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

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

Expected 2 blank lines after function; 1 found

    /**
     * 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;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @return array
     */
    private function getLibraries(): array
    {
        if($this->aLibraries === null)
        {
            $this->aLibraries = $this->xLibraryManager->getLibraries();
        }
        return $this->aLibraries;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

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

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

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

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     * @throws SetupException
     */

Missing @return tag in function comment

    public function getScript(): string
    {
        return array_reduce($this->getLibraries(), function($sCode, $xLibrary) {
            return $sCode . trim($xLibrary->getScript()) . "\n\n";
        }, "jaxon.dialogs = {};\n");
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

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

Expected 2 blank lines after function; 1 found

    /**
     * Show a modal dialog.
     *
     * @param string $sTitle The title of the dialog

Expected 3 spaces after parameter name; 1 found

     * @param string $sContent The content of the dialog
     * @param array $aButtons The buttons of the dialog

Expected 2 spaces after parameter type; 1 found

     * @param array $aOptions The options of the dialog

Expected 2 spaces after parameter type; 1 found

     *
     * @return void
     */
    public function show(string $sTitle, string $sContent, array $aButtons = [], array $aOptions = [])
    {
        // Show the modal dialog
        $aResponse = $this->xLibraryManager->show($sTitle, $sContent, $aButtons, $aOptions);

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

        $aResponse['lib'] = $this->xLibraryManager->getModalLibrary()->getName();
        $this->addCommand('dialog.modal.show', $aResponse);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Hide the modal dialog.
     *
     * @return void
     */
    public function hide()
    {
        // Hide the modal dialog
        $aResponse = $this->xLibraryManager->hide();

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

        $aResponse['lib'] = $this->xLibraryManager->getModalLibrary()->getName();
        $this->addCommand('dialog.modal.hide', $aResponse);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set the title of the next message.
     *
     * @param string $sTitle     The title of the message

Expected 1 spaces after parameter name; 5 found

     *
     * @return MessageInterface
     */
    public function title(string $sTitle): MessageInterface
    {
        return $this->xLibraryManager->title($sTitle);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Show a success message.
     *
     * @param string $sMessage  The text of the message

Expected 1 spaces after parameter name; 2 found

     * @param array $aArgs      The message arguments

Expected 2 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 6 found

     *
     * @return void
     */
    public function success(string $sMessage, array $aArgs = [])
    {
        $aResponse = $this->xLibraryManager->success($sMessage, $aArgs);

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

        $aResponse['lib'] = $this->xLibraryManager->getMessageLibrary()->getName();
        $this->addCommand('dialog.message', $aResponse);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Show an information message.
     *
     * @param string $sMessage  The text of the message

Expected 1 spaces after parameter name; 2 found

     * @param array $aArgs      The message arguments

Expected 2 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 6 found

     *
     * @return void
     */
    public function info(string $sMessage, array $aArgs = [])
    {
        $aResponse = $this->xLibraryManager->info($sMessage, $aArgs);

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

        $aResponse['lib'] = $this->xLibraryManager->getMessageLibrary()->getName();
        $this->addCommand('dialog.message', $aResponse);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Show a warning message.
     *
     * @param string $sMessage  The text of the message

Expected 1 spaces after parameter name; 2 found

     * @param array $aArgs      The message arguments

Expected 2 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 6 found

     *
     * @return void
     */
    public function warning(string $sMessage, array $aArgs = [])
    {
        $aResponse = $this->xLibraryManager->warning($sMessage, $aArgs);

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

        $aResponse['lib'] = $this->xLibraryManager->getMessageLibrary()->getName();
        $this->addCommand('dialog.message', $aResponse);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Show an error message.
     *
     * @param string $sMessage  The text of the message

Expected 1 spaces after parameter name; 2 found

     * @param array $aArgs      The message arguments

Expected 2 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 6 found

     *
     * @return void
     */
    public function error(string $sMessage, array $aArgs = [])
    {
        $aResponse = $this->xLibraryManager->error($sMessage, $aArgs);

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

        $aResponse['lib'] = $this->xLibraryManager->getMessageLibrary()->getName();
        $this->addCommand('dialog.message', $aResponse);
    }

Expected 2 blank lines after function; 0 found

}