archived-phd/phpdotnet/phd/Format/Abstract/XHTML.php

<?php
namespace phpdotnet\phd;

abstract class Format_Abstract_XHTML extends Format {

    /** @var array<?string> Last In First Out stack of roles */
    private array $role = [];

    /** @var array<?string> Last In First Out stack of annotations */
    private array $annotations = [];

    /* XHTMLPhDFormat */
    protected $openPara = 0;
    protected $escapedPara = array();

    /* PhDThemeXhtml */
    protected $mediamanager = null;
    protected $lang = 'en';

    public function __construct(
        Config $config,
        OutputHandler $outputHandler
    ) {
        parent::__construct($config, $outputHandler);
    }

    public function transformFromMap($open, $tag, $name, $attrs, $props) {
        if ($open) {
            $idstr = "";
            if (isset($attrs[Reader::XMLNS_XML]["id"])) {
                $id = $attrs[Reader::XMLNS_XML]["id"];
                $idstr = ' id="' .$id. '"';
            }
            return '<' .$tag. ' class="' .$name. '"' . $idstr . ($props["empty"] ? '/' : "") . '>';
        }
        return '</' .$tag. '>';
    }

    public function TEXT($value) {
        return htmlspecialchars($value, ENT_QUOTES, "UTF-8");
    }

    public function UNDEF($open, $name, $attrs, $props) {
        if ($open) {
            trigger_error("No mapper found for '{$name}'", E_USER_WARNING);
        }
    }

    public function CDATA($value) {
        $annotations = $this->getAnnotations();
        $annotationsStr = '';
        if (count($annotations) > 0) {
            $annotationsStr = 'annotation-' . join(' annotation-', $annotations) . ' ';
        }

        switch($this->getRole()) {
        case '':
            return '<div class="' . $annotationsStr . 'cdata"><pre>'
                . htmlspecialchars($value, ENT_QUOTES, "UTF-8")
                . '</pre></div>';
        default:
            return '<div class="' . $annotationsStr . $this->getRole() . 'code' . '">'
                . $this->highlight(trim($value), $this->getRole(), 'xhtml')
                . '</div>';
        }
    }

    /* Functions from PhDThemeXhtml */

    /**
    * Called after the constructor finished.
    * This is needed since themes set their outputdir and outputfile
    * in the constructor. That file/dir is used for mediamanager.
    * That means we cannot instantiate and complete the manager in our
    * constructor centrally.
    *
    * Each theme needs its own media manager, since the manager contains
    * the output path.
    *
    * @return void
    */
    public function postConstruct() {
        $this->mediamanager = new MediaManager($this->config->xmlRoot);
        $outputdir = $this->getOutputDir();
        if (isset($outputdir) && $outputdir) {
            $this->mediamanager->output_dir = $outputdir;
        } else {
            $this->mediamanager->output_dir        = $this->config->outputDir . '/' . strtolower($this->getFormatName()) . '-data/';
            $this->mediamanager->relative_ref_path = basename($this->mediamanager->output_dir) . '/';
        }
    }


    /* Functions from XHTMLPhDFormat */

    /**
    * Closes a para tag when we are already in a paragraph.
    *
    * @return string HTML code
    *
    * @see $openPara
    * @see restorePara()
    */
    public function escapePara() {
        if (!$this->openPara) {
            return '';
        }

        if (!isset($this->escapedPara[$this->openPara])) {
            $this->escapedPara[$this->openPara] = 1;
            return '</p>';
        } else {
            ++$this->escapedPara[$this->openPara];
            return '';
        }
    }

    /**
    * Opens a para tag again when we escaped one before.
    *
    * @return string HTML code
    *
    * @see $openPara
    * @see escapePara()
    */
    public function restorePara() {
        if (!$this->openPara || !isset($this->escapedPara[$this->openPara])) {
            return '';
        }

        if ($this->escapedPara[$this->openPara] == 1) {
            unset($this->escapedPara[$this->openPara]);
            return '<p>';
        } else {
            --$this->escapedPara[$this->openPara];
            return '';
        }
    }

    protected function pushRole(?string $role): void {
        $this->role[] = $role;
    }

    protected function getRole(): ?string {
        return end($this->role);
    }

    protected function popRole(): ?string {
        return array_pop($this->role);
    }

    protected function pushAnnotations(?string $annotations): void {
        $this->annotations[] = ($annotations != null ? explode(' ', $annotations) : []);
    }

    protected function getAnnotations() : ?array {
        $top = end($this->annotations);
        if ($top === false) {
            $top = [];
        }
        return $top;
    }

    protected function popAnnotations() : ?array {
        return array_pop($this->annotations);
    }
}