TagBuilder.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Fluid\Core\ViewHelper;

/*                                                                        *
 * This script is backported from the TYPO3 Flow package "TYPO3.Fluid".   *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License, either version 3   *
 *  of the License, or (at your option) any later version.                *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */

class TagBuilder {

    protected $tagName = '';

    protected $content = '';

    protected $attributes = array();

    protected $forceClosingTag = FALSE;

    public function __construct($tagName = '', $tagContent = '') {
        $this->setTagName($tagName);
        $this->setContent($tagContent);
    }

    public function setTagName($tagName) {
        $this->tagName = $tagName;
    }

    public function getTagName() {
        return $this->tagName;
    }

    public function setContent($tagContent) {
        $this->content = $tagContent;
    }

    public function getContent() {
        return $this->content;
    }

    public function hasContent() {
        if ($this->content === NULL) {
            return FALSE;
        }
        return $this->content !== '';
    }

    public function forceClosingTag($forceClosingTag) {
        $this->forceClosingTag = $forceClosingTag;
    }

    public function hasAttribute($attributeName) {
        return array_key_exists($attributeName, $this->attributes);
    }

    public function getAttribute($attributeName) {
        if (!$this->hasAttribute($attributeName)) {
            return NULL;
        }
        return $this->attributes[$attributeName];
    }

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

    public function addAttribute($attributeName, $attributeValue, $escapeSpecialCharacters = TRUE) {
        if ($escapeSpecialCharacters) {
            $attributeValue = htmlspecialchars($attributeValue);
        }
        $this->attributes[$attributeName] = $attributeValue;
    }

    public function addAttributes(array $attributes, $escapeSpecialCharacters = TRUE) {
        foreach ($attributes as $attributeName => $attributeValue) {
            $this->addAttribute($attributeName, $attributeValue, $escapeSpecialCharacters);
        }
    }

    public function removeAttribute($attributeName) {
        unset($this->attributes[$attributeName]);
    }

    public function reset() {
        $this->tagName = '';
        $this->content = '';
        $this->attributes = array();
        $this->forceClosingTag = FALSE;
    }

    public function render() {
        if (empty($this->tagName)) {
            return '';
        }
        $output = '<' . $this->tagName;
        foreach ($this->attributes as $attributeName => $attributeValue) {
            $output .= ' ' . $attributeName . '="' . $attributeValue . '"';
        }
        if ($this->hasContent() || $this->forceClosingTag) {
            $output .= '>' . $this->content . '</' . $this->tagName . '>';
        } else {
            $output .= ' />';
        }
        return $output;
    }
}