class.ilPCPlaceHolder.php

Go to the documentation of this file.

<?php

class ilPCPlaceHolder extends ilPageContent
{
    protected ilCtrl $ctrl;
    protected ilLanguage $lng;
    public php4DOMElement $q_node;                      // node of Paragraph element
    public string $content_class;
    public string $height;

    public function init(): void
    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->setType("plach");
    }

    public function setNode(php4DOMElement $a_node): void
    {
        parent::setNode($a_node);               // this is the PageContent node
        $this->q_node = $a_node->first_child();         //... and this the PlaceHolder
    }

    public function create(
        ilPageObject $a_pg_obj,
        string $a_hier_id,
        string $a_pc_id = ""
    ): void {
        $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->q_node = $this->dom->create_element("PlaceHolder");
        $this->q_node = $this->node->append_child($this->q_node);
    }

    public function setContentClass(string $a_class): void
    {
        if (is_object($this->q_node)) {
            $this->q_node->set_attribute("ContentClass", $a_class);
        }
    }

    public function getContentClass(): string
    {
        if (is_object($this->q_node)) {
            return $this->q_node->get_attribute("ContentClass");
        }
        return "";
    }

    public function setHeight(string $a_height): void
    {
        if (is_object($this->q_node)) {
            $this->q_node->set_attribute("Height", $a_height);
        }
    }

    public function getHeight(): string
    {
        if (is_object($this->q_node)) {
            return $this->q_node->get_attribute("Height");
        }
        return "";
    }

    public function getClass(): string
    {
        return "";
    }

    public static function getLangVars(): array
    {
        return array("question_placeh","media_placeh","text_placeh",
            "ed_insert_plach","question_placehl","media_placehl","text_placehl",
            "verification_placeh", "verification_placehl");
    }

    public function modifyPageContentPostXsl(
        string $a_output,
        string $a_mode,
        bool $a_abstract_only = false
    ): string {
        $lng = $this->lng;

        //
        // Note: this standard output is "overwritten", e.g. by ilPortfolioPageGUI::postOutputProcessing
        //

        $end = 0;
        $start = strpos($a_output, "{{{{{PlaceHolder#");
        if (is_int($start)) {
            $end = strpos($a_output, "}}}}}", $start);
        }
        $i = 1;
        while ($end > 0) {
            $param = substr($a_output, $start + 17, $end - $start - 17);
            $param = explode("#", $param);

            $html = $param[2];
            switch ($param[2]) {
                case "Text":
                    $html = $lng->txt("cont_text_placeh");
                    break;

                case "Media":
                    $html = $lng->txt("cont_media_placeh");
                    break;

                case "Question":
                    $html = $lng->txt("cont_question_placeh");
                    break;

                case "Verification":
                    $html = $lng->txt("cont_verification_placeh");
                    break;
            }

            $h2 = substr($a_output, 0, $start) .
                $html .
                substr($a_output, $end + 5);
            $a_output = $h2;
            $i++;

            $start = strpos($a_output, "{{{{{PlaceHolder#", $start + 5);
            $end = 0;
            if (is_int($start)) {
                $end = strpos($a_output, "}}}}}", $start);
            }
        }
        return $a_output;
    }

    public function getModel(): ?stdClass
    {
        $model = new \stdClass();
        $model->contentClass = $this->getContentClass();
        return $model;
    }

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

    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 {
        // remove question placholders
        if (!$a_self_ass) {
            // Get question IDs
            $path = "//PlaceHolder[@ContentClass = 'Question']";
            $xpath = new DOMXPath($a_domdoc);
            $nodes = $xpath->query($path);

            foreach ($nodes as $node) {
                $parent = $node->parentNode;
                $parent->parentNode->removeChild($parent);
            }
        }
    }
}