class.ContentIdManager.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\COPage\ID;

use ILIAS\COPage\Dom\DomUtil;

class ContentIdManager
{
    protected const ID_ELEMENTS =
        ["PageContent",
         "TableRow",
         "TableData",
         "ListItem",
         "FileItem",
         "Section",
         "Tab",
         "ContentPopup",
         "GridCell"];

    protected array $hier_ids = [];
    protected \ilPageObject $page;
    protected DomUtil $dom_util;
    protected ContentIdGenerator $generator;

    public function __construct(
        \ilPageObject $page,
        ContentIdGeneratorInterface $generator = null
    ) {
        global $DIC;

        $this->dom_util = $DIC->copage()
            ->internal()
            ->domain()
            ->domUtil();
        $this->page = $page;
        $this->generator = $generator ?? $DIC->copage()
            ->internal()
            ->domain()
            ->contentIdGenerator();
    }

    public function addHierIDsToDom(): void
    {
        $this->hier_ids = [];
        $dom = $this->page->getDomDoc();

        $sep = $path = "";
        foreach (self::ID_ELEMENTS as $el) {
            $path .= $sep . "//" . $el;
            $sep = " | ";
        }

        $nodes = $this->dom_util->path($dom, $path);

        foreach ($nodes as $node) {
            $cnode = $node;
            $ctag = $cnode->nodeName;

            // get hierarchical id of previous sibling
            $sib_hier_id = "";
            while ($cnode = $cnode->previousSibling) {
                if (($cnode->nodeType == XML_ELEMENT_NODE)
                    && $cnode->hasAttribute("HierId")) {
                    $sib_hier_id = $cnode->getAttribute("HierId");
                    break;
                }
            }

            if ($sib_hier_id != "") {        // set id to sibling id "+ 1"
                $node_hier_id = $this->incEdId($sib_hier_id);
                $node->setAttribute("HierId", $node_hier_id);
                $this->hier_ids[] = $node_hier_id;
            } else {                        // no sibling -> node is first child
                // get hierarchical id of next parent
                $cnode = $node;
                $par_hier_id = "";
                while ($cnode = $cnode->parentNode) {
                    if (($cnode->nodeType == XML_ELEMENT_NODE)
                        && $cnode->hasAttribute("HierId")) {
                        $par_hier_id = $cnode->getAttribute("HierId");
                        break;
                    }
                }
                if (($par_hier_id != "") && ($par_hier_id != "pg")) {        // set id to parent_id."_1"
                    $node_hier_id = $par_hier_id . "_1";
                    $node->setAttribute("HierId", $node_hier_id);
                    $this->hier_ids[] = $node_hier_id;
                } else {        // no sibling, no parent -> first node
                    $node_hier_id = "1";
                    $node->setAttribute("HierId", $node_hier_id);
                    $this->hier_ids[] = $node_hier_id;
                }
            }
        }

        // set special hierarchical id "pg" for pageobject
        $path = "//PageObject";
        $nodes = $this->dom_util->path($dom, $path);
        foreach ($nodes as $node) {
            $node->setAttribute("HierId", "pg");
            $this->hier_ids[] = "pg";
        }
    }

    public function getHierIds(): array
    {
        return $this->hier_ids;
    }

    public function stripHierIDsFromDom(): void
    {
        $this->hier_ids = [];
        $dom = $this->page->getDomDoc();

        if (is_object($dom)) {
            $path = "//*[@HierId]";
            $nodes = $this->dom_util->path($dom, $path);
            foreach ($nodes as $node) {
                if ($node->hasAttribute("HierId")) {
                    $node->removeAttribute("HierId");
                }
            }
        }
    }


    protected function incEdId(string $ed_id): string
    {
        $id = explode("_", $ed_id);
        $id[count($id) - 1]++;
        return implode("_", $id);
    }

    protected function decEdId(string $ed_id): string
    {
        $id = explode("_", $ed_id);
        $id[count($id) - 1]--;
        return implode("_", $id);
    }

    public function generatePCId(): string
    {
        return $this->generator->generate();
    }

    public function insertPCIds(): void
    {
        $this->page->buildDom();
        $dom = $this->page->getDomDoc();

        // add missing ones
        $sep = $path = "";
        foreach (self::ID_ELEMENTS as $el) {
            $path .= $sep . "//" . $el . "[not(@PCID)]";
            $sep = " | ";
            $path .= $sep . "//" . $el . "[@PCID='']";
            $sep = " | ";
        }
        $nodes = $this->dom_util->path($dom, $path);
        foreach ($nodes as $node) {
            $id = $this->generatePCId();
            $node->setAttribute("PCID", $id);
        }
    }

