class.ilPageContent.php

Go to the documentation of this file.

<?php

use ILIAS\COPage\Page\PageManagerInterface;
use ILIAS\Repository\Object\ObjectAdapterInterface;

abstract class ilPageContent
{
    protected DOMDocument $dom_doc;
    protected \ILIAS\COPage\InternalDomainService $domain;
    protected string $pcid;
    protected string $type = "";
    protected ilPageObject $pg_obj;
    public string $hier_id = "";
    public ?DOMNode $dom_node = null;
    public string $page_lang = "";
    // needed for post processing (e.g. content includes)
    protected string $file_download_link;
    // needed for post processing (e.g. content includes)
    protected string $fullscreen_link;
    // needed for post processing (e.g. content includes)
    protected string $sourcecode_download_script;
    protected ilLogger $log;
    protected string $profile_back_url = "";

    protected \ILIAS\COPage\Dom\DomUtil $dom_util;
    protected ?PageManagerInterface $page_manager = null;
    protected ?ObjectAdapterInterface $object = null;

    final public function __construct(
        ilPageObject $a_pg_obj,
        ?PageManagerInterface $page_manager = null,
        ?ObjectAdapterInterface $object_adapter = null
    ) {
        global $DIC;

        $this->log = ilLoggerFactory::getLogger('copg');
        $this->setPage($a_pg_obj);
        $this->dom_doc = $a_pg_obj->getDomDoc();
        //$this->dom = $a_pg_obj->getDom();
        $this->domain = $DIC->copage()->internal()->domain();
        $this->init();
        if ($this->getType() == "") {
            die("Error: ilPageContent::init() did not set type");
        }
        $this->page_manager = $page_manager ?? $DIC->copage()
                                                   ->internal()
                                                   ->domain()
                                                   ->page();
        $this->object = $object_adapter ?? $DIC->copage()
                                                   ->internal()
                                                   ->domain()
                                                   ->object();
        $this->dom_util = $DIC->copage()->internal()->domain()->domUtil();
    }

    protected function getPageManager(): PageManagerInterface
    {
        return $this->page_manager;
    }

    public function setPage(ilPageObject $a_val): void
    {
        $this->pg_obj = $a_val;
    }

    public function getPage(): ilPageObject
    {
        return $this->pg_obj;
    }

    abstract public function init(): void;

    final protected function setType(string $a_type): void
    {
        $this->type = $a_type;
    }

    public function getType(): string
    {
        return $this->type;
    }

    public function getDomNode(): ?DOMNode
    {
        return $this->dom_node;
    }

    public function getDomDoc(): DOMDocument
    {
        return $this->dom_doc;
    }

    public function setDomNode(DOMNode $node): void
    {
        $this->dom_node = $node;
    }

    public function getChildNode(): ?DOMNode
    {
        return $this->getDomNode()?->firstChild;
    }

    public function getJavascriptFiles(string $a_mode): array
    {
        return array();
    }

    public function getCssFiles(string $a_mode): array
    {
        return [];
    }

    public function getOnloadCode(string $a_mode): array
    {
        return array();
    }

    public function setHierId(string $a_hier_id): void
    {
        $this->hier_id = $a_hier_id;
    }

    public function getHierId(): string
    {
        return $this->hier_id;
    }

    // Get hierarchical id from dom
    public function lookupHierId(): string
    {
        return $this->getDomNode()->getAttribute("HierId");
    }

    protected function hasNode(): bool
    {
        return is_object($this->dom_node);
    }

    public function readHierId(): string
    {
        if ($this->hasNode()) {
            return $this->getDomNode()->getAttribute("HierId");
        }
        return "";
    }

    public function setPcId(string $a_pcid): void
    {
        $this->pcid = $a_pcid;
    }

    public function getPCId(): string
    {
        return $this->pcid;
    }

    public function setFileDownloadLink(string $a_download_link): void
    {
        $this->file_download_link = $a_download_link;
    }

    public function getFileDownloadLink(): string
    {
        return $this->file_download_link;
    }

    public function setProfileBackUrl(string $url): void
    {
        $this->profile_back_url = $url;
    }

    public function getProfileBackUrl(): string
    {
        return $this->profile_back_url;
    }

