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

Inheritance diagram for ilPCInteractiveImage:

Collaboration diagram for ilPCInteractiveImage:

Public Member Functions
	init ()
	Init object. More...

	readMediaObject (int $a_mob_id=0)

	setDomNode (DOMNode $dom_node)

	setMediaObject (ilObjMediaObject $a_mediaobject)

	getMediaObject ()

	createMediaObject ()

	create ()

	getStandardMediaItem ()

	getStandardAliasItem ()

	getBaseThumbnailTarget ()

	createAlias (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")

	dumpXML ()

	addContentPopup (?string $title=null)
	Add a tab. More...

	getPopups ()
	Get popup captions. More...

	savePopups (array $a_popups)
	Save popups. More...

	deletePopup (string $a_hier_id, string $a_pc_id)
	Delete popup. More...

	saveContentPopupTitle (string $nr, string $title)

	deletePopupByNr (string $nr)

	addTriggerArea (ilMediaAliasItem $a_alias_item, string $a_shape_type, string $a_coords, string $a_title, string $hl_mode="", string $hl_class="")
	Add a new trigger. More...

	addTriggerMarker (string $title="", string $coords="")
	Add a new trigger marker. More...

	getTriggerNodes (string $a_hier_id, string $a_pc_id="")

	getTriggers ()

	deleteTrigger (ilMediaAliasItem $a_alias_item, int $a_nr)
	Delete Trigger. More...

	setTriggerOverlays (array $a_ovs)
	Set trigger overlays. More...

	deleteOverlay (string $file)

	setTriggerOverlayPositions (array $a_pos)
	Set trigger overlay position. More...

	setTriggerMarkerPositions (array $a_pos)
	Set trigger marker position. More...

	setTriggerPopupPositions (array $a_pos)
	Set trigger popup position. More...

	setTriggerPopupSize (array $a_size)
	Set trigger popup size. More...

	setTriggerPopups (array $a_pops)
	Set trigger popups. More...

	setTriggerTitles (array $a_titles)
	Set trigger titles. More...

	setExtLinkTitle (int $a_nr, string $a_title)

	createFromMobId (\ilPageObject $page, int $mob_id, string $hier_id, string $pc_id)

	getIIMModel ()

	setTriggerProperties (string $nr, string $title, string $shape_type, string $coords, string $hl_mode="", string $hl_class="")

	setTriggerOverlay (string $nr, string $overlay, string $coords)

	setTriggerPopup (string $nr, string $popup, string $position, string $size)

	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	Modify page content after xsl. More...

	getPopupDummy ()

	getBackgroundImage ()

Public Member Functions inherited from ilPageContent
	__construct (ilPageObject $a_pg_obj, ?PageManagerInterface $page_manager=null, ?ObjectAdapterInterface $object_adapter=null)

	setPage (ilPageObject $a_val)

	getPage ()

	init ()
	Init object. More...

	getType ()

	getDomNode ()

	getDomDoc ()

	setDomNode (DOMNode $node)

	getChildNode ()

	getJavascriptFiles (string $a_mode)

	getCssFiles (string $a_mode)

	getOnloadCode (string $a_mode)

	setHierId (string $a_hier_id)

	getHierId ()

	lookupHierId ()

	readHierId ()

	setPcId (string $a_pcid)

	getPCId ()

	setFileDownloadLink (string $a_download_link)

	getFileDownloadLink ()

	setProfileBackUrl (string $url)

	getProfileBackUrl ()

	setFullscreenLink (string $a_fullscreen_link)

	getFullscreenLink ()

	setSourcecodeDownloadScript (string $script_name)

	getSourcecodeDownloadScript ()

	readPCId ()

	writePCId (string $a_pc_id)

	setEnabled (string $value)
	Set Enabled value for page content component. More...

	enable ()

	disable ()

	isEnabled ()

	createPageContentNode (bool $a_set_this_node=true)
	Create page content node (always use this method first when adding a new element) More...

	getNewPageContentNode ()

	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	Modify page content after xsl. More...

	getModel ()
	Get model as needed for the front-end editor. More...

Static Public Member Functions
static	handleCopiedContent (DOMDocument $a_domdoc, bool $a_self_ass=true, bool $a_clone_mobs=false, int $new_parent_id=0, int $obj_copy_id=0)
	Handle copied content. More...

Static Public Member Functions inherited from ilPageContent
static	sortHierIds (array $a_array)
	Sort an array of Hier IDS in ascending order. More...

static	isGreaterHierId (string $a, string $b)
	Check whether Hier ID $a is greater than Hier ID $b. More...

static	getLangVars ()
	Get lang vars needed for editing. More...

static	handleCopiedContent (DOMDocument $a_domdoc, bool $a_self_ass=true, bool $a_clone_mobs=false, int $new_parent_id=0, int $obj_copy_id=0)
	Handle copied content. More...

static	afterPageUpdate (ilPageObject $a_page, DOMDocument $a_domdoc, string $a_xml, bool $a_creation)
	After page has been updated (or created) More...

static	beforePageDelete (ilPageObject $a_page)
	Before page is being deleted. More...

static	afterRepositoryCopy (ilPageObject $page, array $mapping, int $source_ref_id)
	After repository (container) copy action. More...

static	afterPageHistoryEntry (ilPageObject $a_page, DOMDocument $a_old_domdoc, string $a_old_xml, int $a_old_nr)
	After page history entry has been created. More...

static	deleteHistoryLowerEqualThan (string $parent_type, int $page_id, string $lang, int $delete_lower_than_nr)
	Overwrite in derived classes, if old history entries are being deleted. More...

Data Fields
const	AREA = "Area"

const	MARKER = "Marker"

DOMNode	$iim_node

Data Fields inherited from ilPageContent
string	$hier_id = ""

DOMNode	$dom_node = null

string	$page_lang = ""

Protected Member Functions
	setMapAreaProperties (ilMediaAliasItem $a_alias_item, string $a_shape_type, string $a_coords, string $a_title, string $a_id, string $hl_mode="", string $hl_class="")

	getTriggerNode (string $nr)

Protected Member Functions inherited from ilPageContent
	getPageManager ()

	setType (string $a_type)
	Set Type. More...

	hasNode ()

	createInitialChildNode (string $hier_id, string $pc_id, string $child, array $child_attributes=[])

Protected Attributes
ILIAS MediaObjects Thumbs ThumbsManager	$thumbs

ILIAS COPage Xsl XslManager	$xsl

DOMNode	$mal_node

DOMNode	$med_alias_node

ILIAS DI UIServices	$ui

ILIAS COPage Html TransformUtil	$htmlTransform

ILIAS COPage PC InteractiveImage IIMManager	$manager

ilMediaAliasItem	$std_alias_item

ilObjMediaObject	$mediaobject

ilLanguage	$lng

Protected Attributes inherited from ilPageContent
DOMDocument	$dom_doc

ILIAS COPage InternalDomainService	$domain

string	$pcid

string	$type = ""

ilPageObject	$pg_obj

string	$file_download_link = ''

string	$fullscreen_link = ''

string	$sourcecode_download_script = ''

ilLogger	$log

string	$profile_back_url = ""

ILIAS COPage Dom DomUtil	$dom_util

PageManagerInterface	$page_manager = null

ObjectAdapterInterface	$object = null

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 Interactive image.

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

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

Member Function Documentation

◆ addContentPopup()

ilPCInteractiveImage::addContentPopup ( ?string $title = null )

Add a tab.

Definition at line 173 of file class.ilPCInteractiveImage.php.

                                                          : void
    {
        $lng = $this->lng;
 
        if ($title === null) {
            $title = $lng->txt("cont_new_popup");
        }
        $max = 0;
        $popups = $this->getPopups();
        foreach ($popups as $p) {
            $max = max($max, (int) $p["nr"]);
        }
 
        $new_item = $this->dom_doc->createElement("ContentPopup");
        $new_item->setAttribute("Title", $title);
        $new_item->setAttribute("Nr", $max + 1);
        $new_item = $this->iim_node->appendChild($new_item);
    }

References $lng.

◆ addTriggerArea()

ilPCInteractiveImage::addTriggerArea	(	ilMediaAliasItem	$a_alias_item,
		string	$a_shape_type,
		string	$a_coords,
		string	$a_title,
		string	$hl_mode = `""`,
		string	$hl_class = `""`
	)

Add a new trigger.

Definition at line 311 of file class.ilPCInteractiveImage.php.

     : void {
        $max = 0;
        $triggers = $this->getTriggers();
        foreach ($triggers as $t) {
            $max = max($max, (int) $t["Nr"]);
        }
 
        $this->setMapAreaProperties(
            $a_alias_item,
            $a_shape_type,
            $a_coords,
            ilUtil::stripSlashes($a_title),
            (string) ($max + 1),
            $hl_mode,
            $hl_class
        );
 
        $attributes = array("Type" => self::AREA,
                            "Title" => ilUtil::stripSlashes($a_title),
                            "Nr" => $max + 1,
                            "OverlayX" => "0",
                            "OverlayY" => "0",
                            "Overlay" => "",
                            "PopupNr" => "",
                            "PopupX" => "0",
                            "PopupY" => "0",
                            "PopupWidth" => "150",
                            "PopupHeight" => "200"
                            );
        $ma_node = $this->dom_util->addElementToList(
            $this->iim_node,
            "Trigger",
            array("ContentPopup"),
            "",
            $attributes
        );
    }

◆ addTriggerMarker()

ilPCInteractiveImage::addTriggerMarker	(	string	$title = `""`,
		string	$coords = `""`
	)

Add a new trigger marker.

Definition at line 359 of file class.ilPCInteractiveImage.php.

     : void {
        $lng = $this->lng;
 
        $max = 0;
        $triggers = $this->getTriggers();
        foreach ($triggers as $t) {
            $max = max($max, (int) $t["Nr"]);
        }
 
        if ($title === "") {
            $title = $lng->txt("cont_new_marker");
        }
        $markerx = "0";
        $markery = "0";
        if ($coords !== "") {
            $coord_parts = explode(",", $coords);
            $markerx = ($coord_parts[0] ?? "0");
            $markery = ($coord_parts[1] ?? "0");
        }
 
        $attributes = array("Type" => self::MARKER,
                            "Title" => $title,
                            "Nr" => $max + 1,
                            "OverlayX" => "0",
                            "OverlayY" => "0",
                            "MarkerX" => $markerx,
                            "MarkerY" => $markery,
                            "PopupNr" => "",
                            "PopupX" => "0",
                            "PopupY" => "0",
                            "PopupWidth" => "150",
                            "PopupHeight" => "200"
        );
        $ma_node = $this->dom_util->addElementToList(
            $this->iim_node,
            "Trigger",
            array("ContentPopup"),
            "",
            $attributes
        );
    }

◆ create()

ilPCInteractiveImage::create ( )

Definition at line 100 of file class.ilPCInteractiveImage.php.

                            : void
    {
        $this->createPageContentNode();
    }

References ilPageContent\createPageContentNode().

Here is the call graph for this function:

◆ createAlias()

ilPCInteractiveImage::createAlias	(	ilPageObject	$a_pg_obj,
		string	$a_hier_id,
		string	$a_pc_id = `""`
	)

Definition at line 120 of file class.ilPCInteractiveImage.php.

     : void {
        $this->setDomNode($this->dom_doc->createElement("PageContent"));
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->iim_node = $this->dom_doc->createElement("InteractiveImage");
        $this->iim_node = $this->getDomNode()->appendChild($this->iim_node);
        $this->mal_node = $this->dom_doc->createElement("MediaAlias");
        $this->mal_node = $this->iim_node->appendChild($this->mal_node);
        $this->mal_node->setAttribute("OriginId", "il__mob_" . $this->getMediaObject()->getId());
 
        // standard view
        $item_node = $this->dom_doc->createElement("MediaAliasItem");
        $item_node = $this->iim_node->appendChild($item_node);
        $item_node->setAttribute("Purpose", "Standard");
        $media_item = $this->getMediaObject()->getMediaItem("Standard");
 
        $layout_node = $this->dom_doc->createElement("Layout");
        $layout_node = $item_node->appendChild($layout_node);
        $layout_node->setAttribute("HorizontalAlign", "Left");
 
        // caption
        if ($media_item->getCaption() != "") {
            $cap_node = $this->dom_doc->createElement("Caption");
            $cap_node = $item_node->appendChild($cap_node);
            $cap_node->setAttribute("Align", "bottom");
            $this->dom_util->setContent($cap_node, $media_item->getCaption());
        }
 
        // text representation
        if ($media_item->getTextRepresentation() != "") {
            $tr_node = $this->dom_doc->createElement("TextRepresentation");
            $tr_node = $item_node->appendChild($tr_node);
            $this->dom_util->setContent($tr_node, $media_item->getTextRepresentation());
        }
    }

◆ createFromMobId()

ilPCInteractiveImage::createFromMobId	(	\ilPageObject	$page,
		int	$mob_id,
		string	$hier_id,
		string	$pc_id
	)

Definition at line 649 of file class.ilPCInteractiveImage.php.

     : void {
        $this->setMediaObject(new ilObjMediaObject($mob_id));
        $this->createAlias($page, $hier_id, $pc_id);
    }

◆ createMediaObject()

ilPCInteractiveImage::createMediaObject ( )

Definition at line 95 of file class.ilPCInteractiveImage.php.

                                       : void
    {
        $this->setMediaObject(new ilObjMediaObject());
    }

References setMediaObject().

Here is the call graph for this function:

◆ deleteOverlay()

ilPCInteractiveImage::deleteOverlay ( string $file )

Definition at line 480 of file class.ilPCInteractiveImage.php.

                                               : void
    {
        $file = str_replace("..", "", ilUtil::stripSlashes($file));
        $this->getMediaObject()
             ->removeAdditionalFile("overlays/" . $file);
        $tr_nodes = $this->getTriggerNodes($this->hier_id, $this->getPCId());
        for ($i = 0; $i < count($tr_nodes); $i++) {
            $tr_node = $tr_nodes[$i];
            if ($tr_node->getAttribute("Overlay") === $file) {
                $tr_node->removeAttribute("Overlay");
            }
        }
    }

References ilUtil\stripSlashes().

Here is the call graph for this function:

◆ deletePopup()

ilPCInteractiveImage::deletePopup	(	string	$a_hier_id,
		string	$a_pc_id
	)

Delete popup.

Definition at line 235 of file class.ilPCInteractiveImage.php.

     : void {
        foreach ($this->iim_node->childNodes as $c) {
            if ($c->nodeName === "ContentPopup") {
                if ($a_pc_id == $c->getAttribute("PCID") &&
                    $a_hier_id == $c->getAttribute("HierId")) {
                    $c->parentNode->removeChild($c);
                }
            }
        }
    }

References $c.

◆ deletePopupByNr()

ilPCInteractiveImage::deletePopupByNr ( string $nr )

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

     : void {
        foreach ($this->iim_node->childNodes as $c) {
            if ($c->nodeName === "ContentPopup") {
                if ($nr === $c->getAttribute("Nr")) {
                    $c->parentNode->removeChild($c);
                }
            }
        }
        $tr_nodes = $this->getTriggerNodes($this->hier_id, $this->getPCId());
        foreach ($tr_nodes as $tr_node) {
            if ($tr_node->getAttribute("PopupNr") === $nr) {
                $tr_node->removeAttribute("PopupNr");
            }
        }
    }

References $c.

◆ deleteTrigger()

ilPCInteractiveImage::deleteTrigger	(	ilMediaAliasItem	$a_alias_item,
		int	$a_nr
	)

Delete Trigger.

Definition at line 448 of file class.ilPCInteractiveImage.php.

     : void {
        foreach ($this->iim_node->childNodes as $c) {
            if ($c->nodeName === "Trigger") {
                if ($a_nr === (int) $c->getAttribute("Nr")) {
                    $c->parentNode->removeChild($c);
                }
            }
        }
        $a_alias_item->deleteMapAreaById($a_nr);
    }

References $c.

◆ dumpXML()

ilPCInteractiveImage::dumpXML ( )

Definition at line 159 of file class.ilPCInteractiveImage.php.

                             : string
    {
        $xml = $this->dom_util->dump($this->getDomNode());
        return $xml;
    }

◆ getBackgroundImage()

ilPCInteractiveImage::getBackgroundImage ( )

Definition at line 829 of file class.ilPCInteractiveImage.php.

                                        : string
    {
        $mob = $this->getMediaObject();
 
        // output image map
        $xml = "<dummy>";
        $xml .= $mob->getXML(IL_MODE_ALIAS);
        $xml .= $mob->getXML(IL_MODE_OUTPUT);
        $xml .= "</dummy>";
        $wb_path = \ilFileUtils::getWebspaceDir("output") . "/";
        $params = array(
            'media_mode' => 'enable',
            'pg_frame' => "",
            'enlarge_path' => \ilUtil::getImagePath("enlarge.svg"),
            'webspace_path' => $wb_path);
 
        $output = $this->xsl->process($xml, $params);
        return $output;
    }

References $params, ilUtil\getImagePath(), ilFileUtils\getWebspaceDir(), IL_MODE_ALIAS, and IL_MODE_OUTPUT.

Referenced by ILIAS\COPage\PC\InteractiveImage\InteractiveImageCommandActionHandler\getStandardResponse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBaseThumbnailTarget()

ilPCInteractiveImage::getBaseThumbnailTarget ( )

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

                                            : string
    {
        return $this->thumbs->getThumbSrc($this->getMediaObject()->getId());
    }

References ILIAS\Survey\Mode\getId(), and getMediaObject().

Here is the call graph for this function:

◆ getIIMModel()

ilPCInteractiveImage::getIIMModel ( )

Definition at line 659 of file class.ilPCInteractiveImage.php.

                                 : ?stdClass
    {
        $alias_item = $this->getStandardAliasItem();
        $model = new \stdClass();
        $model->triggers = $this->getTriggers();
        $model->popups = $this->getPopups();
        $model->media_item = $alias_item->getModel();
        $model->overlays = $this->manager->getOverlays($this->getMediaObject());
        return $model;
    }

Referenced by ILIAS\COPage\PC\InteractiveImage\InteractiveImageCommandActionHandler\getStandardResponse().

Here is the caller graph for this function:

◆ getMediaObject()

ilPCInteractiveImage::getMediaObject ( )

Definition at line 90 of file class.ilPCInteractiveImage.php.

                                    : ilObjMediaObject
    {
        return $this->mediaobject;
    }

References $mediaobject.

Referenced by getBaseThumbnailTarget(), and getStandardMediaItem().

Here is the caller graph for this function:

◆ getPopupDummy()

ilPCInteractiveImage::getPopupDummy ( )

Definition at line 817 of file class.ilPCInteractiveImage.php.

                                   : string
    {
        $content = <<<EOT
<div style='position:relative'><div class='copg-iim-popup copg-iim-popup-md' data-copg-cont-type='iim-popup'>
<div class="ilc_iim_ContentPopup" data-copg-iim-data-type="popup"><div class="ilc_Paragraph ilc_text_block_Standard">
###content###
</div></div></div></div>
 
EOT;
        return $content;
    }

◆ getPopups()

ilPCInteractiveImage::getPopups ( )

Get popup captions.

Definition at line 195 of file class.ilPCInteractiveImage.php.

                               : array
    {
        $titles = array();
        $k = 0;
        foreach ($this->iim_node->childNodes as $c) {
            if ($c->nodeName == "ContentPopup") {
                $pc_id = $c->getAttribute("PCID");
                $hier_id = $c->getAttribute("HierId");
                $title = $c->getAttribute("Title");
                $nr = $c->getAttribute("Nr");
 
                $titles[] = array("title" => $title,
                                  "nr" => $nr,
                                  "pc_id" => $pc_id,
                                  "hier_id" => $hier_id
                );
                $k++;
            }
        }
        return $titles;
    }

References $c.

◆ getStandardAliasItem()

ilPCInteractiveImage::getStandardAliasItem ( )

Definition at line 110 of file class.ilPCInteractiveImage.php.

                                          : ilMediaAliasItem
    {
        return $this->std_alias_item;
    }

References $std_alias_item.

◆ getStandardMediaItem()

ilPCInteractiveImage::getStandardMediaItem ( )

Definition at line 105 of file class.ilPCInteractiveImage.php.

                                          : ilMediaItem
    {
        return $this->getMediaObject()->getMediaItem("Standard");
    }

References getMediaObject().

Here is the call graph for this function:

◆ getTriggerNode()

ilPCInteractiveImage::getTriggerNode ( string $nr )

protected

Definition at line 670 of file class.ilPCInteractiveImage.php.

    {
        $tr_nodes = $this->getTriggerNodes($this->hier_id, $this->getPCId());
        for ($i = 0; $i < count($tr_nodes); $i++) {
            $tr_node = $tr_nodes[$i];
            if ($tr_node->getAttribute("Nr") == $nr) {
                return $tr_node;
            }
        }
        return null;
    }

◆ getTriggerNodes()

ilPCInteractiveImage::getTriggerNodes	(	string	$a_hier_id,
		string	$a_pc_id = `""`
	)

Definition at line 404 of file class.ilPCInteractiveImage.php.

     : DOMNodeList {
        if ($a_pc_id != "") {
            $path = "//PageContent[@PCID = '" . $a_pc_id . "']/InteractiveImage/Trigger";
            return $this->dom_util->path($this->dom_doc, $path);
        }
 
        $path = "//PageContent[@HierId = '" . $a_hier_id . "']/InteractiveImage/Trigger";
        return $this->dom_util->path($this->dom_doc, $path);
    }

References $path.

◆ getTriggers()

ilPCInteractiveImage::getTriggers ( )

Definition at line 417 of file class.ilPCInteractiveImage.php.

                                 : array
    {
        $tr_nodes = $this->getTriggerNodes($this->hier_id, $this->getPCId());
        $trigger_arr = array();
        foreach ($tr_nodes as $tr_node) {
            $childs = $tr_node->childNodes;
            $trigger_arr[] = array(
                "Nr" => $tr_node->getAttribute("Nr"),
                "Type" => $tr_node->getAttribute("Type"),
                "Title" => $tr_node->getAttribute("Title"),
                "OverlayX" => $tr_node->getAttribute("OverlayX"),
                "OverlayY" => $tr_node->getAttribute("OverlayY"),
                "MarkerX" => $tr_node->getAttribute("MarkerX"),
                "MarkerY" => $tr_node->getAttribute("MarkerY"),
                "Overlay" => $tr_node->getAttribute("Overlay"),
                "PopupNr" => $tr_node->getAttribute("PopupNr"),
                "PopupX" => $tr_node->getAttribute("PopupX"),
                "PopupY" => $tr_node->getAttribute("PopupY"),
                "PopupWidth" => $tr_node->getAttribute("PopupWidth"),
                "PopupHeight" => $tr_node->getAttribute("PopupHeight"),
                "PopupPosition" => $tr_node->getAttribute("PopupPosition"),
                "PopupSize" => $tr_node->getAttribute("PopupSize")
            );
        }
 
        return $trigger_arr;
    }

◆ handleCopiedContent()

static ilPCInteractiveImage::handleCopiedContent	(	DOMDocument	$a_domdoc,
		bool	$a_self_ass = `true`,
		bool	$a_clone_mobs = `false`,
		int	$new_parent_id = `0`,
		int	$obj_copy_id = `0`
	)

static

Handle copied content.

This function must, e.g. create copies of objects referenced within the content (e.g. question objects)

Parameters

DOMDocument	$a_domdoc
bool	$a_self_ass
bool	$a_clone_mobs
int	$new_parent_id
int	$obj_copy_id

Reimplemented from ilPageContent.

Definition at line 623 of file class.ilPCInteractiveImage.php.

     : void {
        global $DIC;
 
        $dom_util = $DIC->copage()->internal()->domain()->domUtil();
        $path = "//InteractiveImage/MediaAlias";
        $nodes = $dom_util->path($a_domdoc, $path);
        foreach ($nodes as $node) {
            $or_id = $node->getAttribute("OriginId");
            $inst_id = ilInternalLink::_extractInstOfTarget($or_id);
            $mob_id = ilInternalLink::_extractObjIdOfTarget($or_id);
            if (!($inst_id > 0)) {
                if ($mob_id > 0) {
                    $media_object = new ilObjMediaObject($mob_id);
                    $new_mob = $media_object->duplicate();
                    $node->setAttribute("OriginId", "il__mob_" . $new_mob->getId());
                }
            }
        }
    }

References ilInternalLink\_extractInstOfTarget(), and ilInternalLink\_extractObjIdOfTarget().

Here is the call graph for this function:

◆ init()

ilPCInteractiveImage::init ( )

Init object.

This function must be overwritten and at least set the content type.

Reimplemented from ilPageContent.

Definition at line 41 of file class.ilPCInteractiveImage.php.

                          : void
    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->setType("iim");
        $this->manager = $DIC->copage()->internal()->domain()->pc()->interactiveImage();
        $this->htmlTransform = $DIC->copage()->internal()->domain()->htmlTransformUtil();
        $this->ui = $DIC->copage()->internal()->gui()->ui();
        $this->xsl = $DIC->copage()->internal()->domain()->xsl();
        $this->thumbs = $DIC->mediaObjects()->internal()->domain()->thumbs();
    }

