This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilMediaAliasItem:

Public Member Functions
	__construct (DOMDocument $dom, string $a_hier_id, string $a_purpose, string $a_pc_id="", string $a_parent_node_name="MediaObject")

	getMAItemNode (string $a_hier_id, string $a_purpose, string $a_pc_id="", string $a_sub_element="")

	getParameterNodes (string $a_hier_id, string $a_purpose, string $a_pc_id="")

	getMapAreaNodes (string $a_hier_id, string $a_purpose, string $a_pc_id="")

	setPcId (string $a_pcid)

	getPcId ()

	exists ()
	check if item node exists More...

	insert ()
	inserts new node in dom More...

	setWidth (string $a_width)

	getWidth ()

	definesSize ()
	check if alias item defines own size or derives size from object More...

	deriveSize ()
	derive size from object (-> width and height attributes are removed from layout element) More...

	setHeight (string $a_height)

	getHeight ()

	setCaption (string $a_caption)

	getCaption ()

	definesCaption ()
	check if alias item defines own caption or derives caption from object More...

	deriveCaption ()
	derive caption from object (-> caption element is removed from media alias item) More...

	setTextRepresentation (string $a_text_representation)

	getTextRepresentation ()

	definesTextRepresentation ()
	check if alias item defines own TextRepresentation or derives TextRepresentation from object More...

	deriveTextRepresentation ()
	derive TextRepresentation from object (-> TextRepresentation element is removed from media alias item) More...

	setHorizontalAlign (string $a_halign)

	getHorizontalAlign ()

	setParameters (array $a_par_array)

	getParameterString ()
	Get all parameters as string. More...

	getParameters ()
	Get all parameters as array. More...

	definesParameters ()
	check if alias item defines own parameters or derives parameters from object More...

	deriveParameters ()
	derive parameters from object (-> all parameter elements are removed from media alias item) More...

	getMapAreas ()
	Get all map areas. More...

	setAreaTitle (int $a_nr, string $a_title)

	setAreaIntLink (int $a_nr, string $a_type, string $a_target, string $a_target_frame)
	Set link of area to an internal one. More...

	setAreaExtLink (int $a_nr, string $a_href)
	Set link of area to an external one. More...

	setShape (int $a_nr, string $a_shape_type, string $a_coords)
	Set shape and coords of single area. More...

	setAreaHighlightMode (int $a_nr, string $a_mode)
	Set highlight mode single area. More...

	setAreaHighlightClass (int $a_nr, string $a_class)
	Set highlight class single area. More...

	addMapArea (string $a_shape_type, string $a_coords, string $a_title, array $a_link, string $a_id="", string $hl_mode="", string $hl_class="",)
	Add a new area to the map. More...

	deleteMapArea (int $a_nr)
	Delete a sinlge map area. More...

	deleteMapAreaById (string $a_id)
	Delete map areas by id. More...

	deleteAllMapAreas ()
	Delete all map areas. More...

	getLinkTypeOfArea (int $a_nr)
	Get link type. More...

	getTypeOfArea (int $a_nr)
	Get type (only internal link) More...

	getTargetOfArea (int $a_nr)
	Get target (only internal link) More...

	getTargetFrameOfArea (int $a_nr)
	Get target frame (only internal link) More...

	getHrefOfArea (int $a_nr)
	Get href (only external link) More...

	getTitleOfArea (int $a_nr)
	Get title. More...

	delete ()
	delete full item node from dom More...

	makeMapWorkCopy (ilMediaItem $a_st_item, int $a_area_nr, bool $a_exclude, bool $a_output_new_area, string $a_area_type, string $a_coords)
	make map work copy of image More...

	hasAnyPropertiesSet ()
	Has the alias any properties set? More...

	getModel ()

Data Fields
string	$hier_id = ""

string	$purpose = ""

DOMNode	$item_node = null

Protected Member Functions
	getItemNode ()

Protected Attributes
DOMDocument	$dom_doc