    public function setFullscreenLink(string $a_fullscreen_link): void
    {
        $this->fullscreen_link = $a_fullscreen_link;
    }

    public function getFullscreenLink(): string
    {
        return $this->fullscreen_link;
    }

    public function setSourcecodeDownloadScript(string $script_name): void
    {
        $this->sourcecode_download_script = $script_name;
    }

    public function getSourcecodeDownloadScript(): string
    {
        return $this->sourcecode_download_script;
    }

    public function readPCId(): string
    {
        if ($this->hasNode()) {
            return $this->getDomNode()->getAttribute("PCID");
        }
        return "";
    }

    public function writePCId(string $a_pc_id): void
    {
        if ($this->hasNode()) {
            $this->getDomNode()->setAttribute("PCID", $a_pc_id);
        }
    }

    public static function sortHierIds(array $a_array): array
    {
        uasort($a_array, array("ilPageContent", "isGreaterHierId"));
        return $a_array;
    }

    public static function isGreaterHierId(string $a, string $b): int
    {
        $a_arr = explode("_", $a);
        $b_arr = explode("_", $b);
        for ($i = 0; $i < count($a_arr); $i++) {
            if ((int) $a_arr[$i] > (int) $b_arr[$i]) {
                return +1;
            } elseif ((int) $a_arr[$i] < (int) $b_arr[$i]) {
                return -1;
            }
        }
        return 0;
    }

    public function setEnabled(string $value): void
    {
        if ($this->hasNode()) {
            $this->getDomNode()->setAttribute("Enabled", $value);
        }
    }

    public function enable(): void
    {
        $this->setEnabled("True");
    }

    public function disable(): void
    {
        $this->setEnabled("False");
    }

    final public function isEnabled(): bool
    {
        if ($this->hasNode() && $this->getDomNode()->hasAttribute("Enabled")) {
            $compare = $this->getDomNode()->getAttribute("Enabled");
        } else {
            $compare = "True";
        }

        return strcasecmp($compare, "true") == 0;
    }

    public function createPageContentNode(bool $a_set_this_node = true): DomNode
    {
        $node = $this->dom_doc->createElement("PageContent");
        if ($a_set_this_node) {
            $this->setDomNode($node);
        }
        return $node;
    }

    public function getNewPageContentNode(): DOMNode
    {
        return $this->dom_doc->createElement("PageContent");
    }

    protected function createInitialChildNode(
        string $hier_id,
        string $pc_id,
        string $child,
        array $child_attributes = []
    ): void {
        $this->createPageContentNode();
        $node = $this->dom_doc->createElement($child);
        $node = $this->getDomNode()->appendChild($node);
        foreach ($child_attributes as $att => $value) {
            $node->setAttribute($att, $value);
        }
        $this->getPage()->insertContent($this, $hier_id, IL_INSERT_AFTER, $pc_id);
    }

    public static function getLangVars(): array
    {
        return array();
    }

    public static function handleCopiedContent(
        DOMDocument $a_domdoc,
        bool $a_self_ass = true,
        bool $a_clone_mobs = false,
        int $new_parent_id = 0,
        int $obj_copy_id = 0
    ): void {
    }

    public function modifyPageContentPostXsl(
        string $a_output,
        string $a_mode,
        bool $a_abstract_only = false
    ): string {
        return $a_output;
    }

    public static function afterPageUpdate(
        ilPageObject $a_page,
        DOMDocument $a_domdoc,
        string $a_xml,
        bool $a_creation
    ): void {
    }

    public static function beforePageDelete(
        ilPageObject $a_page
    ): void {
    }

    public static function afterRepositoryCopy(ilPageObject $page, array $mapping, int $source_ref_id): void
    {
    }

    public static function afterPageHistoryEntry(
        ilPageObject $a_page,
        DOMDocument $a_old_domdoc,
        string $a_old_xml,
        int $a_old_nr
    ): void {
    }

    public function getModel(): ?stdClass
    {
        return null;
    }

    public static function deleteHistoryLowerEqualThan(
        string $parent_type,
        int $page_id,
        string $lang,
        int $delete_lower_than_nr
    ): void {
    }
}