Collaboration diagram for ILIAS\COPage\ID\ContentIdManager:

Public Member Functions
	__construct (\ilPageObject $page, ?ContentIdGeneratorInterface $generator=null)

	addHierIDsToDom ()
	Add hierarchical ID (e.g. More...

	getHierIds ()
	get all hierarchical ids More...

	stripHierIDsFromDom ()

	generatePCId ()

	insertPCIds ()

	getDuplicatePCIds ()

	hasDuplicatePCIds ()

	stripPCIDs ()

	checkPCIds ()

	getAllPCIds ()

	getHierIdsForPCIds (array $a_pc_ids)

	getHierIdForPcId (string $pcid)

	getPCIdsForHierIds (array $hier_ids)

	getPCIdForHierId (string $hier_id)

Protected Member Functions
	incEdId (string $ed_id)
	Increases an hierarchical editing id at lowest level (last number) More...

	decEdId (string $ed_id)
	Decreases an hierarchical editing id at lowest level (last number) More...

Protected Attributes
const	ID_ELEMENTS

array	$hier_ids = []

ilPageObject	$page

DomUtil	$dom_util

ContentIdGenerator	$generator

Detailed Description

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 28 of file class.ContentIdManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\COPage\ID\ContentIdManager::__construct	(	\ilPageObject	$page,
		?ContentIdGeneratorInterface	$generator = `null`
	)

Definition at line 46 of file class.ContentIdManager.php.

References $DIC, and ILIAS\COPage\ID\ContentIdManager\$page.

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

Member Function Documentation

◆ addHierIDsToDom()

ILIAS\COPage\ID\ContentIdManager::addHierIDsToDom ( )

Add hierarchical ID (e.g.

for editing) attributes "HierId" to current dom tree. This attribute will be added to the following elements: PageObject, Paragraph, Table, TableRow, TableData. Only elements of these types are counted as "childs" here. Hierarchical IDs have the format "x_y_z_...", e.g. "1_4_2" means: second child of fourth child of first child of page. The PageObject element gets the special id "pg". The first child of the page starts with id 1. The next child gets the 2 and so on. Another example: The first child of the page is a Paragraph -> id 1. The second child is a table -> id 2. The first row gets the id 2_1, the

Definition at line 75 of file class.ContentIdManager.php.

References $path, and ILIAS\COPage\ID\ContentIdManager\incEdId().

                                      : 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";
         }
     }

Here is the call graph for this function:

◆ checkPCIds()

ILIAS\COPage\ID\ContentIdManager::checkPCIds ( )

Definition at line 260 of file class.ContentIdManager.php.

References ILIAS\COPage\ID\ContentIdManager\$page, $path, and ilPageObject\buildDom().

                                 : 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;
     }

Here is the call graph for this function:

◆ decEdId()

ILIAS\COPage\ID\ContentIdManager::decEdId ( string $ed_id )

protected

Decreases an hierarchical editing id at lowest level (last number)

Parameters

string $ed_id hierarchical ID

Returns: string hierarchical ID (decreased)

Definition at line 180 of file class.ContentIdManager.php.

References $id.

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

◆ generatePCId()

ILIAS\COPage\ID\ContentIdManager::generatePCId ( )

Definition at line 187 of file class.ContentIdManager.php.

Referenced by ILIAS\COPage\ID\ContentIdManager\insertPCIds().

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

Here is the caller graph for this function:

◆ getAllPCIds()

ILIAS\COPage\ID\ContentIdManager::getAllPCIds ( )

Definition at line 279 of file class.ContentIdManager.php.

References ILIAS\COPage\ID\ContentIdManager\$page, $path, and ilPageObject\buildDom().

                                  : 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;
     }

Here is the call graph for this function:

◆ getDuplicatePCIds()

ILIAS\COPage\ID\ContentIdManager::getDuplicatePCIds ( )

Definition at line 212 of file class.ContentIdManager.php.

References $path.

Referenced by ILIAS\COPage\ID\ContentIdManager\hasDuplicatePCIds().

                                        : 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;
     }

Here is the caller graph for this function:

◆ getHierIdForPcId()

ILIAS\COPage\ID\ContentIdManager::getHierIdForPcId ( string $pcid )

Definition at line 323 of file class.ContentIdManager.php.

References ILIAS\COPage\ID\ContentIdManager\getHierIdsForPCIds().

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

Here is the call graph for this function:

◆ getHierIds()

ILIAS\COPage\ID\ContentIdManager::getHierIds ( )

get all hierarchical ids

Definition at line 141 of file class.ContentIdManager.php.

References ILIAS\COPage\ID\ContentIdManager\$hier_ids.

                                 : array
     {
         return $this->hier_ids;
     }

◆ getHierIdsForPCIds()

ILIAS\COPage\ID\ContentIdManager::getHierIdsForPCIds ( array $a_pc_ids )

