ilMediaAliasItem Class Reference

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 (php4DOMDocument $a_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="")
	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...

Data Fields
php4DOMDocument	$dom
string	$hier_id = ""
string	$purpose = ""
php4DOMElement	$item_node = null

Protected Attributes
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	(	php4DOMDocument	$a_dom,
		string	$a_hier_id,
		string	$a_purpose,
		string	$a_pc_id = "",
		string	$a_parent_node_name = "MediaObject"
	)

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

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

      {
        global $DIC;

        $this->lng = $DIC->language();
        $this->dom = $a_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->item_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
    }

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 = ""
	)

Add a new area to the map.

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

References $attributes, ilDOMUtil\addElementToList(), and ilDOMUtil\setFirstOptionalElement().

Referenced by ilPCInteractiveImage\addTriggerArea().

     : void {
        $attributes = array("Shape" => $a_shape_type,
            "Coords" => $a_coords, "Id" => $a_id);

        $ma_node = ilDOMUtil::addElementToList(
            $this->dom,
            $this->item_node,
            "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"]);
            ilDOMUtil::setFirstOptionalElement(
                $this->dom,
                $ma_node,
                "IntLink",
                array(""),
                $a_title,
                $attributes
            );
        }
        if ($a_link["LinkType"] == "ext" || $a_link["LinkType"] == "ExtLink") {
            $attributes = array("Href" => $a_link["Href"]);
            ilDOMUtil::setFirstOptionalElement(
                $this->dom,
                $ma_node,
                "ExtLink",
                array(""),
                $a_title,
                $attributes
            );
        }
    }

Here is the call graph for this function:

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 290 of file class.ilMediaAliasItem.php.

References getMAItemNode(), and getPcId().

Referenced by hasAnyPropertiesSet().

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

Here is the call graph for this function:

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 479 of file class.ilMediaAliasItem.php.

References getParameterNodes(), and getPcId().

Referenced by hasAnyPropertiesSet().

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

Here is the call graph for this function:

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 197 of file class.ilMediaAliasItem.php.

References getMAItemNode(), and getPcId().

Referenced by hasAnyPropertiesSet().

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

Here is the call graph for this function:

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 351 of file class.ilMediaAliasItem.php.

References getMAItemNode(), and getPcId().

Referenced by hasAnyPropertiesSet().

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

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilMediaAliasItem::delete

(

)

delete full item node from dom

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

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

deleteAllMapAreas()

ilMediaAliasItem::deleteAllMapAreas

(

)

Delete all map areas.

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

References $i, $path, $res, xpath_eval(), and xpath_new_context().

                                       : void
    {
        $xpc = xpath_new_context($this->dom);
        $path = "//PageContent[@HierId = '" . $this->hier_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='" . $this->purpose . "']/MapArea";
        $res = xpath_eval($xpc, $path);
        for ($i = 0; $i < count($res->nodeset); $i++) {
            $res->nodeset[$i]->unlink_node($res->nodeset[$i]);
        }
    }

Here is the call graph for this function:

deleteMapArea()

ilMediaAliasItem::deleteMapArea

(

int

$a_nr

)

Delete a sinlge map area.

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

References getMapAreaNodes(), and getPcId().

                                            : 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]->unlink_node($ma_nodes[$a_nr - 1]);
        }
    }

Here is the call graph for this function:

deleteMapAreaById()

ilMediaAliasItem::deleteMapAreaById

(

string

$a_id

)

Delete map areas by id.

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

References getMapAreaNodes(), and getPcId().

Referenced by ilPCInteractiveImage\deleteTrigger().

     : void {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        foreach ($ma_nodes as $node) {
            if ($node->get_attribute("Id") == $a_id) {
                $node->unlink_node($node);
            }
        }
    }

Here is the call graph for this function:

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 307 of file class.ilMediaAliasItem.php.

References getMAItemNode(), and getPcId().

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

Here is the call graph for this function:

deriveParameters()

ilMediaAliasItem::deriveParameters

(

)

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

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

References $i, getParameterNodes(), and getPcId().

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

Here is the call graph for this function:

deriveSize()

ilMediaAliasItem::deriveSize

(

)

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

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