ILIAS COPage Dom DomUtil	$dom_util

string	$parent_node_name

string	$pcid

ilLanguage	$lng

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilMediaAliasItem Media Alias Item, component of a media object (file or reference)

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

Definition at line 24 of file class.ilMediaAliasItem.php.

Constructor & Destructor Documentation

◆ __construct()

ilMediaAliasItem::__construct	(	DOMDocument	$dom,
		string	$a_hier_id,
		string	$a_purpose,
		string	$a_pc_id = `""`,
		string	$a_parent_node_name = `"MediaObject"`
	)

Definition at line 35 of file class.ilMediaAliasItem.php.

      {
        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()
        );
    }

References $DIC, getMAItemNode(), getPcId(), ILIAS\Repository\lng(), and setPcId().

Here is the call graph for this function:

Member Function Documentation

◆ addMapArea()

ilMediaAliasItem::addMapArea	(	string	$a_shape_type,
		string	$a_coords,
		string	$a_title,
		array	$a_link,
		string	$a_id = `""`,
		string	$hl_mode = `""`,
		string	$hl_class = `""`
	)

Add a new area to the map.

Definition at line 658 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testAddMapArea(), PCMediaObjectTest\testAreaProps(), PCMediaObjectTest\testDeleteAllMapAreas(), PCMediaObjectTest\testDeleteMapArea(), and PCMediaObjectTest\testDeleteMapAreaById().

Here is the caller graph for this function:

◆ definesCaption()

ilMediaAliasItem::definesCaption ( )

check if alias item defines own caption or derives caption from object

Returns: bool returns true if caption is not derived from object

Definition at line 273 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testCaption(), and PCMediaObjectTest\testDeriveCaption().

Here is the caller graph for this function:

◆ definesParameters()

ilMediaAliasItem::definesParameters ( )

check if alias item defines own parameters or derives parameters from object

Returns: bool returns true if parameters are not derived from object

Definition at line 458 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testDeriveParameters(), and PCMediaObjectTest\testParameters().

Here is the caller graph for this function:

◆ definesSize()

ilMediaAliasItem::definesSize ( )

check if alias item defines own size or derives size from object

Returns: bool returns true if size is not derived from object

Definition at line 182 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testDeriveSize(), and PCMediaObjectTest\testWidth().

Here is the caller graph for this function:

◆ definesTextRepresentation()

ilMediaAliasItem::definesTextRepresentation ( )

check if alias item defines own TextRepresentation or derives TextRepresentation from object

Returns: bool returns true if TextRepresentation is not derived from object

Definition at line 333 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testDeriveTextRepresentation(), and PCMediaObjectTest\testTextRepresentation().

Here is the caller graph for this function:

◆ delete()

ilMediaAliasItem::delete ( )

delete full item node from dom

Definition at line 860 of file class.ilMediaAliasItem.php.

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

◆ deleteAllMapAreas()

ilMediaAliasItem::deleteAllMapAreas ( )

Delete all map areas.

Definition at line 741 of file class.ilMediaAliasItem.php.

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

References $path.

Referenced by PCMediaObjectTest\testDeleteAllMapAreas().

Here is the caller graph for this function:

◆ deleteMapArea()

ilMediaAliasItem::deleteMapArea ( int $a_nr )

Delete a sinlge map area.

Definition at line 706 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testDeleteMapArea().

Here is the caller graph for this function:

◆ deleteMapAreaById()

ilMediaAliasItem::deleteMapAreaById ( string $a_id )

Delete map areas by id.

Definition at line 723 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testDeleteMapAreaById().

Here is the caller graph for this function:

◆ deriveCaption()

ilMediaAliasItem::deriveCaption ( )

derive caption from object (-> caption element is removed from media alias item)

Definition at line 290 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testDeriveCaption().

Here is the caller graph for this function:

◆ deriveParameters()

ilMediaAliasItem::deriveParameters ( )

derive parameters from object (-> all parameter elements are removed from media alias item)

