class.ilMediaAliasItem.php

Go to the documentation of this file.

<?php

class ilMediaAliasItem
{
    protected DOMDocument $dom_doc;
    protected \ILIAS\COPage\Dom\DomUtil $dom_util;
    protected string $parent_node_name;
    protected string $pcid;
    protected ilLanguage $lng;
    public string $hier_id = "";
    public string $purpose = "";
    public ?DOMNode $item_node = null;

    public function __construct(
        DOMDocument $dom,
        string $a_hier_id,
        string $a_purpose,
        string $a_pc_id = "",
        string $a_parent_node_name = "MediaObject"
    ) {
        global $DIC;

        $this->lng = $DIC->language();
        $this->dom_doc = $dom;
        $this->parent_node_name = $a_parent_node_name;
        $this->hier_id = $a_hier_id;
        $this->purpose = $a_purpose;
        $this->setPcId($a_pc_id);
        $this->dom_util = $DIC->copage()->internal()->domain()->domUtil();
        $this->item_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
    }

    protected function getItemNode(): DOMNode
    {
        return $this->item_node;
    }

    public function getMAItemNode(
        string $a_hier_id,
        string $a_purpose,
        string $a_pc_id = "",
        string $a_sub_element = ""
    ): ?DOMNode {
        if ($a_pc_id != "") {
            $path = "//PageContent[@PCID = '" . $a_pc_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='$a_purpose']" . $a_sub_element;
            $nodes = $this->dom_util->path($this->dom_doc, $path);
            if (count($nodes) == 1) {
                return $nodes->item(0);
            }
        }