References getMAItemNode(), and getPcId().

                                : void
    {
        $layout_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/Layout"
        );
        if (is_object($layout_node)) {
            if ($layout_node->has_attribute("Width")) {
                $layout_node->remove_attribute("Width");
            }
            if ($layout_node->has_attribute("Height")) {
                $layout_node->remove_attribute("Height");
            }
        }
    }

Here is the call graph for this function:

deriveTextRepresentation()

ilMediaAliasItem::deriveTextRepresentation

(

)

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

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

References getMAItemNode(), and getPcId().

                                              : void
    {
        $text_representation_node = $this->getMAItemNode(
            $this->hier_id,
            $this->purpose,
            $this->getPcId(),
            "/TextRepresentation"
        );
        if (is_object($text_representation_node)) {
            $text_representation_node->unlink_node($text_representation_node);
        }
    }

Here is the call graph for this function:

exists()

ilMediaAliasItem::exists

(

)

check if item node exists

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

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

getCaption()

ilMediaAliasItem::getCaption

(

)

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

References getMAItemNode(), and getPcId().

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

Here is the call graph for this function:

getHeight()

ilMediaAliasItem::getHeight

(

)

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

References getMAItemNode(), and getPcId().

Referenced by makeMapWorkCopy().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getHorizontalAlign()

ilMediaAliasItem::getHorizontalAlign

(

)

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

References getMAItemNode(), and getPcId().

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

Here is the call graph for this function:

getHrefOfArea()

ilMediaAliasItem::getHrefOfArea

(

int

$a_nr

)

Get href (only external link)

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

References getMapAreaNodes(), and getPcId().

                                            : string
    {
        $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]->child_nodes();
            return $childs[0]->get_attribute("Href");
        }
        return "";
    }

Here is the call graph for this function:

getLinkTypeOfArea()

ilMediaAliasItem::getLinkTypeOfArea

(

int

$a_nr

)

Get link type.

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

References getMapAreaNodes(), and getPcId().

                                                : string
    {
        $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]->child_nodes();
            if ($childs[0]->node_name() == "IntLink") {
                return "int";
            }
            if ($childs[0]->node_name() == "ExtLink") {
                return "ext";
            }
        }
        return "";
    }

Here is the call 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 56 of file class.ilMediaAliasItem.php.

References $path, $res, xpath_eval(), and xpath_new_context().

Referenced by __construct(), definesCaption(), definesSize(), definesTextRepresentation(), deriveCaption(), deriveSize(), deriveTextRepresentation(), getCaption(), getHeight(), getHorizontalAlign(), getTextRepresentation(), and getWidth().

     : ?php4DOMElement {
        if ($a_pc_id != "") {
            $xpc = xpath_new_context($this->dom);
            $path = "//PageContent[@PCID = '" . $a_pc_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='$a_purpose']" . $a_sub_element;
            $res = xpath_eval($xpc, $path);
            if (count($res->nodeset) == 1) {
                return $res->nodeset[0];
            }
        }

        $xpc = xpath_new_context($this->dom);
        $path = "//PageContent[@HierId = '" . $a_hier_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='$a_purpose']" . $a_sub_element;
        $res = xpath_eval($xpc, $path);
        if (count($res->nodeset) > 0) {
            return $res->nodeset[0];
        }
        return null;
    }

Here is the call graph for this function:

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 103 of file class.ilMediaAliasItem.php.

References $path, $res, xpath_eval(), and xpath_new_context().

Referenced by deleteMapArea(), deleteMapAreaById(), getHrefOfArea(), getLinkTypeOfArea(), getMapAreas(), getTargetFrameOfArea(), getTargetOfArea(), getTitleOfArea(), getTypeOfArea(), setAreaExtLink(), setAreaHighlightClass(), setAreaHighlightMode(), setAreaIntLink(), setAreaTitle(), and setShape().

     : array {
        $xpc = xpath_new_context($this->dom);
        if ($a_pc_id != "") {
            $path = "//PageContent[@PCID = '" . $a_pc_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='$a_purpose']/MapArea";
            $res = xpath_eval($xpc, $path);
            if (count($res->nodeset) > 0) {
                return $res->nodeset;
            }
            return array();
        }

        $path = "//PageContent[@HierId = '" . $a_hier_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='$a_purpose']/MapArea";
        $res = xpath_eval($xpc, $path);
        if (count($res->nodeset) > 0) {
            return $res->nodeset;
        }
        return array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMapAreas()

