kitodo / kitodo-publication

Classes/Services/XPathXMLGenerator.php

<?php
namespace EWW\Dpf\Services;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

/**
 * Class XPathXMLGenerator
 * Generates XML elements for a given xpath
 * Notice: Not all sytax from the original xpath is implemented
 */
class XPathXMLGenerator
{
    protected $regex = '/[a-zA-Z:]+|[<=>]|[@][a-zA-Z][a-zA-Z0-9_\-\:\.]*|\[|\'.*?\'|".*?"|\]|\//';

    private $xmlWriter;

    public function __construct()
    {
        $this->xmlWriter = new \XMLWriter();
        $this->xmlWriter->openMemory();
    }

    function replaceLineBreaks($string) {

It is generally recommended to explicitly declare the visibility for methods.

        return str_replace("\n", "%%nl%%", $string);
    }

    function undoReplaceLineBreaks($string) {

It is generally recommended to explicitly declare the visibility for methods.

        return str_replace("%%nl%%", "\n", $string);
    }

    function generateXmlFromXPath($xpath)

It is generally recommended to explicitly declare the visibility for methods.

    {
        // split xpath to find predicates, attributes and texts
        preg_match_all($this->regex, $this->replaceLineBreaks($xpath), $matches);
        $i = 0;
        $predicateStack = 0;
        $tokenStack = 0;
        $insidePredicate = false;
        $predicateString = "";
        $loopStack = array();

        foreach ($matches[0] as $key => $value) {
            $firstChar = substr($value, 0, 1);

            if ($firstChar === '[' || $insidePredicate) {
                // get corresponding bracket
                $insidePredicate = true;

                $predicateString .= $value;

                if ($value === "]") {
                    $predicateStack--;

                    if ($predicateStack === 0) {
                        // corresponding bracket found
                        $insidePredicate = false;

                        if (!empty($predicateString)) {
                            // recursive call with predicate string
                            $this->generateXmlFromXPath(trim($predicateString, "[]"));
                            $predicateString = "";
                        }
                    }
                } else if ($value === "[") {
                    $predicateStack++;
                }

            } else if ($firstChar === '@') {
                // attribute found
                $this->startAttribute(substr($value, 1, strlen($value)));
                $loopStack[] = 'attribute';

            } else if ($firstChar === '"' || $firstChar === "'") {
                // string found
                $this->setText(trim($this->undoReplaceLineBreaks($value), "'\""));
            } else if ($firstChar === ']') {
                $this->endAttribute();
                array_pop($loopStack);
                $predicateStack--;
            } else if ($firstChar !== '=' && $firstChar !== '[' && $firstChar !== '@' && $firstChar !== '/' && $firstChar!== '.') {
                $this->startToken($value);
                $loopStack[] = 'token';
                if ($predicateStack > 0) {
                    $tokenStack++;
                }
            }
            $i++;
        }

        // end all open token and attributes in stacked order
        foreach (array_reverse($loopStack) as $key => $value) {
            if ($value === "attribute") {
                $this->endAttribute();
            } else if ($value === "token") {
                $this->endToken();
            }
        }
        $this->stack = array();

The property stack does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * @param $value
     * Starts an XML element
     * <$value>
     */
    function startToken($value)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->xmlWriter->startElement($value);
    }

    /**
     * Ends the last token
     */
    function endToken()

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->xmlWriter->endElement();
    }

    /**
     * @param $value
     * Adds content to an XML element or attribute
     * <mods:mods>$value</mods:mods>
     */
    function setText($value)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->xmlWriter->text($value);
    }

    /**
     * @param $name
     * @param $value
     * It adds an attribute with name and value to an XML element
     * <mods:mods $name=$value>
     */
    function addAttribute($name, $value)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->xmlWriter->writeAttribute($name, $value);
    }

    /**
     * @param $name
     * Starts an attribute
     */
    function startAttribute($name)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->xmlWriter->startAttribute($name);
    }

    /**
     * Ends the last started attribute
     */
    function endAttribute()

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->xmlWriter->endAttribute();
    }

    /**
     * @return string
     * Returns the created XML
     */
    function getXML()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->xmlWriter->outputMemory();
    }
}