        $path = "//PageContent[@HierId = '" . $a_hier_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='$a_purpose']" . $a_sub_element;
        $nodes = $this->dom_util->path($this->dom_doc, $path);
        if (count($nodes) > 0) {
            return $nodes->item(0);
        }
        return null;
    }

    public function getParameterNodes(
        string $a_hier_id,
        string $a_purpose,
        string $a_pc_id = ""
    ): DOMNodeList {
        if ($a_pc_id != "") {
            $path = "//PageContent[@PCID = '" . $a_pc_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='$a_purpose']/Parameter";
            return $this->dom_util->path($this->dom_doc, $path);
        }

        $path = "//PageContent[@HierId = '" . $a_hier_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='$a_purpose']/Parameter";
        return $this->dom_util->path($this->dom_doc, $path);
    }

    public function getMapAreaNodes(
        string $a_hier_id,
        string $a_purpose,
        string $a_pc_id = ""
    ): DOMNodeList {
        if ($a_pc_id != "") {
            $path = "//PageContent[@PCID = '" . $a_pc_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='$a_purpose']/MapArea";
            return $this->dom_util->path($this->dom_doc, $path);
        }

        $path = "//PageContent[@HierId = '" . $a_hier_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='$a_purpose']/MapArea";
        return $this->dom_util->path($this->dom_doc, $path);
    }

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

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

    public function exists(): bool
    {
        if (is_object($this->item_node)) {
            return true;
        } else {
            return false;
        }
    }

    public function insert(): void
    {
        $path = "//PageContent[@HierId = '" . $this->hier_id . "']/" . $this->parent_node_name;
        $nodes = $this->dom_util->path($this->dom_doc, $path);
        if (count($nodes) > 0) {
            $obj_node = $nodes->item(0);
            $item_node = $this->dom_doc->createElement("MediaAliasItem");
            $item_node = $obj_node->appendChild($item_node);
            $item_node->setAttribute("Purpose", $this->purpose);
            $this->item_node = $item_node;
        }
    }

    public function setWidth(string $a_width): void
    {
        $this->dom_util->setFirstOptionalElement(
            $this->getItemNode(),
            "Layout",
            array("Caption", "TextRepresentation", "Parameter", "MapArea"),
            "",
            array("Width" => $a_width),
            false
        );
    }


    public function getWidth(): string
    {
        $layout_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/Layout"
        );
        if (is_object($layout_node)) {
            return $layout_node->getAttribute("Width");
        }
        return "";
    }

    public function definesSize(): bool
    {
        $layout_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/Layout"
        );
        if (is_object($layout_node)) {
            return $layout_node->hasAttribute("Width");
        }
        return false;
    }

    public function deriveSize(): void
    {
        $layout_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/Layout"
        );
        if (is_object($layout_node)) {
            if ($layout_node->hasAttribute("Width")) {
                $layout_node->removeAttribute("Width");
            }
            if ($layout_node->hasAttribute("Height")) {
                $layout_node->removeAttribute("Height");
            }
        }
    }

    public function setHeight(string $a_height): void
    {
        $this->dom_util->setFirstOptionalElement(
            $this->getItemNode(),
            "Layout",
            array("Caption", "TextRepresentation", "Parameter", "MapArea"),
            "",
            array("Height" => $a_height),
            false
        );
    }


    public function getHeight(): string
    {
        $layout_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/Layout"
        );
        if (is_object($layout_node)) {
            return $layout_node->getAttribute("Height");
        }
        return "";
    }

    public function setCaption(string $a_caption): void
    {
        $this->dom_util->setFirstOptionalElement(
            $this->getItemNode(),
            "Caption",
            array("TextRepresentation", "Parameter", "MapArea"),
            $a_caption,
            array("Align" => "bottom")
        );
    }

    public function getCaption(): string
    {
        $caption_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/Caption"
        );
        if (is_object($caption_node)) {
            return $this->dom_util->getContent($caption_node);
        }
        return "";
    }

    public function definesCaption(): bool
    {
        $caption_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/Caption"
        );
        if (is_object($caption_node)) {
            return true;
        }
        return false;
    }

    public function deriveCaption(): void
    {
        $caption_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/Caption"
        );
        if (is_object($caption_node)) {
            $caption_node->parentNode->removeChild($caption_node);
        }
    }

    public function setTextRepresentation(
        string $a_text_representation
    ): void {
        $this->dom_util->setFirstOptionalElement(
            $this->getItemNode(),
            "TextRepresentation",
            array("Parameter", "MapArea"),
            $a_text_representation,
            array()
        );
    }

    public function getTextRepresentation(): string
    {
        $text_representation_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/TextRepresentation"
        );
        if (is_object($text_representation_node)) {
            return $this->dom_util->getContent($text_representation_node);
        }
        return "";
    }

    public function definesTextRepresentation(): bool
    {
        $text_representation_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/TextRepresentation"
        );
        if (is_object($text_representation_node)) {
            return true;
        }
        return false;
    }

    public function deriveTextRepresentation(): void
    {
        $text_representation_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/TextRepresentation"
        );
        if (is_object($text_representation_node)) {
            $text_representation_node->parentNode->removeChild($text_representation_node);
        }
    }

    public function setHorizontalAlign(string $a_halign): void
    {
        $this->dom_util->setFirstOptionalElement(
            $this->getItemNode(),
            "Layout",
            array("Caption", "TextRepresentation", "Parameter", "MapArea"),
            "",
            array("HorizontalAlign" => $a_halign),
            false
        );
    }


    public function getHorizontalAlign(): string
    {
        $layout_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/Layout"
        );
        if (is_object($layout_node)) {
            return $layout_node->getAttribute("HorizontalAlign");
        }
        return "";
    }

    public function setParameters(array $a_par_array): void
    {
        $par_nodes = $this->getParameterNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        for ($i = 0; $i < count($par_nodes); $i++) {
            $par_node = $par_nodes[$i];
            $par_node->unlink_node($par_node);
        }

        if (is_array($a_par_array)) {
            foreach ($a_par_array as $par => $val) {
                if (ilMediaItem::checkParameter($par, $val)) {
                    $attributes = array("Name" => $par, "Value" => $val);
                    $this->dom_util->addElementToList(
                        $this->getItemNode(),
                        "Parameter",
                        array("MapArea"),
                        "",
                        $attributes
                    );
                }
            }
        }
    }

    public function getParameterString(): string
    {
        $par_nodes = $this->getParameterNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        $par_arr = array();
        foreach ($par_nodes as $par_node) {
            $par_arr[] = $par_node->getAttribute("Name") . "=\"" . $par_node->getAttribute("Value") . "\"";
        }
        return implode(", ", $par_arr);
    }

    public function getParameters(): array
    {
        $par_nodes = $this->getParameterNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        $par_arr = array();
        for ($i = 0; $i < count($par_nodes); $i++) {
            $par_node = $par_nodes[$i];
            $par_arr[$par_node->getAttribute("Name")] =
                $par_node->getAttribute("Value");
        }
        return $par_arr;
    }

    public function definesParameters(): bool
    {
        $par_nodes = $this->getParameterNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (count($par_nodes) > 0) {
            return true;
        }
        return false;
    }

    public function deriveParameters(): void
    {
        $par_nodes = $this->getParameterNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        foreach ($par_nodes as $par_node) {
            $par_node->parentNode->removeChild($par_node);
        }
    }


    public function getMapAreas(): array
    {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        $maparea_arr = array();
        $i = 0;
        foreach ($ma_nodes as $maparea_node) {
            $childs = $maparea_node->childNodes;
            $link = array();
            $first = $childs->item(0);
            if ($first->nodeName == "ExtLink") {
                $link = array("LinkType" => "ExtLink",
                    "Href" => $first->getAttribute("Href"),
                    "Title" => $this->dom_util->getContent($first));
            }
            if ($first->nodeName == "IntLink") {
                $link = array("LinkType" => "IntLink",
                    "Target" => $first->getAttribute("Target"),
                    "Type" => $first->getAttribute("Type"),
                    "TargetFrame" => $first->getAttribute("TargetFame"),
                    "Title" => $this->dom_util->getContent($first));
            }
            $maparea_arr[] = array(
                "Nr" => $i + 1,
                "Shape" => $maparea_node->getAttribute("Shape"),
                "Coords" => $maparea_node->getAttribute("Coords"),
                "HighlightMode" => $maparea_node->getAttribute("HighlightMode"),
                "HighlightClass" => $maparea_node->getAttribute("HighlightClass"),
                "Id" => $maparea_node->getAttribute("Id"),
                "Link" => $link);
            $i++;
        }

        return $maparea_arr;
    }

    public function setAreaTitle(
        int $a_nr,
        string $a_title
    ): void {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (is_object($ma_nodes[$a_nr - 1])) {
            $childs = $ma_nodes[$a_nr - 1]->childNodes;
            if (is_object($childs[0]) &&
                ($childs[0]->nodeName == "IntLink" || $childs[0]->nodeName == "ExtLink")) {
                $childs[0]->nodeValue = $a_title;
            }
        }
    }

    public function setAreaIntLink(
        int $a_nr,
        string $a_type,
        string $a_target,
        string $a_target_frame
    ): void {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (is_object($ma_nodes[$a_nr - 1])) {
            $title = $this->getTitleOfArea($a_nr);
            $this->dom_util->deleteAllChildsByName($ma_nodes[$a_nr - 1], array("IntLink", "ExtLink"));
            $attributes = array("Type" => $a_type, "Target" => $a_target,
                "TargetFrame" => $a_target_frame);
            $this->dom_util->setFirstOptionalElement(
                $ma_nodes[$a_nr - 1],
                "IntLink",
                array(""),
                $title,
                $attributes
            );
        }
    }

    public function setAreaExtLink(
        int $a_nr,
        string $a_href
    ): void {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (is_object($ma_nodes[$a_nr - 1])) {
            $title = $this->getTitleOfArea($a_nr);
            $this->dom_util->deleteAllChildsByName($ma_nodes[$a_nr - 1]->myDOMNode, array("IntLink", "ExtLink"));
            $attributes = array("Href" => $a_href);
            $this->dom_util->setFirstOptionalElement(
                $ma_nodes[$a_nr - 1]->myDOMNode,
                "ExtLink",
                array(""),
                $title,
                $attributes
            );
        }
    }

    public function setShape(
        int $a_nr,
        string $a_shape_type,
        string $a_coords
    ): void {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (is_object($ma_nodes[$a_nr - 1])) {
            $ma_nodes[$a_nr - 1]->setAttribute("Shape", $a_shape_type);
            $ma_nodes[$a_nr - 1]->setAttribute("Coords", $a_coords);
        }
    }

    public function setAreaHighlightMode(
        int $a_nr,
        string $a_mode
    ): void {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (is_object($ma_nodes[$a_nr - 1])) {
            $ma_nodes[$a_nr - 1]->setAttribute("HighlightMode", $a_mode);
        }
    }

    public function setAreaHighlightClass(
        int $a_nr,
        string $a_class
    ): void {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (is_object($ma_nodes[$a_nr - 1])) {
            $ma_nodes[$a_nr - 1]->setAttribute("HighlightClass", $a_class);
        }
    }

    public function addMapArea(
        string $a_shape_type,
        string $a_coords,
        string $a_title,
        array $a_link,
        string $a_id = "",
        string $hl_mode = "",
        string $hl_class = "",
    ): void {
        $attributes = array("Shape" => $a_shape_type,
            "Coords" => $a_coords, "Id" => $a_id,
            "HighlightMode" => $hl_mode, "HighlightClass" => $hl_class);

        $ma_node = $this->dom_util->addElementToList(
            $this->getItemNode(),
            "MapArea",
            array(),
            "",
            $attributes
        );

        if ($a_link["LinkType"] == "int" || $a_link["LinkType"] == "IntLink") {
            $attributes = array("Type" => $a_link["Type"],
                "TargetFrame" => $a_link["TargetFrame"],
                "Target" => $a_link["Target"]);
            $this->dom_util->setFirstOptionalElement(
                $ma_node,
                "IntLink",
                array(""),
                $a_title,
                $attributes
            );
        }
        if ($a_link["LinkType"] == "ext" || $a_link["LinkType"] == "ExtLink") {
            $attributes = array("Href" => $a_link["Href"]);
            $this->dom_util->setFirstOptionalElement(
                $ma_node,
                "ExtLink",
                array(""),
                $a_title,
                $attributes
            );
        }
    }

    public function deleteMapArea(int $a_nr): void
    {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );

        if (is_object($ma_nodes->item($a_nr - 1))) {
            $node = $ma_nodes->item($a_nr - 1);
            $node->parentNode->removeChild($node);
        }
    }

    public function deleteMapAreaById(
        string $a_id
    ): void {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        foreach ($ma_nodes as $node) {
            if ($node->getAttribute("Id") == $a_id) {
                $node->parentNode->removeChild($node);
            }
        }
    }

    public function deleteAllMapAreas(): void
    {
        $path = "//PageContent[@HierId = '" . $this->hier_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='" . $this->purpose . "']/MapArea";
        $nodes = $this->dom_util->path($this->dom_doc, $path);
        foreach ($nodes as $node) {
            $node->parentNode->removeChild($node);
        }
    }

    public function getLinkTypeOfArea(int $a_nr): string
    {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (is_object($ma_nodes->item($a_nr - 1))) {
            $childs = $ma_nodes->item($a_nr - 1)->childNodes;
            if ($childs->item(0)->nodeName == "IntLink") {
                return "int";
            }
            if ($childs->item(0)->nodeName == "ExtLink") {
                return "ext";
            }
        }
        return "";
    }

    public function getTypeOfArea(int $a_nr): string
    {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (is_object($ma_nodes->item($a_nr - 1))) {
            $childs = $ma_nodes->item($a_nr - 1)->childNodes;
            return $childs->item(0)->getAttribute("Type");
        }
        return "";
    }

    public function getTargetOfArea(int $a_nr): string
    {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (is_object($ma_nodes->item($a_nr - 1))) {
            $childs = $ma_nodes->item($a_nr - 1)->childNodes;
            return $childs->item(0)->getAttribute("Target");
        }
        return "";
    }

    public function getTargetFrameOfArea(int $a_nr): string
    {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (is_object($ma_nodes->item($a_nr - 1))) {
            $childs = $ma_nodes->item($a_nr - 1)->childNodes;
            return $childs->item(0)->getAttribute("TargetFrame");
        }
        return "";
    }

    public function getHrefOfArea(int $a_nr): string
    {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (is_object($ma_nodes->item($a_nr - 1))) {
            $childs = $ma_nodes->item($a_nr - 1)->childNodes;
            return $childs->item(0)->getAttribute("Href");
        }
        return "";
    }

    public function getTitleOfArea(int $a_nr): string
    {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        if (is_object($ma_nodes->item($a_nr - 1))) {
            $childs = $ma_nodes->item($a_nr - 1)->childNodes;
            return $this->dom_util->getContent($childs->item(0));
        }
        return "";
    }

    public function delete(): void
    {
        if (is_object($this->item_node)) {
            $this->item_node->parentNode->removeChild($this->item_node);
        }
    }

    public function makeMapWorkCopy(
        ilMediaItem $a_st_item,
        int $a_area_nr,
        bool $a_exclude,
        bool $a_output_new_area,
        string $a_area_type,
        string $a_coords
    ): bool {
        $a_st_item->buildMapWorkImage();

        // determine ratios (first see whether the instance has w/h defined)
        $width = $this->getWidth();
        $height = $this->getHeight();

        // if instance has no size, use object w/h
        if ($width == 0 && $height == 0) {
            $width = $a_st_item->getWidth();
            $height = $a_st_item->getHeight();
        }
        $size = getimagesize($a_st_item->getOriginalSource());
        $x_ratio = 1;
        if ($size[0] > 0 && $width > 0) {
            $x_ratio = $width / $size[0];
        }
        $y_ratio = 1;
        if ($size[1] > 0 && $height > 0) {
            $y_ratio = $height / $size[1];
        }

        // draw map areas
        $areas = $this->getMapAreas();
        for ($i = 0; $i < count($areas); $i++) {
            if (((($i + 1) == $a_area_nr) && !$a_exclude) ||
                    ((($i + 1) != $a_area_nr) && $a_exclude) ||
                    ($a_area_nr == 0)
            ) {
                $area = new ilMapArea();
                $area->setShape($areas[$i]["Shape"]);
                $area->setCoords($areas[$i]["Coords"]);
                $area->draw(
                    $a_st_item->getMapWorkImage(),
                    $a_st_item->color1,
                    $a_st_item->color2,
                    true,
                    $x_ratio,
                    $y_ratio
                );
            }
        }

        if ($a_output_new_area) {
            $area = new ilMapArea();
            $area->setShape($a_area_type);
            $area->setCoords($a_coords);
            $area->draw(
                $a_st_item->getMapWorkImage(),
                $a_st_item->color1,
                $a_st_item->color2,
                false,
                $x_ratio,
                $y_ratio
            );
        }

        return true;
    }

    public function hasAnyPropertiesSet(): bool
    {
        return ($this->definesSize() ||
            $this->definesCaption() ||
            $this->definesTextRepresentation() ||
            $this->definesParameters());
    }

    public function getModel(): ?stdClass
    {
        $model = new \stdClass();
        $model->areas = $this->getMapAreas();
        $model->caption = $this->getCaption();
        return $model;
    }
}