ilMediaAliasItem::getMapAreas

(

)

Get all map areas.

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

References $i, getMapAreaNodes(), and getPcId().

Referenced by ilPCImageMapTableGUI\getItems(), and makeMapWorkCopy().

                                 : array
    {
        $ma_nodes = $this->getMapAreaNodes(
            $this->hier_id,
            $this->purpose,
            $this->getPcId()
        );
        $maparea_arr = array();
        for ($i = 0; $i < count($ma_nodes); $i++) {
            $maparea_node = $ma_nodes[$i];
            $childs = $maparea_node->child_nodes();
            $link = array();
            if ($childs[0]->node_name() == "ExtLink") {
                $link = array("LinkType" => "ExtLink",
                    "Href" => $childs[0]->get_attribute("Href"),
                    "Title" => $childs[0]->get_content());
            }
            if ($childs[0]->node_name() == "IntLink") {
                $link = array("LinkType" => "IntLink",
                    "Target" => $childs[0]->get_attribute("Target"),
                    "Type" => $childs[0]->get_attribute("Type"),
                    "TargetFrame" => $childs[0]->get_attribute("TargetFame"),
                    "Title" => $childs[0]->get_content());
            }
            $maparea_arr[] = array(
                "Nr" => $i + 1,
                "Shape" => $maparea_node->get_attribute("Shape"),
                "Coords" => $maparea_node->get_attribute("Coords"),
                "HighlightMode" => $maparea_node->get_attribute("HighlightMode"),
                "HighlightClass" => $maparea_node->get_attribute("HighlightClass"),
                "Id" => $maparea_node->get_attribute("Id"),
                "Link" => $link);
        }

        return $maparea_arr;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParameterNodes()

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

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

References $path, $res, xpath_eval(), and xpath_new_context().

Referenced by definesParameters(), deriveParameters(), getParameters(), getParameterString(), and setParameters().

     : array {
        $xpc = xpath_new_context($this->dom);
        if ($a_pc_id != "") {
            $path = "//PageContent[@PCID = '" . $a_pc_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='$a_purpose']/Parameter";
            $res = xpath_eval($xpc, $path);
            if (count($res->nodeset) > 0) {
                return $res->nodeset;
            }
            return array();
        }

        $path = "//PageContent[@HierId = '" . $a_hier_id . "']/" . $this->parent_node_name . "/MediaAliasItem[@Purpose='$a_purpose']/Parameter";
        $res = xpath_eval($xpc, $path);
        if (count($res->nodeset) > 0) {
            return $res->nodeset;
        }
        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParameters()

ilMediaAliasItem::getParameters

(

)

Get all parameters as array.

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

References $i, getParameterNodes(), and getPcId().

                                   : 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->get_attribute("Name")] =
                $par_node->get_attribute("Value");
        }
        return $par_arr;
    }

Here is the call graph for this function:

getParameterString()

ilMediaAliasItem::getParameterString

(

)

Get all parameters as string.

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

References $i, getParameterNodes(), and getPcId().

                                        : string
    {
        $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->get_attribute("Name") . "=\"" . $par_node->get_attribute("Value") . "\"";
        }
        return implode(", ", $par_arr);
    }

Here is the call graph for this function:

getPcId()

ilMediaAliasItem::getPcId

(

)

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

References $pcid.

Referenced by __construct(), definesCaption(), definesParameters(), definesSize(), definesTextRepresentation(), deleteMapArea(), deleteMapAreaById(), deriveCaption(), deriveParameters(), deriveSize(), deriveTextRepresentation(), getCaption(), getHeight(), getHorizontalAlign(), getHrefOfArea(), getLinkTypeOfArea(), getMapAreas(), getParameters(), getParameterString(), getTargetFrameOfArea(), getTargetOfArea(), getTextRepresentation(), getTitleOfArea(), getTypeOfArea(), getWidth(), setAreaExtLink(), setAreaHighlightClass(), setAreaHighlightMode(), setAreaIntLink(), setAreaTitle(), setParameters(), and setShape().

                             : string
    {
        return $this->pcid;
    }

Here is the caller graph for this function:

