icingaweb2-module-director/library/vendor/ipl/Html/HtmlDocument.php

<?php

namespace dipl\Html;

use Countable;
use Exception;
use InvalidArgumentException;

/**
 * Class Html
 * @package ipl\Html
 */
class HtmlDocument implements Countable, ValidHtml
{
    protected $contentSeparator = '';

    /** @var BaseHtmlElement */
    protected $wrapper;

    /** @var ValidHtml[] */
    private $content = [];

    /** @var array */
    private $contentIndex = [];

    protected $hasBeenAssembled = false;

    /**
     * @param ValidHtml|array|string $content
     * @return $this
     */
    public function add($content)
    {
        if (is_array($content)) {
            foreach ($content as $c) {
                $this->add($c);
            }
        } else {
            $this->addIndexedContent(Html::wantHtml($content));
        }

        return $this;
    }

    /**
     * @param BaseHtmlElement $wrapper
     * @return $this
     */
    public function setWrapper(BaseHtmlElement $wrapper)
    {
        $this->wrapper = $wrapper;

        return $this;
    }

    /**
     * @param BaseHtmlElement $wrapper
     * @return $this
     */
    public function addWrapper(BaseHtmlElement $wrapper)
    {
        if ($this->wrapper === null) {
            $this->setWrapper($wrapper);
        } else {
            $this->setWrapper($wrapper->wrap($this->wrapper));
        }

        return $this;
    }

    /**
     * @return HtmlDocument|null
     */
    public function getWrapper()
    {
        return $this->wrapper;
    }

    /**
     * @return bool
     */
    public function isEmpty()
    {
        return empty($this->content);
    }

    /**
     * @return int
     */
    public function count()
    {
        return count($this->content);
    }

    /**
     * @param $tag
     * @return BaseHtmlElement
     * @throws InvalidArgumentException
     */
    public function getFirst($tag)
    {
        foreach ($this->content as $c) {
            if ($c instanceof BaseHtmlElement && $c->getTag() === $tag) {
                return $c;
            }
        }

        throw new InvalidArgumentException(sprintf(
            'Trying to get first %s, but there is no such',
            $tag
        ));
    }

    /**
     * @param $content
     * @return $this
     */
    public function prepend($content)
    {
        if (is_array($content)) {
            foreach (array_reverse($content) as $c) {
                $this->prepend($c);
            }
        } else {
            $pos = 0;
            $html = Html::wantHtml($content);
            array_unshift($this->content, $html);
            $this->incrementIndexKeys();
            $this->addObjectPosition($html, $pos);
        }

        return $this;
    }

    public function remove(ValidHtml $html)
    {
        $key = spl_object_hash($html);
        if (array_key_exists($key, $this->contentIndex)) {
            foreach ($this->contentIndex[$key] as $pos) {
                unset($this->content[$pos]);
            }
        }

        $this->reIndexContent();
    }

    /**
     * @param $string
     * @return HtmlDocument
     */
    public function addPrintf($string)
    {
        $args = func_get_args();
        array_shift($args);

        return $this->add(
            new FormattedString($string, $args)
        );
    }

    /**
     * @param HtmlDocument|array|string $content
     * @return $this
     */
    public function setContent($content)
    {
        $this->content = array();
        $this->add($content);

        return $this;
    }

    /**
     * @param $separator
     * @return self
     */
    public function setSeparator($separator)
    {
        $this->contentSeparator = $separator;
        return $this;
    }

    protected function assemble()
    {
    }

    /**
     * @return string
     */
    public function render()
    {
        if ($this->wrapper === null) {
            return $this->renderUnwrapped();
        } else {
            return $this->renderWrapped();
        }
    }

    /**
     * @return string
     */
    protected function renderWrapped()
    {
        // TODO: we don't like this, but have no better solution right now.
        //       However, it works as expected, tests are green
        $wrapper = $this->wrapper;
        $this->wrapper = null;
        $result = $wrapper->renderWrappedDocument($this);
        $this->wrapper = $wrapper;

        return $result;
    }

    /**
     * @param HtmlDocument $document
     * @return string
     */
    protected function renderWrappedDocument(HtmlDocument $document)
    {
        $wrapper = clone($this);
        $wrapper->add($document);
        return $wrapper->render();
    }

    /**
     * @return $this
     */
    public function ensureAssembled()
    {
        if (! $this->hasBeenAssembled) {
            $this->hasBeenAssembled = true;
            $this->assemble();
        }

        return $this;
    }

    /**
     * @return string
     */
    public function renderUnwrapped()
    {
        $this->ensureAssembled();
        $html = [];

        foreach ($this->content as $element) {
            if (is_string($element)) {
                var_dump($this->content);
            }
            $html[] = $element->render();
        }

        return implode($this->contentSeparator, $html);
    }

    /**
     * @return string
     */
    public function __toString()
    {
        try {
            return $this->render();
        } catch (Exception $e) {
            return Error::render($e);
        }
    }

    private function reIndexContent()
    {
        $this->contentIndex = [];
        foreach ($this->content as $pos => $html) {
            $this->addObjectPosition($html, $pos);
        }
    }

    private function addObjectPosition(ValidHtml $html, $pos)
    {
        $key = spl_object_hash($html);
        if (array_key_exists($key, $this->contentIndex)) {
            $this->contentIndex[$key][] = $pos;
        } else {
            $this->contentIndex[$key] = [$pos];
        }
    }

    private function addIndexedContent(ValidHtml $html)
    {
        $pos = count($this->content);
        $this->content[$pos] = $html;
        $this->addObjectPosition($html, $pos);
    }

    private function incrementIndexKeys()
    {
        foreach ($this->contentIndex as & $index) {
            foreach ($index as & $pos) {
                $pos++;
            }
        }
    }

    /**
     * @deprecated
     *
     * return ValidHtml[]
     */
    public function getContent()
    {
        return $this->content;
    }

    public function __clone()
    {
        foreach ($this->content as $key => $element) {
            $this->content[$key] = clone($element);
        }

        $this->reIndexContent();
    }
}