sandrokeil / HtmlElement

src/View/Helper/HtmlElement.php

<?php
/**
 * Sake
 *
 * @link      http://github.com/sandrokeil/HtmlElement for the canonical source repository
 * @copyright Copyright (c) 2014-2017 Sandro Keil
 * @license   http://github.com/sandrokeil/HtmlElement/blob/master/LICENSE.txt New BSD License
 */

namespace Sake\HtmlElement\View\Helper;

use Zend\Escaper\Escaper;
use Zend\View\Helper\AbstractHelper;

/**
 * HtmlElement view helper
 *
 * This view helper creates a html tag object which can be configured and rendered.
 */
class HtmlElement extends AbstractHelper
{
    /**
     * Tag type e.g. div
     *
     * @var string
     */
    protected $tag;

    /**
     * Tag content
     *
     * @var string
     */
    protected $text = '';

    /**
     * Array of attribute / value pair
     *
     * @var array
     */
    protected $attributes = array();

    /**
     * Escape html
     *
     * @var bool
     */
    protected $renderHtml = false;

    /**
     * List of self closing tags for valid html
     *
     * @var array
     */
    protected $singletonTags = array(
        'area',
        'base',
        'br',
        'col',
        'command',
        'embed',
        'hr',
        'img',
        'input',
        'keygen',
        'link',
        'meta',
        'param',
        'source',
        'track',
        'wbr',
    );

    /**
     * Html/text escaper
     *
     * @var Escaper
     */
    protected $escaper;

    /**
     * Should be html attributes escaped
     *
     * @var bool
     */
    protected $escapeHtmlAttribute = true;

    /**
     * Should be text escaped
     *
     * @var bool
     */
    protected $escapeText = true;

    /**
     * Create html object with provided settings.
     *
     * @param string $tag Html tag
     * @param string $text Html content
     * @param array $attributes Html attributes
     * @param bool $renderHtml Escape html
     * @return HtmlElement
     */
    public function __invoke($tag, $text = '', array $attributes = array(), $renderHtml = false)
    {
        $html = clone $this;

        $html->setTag($tag);
        $html->setText($text);
        $html->setAttributes($attributes);
        $html->enableHtml($renderHtml);
        return $html;
    }

    /**
     * Renders element. Triggers an error instead of throw an exception, because it is not allowed here.
     *
     * @return string
     */
    public function __toString()
    {
        try {
            $html = $this->render();
        } catch (\Exception $exception) {
            trigger_error($exception, E_USER_WARNING);
            $html = '';
        }
        return $html;
    }

    /**
     * Alias for __toString
     *
     * @return string
     */
    public function toString()
    {
        return $this->__toString();
    }

    /**
     * Returns tag
     *
     * @return string
     */
    public function getTag()
    {
        return $this->tag;
    }

    /**
     * Returns the current text (content) of tag
     *
     * @return string
     */
    public function getText()
    {
        return $this->text;
    }

    /**
     * Returns an array of html attribute / value pair for the current html element
     *
     * @return array
     */
    public function getAttributes()
    {
        return $this->attributes;
    }

    /**
     * Sets an array of html attributes / value pair
     *
     * @param array $attributes Html attributes
     * @return HtmlElement
     */
    public function setAttributes(array $attributes)
    {
        $this->attributes = $attributes;
        return $this;
    }

    /**
     * Sets html tag
     *
     * @param string $tag
     * @return HtmlElement
     */
    public function setTag($tag)
    {
        $this->tag = (string) $tag;
        return $this;
    }

    /**
     * Sets tag text (content)
     *
     * @param string $text
     * @return HtmlElement
     */
    public function setText($text)
    {
        $this->text = (string) $text;
        return $this;
    }

    /**
     * Appends text
     *
     * @param string $text
     * @return HtmlElement
     */
    public function appendText($text)
    {
        $this->text .= (string) $text;
        return $this;
    }

    /**
     * Returns css classes
     *
     * @return string
     */
    public function getClass()
    {
        return isset($this->attributes['class']) ? $this->attributes['class'] : '';
    }

    /**
     * Sets a css class for current element. This method overrides all existing css classes. To append css classes
     * use appendClass()
     *
     * @param string $class Css class
     * @return HtmlElement
     */
    public function setClass($class)
    {
        $this->attributes['class'] = $class;
        return $this;
    }