getTargetFrameOfArea()

ilMediaAliasItem::getTargetFrameOfArea

(

int

$a_nr

)

Get target frame (only internal link)

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

References getMapAreaNodes(), and getPcId().

                                                   : string
    {
        $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]->child_nodes();
            return $childs[0]->get_attribute("TargetFrame");
        }
        return "";
    }

Here is the call graph for this function:

getTargetOfArea()

ilMediaAliasItem::getTargetOfArea

(

int

$a_nr

)

Get target (only internal link)

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

References getMapAreaNodes(), and getPcId().

                                              : string
    {
        $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]->child_nodes();
            return $childs[0]->get_attribute("Target");
        }
        return "";
    }

Here is the call graph for this function:

getTextRepresentation()

ilMediaAliasItem::getTextRepresentation

(

)

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

References getMAItemNode(), and getPcId().

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

Here is the call graph for this function:

getTitleOfArea()

ilMediaAliasItem::getTitleOfArea

(

int

$a_nr

)

Get title.

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

References getMapAreaNodes(), and getPcId().

Referenced by setAreaExtLink(), and setAreaIntLink().

                                             : string
    {
        $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]->child_nodes();
            return $childs[0]->get_content();
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTypeOfArea()

ilMediaAliasItem::getTypeOfArea

(

int

$a_nr

)

Get type (only internal link)

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

References getMapAreaNodes(), and getPcId().

                                            : string
    {
        $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]->child_nodes();
            return $childs[0]->get_attribute("Type");
        }
        return "";
    }

Here is the call graph for this function:

getWidth()

ilMediaAliasItem::getWidth

(

)

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

References getMAItemNode(), and getPcId().

Referenced by makeMapWorkCopy().

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

Here is the call graph for this function:

Here is the caller graph for this function:

hasAnyPropertiesSet()

ilMediaAliasItem::hasAnyPropertiesSet

(

)

Has the alias any properties set?

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

References definesCaption(), definesParameters(), definesSize(), and definesTextRepresentation().

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

Here is the call graph for this function:

insert()

ilMediaAliasItem::insert

(

)

inserts new node in dom

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

References $item_node, $parent_node_name, $path, $res, php4DOMNode\append_child(), php4DOMElement\set_attribute(), xpath_eval(), and xpath_new_context().

                            : void
    {
        $xpc = xpath_new_context($this->dom);
        $path = "//PageContent[@HierId = '" . $this->hier_id . "']/" . $this->parent_node_name;
        $res = xpath_eval($xpc, $path);
        if (count($res->nodeset) > 0) {
            $obj_node = $res->nodeset[0];
            $item_node = $this->dom->create_element("MediaAliasItem");
            $item_node = $obj_node->append_child($item_node);
            $item_node->set_attribute("Purpose", $this->purpose);
            $this->item_node = $item_node;
        }
    }

Here is the call graph for this function:

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 896 of file class.ilMediaAliasItem.php.

References $i, ilMediaItem\buildMapWorkImage(), ilMediaItem\copyOriginal(), getHeight(), ilMediaItem\getHeight(), getMapAreas(), ilMediaItem\getMapWorkCopyName(), ilMediaItem\getMapWorkImage(), getWidth(), ilMediaItem\getWidth(), and ilMediaItem\saveMapWorkImage().

Referenced by ilPCImageMapEditorGUI\makeMapWorkCopy().

     : bool {
        $a_st_item->copyOriginal();
        $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->getMapWorkCopyName());
        $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
            );
        }

        $a_st_item->saveMapWorkImage();
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAreaExtLink()

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

Set link of area to an external one.

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

References $attributes, ilDOMUtil\deleteAllChildsByName(), getMapAreaNodes(), getPcId(), getTitleOfArea(), and ilDOMUtil\setFirstOptionalElement().

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

Here is the call graph for this function:

setAreaHighlightClass()

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

Set highlight class single area.

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

References getMapAreaNodes(), and getPcId().

     : 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]->set_attribute("HighlightClass", $a_class);
        }
    }

Here is the call graph for this function:

setAreaHighlightMode()

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

Set highlight mode single area.

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

References getMapAreaNodes(), and getPcId().

     : 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]->set_attribute("HighlightMode", $a_mode);
        }
    }

