Jaxon\Plugin\AbstractPackage

Complexity

Total Complexity

8

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getConfig()	0	3	1
A	init()	0	2	1
A	getHtml()	0	3	1
A	html()	0	3	1
A	getHash()	0	4	1
A	getOption()	0	3	1
A	view()	0	3	1
A	getReadyScript()	0	3	1

<?php

/**
 * AbstractPackage.php
 *
 * Base class for the Jaxon packages.
 *
 * @package jaxon-core
 * @author 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-core
 */

namespace Jaxon\Plugin;

use Jaxon\App\View\ViewRenderer;
use Jaxon\Config\Config;
use Stringable;

abstract class AbstractPackage extends AbstractCodeGenerator
{
    /**
     * The configuration options of the package
     *
     * @var Config
     */
    protected $xPkgConfig;

    /**
     * The view renderer
     *
     * @var ViewRenderer
     */
    protected $xRenderer;

    /**
     * Get the path to the config file, or the config options in an array.
     *
     * @return string|array
     */
    abstract public static function config(): string|array;

    /**
     * Get the package config object
     *
     * @return Config
     */
    final public function getConfig(): Config
    {
        return $this->xPkgConfig;
    }

    /**
     * This method is automatically called after the package instance is created and configured.
     *
     * @return void
     */
    protected function init(): void
    {}

    /**
     * Get the value of a given package option
     *
     * @param string $sOption    The option name
     * @param mixed $xDefault    The default value
     *
     * @return mixed
     */
    final public function getOption(string $sOption, $xDefault = null): mixed
    {
        return $this->xPkgConfig->getOption($sOption, $xDefault);
    }

    /**
     * Get the view renderer
     *
     * @return ViewRenderer
     */
    final public function view(): ViewRenderer
    {
        return $this->xRenderer;
    }

    /**
     * @inheritDoc
     */
    final public function getHash(): string
    {
        // Packages do not generate hash on their own. So we make this method final.
        return '';
    }

    /**
     * Get the HTML code of the package home page
     *
     * @return string|Stringable
     */
    public function getHtml(): string|Stringable
    {
        return '';
    }

    /**
     * Get the HTML code of the package home page
     *
     * This method is an alias for getHtml().
     *
     * @return string|Stringable
     */
    public function html(): string|Stringable
    {
        return $this->getHtml();
    }

    /**
     * Get the Js code of the ready() callback
     *
     * @return string|Stringable
     */
    public function getReadyScript(): string|Stringable
    {
        return '';
    }
}