jaxon-php / jaxon-core

src/App/Dialog/Library/DialogLibraryHelper.php

<?php

Missing file doc comment

namespace Jaxon\App\Dialog\Library;

use Jaxon\App\Config\ConfigManager;
use Jaxon\App\Dialog\LibraryInterface;
use Jaxon\Utils\Template\TemplateEngine;

use function array_merge;
use function is_bool;
use function is_numeric;
use function is_string;
use function json_encode;
use function rtrim;
use function str_repeat;
use function trim;

class DialogLibraryHelper

Missing doc comment for class DialogLibraryHelper

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

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

    /**
     * The Jaxon template engine
     *
     * @var TemplateEngine
     */
    protected $xTemplateEngine;

    /**
     * The name of the library
     *
     * @var string
     */
    protected $sName = '';

    /**
     * The URI where to get the library files from
     *
     * @var string
     */
    protected $sUri = '';

    /**
     * The subdir of the JS and CSS files in the CDN
     *
     * @var string
     */
    protected $sSubDir = '';

    /**
     * The default version of the plugin library
     *
     * @var string
     */
    protected $sVersion = '';

    /**
     * The constructor
     *
     * @param LibraryInterface $xDialogLibrary

Missing parameter comment

     * @param ConfigManager $xConfigManager

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     * @param TemplateEngine $xTemplateEngine

Expected 3 spaces after parameter type; 1 found

Missing parameter comment

     */
    public function __construct(LibraryInterface $xDialogLibrary,

Expected 2 blank lines before function; 1 found

        ConfigManager $xConfigManager, TemplateEngine $xTemplateEngine)
    {
        $this->xConfigManager = $xConfigManager;
        $this->xTemplateEngine = $xTemplateEngine;

        // Set the library name
        $this->sName = $xDialogLibrary->getName();
        // Set the default URI.
        $sDefaultUri = $xConfigManager->getOption('dialogs.lib.uri', $xDialogLibrary->getUri());
        // Set the library URI.
        $this->sUri = rtrim($this->getOption('uri', $sDefaultUri), '/');
        // Set the subdir
        $this->sSubDir = trim($this->getOption('subdir', $xDialogLibrary->getSubDir()), '/');
        // Set the version number
        $this->sVersion = trim($this->getOption('version', $xDialogLibrary->getVersion()), '/');
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the value of a config option
     *
     * @param string $sOptionName The option name
     * @param mixed $xDefault The default value, to be returned if the option is not defined

Expected 2 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 1 found

     *
     * @return mixed
     */
    public function getOption(string $sOptionName, $xDefault = null)
    {
        $sOptionName = 'dialogs.' . $this->sName . '.' . $sOptionName;
        return $this->xConfigManager->getOption($sOptionName, $xDefault);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Check the presence of a config option
     *
     * @param string $sOptionName The option name
     *
     * @return bool
     */
    public function hasOption(string $sOptionName): bool
    {
        $sOptionName = 'dialogs.' . $this->sName . '.' . $sOptionName;
        return $this->xConfigManager->hasOption($sOptionName);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the names of the options matching a given prefix
     *
     * @param string $sPrefix The prefix to match
     *
     * @return array
     */
    public function getOptionNames(string $sPrefix): array
    {
        // The options names are relative to the plugin in Dialogs configuration
        return $this->xConfigManager->getOptionNames('dialogs.' . $this->sName . '.' . $sPrefix);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the names of the options matching a given prefix
     *
     * @param string $sVarPrefix

Missing parameter comment

     * @param string $sKeyPrefix

Missing parameter comment

     * @param int $nSpaces

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     *
     * @return string
     */
    public function getOptionScript(string $sVarPrefix, string $sKeyPrefix, int $nSpaces = 4): string
    {
        $aOptions = $this->getOptionNames($sKeyPrefix);
        $sSpaces = str_repeat(' ', $nSpaces);
        $sScript = '';
        foreach($aOptions as $sShortName => $sFullName)
        {
            $value = $this->xConfigManager->getOption($sFullName);
            if(is_string($value))
            {
                $value = "'$value'";
            }
            elseif(is_bool($value))
            {
                $value = ($value ? 'true' : 'false');
            }
            elseif(!is_numeric($value))
            {
                $value = json_encode($value);
            }
            $sScript .= "\n" . $sSpaces . $sVarPrefix . $sShortName . ' = ' . $value . ';';
        }
        return $sScript;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the text of the "Yes" button for confirm dialog
     *
     * @return string
     */
    public function getQuestionTitle(): string
    {
        return $this->xConfigManager->getOption('dialogs.question.title', '');
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the javascript HTML header code
     *
     * @param string $sFile The javascript file name
     *
     * @return string
     */
    public function getJsCode(string $sFile): string
    {
        if($this->hasOption('assets.js'))
        {
            // If this expression evaluates to false, then the asset is not displayed.
            if(!($sUri = $this->getOption('assets.js')))

Variable assignment found within a condition. Did you mean to do a comparison ?

            {
                return '';
            }
        }
        else
        {
            $sUri = $this->sUri . '/' . ($this->sSubDir ? $this->sSubDir . '/' : '') .
                ($this->sVersion ? $this->sVersion . '/' : '') . $sFile;
        }
        return '<script type="text/javascript" src="' . $sUri . '"></script>';
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the CSS HTML header code
     *
     * @param string $sFile The CSS file name
     *
     * @return string
     */
    public function getCssCode(string $sFile): string
    {
        if($this->hasOption('assets.css'))
        {
            // If this expression evaluates to false, then the asset is not displayed.
            if(!($sUri = $this->getOption('assets.css')))

Variable assignment found within a condition. Did you mean to do a comparison ?

            {
                return '';
            }
        }
        else
        {
            $sUri = $this->sUri . '/' . ($this->sSubDir ? $this->sSubDir . '/' : '') .
                ($this->sVersion ? $this->sVersion . '/' : '') . $sFile;
        }
        return '<link rel="stylesheet" href="' . $sUri . '" />';
    }

Expected 2 blank lines after function; 1 found

    /**
     * Render a template
     *
     * @param string $sTemplate The name of template to be rendered
     * @param array $aVars The template vars

Expected 2 spaces after parameter type; 1 found

Expected 5 spaces after parameter name; 1 found

     *
     * @return string
     */
    public function render(string $sTemplate, array $aVars = []): string
    {
        // Is the library the default for alert messages?
        $isDefaultForMessage = ($this->sName == $this->xConfigManager->getOption('dialogs.default.message'));
        // Is the library the default for confirm questions?
        $isDefaultForQuestion = ($this->sName == $this->xConfigManager->getOption('dialogs.default.question'));
        $aLocalVars = [

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

            'yes' => $this->xConfigManager->getOption('dialogs.question.yes', 'Yes'),
            'no' =>  $this->xConfigManager->getOption('dialogs.question.no', 'No'),

Expected 1 space after "=>"; 2 found

            'defaultForMessage' => $isDefaultForMessage,
            'defaultForQuestion' => $isDefaultForQuestion
        ];
        return $this->xTemplateEngine->render('jaxon::dialogs::' . $sTemplate, array_merge($aLocalVars, $aVars));
    }

Expected 2 blank lines after function; 0 found

}