Definition at line 474 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testDeriveParameters().

Here is the caller graph for this function:

◆ deriveSize()

ilMediaAliasItem::deriveSize ( )

derive size from object (-> width and height attributes are removed from layout element)

Definition at line 199 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testDeriveSize().

Here is the caller graph for this function:

◆ deriveTextRepresentation()

ilMediaAliasItem::deriveTextRepresentation ( )

derive TextRepresentation from object (-> TextRepresentation element is removed from media alias item)

Definition at line 350 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testDeriveTextRepresentation().

Here is the caller graph for this function:

◆ exists()

ilMediaAliasItem::exists ( )

check if item node exists

Definition at line 126 of file class.ilMediaAliasItem.php.

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

◆ getCaption()

ilMediaAliasItem::getCaption ( )

Definition at line 255 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testCaption().

Here is the caller graph for this function:

◆ getHeight()

ilMediaAliasItem::getHeight ( )

Definition at line 230 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testHeight().

Here is the caller graph for this function:

◆ getHorizontalAlign()

ilMediaAliasItem::getHorizontalAlign ( )

Definition at line 376 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testHorizontalAlign().

Here is the caller graph for this function:

◆ getHrefOfArea()

ilMediaAliasItem::getHrefOfArea ( int $a_nr )

Get href (only external link)

Definition at line 826 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testAddMapArea().

Here is the caller graph for this function:

◆ getItemNode()

ilMediaAliasItem::getItemNode ( )

protected

Definition at line 58 of file class.ilMediaAliasItem.php.

                                    : DOMNode
    {
        return $this->item_node;
    }

References $item_node.

◆ getLinkTypeOfArea()

ilMediaAliasItem::getLinkTypeOfArea ( int $a_nr )

Get link type.

Definition at line 753 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testAreaProps().

Here is the caller graph for this function:

◆ getMAItemNode()

ilMediaAliasItem::getMAItemNode	(	string	$a_hier_id,
		string	$a_purpose,
		string	$a_pc_id = `""`,
		string	$a_sub_element = `""`
	)

Definition at line 63 of file class.ilMediaAliasItem.php.

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

References $path.

Referenced by __construct().

Here is the caller graph for this function:

◆ getMapAreaNodes()

ilMediaAliasItem::getMapAreaNodes	(	string	$a_hier_id,
		string	$a_purpose,
		string	$a_pc_id = `""`
	)

Definition at line 99 of file class.ilMediaAliasItem.php.

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

References $path.

◆ getMapAreas()

ilMediaAliasItem::getMapAreas ( )

Get all map areas.

Definition at line 490 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testAddMapArea().

Here is the caller graph for this function:

◆ getModel()

ilMediaAliasItem::getModel ( )

Definition at line 950 of file class.ilMediaAliasItem.php.

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

◆ getParameterNodes()

ilMediaAliasItem::getParameterNodes	(	string	$a_hier_id,
		string	$a_purpose,
		string	$a_pc_id = `""`
	)

Definition at line 85 of file class.ilMediaAliasItem.php.

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

References $path.

◆ getParameters()

ilMediaAliasItem::getParameters ( )

Get all parameters as array.

Definition at line 438 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testParameters().

Here is the caller graph for this function:

◆ getParameterString()

ilMediaAliasItem::getParameterString ( )

Get all parameters as string.

Definition at line 421 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testParameters().

Here is the caller graph for this function:

◆ getPcId()

ilMediaAliasItem::getPcId ( )

