LibraryHelper::getOptionScript() - Code Metrics - Inspection of "Moved the dialog options to the app section of the..." - jaxon-php/jaxon-dialogs - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 02d0e2...a48ca0 )

by Thierry

created 2025-01-09 19:00 UTC

LibraryHelper::getOptionScript() A

↳ Parent: LibraryHelper

Complexity

Conditions	6
Paths	6

Size

Total Lines	23
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	13
nc	6
nop	3
dl	0
loc	23
rs	9.2222
c	1
b	0
f	0

<?php

namespace Jaxon\Dialogs\Dialog;

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

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 LibraryHelper
{
    /**
     * The name of the library
     *
     * @var string
     */
    protected $sName = '';

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

    /**
     * The constructor
     *
     * @param LibraryInterface $xDialogLibrary
     * @param ConfigManager $xConfigManager
     * @param TemplateEngine $xTemplateEngine
     */
    public function __construct(LibraryInterface $xDialogLibrary,
        private ConfigManager $xConfigManager, private TemplateEngine $xTemplateEngine)
    {
        // Set the library name
        $this->sName = $xDialogLibrary->getName();
        // Set the default URI.
        $sDefaultUri = $xConfigManager->getAppOption('dialogs.lib.uri', $xDialogLibrary->getUri());
        // Set the library URI.
        $this->sUri = rtrim($this->getOption('uri', $sDefaultUri), '/');
    }

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

    /**
     * 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->hasAppOption($sOptionName);
    }

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

    /**
     * Get the names of the options matching a given prefix
     *
     * @param string $sVarPrefix
     * @param string $sKeyPrefix
     * @param int $nSpaces
     *
     * @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->getAppOption($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;
    }

    /**
     * @param string $sOption The assets option name
     * @param string $sFile The javascript file name
     *
     * @return string|null
     */
    private function getAssetUri(string $sOption, string $sFile): ?string
    {
        return !$this->hasOption($sOption) ? "{$this->sUri}/$sFile" :
            (trim($this->getOption($sOption)) ?: null);
            (trim(/** @scrutinizer ignore-type */ $this->getOption($sOption)) ?: null);
    }

    /**
     * Get the javascript HTML header code
     *
     * @param string $sFile The javascript file name
     *
     * @return string
     */
    public function getJsCode(string $sFile): string
    {
        // If this 'assets.js' option is defined and evaluates to false, then the asset is not displayed.
        $sUri = $this->getAssetUri('assets.js', $sFile);
        return !$sUri ? '' : '<script type="text/javascript" src="' . $sUri . '"></script>';
    }

    /**
     * Get the CSS HTML header code
     *
     * @param string $sFile The CSS file name
     *
     * @return string
     */
    public function getCssCode(string $sFile): string
    {
        // If this 'assets.css' option is defined and evaluates to false, then the asset is not displayed.
        $sUri = $this->getAssetUri('assets.css', $sFile);
        return !$sUri ? '' : '<link rel="stylesheet" href="' . $sUri . '" />';
    }

    /**
     * Render a template
     *
     * @param string $sTemplate The name of template to be rendered
     * @param array $aVars The template vars
     *
     * @return string
     */
    public function render(string $sTemplate, array $aVars = []): string
    {
        return $this->xTemplateEngine->render('jaxon::dialogs::' . $sTemplate, $aVars);
    }
}


jaxon-php / jaxon-dialogs

Push — main ( 02d0e2...a48ca0 )

LibraryHelper::getOptionScript() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like