References $DIC, ILIAS\Repository\lng(), ilPageContent\setType(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ modifyPageContentPostXsl()

ilPCInteractiveImage::modifyPageContentPostXsl	(	string	$a_output,
		string	$a_mode,
		bool	$a_abstract_only = `false`
	)

Modify page content after xsl.

Reimplemented from ilPageContent.

Definition at line 766 of file class.ilPCInteractiveImage.php.

     : string {
        $keep_original = false;
        if (in_array($a_mode, [ilPageObjectGUI::EDIT], true)) {
            $keep_original = true;
        }
        $trans = $this->htmlTransform;
        while (!is_null($params = $trans->getPlaceholderParams($a_output, "InteractiveImage;PopupStart"))) {
            $params = $trans->getPlaceholderParams($a_output, "InteractiveImage;PopupStart");
            $par_page = $params[2] ?? 0;
            $par_pop_nr = $params[4] ?? 0;
            $inner = $trans->getInnerContentOfPlaceholders(
                $a_output,
                "InteractiveImage;PopupStart",
                "InteractiveImage;PopupEnd"
            );
            if ($keep_original) {
                $new_inner = $inner;
            } else {
                $pop = $this->ui->factory()->popover()->standard(
                    $this->ui->factory()->legacy()->content("#####popovercontent#####")
                );
                $signal_id = $pop->getShowSignal()->getId();
                //$new_inner = $this->ui->renderer()->render($pop);
                $new_inner = "#####popovercontent#####";
                // we need a position relative around the absolute inner div, to make 100% the current available space
                $new_inner = str_replace(
                    "#####popovercontent#####",
                    "<div style='position:relative'><div class='copg-iim-popup copg-iim-popup-md' style='display:none;' data-copg-cont-type='iim-popup' data-signal-id='$signal_id' data-copg-page='$par_page' data-copg-popup-nr='$par_pop_nr'>" . $inner . "</div></div>",
                    $new_inner
                );
            }
            $html = $trans->replaceInnerContentAndPlaceholders(
                $a_output,
                "InteractiveImage;PopupStart",
                "InteractiveImage;PopupEnd",
                $new_inner
            );
            if (is_null($html)) {
                break;
            } else {
                $a_output = $html;
            }
        }
        return $a_output .
'<script type="module" src="./components/ILIAS/COPage/PC/InteractiveImage/js/presentation/src/presentation.js"></script>';
    }

◆ readMediaObject()

ilPCInteractiveImage::readMediaObject ( int $a_mob_id = 0 )

Definition at line 54 of file class.ilPCInteractiveImage.php.

                                                      : void
    {
        if ($a_mob_id > 0) {
            $mob = new ilObjMediaObject($a_mob_id);
            $this->setMediaObject($mob);
        }
    }

References setMediaObject().

Here is the call graph for this function:

◆ saveContentPopupTitle()

ilPCInteractiveImage::saveContentPopupTitle	(	string	$nr,
		string	$title
	)

Definition at line 249 of file class.ilPCInteractiveImage.php.

                                                                    : void
    {
        foreach ($this->iim_node->childNodes as $c) {
            if ($c->nodeName === "ContentPopup") {
                if ($nr === $c->getAttribute("Nr")) {
                    $c->setAttribute("Title", $title);
                }
            }
        }
    }

References $c.

◆ savePopups()

ilPCInteractiveImage::savePopups ( array $a_popups )

Save popups.

Definition at line 220 of file class.ilPCInteractiveImage.php.

                                               : void
    {
        foreach ($this->iim_node->childNodes as $c) {
            if ($c->nodeName == "ContentPopup") {
                $pc_id = $c->getAttribute("PCID");
                $hier_id = $c->getAttribute("HierId");
                $k = $hier_id . ":" . $pc_id;
                $c->setAttribute("Title", $a_popups[$k]);
            }
        }
    }

References $c.

◆ setDomNode()

ilPCInteractiveImage::setDomNode ( DOMNode $dom_node )

Reimplemented from ilPageContent.

Definition at line 62 of file class.ilPCInteractiveImage.php.

                                                 : void
    {
        parent::setDomNode($dom_node);          // this is the PageContent node
        $this->iim_node = $dom_node->firstChild;
        if (isset($this->iim_node)) {
            $this->med_alias_node = $this->iim_node->firstChild;
        }
        if (isset($this->med_alias_node)) {
            $id = $this->med_alias_node->getAttribute("OriginId");
            $mob_id = ilInternalLink::_extractObjIdOfTarget($id);
            if ($this->object->getTypeForObjId($mob_id) == "mob") {
                $this->setMediaObject(new ilObjMediaObject($mob_id));
            }
        }
        $this->std_alias_item = new ilMediaAliasItem(
            $this->getDomDoc(),
            $this->readHierId(),
            "Standard",
            $this->readPCId(),
            "InteractiveImage"
        );
    }

References ilPageContent\$dom_node, $id, ilInternalLink\_extractObjIdOfTarget(), ilPageContent\getDomDoc(), ILIAS\Repository\object(), ilPageContent\readHierId(), ilPageContent\readPCId(), and setMediaObject().

Here is the call graph for this function:

◆ setExtLinkTitle()

ilPCInteractiveImage::setExtLinkTitle	(	int	$a_nr,
		string	$a_title
	)

Definition at line 603 of file class.ilPCInteractiveImage.php.

     : void {
        if ($this->getPCId() != "") {
            $path = "//PageContent[@PCID = '" . $this->getPCId() . "']/InteractiveImage/MediaAliasItem/MapArea[@Id='" . $a_nr . "']/ExtLink";
            $res = $this->dom_util->path($this->dom_doc, $path);
            if (count($res) > 0) {
                $this->dom_util->setContent($res->item(0), $a_title);
            }
            return;
        }
 
        $path = "//PageContent[@HierId = '" . $this->hier_id . "']/InteractiveImage/MediaAliasItem/MapArea[@Id='" . $a_nr . "']/ExtLink";
        $res = $this->dom_util->path($this->dom_doc, $path);
        if (count($res) > 0) {
            $this->dom_util->setContent($res->item(0), $a_title);
        }
    }

References $path, and $res.

◆ setMapAreaProperties()

ilPCInteractiveImage::setMapAreaProperties	(	ilMediaAliasItem	$a_alias_item,
		string	$a_shape_type,
		string	$a_coords,
		string	$a_title,
		string	$a_id,
		string	$hl_mode = `""`,
		string	$hl_class = `""`
	)

protected

Definition at line 282 of file class.ilPCInteractiveImage.php.

     : void {
        $link = array(
            "LinkType" => IL_EXT_LINK,
            "Href" => ilUtil::stripSlashes("#")
        );
 
        $a_alias_item->deleteMapAreaById($a_id);
        $a_alias_item->addMapArea(
            $a_shape_type,
            $a_coords,
            ilUtil::stripSlashes($a_title),
            $link,
            $a_id,
            $hl_mode,
            $hl_class
        );
    }

◆ setMediaObject()

ilPCInteractiveImage::setMediaObject ( ilObjMediaObject $a_mediaobject )

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

                                                                   : void
    {
        $this->mediaobject = $a_mediaobject;
    }

Referenced by createMediaObject(), readMediaObject(), and setDomNode().

Here is the caller graph for this function:

◆ setTriggerMarkerPositions()

ilPCInteractiveImage::setTriggerMarkerPositions ( array $a_pos )

Set trigger marker position.

Parameters

array $a_pos array of strings (representing the marker positions for the trigger)

Definition at line 516 of file class.ilPCInteractiveImage.php.

     : void {
        $tr_nodes = $this->getTriggerNodes($this->hier_id, $this->getPCId());
        foreach ($tr_nodes as $tr_node) {
            if ($tr_node->getAttribute("Type") == self::MARKER) {
                if (isset($a_pos["" . $tr_node->getAttribute("Nr")])) {
                    $pos = explode(",", $a_pos["" . $tr_node->getAttribute("Nr")]);
                    $tr_node->setAttribute("MarkerX", (int) $pos[0]);
                    $tr_node->setAttribute("MarkerY", (int) $pos[1]);
                }
            }
        }
    }

◆ setTriggerOverlay()

ilPCInteractiveImage::setTriggerOverlay	(	string	$nr,
		string	$overlay,
		string	$coords
	)

Definition at line 743 of file class.ilPCInteractiveImage.php.

                                                                                  : void
    {
        $tr_node = $this->getTriggerNode($nr);
        if ($tr_node) {
            $c = explode(",", $coords);
            $x = (int) ($c[0] ?? 0);
            $y = (int) ($c[1] ?? 0);
            $tr_node->setAttribute("Overlay", $overlay);
            $tr_node->setAttribute("OverlayX", $x);
            $tr_node->setAttribute("OverlayY", $y);
        }
    }

References $c, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ setTriggerOverlayPositions()

ilPCInteractiveImage::setTriggerOverlayPositions ( array $a_pos )

Set trigger overlay position.

Parameters

array $a_pos array of strings (representing the overlays for the trigger)

Definition at line 498 of file class.ilPCInteractiveImage.php.

     : void {
        $tr_nodes = $this->getTriggerNodes($this->hier_id, $this->getPCId());
        for ($i = 0; $i < count($tr_nodes); $i++) {
            $tr_node = $tr_nodes[$i];
            if (isset($a_pos["" . $tr_node->getAttribute("Nr")])) {
                $pos = explode(",", $a_pos["" . $tr_node->getAttribute("Nr")]);
                $tr_node->setAttribute("OverlayX", (int) $pos[0]);
                $tr_node->setAttribute("OverlayY", (int) $pos[1]);
            }
        }
    }

◆ setTriggerOverlays()

ilPCInteractiveImage::setTriggerOverlays ( array $a_ovs )

Set trigger overlays.

Parameters

array $a_ovs array of strings (representing the overlays for the trigger)

Definition at line 466 of file class.ilPCInteractiveImage.php.

     : void {
        $tr_nodes = $this->getTriggerNodes($this->hier_id, $this->getPCId());
        foreach ($tr_nodes as $tr_node) {
            if (isset($a_ovs["" . $tr_node->getAttribute("Nr")])) {
                $tr_node->setAttribute(
                    "Overlay",
                    $a_ovs["" . $tr_node->getAttribute("Nr")]
                );
            }
        }
    }

◆ setTriggerPopup()

ilPCInteractiveImage::setTriggerPopup	(	string	$nr,
		string	$popup,
		string	$position,
		string	$size
	)

Definition at line 756 of file class.ilPCInteractiveImage.php.

                                                                                              : void
    {
        $tr_node = $this->getTriggerNode($nr);
        if ($tr_node) {
            $tr_node->setAttribute("PopupNr", $popup);
            $tr_node->setAttribute("PopupPosition", $position);
            $tr_node->setAttribute("PopupSize", $size);
        }
    }

◆ setTriggerPopupPositions()

ilPCInteractiveImage::setTriggerPopupPositions ( array $a_pos )

Set trigger popup position.

Parameters

array $a_pos array of strings (representing the popup positions for the trigger)

Definition at line 535 of file class.ilPCInteractiveImage.php.

     : void {
        $tr_nodes = $this->getTriggerNodes($this->hier_id, $this->getPCId());
        foreach ($tr_nodes as $tr_node) {
            if (isset($a_pos["" . $tr_node->getAttribute("Nr")])) {
                $pos = explode(",", $a_pos["" . $tr_node->getAttribute("Nr")]);
                $tr_node->setAttribute("PopupX", (int) $pos[0]);
                $tr_node->setAttribute("PopupY", (int) $pos[1]);
            }
        }
    }

◆ setTriggerPopups()

ilPCInteractiveImage::setTriggerPopups ( array $a_pops )

Set trigger popups.

Parameters

array $a_pops array of strings (representing the popups for the trigger)

Definition at line 569 of file class.ilPCInteractiveImage.php.

     : void {
        $tr_nodes = $this->getTriggerNodes($this->hier_id, $this->getPCId());
        foreach ($tr_nodes as $tr_node) {
            if (isset($a_pops[(string) $tr_node->getAttribute("Nr")])) {
                $pop = $a_pops[(string) $tr_node->getAttribute("Nr")];
                $tr_node->setAttribute("PopupNr", $pop);
            }
        }
    }

◆ setTriggerPopupSize()

ilPCInteractiveImage::setTriggerPopupSize ( array $a_size )

Set trigger popup size.

Parameters

array $a_size array of strings (representing the popup sizes for the trigger)

Definition at line 552 of file class.ilPCInteractiveImage.php.

     : void {
        $tr_nodes = $this->getTriggerNodes($this->hier_id, $this->getPCId());
        foreach ($tr_nodes as $tr_node) {
            if (isset($a_size["" . $tr_node->getAttribute("Nr")])) {
                $size = explode(",", $a_size["" . $tr_node->getAttribute("Nr")]);
                $tr_node->setAttribute("PopupWidth", (int) $size[0]);
                $tr_node->setAttribute("PopupHeight", (int) $size[1]);
            }
        }
    }

◆ setTriggerProperties()

ilPCInteractiveImage::setTriggerProperties	(	string	$nr,
		string	$title,
		string	$shape_type,
		string	$coords,
		string	$hl_mode = `""`,
		string	$hl_class = `""`
	)

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

                                                                                                                                                    : void
    {
        $tr_node = $this->getTriggerNode($nr);
 
        if ($shape_type === "Marker") {
 
            if (!$tr_node) {
                $this->addTriggerMarker(
                    ilUtil::stripSlashes($title),
                    $coords
                );
            } else {
                // set marker properties
                $tr_node->setAttribute("Type", "Marker");
                $tr_node->setAttribute(
                    "Title",
                    $title
                );
                $coord_parts = explode(",", $coords);
                $tr_node->setAttribute("MarkerX", ($coord_parts[0] ?? "0"));
                $tr_node->setAttribute("MarkerY", ($coord_parts[1] ?? "0"));
 
                // remove area
                $path = "//PageContent[@HierId = '" . $this->hier_id . "']/InteractiveImage/MediaAliasItem/MapArea[@Id='" . $nr . "']";
                $res = $this->dom_util->path($this->dom_doc, $path);
                if ($child = $res->item(0)) {
                    $child->parentNode->removeChild($child);
                }
            }
            return;
        }
 
        if ($tr_node) {
            $tr_node->setAttribute("Type", "Area");
            $tr_node->removeAttribute("MarkerX");
            $tr_node->removeAttribute("MarkerY");
            $tr_node->setAttribute(
                "Title",
                ilUtil::stripSlashes($title),
            );
            $this->setMapAreaProperties(
                $this->getStandardAliasItem(),
                $shape_type,
                $coords,
                ilUtil::stripSlashes($title),
                $nr,
                $hl_mode,
                $hl_class
            );
        } else {
            $this->addTriggerArea(
                $this->getStandardAliasItem(),
                $shape_type,
                $coords,
                $title,
                $hl_mode,
                $hl_class
            );
        }
    }

References $path, $res, and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ setTriggerTitles()

ilPCInteractiveImage::setTriggerTitles ( array $a_titles )

Set trigger titles.

Parameters

array $a_titles array of strings (representing the titles for the trigger)

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

     : void {
        $tr_nodes = $this->getTriggerNodes($this->hier_id, $this->getPCId());
        foreach ($tr_nodes as $tr_node) {
            if (isset($a_titles[(string) $tr_node->getAttribute("Nr")])) {
                $tr_node->setAttribute(
                    "Title",
                    $a_titles[(string) $tr_node->getAttribute("Nr")]
                );
                $this->setExtLinkTitle(
                    $tr_node->getAttribute("Nr"),
                    $a_titles[(string) $tr_node->getAttribute("Nr")]
                );
            }
        }
    }

Field Documentation

◆ $htmlTransform

ILIAS COPage Html TransformUtil ilPCInteractiveImage::$htmlTransform

protected

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

◆ $iim_node

DOMNode ilPCInteractiveImage::$iim_node

Definition at line 39 of file class.ilPCInteractiveImage.php.

◆ $lng

ilLanguage ilPCInteractiveImage::$lng

protected

Definition at line 38 of file class.ilPCInteractiveImage.php.

◆ $mal_node

DOMNode ilPCInteractiveImage::$mal_node

protected

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

◆ $manager

ILIAS COPage PC InteractiveImage IIMManager ilPCInteractiveImage::$manager

protected

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

◆ $med_alias_node

DOMNode ilPCInteractiveImage::$med_alias_node

protected

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

◆ $mediaobject

ilObjMediaObject ilPCInteractiveImage::$mediaobject

protected

Definition at line 37 of file class.ilPCInteractiveImage.php.

Referenced by getMediaObject().

◆ $std_alias_item

ilMediaAliasItem ilPCInteractiveImage::$std_alias_item

protected

Definition at line 36 of file class.ilPCInteractiveImage.php.

Referenced by getStandardAliasItem().

◆ $thumbs

ILIAS MediaObjects Thumbs ThumbsManager ilPCInteractiveImage::$thumbs

protected

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

◆ $ui

ILIAS DI UIServices ilPCInteractiveImage::$ui

protected

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

◆ $xsl

ILIAS COPage Xsl XslManager ilPCInteractiveImage::$xsl

protected

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

◆ AREA

const ilPCInteractiveImage::AREA = "Area"

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

◆ MARKER

const ilPCInteractiveImage::MARKER = "Marker"

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

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

components/ILIAS/COPage/PC/InteractiveImage/class.ilPCInteractiveImage.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addContentPopup()

◆ addTriggerArea()

◆ addTriggerMarker()

◆ create()

◆ createAlias()

◆ createFromMobId()

◆ createMediaObject()

◆ deleteOverlay()

◆ deletePopup()

◆ deletePopupByNr()

◆ deleteTrigger()

◆ dumpXML()

◆ getBackgroundImage()

◆ getBaseThumbnailTarget()

◆ getIIMModel()

◆ getMediaObject()

◆ getPopupDummy()

◆ getPopups()

◆ getStandardAliasItem()

◆ getStandardMediaItem()

◆ getTriggerNode()

◆ getTriggerNodes()

◆ getTriggers()

◆ handleCopiedContent()

◆ init()

◆ modifyPageContentPostXsl()

◆ readMediaObject()

◆ saveContentPopupTitle()

◆ savePopups()

◆ setDomNode()

◆ setExtLinkTitle()

◆ setMapAreaProperties()

◆ setMediaObject()

◆ setTriggerMarkerPositions()

◆ setTriggerOverlay()

◆ setTriggerOverlayPositions()

◆ setTriggerOverlays()

◆ setTriggerPopup()

◆ setTriggerPopupPositions()

◆ setTriggerPopups()

◆ setTriggerPopupSize()

◆ setTriggerProperties()

◆ setTriggerTitles()

Field Documentation

◆ $htmlTransform

◆ $iim_node

◆ $lng

◆ $mal_node

◆ $manager

◆ $med_alias_node

◆ $mediaobject

◆ $std_alias_item

◆ $thumbs

◆ $ui

◆ $xsl

◆ AREA

◆ MARKER