Jaxon\Dialogs\Dialog\AbstractLibrary

Complexity

Total Complexity

7

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getCss()	0	3	1
A	helper()	0	3	2
A	getJs()	0	3	1
A	getUri()	0	3	1
A	getScript()	0	3	1
A	getJsCode()	0	5	1

<?php

/**
 * AbstractDialogLibrary.php
 *
 * Base class for javascript dialog libraries.
 *
 * @package jaxon-core
 * @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
 */

namespace Jaxon\Dialogs\Dialog;

use Jaxon\Plugin\Code\JsCode;

use function Jaxon\Dialogs\dialog;

abstract class AbstractLibrary
{
    /**
     * The dialog library helper
     *
     * @var LibraryHelper
     */
    private $xHelper = null;

    /**
     * The css files
     *
     * @var array
     */
    protected $aCssFiles = [];

    /**
     * The js files
     *
     * @var array
     */
    protected $aJsFiles = [];

    /**
     * Get the library name
     *
     * @return string
     */
    abstract public function getName(): string;

    /**
     * Get the helper
     *
     * @return LibraryHelper
     */
    public function helper(): LibraryHelper
    {
        return $this->xHelper ?: $this->xHelper = dialog()->getLibraryHelper($this->getName());
    }

    /**
     * Get the library base URI
     *
     * @return string
     */
    public function getUri(): string
    {
        return '';
    }

    /**
     * Get the CSS header code and file includes
     *
     * @return string
     */
    public function getJs(): string
    {
        return $this->helper()->getJs($this->aJsFiles);
    }

    /**
     * Get the javascript header code and file includes
     *
     * @return string
     */
    public function getCss(): string
    {
        return $this->helper()->getCss($this->aCssFiles);
    }

    /**
     * Get the javascript code to be printed into the page
     *
     * @return string
     */
    public function getScript(): string
    {
        return '';
    }

    /**
     * Get the javascript code to be executed on page load
     *
     * @return JsCode|null
     */
    public function getJsCode(): ?JsCode
    {
        $xJsCode = new JsCode();
        $xJsCode->sJs = $this->helper()->getScript();
        return $xJsCode;
    }
}