ilMediaAliasItem Class Reference

Class ilMediaAliasItem. More...

Collaboration diagram for ilMediaAliasItem:

Public Member Functions
	__construct (&$a_dom, $a_hier_id, $a_purpose, $a_pc_id="", $a_parent_node_name="MediaObject")
	getMAItemNode ($a_hier_id, $a_purpose, $a_pc_id="", $a_sub_element="")
	getParameterNodes ($a_hier_id, $a_purpose, $a_pc_id="")
	getMapAreaNodes ($a_hier_id, $a_purpose, $a_pc_id="")
	setPcId ($a_pcid)
	Set PC Id. More...
	getPcId ()
	Get PC Id. More...
	exists ()
	check if item node exists More...
	insert ()
	inserts new node in dom More...
	setWidth ($a_width)
	Set width. More...
	getWidth ()
	Get width. More...
	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 ($a_height)
	Set Height. More...
	getHeight ()
	Get Height. More...
	setCaption ($a_caption)
	Set Caption. More...
	getCaption ()
	Get Caption. More...
	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 ($a_text_representation)
	Set TextRepresentation. More...
	getTextRepresentation ()
	Get TextRepresentation. More...
	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 ($a_halign)
	getHorizontalAlign ()
	setParameters ($a_par_array)
	set parameter More...
	getParameterString ()
	Get all parameters as string. More...
	getParameters ()
	Get all parameters as array. More...
	getParameter ($a_name)
	get a single parameter 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 ($a_nr, $a_title)
	Set title of area. More...
	setAreaIntLink ($a_nr, $a_type, $a_target, $a_target_frame)
	Set link of area to an internal one. More...
	setAreaExtLink ($a_nr, $a_href)
	Set link of area to an external one. More...
	setShape ($a_nr, $a_shape_type, $a_coords)
	Set shape and coords of single area. More...
	setAreaHighlightMode ($a_nr, $a_mode)
	Set highlight mode single area. More...
	setAreaHighlightClass ($a_nr, $a_class)
	Set highlight class single area. More...
	addMapArea ( $a_shape_type, $a_coords, $a_title, $a_link, $a_id="")
	Add a new area to the map. More...
	deleteMapArea ($a_nr)
	Delete a sinlge map area. More...
	deleteMapAreaById ($a_id)
	Delete map areas by id. More...
	deleteAllMapAreas ()
	Delete all map areas. More...
	getLinkTypeOfArea ($a_nr)
	Get link type. More...
	getTypeOfArea ($a_nr)
	Get type (only interna link. More...
	getTargetOfArea ($a_nr)
	Get target (only interna link. More...
	getTargetFrameOfArea ($a_nr)
	Get target frame (only interna link. More...
	getHrefOfArea ($a_nr)
	Get href (only external link) More...
	getTitleOfArea ($a_nr)
	Get title. More...
	delete ()
	delete full item node from dom More...
	makeMapWorkCopy ( $a_st_item, $a_area_nr=0, $a_exclude=false, $a_output_new_area, $a_area_type, $a_coords)
	make map work copy of image More...

Data Fields
	$dom
	$hier_id
	$purpose
	$item_node

Protected Attributes
	$lng

Detailed Description

Class ilMediaAliasItem.

Media Alias Item, component of a media object (file or reference)

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilMediaAliasItem::__construct	(	&	$a_dom,
			$a_hier_id,
			$a_purpose,
			$a_pc_id = "",
			$a_parent_node_name = "MediaObject"
	)

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

References $DIC, getMAItemNode(), getPcId(), 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	(		$a_shape_type,
			$a_coords,
			$a_title,
			$a_link,
			$a_id = ""
	)

Add a new area to the map.

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

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

      {
        $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:

definesCaption()

ilMediaAliasItem::definesCaption

(

)

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

Returns

boolean returns true if caption is not derived from object

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

References getMAItemNode(), and getPcId().

    {
        $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:

definesParameters()

ilMediaAliasItem::definesParameters

(

)

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

Returns

boolean returns true if parameters are not derived from object

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

References getParameterNodes(), and getPcId().

    {
        $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:

definesSize()

ilMediaAliasItem::definesSize

(

)

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

Returns

boolean returns true if size is not derived from object

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

References getMAItemNode(), and getPcId().

    {
        $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:

definesTextRepresentation()

ilMediaAliasItem::definesTextRepresentation

(

)

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

Returns

boolean returns true if TextRepresentation is not derived from object

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

References getMAItemNode(), and getPcId().

    {
        $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:

delete()

ilMediaAliasItem::delete

(

)

delete full item node from dom

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

Referenced by ilPCMediaObjectGUI\saveAliasProperties().

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

Here is the caller graph for this function:

deleteAllMapAreas()

ilMediaAliasItem::deleteAllMapAreas

(

)

Delete all map areas.

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

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

    {
        $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

(

$a_nr

)

Delete a sinlge map area.

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

References getMapAreaNodes(), and getPcId().

    {
        $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

(

$a_id

)

Delete map areas by id.

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

References getMapAreaNodes(), and getPcId().

    {
        $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:

deriveCaption()

ilMediaAliasItem::deriveCaption

(

)

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

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

References getMAItemNode(), and getPcId().

Referenced by ilPCMediaObjectGUI\saveAliasProperties().

    {
        $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:

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

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

Referenced by ilPCMediaObjectGUI\saveAliasProperties().

    {
        $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:

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

References getMAItemNode(), and getPcId().

Referenced by ilPCMediaObjectGUI\saveAliasProperties().

    {
        $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:

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

References getMAItemNode(), and getPcId().

Referenced by ilPCMediaObjectGUI\saveAliasProperties().

    {
        $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:

Here is the caller graph for this function:

exists()

ilMediaAliasItem::exists

(

)

check if item node exists

Returns

boolean returns true if item node exists

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

Referenced by ilPCMediaObjectGUI\saveAliasProperties().

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

Here is the caller graph for this function:

getCaption()

ilMediaAliasItem::getCaption

(

)

Get Caption.

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

References getMAItemNode(), and getPcId().

Referenced by ilPCMediaObjectGUI\getAliasValues().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getHeight()

ilMediaAliasItem::getHeight

(

)

Get Height.

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

References getMAItemNode(), and getPcId().

Referenced by ilPCMediaObjectGUI\checkFixSize(), ilPCMediaObjectGUI\getAliasValues(), and makeMapWorkCopy().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getHorizontalAlign()

ilMediaAliasItem::getHorizontalAlign

(

)

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

References getMAItemNode(), and getPcId().

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

Here is the call graph for this function:

getHrefOfArea()

ilMediaAliasItem::getHrefOfArea

(

$a_nr

)

Get href (only external link)

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

References getMapAreaNodes(), and getPcId().

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

Here is the call graph for this function:

getLinkTypeOfArea()

ilMediaAliasItem::getLinkTypeOfArea

(

$a_nr

)

Get link type.

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

References getMapAreaNodes(), and getPcId().

    {
        $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";
            }
        }
    }

Here is the call graph for this function:

getMAItemNode()

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

Definition at line 50 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().

    {
        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];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMapAreaNodes()

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

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

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

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

    {
        if ($a_pc_id != "") {
            $xpc = xpath_new_context($this->dom);
            $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();
        }
        
        $xpc = xpath_new_context($this->dom);
        $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 545 of file class.ilMediaAliasItem.php.

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

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

    {
        $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:

getParameter()

ilMediaAliasItem::getParameter

(

$a_name

)

get a single parameter

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

    {
    }

getParameterNodes()

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

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

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

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

    {
        if ($a_pc_id != "") {
            $xpc = xpath_new_context($this->dom);
            $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();
        }
        
        $xpc = xpath_new_context($this->dom);
        $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;
        }
    }

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

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

Referenced by ilPCMediaObjectGUI\initAliasForm().

    {
        $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:

Here is the caller graph for this function:

getParameterString()

ilMediaAliasItem::getParameterString

(

)

Get all parameters as string.

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

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

Referenced by ilPCMediaObjectGUI\getAliasValues().

    {
        $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:

Here is the caller graph for this function:

getPcId()

ilMediaAliasItem::getPcId

(

)

Get PC Id.

Returns

string PC Id

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

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().

    {
        return $this->pcid;
    }

Here is the caller graph for this function:

getTargetFrameOfArea()

ilMediaAliasItem::getTargetFrameOfArea

(

$a_nr

)

Get target frame (only interna link.

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

References getMapAreaNodes(), and getPcId().

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

Here is the call graph for this function:

getTargetOfArea()

ilMediaAliasItem::getTargetOfArea

(

$a_nr

)

Get target (only interna link.

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

References getMapAreaNodes(), and getPcId().

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

Here is the call graph for this function:

getTextRepresentation()

ilMediaAliasItem::getTextRepresentation

(

)

Get TextRepresentation.

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

References getMAItemNode(), and getPcId().

Referenced by ilPCMediaObjectGUI\getAliasValues().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getTitleOfArea()

ilMediaAliasItem::getTitleOfArea

(

$a_nr

)

Get title.

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

References getMapAreaNodes(), and getPcId().

Referenced by setAreaExtLink(), and setAreaIntLink().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getTypeOfArea()

ilMediaAliasItem::getTypeOfArea

(

$a_nr

)

Get type (only interna link.

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

References getMapAreaNodes(), and getPcId().

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

Here is the call graph for this function:

getWidth()

ilMediaAliasItem::getWidth

(

)

Get width.

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

References getMAItemNode(), and getPcId().

Referenced by ilPCMediaObjectGUI\checkFixSize(), ilPCMediaObjectGUI\getAliasValues(), and makeMapWorkCopy().

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

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilMediaAliasItem::insert

(

)

inserts new node in dom

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

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

Referenced by ilPCMediaObjectGUI\saveAliasProperties().

    {
        $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:

Here is the caller graph for this function:

makeMapWorkCopy()

ilMediaAliasItem::makeMapWorkCopy	(		$a_st_item,
			$a_area_nr = 0,
			$a_exclude = false,
			$a_output_new_area,
			$a_area_type,
			$a_coords
	)

make map work copy of image

Parameters

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

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

References $i, $lng, $size, getHeight(), getMapAreas(), and getWidth().

Referenced by ilPCImageMapEditorGUI\makeMapWorkCopy().

      {
        $lng = $this->lng;
        
        if (!$a_st_item->copyOriginal()) {
            return false;
        }
        $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	(		$a_nr,
			$a_href
	)

Set link of area to an external one.

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

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

    {
        $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	(		$a_nr,
			$a_class
	)

Set highlight class single area.

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

References getMapAreaNodes(), and getPcId().

    {
        $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	(		$a_nr,
			$a_mode
	)

Set highlight mode single area.

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

References getMapAreaNodes(), and getPcId().

    {
        $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	(		$a_nr,
			$a_type,
			$a_target,
			$a_target_frame
	)

Set link of area to an internal one.

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

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

    {
        $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	(		$a_nr,
			$a_title
	)

Set title of area.

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

References getMapAreaNodes(), and getPcId().

    {
        $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

(

$a_caption

)

Set Caption.

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

References array, and ilDOMUtil\setFirstOptionalElement().

Referenced by ilPCMediaObjectGUI\saveAliasProperties(), and ilPCInteractiveImageGUI\update().

    {
        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

(

$a_height

)

Set Height.

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

References array, and ilDOMUtil\setFirstOptionalElement().

Referenced by ilPCMediaObjectGUI\saveAliasProperties().

    {
        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:

Here is the caller graph for this function:

setHorizontalAlign()

ilMediaAliasItem::setHorizontalAlign

(

$a_halign

)

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

References array, and ilDOMUtil\setFirstOptionalElement().

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

    {
        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

(

$a_par_array

)

set parameter

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

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

Referenced by ilPCMediaObjectGUI\saveAliasProperties().

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

        include_once("./Services/MediaObjects/classes/class.ilMediaItem.php");
        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:

Here is the caller graph for this function:

setPcId()

ilMediaAliasItem::setPcId

(

$a_pcid

)

Set PC Id.

Parameters

string

$a_pcid

PC Id

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

Referenced by __construct().

    {
        $this->pcid = $a_pcid;
    }

Here is the caller graph for this function:

setShape()

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

Set shape and coords of single area.

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

References getMapAreaNodes(), and getPcId().

    {
        $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

(

$a_text_representation

)

Set TextRepresentation.

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

References array, and ilDOMUtil\setFirstOptionalElement().

Referenced by ilPCMediaObjectGUI\saveAliasProperties().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setWidth()

ilMediaAliasItem::setWidth

(

$a_width

)

Set width.

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

References array, and ilDOMUtil\setFirstOptionalElement().

Referenced by ilPCMediaObjectGUI\saveAliasProperties().

    {
        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:

Here is the caller graph for this function:

Field Documentation

$dom

ilMediaAliasItem::$dom

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

$hier_id

ilMediaAliasItem::$hier_id

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

$item_node

ilMediaAliasItem::$item_node

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

Referenced by insert().

$lng

ilMediaAliasItem::$lng

protected

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

Referenced by makeMapWorkCopy().

$purpose

ilMediaAliasItem::$purpose

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

---

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

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