Definition at line 302 of file class.ContentIdManager.php.

References $path.

Referenced by ILIAS\COPage\ID\ContentIdManager\getHierIdForPcId().

                                                        : 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;
     }

Here is the caller graph for this function:

◆ getPCIdForHierId()

ILIAS\COPage\ID\ContentIdManager::getPCIdForHierId ( string $hier_id )

Definition at line 351 of file class.ContentIdManager.php.

References ILIAS\COPage\ID\ContentIdManager\getPCIdsForHierIds().

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

Here is the call graph for this function:

◆ getPCIdsForHierIds()

ILIAS\COPage\ID\ContentIdManager::getPCIdsForHierIds ( array $hier_ids )

Definition at line 329 of file class.ContentIdManager.php.

References ILIAS\COPage\ID\ContentIdManager\$page, $path, and ilPageObject\getDomDoc().

Referenced by ILIAS\COPage\ID\ContentIdManager\getPCIdForHierId().

                                                        : 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasDuplicatePCIds()

ILIAS\COPage\ID\ContentIdManager::hasDuplicatePCIds ( )

Definition at line 240 of file class.ContentIdManager.php.

References ILIAS\COPage\ID\ContentIdManager\getDuplicatePCIds().

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

Here is the call graph for this function:

◆ incEdId()

ILIAS\COPage\ID\ContentIdManager::incEdId ( string $ed_id )

protected

Increases an hierarchical editing id at lowest level (last number)

Parameters

string $ed_id hierarchical ID

Returns: string hierarchical ID (increased)

Definition at line 168 of file class.ContentIdManager.php.

References $id.

Referenced by ILIAS\COPage\ID\ContentIdManager\addHierIDsToDom().

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

Here is the caller graph for this function:

◆ insertPCIds()

ILIAS\COPage\ID\ContentIdManager::insertPCIds ( )

Definition at line 192 of file class.ContentIdManager.php.

References $id, $path, and ILIAS\COPage\ID\ContentIdManager\generatePCId().

                                  : 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);
         }
     }

Here is the call graph for this function:

◆ stripHierIDsFromDom()

ILIAS\COPage\ID\ContentIdManager::stripHierIDsFromDom ( )

Definition at line 146 of file class.ContentIdManager.php.

References $path.

                                          : 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");
                 }
             }
         }
     }

◆ stripPCIDs()

ILIAS\COPage\ID\ContentIdManager::stripPCIDs ( )

Definition at line 246 of file class.ContentIdManager.php.

References $path.

                                 : 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");
                 }
             }
         }
     }

Field Documentation

◆ $dom_util

DomUtil ILIAS\COPage\ID\ContentIdManager::$dom_util

protected

Definition at line 43 of file class.ContentIdManager.php.

◆ $generator

ContentIdGenerator ILIAS\COPage\ID\ContentIdManager::$generator

protected

Definition at line 44 of file class.ContentIdManager.php.

◆ $hier_ids

array ILIAS\COPage\ID\ContentIdManager::$hier_ids = []

protected

Definition at line 41 of file class.ContentIdManager.php.

Referenced by ILIAS\COPage\ID\ContentIdManager\getHierIds().

◆ $page

ilPageObject ILIAS\COPage\ID\ContentIdManager::$page

protected

Definition at line 42 of file class.ContentIdManager.php.

Referenced by ILIAS\COPage\ID\ContentIdManager\__construct(), ILIAS\COPage\ID\ContentIdManager\checkPCIds(), ILIAS\COPage\ID\ContentIdManager\getAllPCIds(), and ILIAS\COPage\ID\ContentIdManager\getPCIdsForHierIds().

◆ ID_ELEMENTS

const ILIAS\COPage\ID\ContentIdManager::ID_ELEMENTS

protected

Initial value:

=
        ["PageContent",
         "TableRow",
         "TableData",
         "ListItem",
         "FileItem",
         "Section",
         "Tab",
         "ContentPopup",
         "GridCell"]

Definition at line 30 of file class.ContentIdManager.php.

The documentation for this class was generated from the following file:

components/ILIAS/COPage/ID/class.ContentIdManager.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addHierIDsToDom()

◆ checkPCIds()

◆ decEdId()

◆ generatePCId()

◆ getAllPCIds()

◆ getDuplicatePCIds()

◆ getHierIdForPcId()

◆ getHierIds()

◆ getHierIdsForPCIds()

◆ getPCIdForHierId()

◆ getPCIdsForHierIds()

◆ hasDuplicatePCIds()

◆ incEdId()

◆ insertPCIds()

◆ stripHierIDsFromDom()

◆ stripPCIDs()

Field Documentation

◆ $dom_util

◆ $generator

◆ $hier_ids

◆ $page

◆ ID_ELEMENTS