Definition at line 118 of file class.ilMediaAliasItem.php.

                             : string
    {
        return $this->pcid;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ getTargetFrameOfArea()

ilMediaAliasItem::getTargetFrameOfArea ( int $a_nr )

Get target frame (only internal link)

Definition at line 809 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testAreaProps().

Here is the caller graph for this function:

◆ getTargetOfArea()

ilMediaAliasItem::getTargetOfArea ( int $a_nr )

Get target (only internal link)

Definition at line 792 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testAreaProps().

Here is the caller graph for this function:

◆ getTextRepresentation()

ilMediaAliasItem::getTextRepresentation ( )

Definition at line 315 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testTextRepresentation().

Here is the caller graph for this function:

◆ getTitleOfArea()

ilMediaAliasItem::getTitleOfArea ( int $a_nr )

Get title.

Definition at line 843 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testAreaProps().

Here is the caller graph for this function:

◆ getTypeOfArea()

ilMediaAliasItem::getTypeOfArea ( int $a_nr )

Get type (only internal link)

Definition at line 775 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testAreaProps().

Here is the caller graph for this function:

◆ getWidth()

ilMediaAliasItem::getWidth ( )

Definition at line 164 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testWidth().

Here is the caller graph for this function:

◆ hasAnyPropertiesSet()

ilMediaAliasItem::hasAnyPropertiesSet ( )

Has the alias any properties set?

Definition at line 942 of file class.ilMediaAliasItem.php.

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

◆ insert()

ilMediaAliasItem::insert ( )

inserts new node in dom

Definition at line 138 of file class.ilMediaAliasItem.php.

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

References $path.

◆ makeMapWorkCopy()

ilMediaAliasItem::makeMapWorkCopy	(	ilMediaItem	$a_st_item,
		int	$a_area_nr,
		bool	$a_exclude,
		bool	$a_output_new_area,
		string	$a_area_type,
		string	$a_coords
	)

make map work copy of image

Parameters

int	$a_area_nr	draw area $a_area_nr only
bool	$a_exclude	true: draw all areas but area $a_area_nr

Definition at line 872 of file class.ilMediaAliasItem.php.

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

◆ setAreaExtLink()

ilMediaAliasItem::setAreaExtLink	(	int	$a_nr,
		string	$a_href
	)

Set link of area to an external one.

Definition at line 579 of file class.ilMediaAliasItem.php.

     : 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("Href" => $a_href);
            $this->dom_util->setFirstOptionalElement(
                $ma_nodes[$a_nr - 1],
                "ExtLink",
                array(""),
                $title,
                $attributes
            );
        }
    }

◆ setAreaHighlightClass()

ilMediaAliasItem::setAreaHighlightClass	(	int	$a_nr,
		string	$a_class
	)

Set highlight class single area.

Definition at line 641 of file class.ilMediaAliasItem.php.

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

◆ setAreaHighlightMode()

ilMediaAliasItem::setAreaHighlightMode	(	int	$a_nr,
		string	$a_mode
	)

Set highlight mode single area.

Definition at line 624 of file class.ilMediaAliasItem.php.

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

◆ setAreaIntLink()

ilMediaAliasItem::setAreaIntLink	(	int	$a_nr,
		string	$a_type,
		string	$a_target,
		string	$a_target_frame
	)

Set link of area to an internal one.

Definition at line 550 of file class.ilMediaAliasItem.php.

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

◆ setAreaTitle()

ilMediaAliasItem::setAreaTitle	(	int	$a_nr,
		string	$a_title
	)

Definition at line 529 of file class.ilMediaAliasItem.php.

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

◆ setCaption()

ilMediaAliasItem::setCaption ( string $a_caption )

Definition at line 244 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testCaption(), and PCMediaObjectTest\testDeriveCaption().

Here is the caller graph for this function:

◆ setHeight()

ilMediaAliasItem::setHeight ( string $a_height )

Definition at line 217 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testDeriveSize(), and PCMediaObjectTest\testHeight().

Here is the caller graph for this function:

◆ setHorizontalAlign()

ilMediaAliasItem::setHorizontalAlign ( string $a_halign )

Definition at line 363 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testHorizontalAlign().

Here is the caller graph for this function:

◆ setParameters()

ilMediaAliasItem::setParameters ( array $a_par_array )

Definition at line 390 of file class.ilMediaAliasItem.php.

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

References ilMediaItem\checkParameter().

