AppUtils\HTMLTag

Complexity

Total Complexity

34

Size/Duplication

Total Lines	244
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

24 Methods

Rating	Name	Duplication	Size	Complexity
A	getAttributes()	0	3	1
A	__toString()	0	3	1
A	name()	0	4	1
A	setSelfClosing()	0	4	1
A	id()	0	4	1
A	getSelfClosingChar()	0	8	3
A	getStyles()	0	3	1
A	create()	0	8	2
A	addText()	0	4	1
A	__construct()	0	5	1
A	isEmptyAllowed()	0	8	2
A	getGlobalOptions()	0	8	2
A	getName()	0	3	1
A	setEmptyAllowed()	0	4	1
A	setContent()	0	4	1
A	renderClose()	0	8	2
A	isEmpty()	0	3	2
A	render()	0	11	3
A	renderContent()	0	8	2
A	isSelfClosing()	0	3	1
A	src()	0	4	1
A	addHTML()	0	4	1
A	renderOpen()	0	7	1
A	href()	0	4	1

<?php
/**
 * File containing the class {@see \AppUtils\HTMLTag}.
 *
 * @package AppUtils
 * @subpackage HTML
 * @see \AppUtils\HTMLTag
 */

declare(strict_types=1);

namespace AppUtils;

use AppUtils\HTMLTag\GlobalOptions;

/**
 * Helper class for generating individual HTML tags,
 * with chainable methods.
 *
 * @package AppUtils
 * @subpackage HTML
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 *
 * @link https://github.com/Mistralys/application-utils/wiki/HTMLTag
 */
class HTMLTag implements Interface_Stringable, Interface_Stylable, Interface_Attributable, Interface_ClassableViaAttributes
{
    use Trait_ClassableViaAttributes;
    use Traits_Stylable;
    use Traits_Attributable;

    /**
     * @var AttributeCollection
     */
    public $attributes;

    /**
     * @var string
     */
    private $name;

    /**
     * @var StringBuilder
     */
    public $content;

    /**
     * @var GlobalOptions|NULL
     */
    private static $globalOptions;

    private function __construct(string $name, AttributeCollection $attributes)
    {
        $this->name = $name;
        $this->attributes = $attributes;
        $this->content = sb();
    }

    /**
     * @return string
     */
    public function getName() : string
    {
        return $this->name;
    }

    public function setSelfClosing(bool $selfClosing=true) : HTMLTag
    {
        $this->selfClosing = $selfClosing;
        return $this;
    }

    public function isSelfClosing() : bool
    {
        return $this->selfClosing;
    }

    public function setEmptyAllowed(bool $allowed=true) : HTMLTag
    {
        $this->allowEmpty = $allowed;
        return $this;
    }

    public function isEmptyAllowed() : bool
    {
        if($this->isSelfClosing())
        {
            return true;
        }

        return $this->allowEmpty;
    }

    public static function create(string $name, ?AttributeCollection $attributes=null) : HTMLTag
    {
        if($attributes === null)
        {
            $attributes = AttributeCollection::create();
        }

        return new HTMLTag($name, $attributes);
    }

    /**
     * Returns true if the tag has no content, and no attributes.
     * By default, an empty tag is not rendered.
     *
     * @return bool
     */
    public function isEmpty() : bool
    {
        return !$this->hasAttributes() && $this->renderContent() === '';
    }

    // region: Rendering

    public const SELF_CLOSE_STYLE_SLASH = 'slash';
    public const SELF_CLOSE_STYLE_NONE = 'none';

    /**
     * @var bool
     */
    private $selfClosing = false;

    /**
     * @var bool
     */
    private $allowEmpty = false;

    public function render() : string
    {
        if(!$this->isEmptyAllowed() && $this->isEmpty())
        {
            return '';
        }

        return
            $this->renderOpen().
            $this->renderContent().
            $this->renderClose();
    }

    public function renderContent() : string
    {
        if($this->selfClosing)
        {
            return '';
        }

        return (string)$this->content;
    }

    public function getSelfClosingChar() : string
    {
        if($this->selfClosing && self::getGlobalOptions()->getSelfCloseStyle() === self::SELF_CLOSE_STYLE_SLASH)
        {
            return '/';
        }

        return '';
    }

    public function renderOpen() : string
    {
        return sprintf(
            '<%s%s%s>',
            $this->name,
            $this->attributes,
            $this->getSelfClosingChar()
        );
    }

    public function renderClose() : string
    {
        if($this->selfClosing)
        {
            return '';
        }

        return sprintf('</%s>', $this->name);
    }

    // endregion

    public static function getGlobalOptions() : GlobalOptions
    {
        if(!isset(self::$globalOptions))
        {
            self::$globalOptions = new GlobalOptions();
        }

        return self::$globalOptions;
    }

    public function __toString()
    {
        return $this->render();
    }

    // region: 2) Setting / adding content

    /**
     * Adds a bit of text to the content (with an automatic space at the end).
     *
     * @param string|number|StringBuilder_Interface|NULL $content
     * @return $this
     */
    public function addText($content) : HTMLTag
    {
        $this->content->add($content);
        return $this;
    }

    /**
     * Adds a bit of HTML at the end of the content.
     *
     * @param string|number|StringBuilder_Interface|NULL $content
     * @return $this
     */
    public function addHTML($content) : HTMLTag
    {
        $this->content->html($content);
        return $this;
    }

    public function setContent($content) : HTMLTag
    {
        $this->content = sb()->add($content);
        return $this;
    }

    // endregion

    // region: 1) Setting attributes

    public function name(string $name) : HTMLTag
    {
        $this->attributes->name($name);
        return $this;
    }

    public function id(string $id) : HTMLTag
    {
        $this->attributes->id($id);
        return $this;
    }

    public function href(string $url) : HTMLTag
    {
        $this->attributes->href($url);
        return $this;
    }

    public function src(string $url) : HTMLTag
    {
        $this->attributes->attrURL('src', $url);
        return $this;
    }

    // endregion

    public function getAttributes() : AttributeCollection
    {
        return $this->attributes;
    }

    public function getStyles() : StyleCollection
    {
        return $this->attributes->getStyles();
    }
}