    public function getDuplicatePCIds(): array
    {
        $this->page->buildDom();
        $dom = $this->page->getDomDoc();

        $pcids = [];
        $duplicates = [];

        $sep = $path = "";
        foreach (self::ID_ELEMENTS as $el) {
            $path .= $sep . "//" . $el . "[@PCID]";
            $sep = " | ";
        }

        // get existing ids
        $nodes = $this->dom_util->path($dom, $path);
        foreach ($nodes as $node) {
            $pc_id = $node->getAttribute("PCID");
            if ($pc_id != "") {
                if (isset($pcids[$pc_id])) {
                    $duplicates[] = $pc_id;
                }
                $pcids[$pc_id] = $pc_id;
            }
        }
        return $duplicates;
    }

    public function hasDuplicatePCIds(): bool
    {
        $duplicates = $this->getDuplicatePCIds();
        return count($duplicates) > 0;
    }

    public function stripPCIDs(): void
    {
        $dom = $this->page->getDomDoc();
        if (is_object($dom)) {
            $path = "//*[@PCID]";
            $nodes = $this->dom_util->path($dom, $path);
            foreach ($nodes as $node) {
                if ($node->hasAttribute("PCID")) {
                    $node->removeAttribute("PCID");
                }
            }
        }
    }

    public function checkPCIds(): bool
    {
        $page = $this->page;
        $page->buildDom();
        $dom = $page->getDomDoc();

        $sep = $path = "";
        foreach (self::ID_ELEMENTS as $el) {
            $path .= $sep . "//" . $el . "[not(@PCID)]";
            $sep = " | ";
            $path .= $sep . "//" . $el . "[@PCID='']";
        }
        $nodes = $this->dom_util->path($dom, $path);
        if (count($nodes) > 0) {
            return false;
        }
        return true;
    }

    public function getAllPCIds(): array
    {
        $page = $this->page;
        $page->buildDom();
        $dom = $page->getDomDoc();

        $pcids = array();

        $sep = $path = "";
        foreach (self::ID_ELEMENTS as $el) {
            $path .= $sep . "//" . $el . "[@PCID]";
            $sep = " | ";
        }

        // get existing ids
        $nodes = $this->dom_util->path($dom, $path);
        foreach ($nodes as $node) {
            $pcids[] = $node->getAttribute("PCID");
        }
        return $pcids;
    }


    public function getHierIdsForPCIds(array $a_pc_ids): array
    {
        if (!is_array($a_pc_ids) || count($a_pc_ids) == 0) {
            return array();
        }
        $ret = array();

        $dom = $this->page->getDomDoc();
        if (is_object($dom)) {
            $path = "//*[@PCID]";
            $nodes = $this->dom_util->path($dom, $path);
            foreach ($nodes as $node) {
                $pc_id = $node->getAttribute("PCID");
                if (in_array($pc_id, $a_pc_ids)) {
                    $ret[$pc_id] = $node->getAttribute("HierId");
                }
            }
        }
        return $ret;
    }

    public function getHierIdForPcId(string $pcid): string
    {
        $hier_ids = $this->getHierIdsForPCIds([$pcid]);
        return $hier_ids[$pcid] ?? "";
    }

    public function getPCIdsForHierIds(array $hier_ids): array
    {
        $page = $this->page;
        $dom = $page->getDomDoc();
        if (!is_array($hier_ids) || count($hier_ids) == 0) {
            return [];
        }
        $ret = [];
        if (is_object($dom)) {
            $page->addHierIDs();
            $path = "//*[@HierId]";
            $nodes = $this->dom_util->path($dom, $path);
            foreach ($nodes as $node) {
                $hier_id = $node->getAttribute("HierId");
                if (in_array($hier_id, $hier_ids)) {
                    $ret[$hier_id] = $node->getAttribute("PCID");
                }
            }
        }
        return $ret;
    }

    public function getPCIdForHierId(string $hier_id): string
    {
        $hier_ids = $this->getPCIdsForHierIds([$hier_id]);
        return ($hier_ids[$hier_id] ?? "");
    }
}