Here is the call graph for this function:

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 572 of file class.ilMediaAliasItem.php.

References $attributes, ilDOMUtil\deleteAllChildsByName(), getMapAreaNodes(), getPcId(), getTitleOfArea(), and ilDOMUtil\setFirstOptionalElement().

     : 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);
            ilDOMUtil::deleteAllChildsByName($ma_nodes[$a_nr - 1], array("IntLink", "ExtLink"));
            $attributes = array("Type" => $a_type, "Target" => $a_target,
                "TargetFrame" => $a_target_frame);
            ilDOMUtil::setFirstOptionalElement(
                $this->dom,
                $ma_nodes[$a_nr - 1],
                "IntLink",
                array(""),
                $title,
                $attributes
            );
        }
    }

Here is the call graph for this function:

setAreaTitle()

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

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

References getMapAreaNodes(), and getPcId().

     : 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]->child_nodes();
            if (is_object($childs[0]) &&
                ($childs[0]->node_name() == "IntLink" || $childs[0]->node_name() == "ExtLink")) {
                $childs[0]->set_content($a_title);
            }
        }
    }

Here is the call graph for this function:

setCaption()

ilMediaAliasItem::setCaption

(

string

$a_caption

)

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

References ilDOMUtil\setFirstOptionalElement().

Referenced by ilPCInteractiveImageGUI\update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setHeight()

ilMediaAliasItem::setHeight

(

string

$a_height

)

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

References ilDOMUtil\setFirstOptionalElement().

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

Here is the call graph for this function:

setHorizontalAlign()

ilMediaAliasItem::setHorizontalAlign

(

string

$a_halign

)

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

References ilDOMUtil\setFirstOptionalElement().

Referenced by ilPCInteractiveImageGUI\centerAlign(), ilPCInteractiveImageGUI\leftAlign(), ilPCInteractiveImageGUI\leftFloatAlign(), ilPCInteractiveImageGUI\rightAlign(), and ilPCInteractiveImageGUI\rightFloatAlign().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setParameters()

ilMediaAliasItem::setParameters

(

array

$a_par_array

)

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

References $attributes, $i, ilDOMUtil\addElementToList(), ilMediaItem\checkParameter(), getParameterNodes(), and getPcId().

                                                     : 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);
                    ilDOMUtil::addElementToList(
                        $this->dom,
                        $this->item_node,
                        "Parameter",
                        array("MapArea"),
                        "",
                        $attributes
                    );
                }
            }
        }
    }

Here is the call graph for this function:

setPcId()

ilMediaAliasItem::setPcId

(

string

$a_pcid

)

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

Referenced by __construct().

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

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 629 of file class.ilMediaAliasItem.php.

References getMapAreaNodes(), and getPcId().

     : 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]->set_attribute("Shape", $a_shape_type);
            $ma_nodes[$a_nr - 1]->set_attribute("Coords", $a_coords);
        }
    }

Here is the call graph for this function:

setTextRepresentation()

ilMediaAliasItem::setTextRepresentation

(

string

$a_text_representation

)

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

References ilDOMUtil\setFirstOptionalElement().

     : void {
        ilDOMUtil::setFirstOptionalElement(
            $this->dom,
            $this->item_node,
            "TextRepresentation",
            array("Parameter", "MapArea"),
            $a_text_representation,
            array()
        );
    }

Here is the call graph for this function:

setWidth()

ilMediaAliasItem::setWidth

(

string

$a_width

)

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

References ilDOMUtil\setFirstOptionalElement().

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

Here is the call graph for this function:

Field Documentation

$dom

php4DOMDocument ilMediaAliasItem::$dom

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

$hier_id

string ilMediaAliasItem::$hier_id = ""

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

$item_node

php4DOMElement ilMediaAliasItem::$item_node = null

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

Referenced by insert().

$lng

ilLanguage ilMediaAliasItem::$lng

protected

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

$parent_node_name

string ilMediaAliasItem::$parent_node_name

protected

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

Referenced by insert().

$pcid

string ilMediaAliasItem::$pcid

protected

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

Referenced by getPcId().

$purpose

string ilMediaAliasItem::$purpose = ""

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

---

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

• Services/COPage/classes/class.ilMediaAliasItem.php