    /**
     * Appends a css class to current element.
     *
     * @param string $class Css class
     * @return HtmlElement
     */
    public function appendClass($class)
    {
        if (!isset($this->attributes['class'])) {
            $this->attributes['class'] = '';
        } else {
            $this->attributes['class'] .= ' ';
        }
        $this->attributes['class'] .= (string) $class;
        return $this;
    }

    /**
     * Returns id attribute of current element
     *
     * @return string
     */
    public function getId()
    {
        return isset($this->attributes['id']) ? $this->attributes['id'] : '';
    }

    /**
     * Sets id attribute for current element
     *
     * @param string $id Name
     * @return HtmlElement
     */
    public function setId($id)
    {
        $this->attributes['id'] = (string) $id;
        return $this;
    }

    /**
     * Return true or false to indicate escaping of text
     *
     * @return bool
     */
    public function useHtml()
    {
        return $this->renderHtml;
    }

    /**
     * Turn on / off html rendering text
     *
     * @param bool $renderHtml Render html or escape content
     * @return HtmlElement
     */
    public function enableHtml($renderHtml)
    {
        $this->renderHtml = (bool) $renderHtml;
        return $this;
    }

    /**
     * Builds html attributes
     *
     * @return string
     */
    protected function buildAttributes()
    {
        $attributes = '';

        foreach ($this->attributes as $key => $value) {
            $attributes .= ' ' . $key . '="' . $this->escapeHtmlAttribute($value) . '"';
        }
        return $attributes;
    }

    /**
     * Renders html element
     *
     * @return string
     */
    public function render()
    {
        if (in_array($this->tag, $this->singletonTags)) {
            // strict html 5 is omitted for backward compatibility, html 5 is still valid
            return '<' . $this->tag . $this->buildAttributes() . ' />';
        }

        if (false === $this->renderHtml) {
            $text = $this->escapeText($this->text);
        } else {
            $text = $this->text;
        }
        return '<' . $this->tag . $this->buildAttributes() . '>' . $text . '</' . $this->tag . '>';
    }

    /**
     * Returns if html attributes should be escaped
     *
     * @return boolean
     */
    public function isEscapeHtmlAttribute()
    {
        return $this->escapeHtmlAttribute;
    }

    /**
     * Enable/disable escaping of html attributes
     *
     * @param boolean $escapeHtmlAttributes
     * @return HtmlElement
     */
    public function setEscapeHtmlAttribute($escapeHtmlAttributes)
    {
        $this->escapeHtmlAttribute = (bool) $escapeHtmlAttributes;
        return $this;
    }

    /**
     * Returns if text should be escaped
     *
     * @return boolean
     */
    public function isEscapeText()
    {
        return $this->escapeText;
    }

    /**
     * Enable/disable escaping of text
     *
     * @param boolean $escapeText
     * @return HtmlElement
     */
    public function setEscapeText($escapeText)
    {
        $this->escapeText = (bool) $escapeText;
        return $this;
    }

    /**
     * Returns escaper for html attributes, if no one is set, escaper of view will be used
     *
     * @return string
     */
    protected function escapeHtmlAttribute($value)
    {
        if (false === $this->escapeHtmlAttribute) {
            return $value;
        }
        return $this->getEscaper()->escapeHtmlAttr($value);
    }

    /**
     * Returns escaper for html, if no one is set, escaper of view will be used
     *
     * @return string
     */
    protected function escapeText($value)
    {
        if (false === $this->escapeText) {
            return $value;
        }
        return $this->getEscaper()->escapeHtml($value);
    }

    /**
     * Sets escaper for html
     *
     * @param Escaper $helperEscapeHtml
     * @return HtmlElement
     */
    public function setEscaper(Escaper $helperEscapeHtml)
    {
        $this->escaper = $helperEscapeHtml;
        return $this;
    }

    /**
     * Returns escaper for html, if no one is set, lazy loads escaper from view
     *
     * @return Escaper
     */
    protected function getEscaper()
    {
        if (null === $this->escaper) {
            $this->escaper = $this->getView()->plugin('escapehtml')->getEscaper();

It seems like you code against a concrete implementation and not the interface Zend\View\Renderer\RendererInterface as the method plugin() does only exist in the following implementations of said interface: Zend\View\Renderer\PhpRenderer.

        }
        return $this->escaper;
    }
}