Referenced by PCMediaObjectTest\testDeriveParameters(), and PCMediaObjectTest\testParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPcId()

ilMediaAliasItem::setPcId ( string $a_pcid )

Definition at line 113 of file class.ilMediaAliasItem.php.

                                           : void
    {
        $this->pcid = $a_pcid;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setShape()

ilMediaAliasItem::setShape	(	int	$a_nr,
		string	$a_shape_type,
		string	$a_coords
	)

Set shape and coords of single area.

Definition at line 605 of file class.ilMediaAliasItem.php.

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

◆ setTextRepresentation()

ilMediaAliasItem::setTextRepresentation ( string $a_text_representation )

Definition at line 303 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testDeriveTextRepresentation(), and PCMediaObjectTest\testTextRepresentation().

Here is the caller graph for this function:

◆ setWidth()

ilMediaAliasItem::setWidth ( string $a_width )

Definition at line 151 of file class.ilMediaAliasItem.php.

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

Referenced by PCMediaObjectTest\testDeriveSize(), and PCMediaObjectTest\testWidth().

Here is the caller graph for this function:

Field Documentation

◆ $dom_doc

DOMDocument ilMediaAliasItem::$dom_doc

protected

Definition at line 26 of file class.ilMediaAliasItem.php.

◆ $dom_util

ILIAS COPage Dom DomUtil ilMediaAliasItem::$dom_util

protected

Definition at line 27 of file class.ilMediaAliasItem.php.

◆ $hier_id

string ilMediaAliasItem::$hier_id = ""

Definition at line 31 of file class.ilMediaAliasItem.php.

◆ $item_node

DOMNode ilMediaAliasItem::$item_node = null

Definition at line 33 of file class.ilMediaAliasItem.php.

Referenced by getItemNode().

◆ $lng

ilLanguage ilMediaAliasItem::$lng

protected

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

◆ $parent_node_name

string ilMediaAliasItem::$parent_node_name

protected

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

◆ $pcid

string ilMediaAliasItem::$pcid

protected

Definition at line 29 of file class.ilMediaAliasItem.php.

◆ $purpose

string ilMediaAliasItem::$purpose = ""

Definition at line 32 of file class.ilMediaAliasItem.php.

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

components/ILIAS/COPage/classes/class.ilMediaAliasItem.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addMapArea()

◆ definesCaption()

◆ definesParameters()

◆ definesSize()

◆ definesTextRepresentation()

◆ delete()

◆ deleteAllMapAreas()

◆ deleteMapArea()

◆ deleteMapAreaById()

◆ deriveCaption()

◆ deriveParameters()

◆ deriveSize()

◆ deriveTextRepresentation()

◆ exists()

◆ getCaption()

◆ getHeight()

◆ getHorizontalAlign()

◆ getHrefOfArea()

◆ getItemNode()

◆ getLinkTypeOfArea()

◆ getMAItemNode()

◆ getMapAreaNodes()

◆ getMapAreas()

◆ getModel()

◆ getParameterNodes()

◆ getParameters()

◆ getParameterString()

◆ getPcId()

◆ getTargetFrameOfArea()

◆ getTargetOfArea()

◆ getTextRepresentation()

◆ getTitleOfArea()

◆ getTypeOfArea()

◆ getWidth()

◆ hasAnyPropertiesSet()

◆ insert()

◆ makeMapWorkCopy()

◆ setAreaExtLink()

◆ setAreaHighlightClass()

◆ setAreaHighlightMode()

◆ setAreaIntLink()

◆ setAreaTitle()

◆ setCaption()

◆ setHeight()

◆ setHorizontalAlign()

◆ setParameters()

◆ setPcId()

◆ setShape()

◆ setTextRepresentation()

◆ setWidth()

Field Documentation

◆ $dom_doc

◆ $dom_util

◆ $hier_id

◆ $item_node

◆ $lng

◆ $parent_node_name

◆ $pcid

◆ $purpose