class.ilXmlWriter.php

Go to the documentation of this file.

<?php
class ilXmlWriter
{
    private string $xmlStr;

    private string $version;

    private string $outEnc;

    private string $inEnc;

    private string $dtdDef = "";

    private string $stSheet = "";

    private string $genCmt = "Generated by ILIAS XmlWriter";

    public function __construct(
        string $version = "1.0",
        string $outEnc = "utf-8",
        string $inEnc = "utf-8"
    ) {
        // initialize xml string
        $this->xmlStr = "";

        // set properties
        $this->version = $version;
        $this->outEnc = $outEnc;
        $this->inEnc = $inEnc;
    }

    public function xmlSetDtdDef(string $dtdDef): void
    {
        $this->dtdDef = $dtdDef;
    }

    private function xmlSetStSheet(string $stSheet): void
    {
        $this->stSheet = $stSheet;
    }

    public function xmlSetGenCmt(string $genCmt): void
    {
        $this->genCmt = $genCmt;
    }

    private function xmlEscapeData(string $data): string
    {
        $position = 0;
        $length = strlen($data);
        $escapedData = "";

        for (; $position < $length;) {
            $character = substr($data, $position, 1);
            $code = Ord($character);

            switch ($code) {
                case 34:
                    $character = "&quot;";
                    break;

                case 38:
                    $character = "&amp;";
                    break;

                case 39:
                    $character = "&apos;";
                    break;

                case 60:
                    $character = "&lt;";
                    break;

                case 62:
                    $character = "&gt;";
                    break;

                default:
                    if ($code < 32) {
                        $character = ("&#" . $code . ";");
                    }
                    break;
            }

            $escapedData .= $character;
            $position++;
        }
        return $escapedData;
    }

    private function xmlEncodeData(string $data): string
    {
        if ($this->inEnc == $this->outEnc) {
            $encodedData = $data;
        } else {
            throw new ilException(
                'Differing in and out-encodings are not supported.'
            );
        }
        return $encodedData;
    }

    public function xmlFormatData(string $data): ?string
    {
        // regular expression for tags
        $formatedXml = preg_replace_callback(
            "|<[^>]*>[^<]*|",
            [$this, "xmlFormatElement"],
            $data
        );

        return $formatedXml;
    }

    private function xmlFormatElement(array $array): string
    {
        $found = trim($array[0]);

        static $indent;

        // linebreak (default)
        $nl = "\n";

        $tab = str_repeat(" ", $indent * 2);

        // closing tag
        if (substr($found, 0, 2) == "</") {
            if ($indent) {
                $indent--;
            }
            $tab = str_repeat(" ", $indent * 2);
        } elseif (substr(
            $found,
            -2,
            1
        ) == "/" or // opening and closing, comment, ...
            strpos($found, "/>") or
            substr($found, 0, 2) == "<!") {
            // do not change indent
        } elseif (substr($found, 0, 2) == "<?") {
            // do not change indent
            // no linebreak
            $nl = "";
        } else { // opening tag
            $indent++;
        }

        // content
        if (substr($found, -1) != ">") {
            $found = str_replace(
                ">",
                ">\n" . str_repeat(" ", ($indent + 0) * 2),
                $found
            );
        }

        return $nl . $tab . $found;
    }

    public function xmlHeader(): void
    {
        // version and encoding
        $this->xmlStr .= "<?xml version=\"" . $this->version . "\" encoding=\"" . $this->outEnc . "\"?>";

        // dtd definition
        if ($this->dtdDef <> "") {
            $this->xmlStr .= $this->dtdDef;
        }

        // stSheet
        if ($this->stSheet <> "") {
            $this->xmlStr .= $this->stSheet;
        }

        // generated comment
        if ($this->genCmt <> "") {
            $this->xmlComment($this->genCmt);
        }
    }

    public function xmlStartTag(
        string $tag,
        ?array $attrs = null,
        bool $empty = false,
        bool $encode = true,
        bool $escape = true
    ): void {
        // write first part of the starttag
        $this->xmlStr .= "<" . $tag;

        // check for existing attributes
        if (is_array($attrs)) {
            // write attributes
            foreach ($attrs as $name => $value) {
                if ($value === null) {
                    $value = '';
                }

                // encode
                if ($encode) {
                    $value = $this->xmlEncodeData($value);
                }

                // escape
                if ($escape) {
                    $value = $this->xmlEscapeData($value);
                }

                $this->xmlStr .= " " . $name . "=\"" . $value . "\"";
            }
        }

        // write last part of the starttag
        if ($empty) {
            $this->xmlStr .= "/>";
        } else {
            $this->xmlStr .= ">";
        }
    }

    public function xmlEndTag(string $tag): void
    {
        $this->xmlStr .= "</" . $tag . ">";
    }

    private function xmlComment(string $comment): void
    {
        $this->xmlStr .= "<!--" . $comment . "-->";
    }

    public function xmlData(
        string $data,
        bool $encode = true,
        bool $escape = true
    ): void {
        // encode
        if ($encode) {
            $data = $this->xmlEncodeData($data);
        }

        // escape
        if ($escape) {
            $data = $this->xmlEscapeData($data);
        }

        $this->xmlStr .= $data;
    }

    public function xmlElement(
        string $tag,
        $attrs = null,
        $data = null,
        $encode = true,
        $escape = true
    ): void {
        // check for existing data (element's content)
        if (is_string($data) or
            is_integer($data) or
            is_float($data)) {
            // write starttag
            $this->xmlStartTag($tag, $attrs, false, $encode, $escape);

            // write text
            $this->xmlData($data, $encode, $escape);

            // write endtag
            $this->xmlEndTag($tag);
        } else { // no data
            // write starttag (= empty tag)
            $this->xmlStartTag($tag, $attrs, true, $encode, $escape);
        }
    }

    public function xmlDumpFile(string $file, bool $format = true): void
    {
        // open file
        if (!($fp = fopen($file, "w+"))) {
            throw new RuntimeException(
                "<b>Error</b>: Could not open \"" . $file . "\" for writing" .
                " in <b>" . __FILE__ . "</b> on line <b>" . __LINE__ . "</b><br />"
            );
        }

        // set file permissions
        chmod($file, 0770);

        // format xml data
        if ($format) {
            $xmlStr = $this->xmlFormatData($this->xmlStr);
        } else {
            $xmlStr = $this->xmlStr;
        }

        // write xml data into the file
        fwrite($fp, $xmlStr);

        // close file
        fclose($fp);
    }

    public function xmlDumpMem(bool $format = true): string
    {
        // format xml data
        if ($format) {
            $xmlStr = $this->xmlFormatData($this->xmlStr);
        } else {
            $xmlStr = $this->xmlStr;
        }

        return $xmlStr;
    }

    public function appendXML(string $a_str): void
    {
        $this->xmlStr .= $a_str;
    }

    public function xmlClear(): void
    {
        // reset xml string
        $this->xmlStr = "";
    }
}