Class ilPCMediaObject Media content object (see ILIAS DTD) More...

Inheritance diagram for ilPCMediaObject:

Collaboration diagram for ilPCMediaObject:

Public Member Functions
	init ()

	readMediaObject (int $a_mob_id=0)

	setHierId (string $a_hier_id)

	setMediaObject (ilObjMediaObject $a_mediaobject)

	getMediaObject ()

	createMediaObject ()

	create ()

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

	updateObjectReference ()
	Updates the media object referenced by the media alias. More...

	dumpXML ()

	setClass (string $a_class)

	getClass ()
	Get characteristic of section. More...

	setCaptionClass (string $a_class)
	Set caption style class of media object. More...

	getCaptionClass ()

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

	getOnloadCode (string $a_mode)

	getJavascriptFiles (string $a_mode)

	getCssFiles (string $a_mode)

	getStandardMediaAliasItem ()

	getFullscreenMediaAliasItem ()

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

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)

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	saveMobUsage (ilPageObject $a_page, DOMDocument $a_domdoc, int $a_old_nr=0)

static	deleteHistoryLowerEqualThan (string $parent_type, int $page_id, string $lang, int $delete_lower_than_nr)

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)

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

Protected Member Functions
	getMediaAliasNode ()

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
ilCtrlInterface	$ctrl

UsageDBRepository	$mob_usage_repo

DOMNode	$mal_node

ilObjUser	$user

DOMNode	$mob_node

ILIAS DI UIServices	$ui

ilObjMediaObject	$mediaobject = null

ilLanguage	$lng

ilGlobalPageTemplate	$global_tpl

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

Static Protected Attributes
static string	$modal_show_signal = ""

static string	$modal_suffix = ""

Additional Inherited Members
Data Fields inherited from ilPageContent
string	$hier_id = ""

DOMNode	$dom_node = null

string	$page_lang = ""

Detailed Description

Class ilPCMediaObject Media content object (see ILIAS DTD)

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

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

Member Function Documentation

◆ afterPageHistoryEntry()

static ilPCMediaObject::afterPageHistoryEntry	(	ilPageObject	$a_page,
		DOMDocument	$a_old_domdoc,
		string	$a_old_xml,
		int	$a_old_nr
	)

static

After page history entry has been created.

Parameters

ilPageObject	$a_page	page object
DOMDocument	$a_old_domdoc	old dom document
string	$a_old_xml	old xml
int	$a_old_nr	history number

Definition at line 310 of file class.ilPCMediaObject.php.

      : void {
         self::saveMobUsage($a_page, $a_old_domdoc, $a_old_nr);
     }

◆ afterPageUpdate()

static ilPCMediaObject::afterPageUpdate	(	ilPageObject	$a_page,
		DOMDocument	$a_domdoc,
		string	$a_xml,
		bool	$a_creation
	)

static

After page has been updated (or created)

Parameters

ilPageObject	$a_page	page object
DOMDocument	$a_domdoc	dom document
string	$a_xml	xml
bool	$a_creation	true on creation, otherwise false

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

References ilObject\_exists(), ilObjMediaObject\_getMobsOfObject(), ilObject\_lookupType(), ilPageObject\getId(), ilPageObject\getImportMode(), ilPageObject\getLanguage(), and ilPageObject\getParentType().

      : void {
         if (!$a_page->getImportMode()) {
             $mob_ids = ilObjMediaObject::_getMobsOfObject(
                 $a_page->getParentType() . ":pg",
                 $a_page->getId(),
                 0,
                 $a_page->getLanguage()
             );
             self::saveMobUsage($a_page, $a_domdoc);
             foreach ($mob_ids as $mob) {        // check, whether media object can be deleted
                 if (ilObject::_exists($mob) && ilObject::_lookupType($mob) == "mob") {
                     $mob_obj = new ilObjMediaObject($mob);
                     $usages = $mob_obj->getUsages(false);
                     if (count($usages) == 0) {  // delete, if no usage exists
                         $mob_obj->delete();
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

◆ beforePageDelete()

static ilPCMediaObject::beforePageDelete ( ilPageObject $a_page )

static

Definition at line 275 of file class.ilPCMediaObject.php.

References ilObjMediaObject\_deleteAllUsages(), ilObject\_exists(), ilObjMediaObject\_getMobsOfObject(), ilObject\_lookupType(), ilPageObject\getId(), ilPageObject\getLanguage(), and ilPageObject\getParentType().

      : void {
         $mob_ids = ilObjMediaObject::_getMobsOfObject(
             $a_page->getParentType() . ":pg",
             $a_page->getId(),
             0,
             $a_page->getLanguage()
         );
 
         ilObjMediaObject::_deleteAllUsages(
             $a_page->getParentType() . ":pg",
             $a_page->getId(),
             null,
             $a_page->getLanguage()
         );
 
         foreach ($mob_ids as $mob) {    // check, whether media object can be deleted
             if (ilObject::_exists($mob) && ilObject::_lookupType($mob) == "mob") {
                 $mob_obj = new ilObjMediaObject($mob);
                 $usages = $mob_obj->getUsages(false);
                 if (count($usages) == 0) {      // delete, if no usage exists
                     $mob_obj->delete();
                 }
             }
         }
     }

Here is the call graph for this function:

◆ create()

ilPCMediaObject::create ( )

Definition at line 83 of file class.ilPCMediaObject.php.

References ilPageContent\createPageContentNode().

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

Here is the call graph for this function:

◆ createAlias()

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

Definition at line 88 of file class.ilPCMediaObject.php.

References ilPageContent\getDomNode(), ILIAS\Survey\Mode\getId(), getMediaObject(), IL_INSERT_AFTER, ilPageObject\insertContent(), and ilPageContent\setDomNode().

      : void {
         $this->setDomNode($this->dom_doc->createElement("PageContent"));
         $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
         $mob_node = $this->dom_doc->createElement("MediaObject");
         $mob_node = $this->getDomNode()->appendChild($mob_node);
         $this->mal_node = $this->dom_doc->createElement("MediaAlias");
         $this->mal_node = $mob_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 = $mob_node->appendChild($item_node);
         $item_node->setAttribute("Purpose", "Standard");
         $media_item = $this->getMediaObject()->getMediaItem("Standard");
         if (is_null($media_item)) {
             return;
         }
 
         $layout_node = $this->dom_doc->createElement("Layout");
         $layout_node = $item_node->appendChild($layout_node);
         if ($media_item->getWidth() > 0) {
             //$layout_node->set_attribute("Width", $media_item->getWidth());
         }
         if ($media_item->getHeight() > 0) {
             //$layout_node->set_attribute("Height", $media_item->getHeight());
         }
         $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());
         }
 
         $pars = $media_item->getParameters();
         foreach ($pars as $par => $val) {
             $par_node = $this->dom_doc->createElement("Parameter");
             $par_node = $item_node->appendChild($par_node);
             $par_node->setAttribute("Name", $par);
             $par_node->setAttribute("Value", $val);
         }
 
         // fullscreen view
         $fullscreen_item = $this->getMediaObject()->getMediaItem("Fullscreen");
         if (is_object($fullscreen_item)) {
             $item_node = $this->dom_doc->createElement("MediaAliasItem");
             $item_node = $mob_node->appendChild($item_node);
             $item_node->setAttribute("Purpose", "Fullscreen");
 
             // width and height
             $layout_node = $this->dom_doc->createElement("Layout");
             $layout_node = $item_node->appendChild($layout_node);
             if ($fullscreen_item->getWidth() > 0) {
                 $layout_node->setAttribute("Width", $fullscreen_item->getWidth());
             }
             if ($fullscreen_item->getHeight() > 0) {
                 $layout_node->setAttribute("Height", $fullscreen_item->getHeight());
             }
 
             // caption
             if ($fullscreen_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, $fullscreen_item->getCaption());
             }
 
             // text representation
             if ($fullscreen_item->getTextRepresentation() != "") {
                 $tr_node = $this->dom_doc->createElement("TextRepresentation");
                 $tr_node = $item_node->appendChild($tr_node);
                 $this->dom_util->setContent($tr_node, $fullscreen_item->getTextRepresentation());
             }
 
             $pars = $fullscreen_item->getParameters();
             foreach ($pars as $par => $val) {
                 $par_node = $this->dom_doc->createElement("Parameter");
                 $par_node = $item_node->appendChild($par_node);
                 $par_node->setAttribute("Name", $par);
                 $par_node->setAttribute("Value", $val);
             }
         }
     }

Here is the call graph for this function:

◆ createMediaObject()

ilPCMediaObject::createMediaObject ( )

Definition at line 78 of file class.ilPCMediaObject.php.

References setMediaObject().

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

Here is the call graph for this function:

◆ deleteHistoryLowerEqualThan()

static ilPCMediaObject::deleteHistoryLowerEqualThan	(	string	$parent_type,
		int	$page_id,
		string	$lang,
		int	$delete_lower_than_nr
	)

static

Definition at line 564 of file class.ilPCMediaObject.php.

References $DIC, ilPageContent\$log, ilObject\_lookupType(), ilLogger\debug(), ILIAS\Skill\Usage\UsageDBRepository\deleteHistoryUsagesLowerEqualThan(), ILIAS\Skill\Usage\UsageDBRepository\getHistoryUsagesLowerEqualThan(), ilLoggerFactory\getLogger(), and ilObjMediaObject\lookupUsages().

      : void {
         global $DIC;
 
         $mob_usage_repo = $DIC->mediaObjects()
             ->internal()
             ->repo()
             ->usage();
 
         $log = ilLoggerFactory::getLogger("copg");
 
         $mob_ids = $mob_usage_repo->getHistoryUsagesLowerEqualThan(
             $parent_type . ":pg",
             $page_id,
             $delete_lower_than_nr,
             $lang
         );
 
         $mob_usage_repo->deleteHistoryUsagesLowerEqualThan(
             $parent_type . ":pg",
             $page_id,
             $delete_lower_than_nr,
             $lang
         );
 
         foreach ($mob_ids as $mob_id) {
             $usages = ilObjMediaObject::lookupUsages($mob_id, true);
             $log->debug("...check deletion of mob $mob_id. Usages: " . count($usages));
             if (count($usages) == 0) {
                 if (ilObject::_lookupType($mob_id) === "mob") {
                     $mob = new ilObjMediaObject($mob_id);
                     $log->debug("Deleting Mob ID: " . $mob_id);
                     $mob->delete();
                 }
             }
         }
     }

Here is the call graph for this function:

◆ dumpXML()

ilPCMediaObject::dumpXML ( )

Definition at line 206 of file class.ilPCMediaObject.php.

References ilPageContent\getDomNode().

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

Here is the call graph for this function:

◆ getCaptionClass()

ilPCMediaObject::getCaptionClass ( )

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

References getMediaAliasNode().

                                      : string
     {
         return (string) $this->getMediaAliasNode()?->getAttribute("CaptionClass");
     }

Here is the call graph for this function:

◆ getClass()

ilPCMediaObject::getClass ( )

Get characteristic of section.

Definition at line 219 of file class.ilPCMediaObject.php.

References getMediaAliasNode().

                               : string
     {
         return (string) $this->getMediaAliasNode()?->getAttribute("Class");
     }

Here is the call graph for this function:

◆ getCssFiles()

ilPCMediaObject::getCssFiles ( string $a_mode )

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

      : array {
         return [];
     }

◆ getFullscreenMediaAliasItem()

ilPCMediaObject::getFullscreenMediaAliasItem ( )

Definition at line 518 of file class.ilPCMediaObject.php.

References ilPageContent\getDomDoc(), ilPageContent\getHierId(), getMediaObject(), ilPageContent\getPage(), ilPageContent\getPCId(), and getStandardMediaAliasItem().

                                                  : ilMediaAliasItem
     {
         $std_alias_item = new ilMediaAliasItem(
             $this->getDomDoc(),
             $this->getHierId(),
             "Fullscreen",
             $this->getPCId()
         );
         return $std_alias_item;
     }

Here is the call graph for this function:

◆ getJavascriptFiles()

ilPCMediaObject::getJavascriptFiles ( string $a_mode )

Definition at line 493 of file class.ilPCMediaObject.php.

References iljQueryUtil\getLocalMaphilightPath().

      : array {
         //$js_files = ilPlayerUtil::getJsFilePaths();
         $js_files[] = iljQueryUtil::getLocalMaphilightPath();
         return $js_files;
     }

Here is the call graph for this function:

◆ getLangVars()

static ilPCMediaObject::getLangVars ( )

static

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

                                         : array
     {
         return array("pc_mob");
     }

◆ getMediaAliasNode()

ilPCMediaObject::getMediaAliasNode ( )

protected

Definition at line 185 of file class.ilPCMediaObject.php.

References $mal_node, and ilPageContent\getChildNode().

Referenced by getCaptionClass(), getClass(), setCaptionClass(), setClass(), and updateObjectReference().

                                           : ?DOMNode
     {
         if (is_object($this->getChildNode())) {
             $mal_node = $this->getChildNode()->firstChild;
             if (is_object($mal_node) && $mal_node->nodeName == "MediaAlias") {
                 return $mal_node;
             }
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMediaObject()

ilPCMediaObject::getMediaObject ( )

Definition at line 73 of file class.ilPCMediaObject.php.

References $mediaobject.

Referenced by ilPCImageMapTableGUI\__construct(), ilPCMediaObjectQuickEdit\__construct(), createAlias(), getFullscreenMediaAliasItem(), and updateObjectReference().

                                     : ?ilObjMediaObject
     {
         return $this->mediaobject;
     }

Here is the caller graph for this function:

◆ getOnloadCode()

ilPCMediaObject::getOnloadCode ( string $a_mode )

Definition at line 482 of file class.ilPCMediaObject.php.

                                                  : array
     {
         $onload_code = [];
         // necessary due to 32198 (other main template used)
         if (self::$modal_show_signal !== "") {
             $onload_code[] = "il.COPagePres.setFullscreenModalShowSignal('" . self::$modal_show_signal .
                 "', '" . self::$modal_suffix . "');";
         }
         return $onload_code;
     }

◆ getStandardMediaAliasItem()

ilPCMediaObject::getStandardMediaAliasItem ( )

Definition at line 507 of file class.ilPCMediaObject.php.

References ilPageContent\getDomDoc(), ilPageContent\getHierId(), and ilPageContent\getPCId().

Referenced by getFullscreenMediaAliasItem().

                                                : ilMediaAliasItem
     {
         $std_alias_item = new ilMediaAliasItem(
             $this->getDomDoc(),
             $this->getHierId(),
             "Standard",
             $this->getPCId()
         );
         return $std_alias_item;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleCopiedContent()

static ilPCMediaObject::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

Definition at line 606 of file class.ilPCMediaObject.php.

References $DIC, ilPageContent\$dom_util, $path, ilInternalLink\_extractInstOfTarget(), and ilInternalLink\_extractObjIdOfTarget().

      : void {
         global $DIC;
 
         if (!$a_clone_mobs) {
             return;
         }
 
         $dom_util = $DIC->copage()->internal()->domain()->domUtil();
         $path = "//MediaObject/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());
                 }
             }
         }
     }

Here is the call graph for this function:

◆ init()

ilPCMediaObject::init ( )

Definition at line 40 of file class.ilPCMediaObject.php.

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

                           : void
     {
         global $DIC;
 
         $this->user = $DIC->user();
         $this->setType("media");
         $this->ui = $DIC->ui();
         $this->lng = $DIC->language();
         $this->mob_usage_repo = $DIC->mediaObjects()
             ->internal()
             ->repo()
             ->usage();
         $this->ctrl = $DIC->ctrl();
     }

Here is the call graph for this function:

◆ modifyPageContentPostXsl()

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

Definition at line 386 of file class.ilPCMediaObject.php.

References $DIC, $user, ilObjMediaObject\_getDirectory(), ilObjMediaObject\_getMobsOfObject(), ILIAS\Repository\ctrl(), ilPageContent\getPage(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

      : string {
         global $DIC;
 
         $this->global_tpl = $DIC['tpl'];
         $ilUser = $this->user;
 
         if ($a_mode == "offline") {
             $page = $this->getPage();
 
             $mob_ids = ilObjMediaObject::_getMobsOfObject(
                 $page->getParentType() . ":pg",
                 $page->getId(),
                 0,
                 $page->getLanguage()
             );
             foreach ($mob_ids as $mob_id) {
                 $mob = new ilObjMediaObject($mob_id);
                 $srts = $mob->getSrtFiles();
                 foreach ($srts as $srt) {
                     if ($ilUser->getLanguage() == $srt["language"]) {
                         $srt_content = file_get_contents(ilObjMediaObject::_getDirectory($mob->getId()) . "/" . $srt["full_path"]);
                         $a_output = str_replace("[[[[[mobsubtitle;il__mob_" . $mob->getId() . "_Standard]]]]]", $srt_content, $a_output);
                     }
                 }
             }
         }
 
         if ($a_abstract_only) {
             return $a_output;
         }
 
         if ($a_mode === "edit") {
             $a_output = str_replace(
                 "{{{{{Unsupported Media Type}}}}}",
                 $this->ui->renderer()->render(
                     $this->ui->factory()->messageBox()->info(
                         $this->lng->txt("copg_unsupported_media_type")
                     )
                 ),
                 $a_output
             );
             // currently media objects, when in translation mode
             $a_output = str_replace(
                 "{{{{{No Media Type}}}}}",
                 '<div class="copg-new-content-placeholder">' .
                 $this->ui->renderer()->render(
                     $this->ui->factory()->symbol()->icon()->standard("pemed", "pemed", 'medium')
                 ) . "</div>",
                 $a_output
             );
         } else {
             $a_output = str_replace(
                 "{{{{{Unsupported Media Type}}}}}",
                 "",
                 $a_output
             );
             $a_output = str_replace(
                 "{{{{{No Media Type}}}}}",
                 "",
                 $a_output
             );
         }
 
         // add fullscreen modals
         $page = $this->getPage();
         $suffix = "-" . $page->getParentType() . "-" . $page->getId();
         $modal = $this->ui->factory()->modal()->roundtrip(
             $this->lng->txt("cont_fullscreen"),
             $this->ui->factory()->legacy("<iframe class='il-copg-mob-fullscreen' id='il-copg-mob-fullscreen" . $suffix . "'></iframe>")
         );
         $show_signal = $modal->getShowSignal();
 
         $js = "
             $(function () {
                 il.COPagePres.setFullscreenModalShowSignal('$show_signal', '$suffix');
             });
         ";
         self::$modal_show_signal = $show_signal;
         self::$modal_suffix = $suffix;
         $this->global_tpl->addOnloadCode($js);
 
         // async ensures to have onloadcode of modal in output
         // if other main tpl is used, see #32198
         // note: if always rendered async, $ not defined errors will be thrown in non-async cases
         if ($this->ctrl->isAsynch()) {
             $html = $this->ui->renderer()->renderAsync($modal);
         } else {
             $html = $this->ui->renderer()->render($modal);
         }
         return $a_output . "<div class='il-copg-mob-fullscreen-modal'>" . $html . "</div>";
     }

Here is the call graph for this function:

◆ readMediaObject()

ilPCMediaObject::readMediaObject ( int $a_mob_id = 0 )

Definition at line 55 of file class.ilPCMediaObject.php.

References setMediaObject().

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

Here is the call graph for this function:

◆ saveMobUsage()

static ilPCMediaObject::saveMobUsage	(	ilPageObject	$a_page,
		DOMDocument	$a_domdoc,
		int	$a_old_nr = `0`
	)

static

Definition at line 319 of file class.ilPCMediaObject.php.

References ilObjMediaObject\_deleteAllUsages(), ilObject\_lookupType(), ilObjMediaObject\_saveUsage(), ilPageObject\getId(), ilPageObject\getLanguage(), and ilPageObject\getParentType().

      : array {
         $usages = array();
 
         // media aliases
         $xpath = new DOMXPath($a_domdoc);
         $nodes = $xpath->query('//MediaAlias');
         foreach ($nodes as $node) {
             $id_arr = explode("_", $node->getAttribute("OriginId"));
             $mob_id = $id_arr[count($id_arr) - 1];
             if ($mob_id > 0 && $id_arr[1] == "") {
                 $usages[$mob_id] = true;
             }
         }
 
         // media objects
         $xpath = new DOMXPath($a_domdoc);
         $nodes = $xpath->query('//MediaObject/MetaData/General/Identifier');
         foreach ($nodes as $node) {
             $mob_entry = $node->getAttribute("Entry");
             $mob_arr = explode("_", $mob_entry);
             $mob_id = $mob_arr[count($mob_arr) - 1];
             if ($mob_id > 0 && $mob_arr[1] == "") {
                 $usages[$mob_id] = true;
             }
         }
 
         // internal links
         $xpath = new DOMXPath($a_domdoc);
         $nodes = $xpath->query("//IntLink[@Type='MediaObject']");
         foreach ($nodes as $node) {
             $mob_target = $node->getAttribute("Target");
             $mob_arr = explode("_", $mob_target);
             //echo "<br>3<br>";
             //echo $mob_target."<br>";
             //var_dump($mob_arr);
             $mob_id = $mob_arr[count($mob_arr) - 1];
             if ($mob_id > 0 && $mob_arr[1] == "") {
                 $usages[$mob_id] = true;
             }
         }
 
         ilObjMediaObject::_deleteAllUsages(
             $a_page->getParentType() . ":pg",
             $a_page->getId(),
             $a_old_nr,
             $a_page->getLanguage()
         );
         foreach ($usages as $mob_id => $val) {
             // save usage, if object exists...
             if (ilObject::_lookupType($mob_id) == "mob") {
                 ilObjMediaObject::_saveUsage(
                     $mob_id,
                     $a_page->getParentType() . ":pg",
                     $a_page->getId(),
                     $a_old_nr,
                     $a_page->getLanguage()
                 );
             }
         }
 
         return $usages;
     }

Here is the call graph for this function:

◆ setCaptionClass()

ilPCMediaObject::setCaptionClass ( string $a_class )

Set caption style class of media object.

Definition at line 227 of file class.ilPCMediaObject.php.

References getMediaAliasNode().

                                                     : void
     {
         $this->dom_util->setAttribute($this->getMediaAliasNode(), "CaptionClass", $a_class);
     }

Here is the call graph for this function:

◆ setClass()

ilPCMediaObject::setClass ( string $a_class )

Definition at line 211 of file class.ilPCMediaObject.php.

References getMediaAliasNode().

                                              : void
     {
         $this->dom_util->setAttribute($this->getMediaAliasNode(), "Class", $a_class);
     }

Here is the call graph for this function:

◆ setHierId()

ilPCMediaObject::setHierId ( string $a_hier_id )

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

                                                 : void
     {
         $this->hier_id = $a_hier_id;
     }

◆ setMediaObject()

ilPCMediaObject::setMediaObject ( ilObjMediaObject $a_mediaobject )

Definition at line 68 of file class.ilPCMediaObject.php.

Referenced by createMediaObject(), and readMediaObject().

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

Here is the caller graph for this function:

◆ updateObjectReference()

ilPCMediaObject::updateObjectReference ( )

Updates the media object referenced by the media alias.

This makes only sense, after the media object has changed. (-> change object reference function)

Definition at line 201 of file class.ilPCMediaObject.php.

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

                                            : void
     {
         $this->getMediaAliasNode()?->setAttribute("OriginId", "il__mob_" . $this->getMediaObject()->getId());
     }

Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilCtrlInterface ilPCMediaObject::$ctrl

protected

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

◆ $global_tpl

ilGlobalPageTemplate ilPCMediaObject::$global_tpl

protected

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

◆ $lng

ilLanguage ilPCMediaObject::$lng

protected

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

◆ $mal_node

DOMNode ilPCMediaObject::$mal_node

protected

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

Referenced by getMediaAliasNode().

◆ $mediaobject

ilObjMediaObject ilPCMediaObject::$mediaobject = null

protected

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

Referenced by getMediaObject().

◆ $mob_node

DOMNode ilPCMediaObject::$mob_node

protected

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

◆ $mob_usage_repo

UsageDBRepository ilPCMediaObject::$mob_usage_repo

protected

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

◆ $modal_show_signal

string ilPCMediaObject::$modal_show_signal = ""

staticprotected

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

◆ $modal_suffix

string ilPCMediaObject::$modal_suffix = ""

staticprotected

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

◆ $ui

ILIAS DI UIServices ilPCMediaObject::$ui

protected

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

◆ $user

ilObjUser ilPCMediaObject::$user

protected

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

Referenced by modifyPageContentPostXsl().

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

components/ILIAS/COPage/PC/MediaObject/class.ilPCMediaObject.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ afterPageHistoryEntry()

◆ afterPageUpdate()

◆ beforePageDelete()

◆ create()

◆ createAlias()

◆ createMediaObject()

◆ deleteHistoryLowerEqualThan()

◆ dumpXML()

◆ getCaptionClass()

◆ getClass()

◆ getCssFiles()

◆ getFullscreenMediaAliasItem()

◆ getJavascriptFiles()

◆ getLangVars()

◆ getMediaAliasNode()

◆ getMediaObject()

◆ getOnloadCode()

◆ getStandardMediaAliasItem()

◆ handleCopiedContent()

◆ init()

◆ modifyPageContentPostXsl()

◆ readMediaObject()

◆ saveMobUsage()

◆ setCaptionClass()

◆ setClass()

◆ setHierId()

◆ setMediaObject()

◆ updateObjectReference()

Field Documentation

◆ $ctrl

◆ $global_tpl

◆ $lng

◆ $mal_node

◆ $mediaobject

◆ $mob_node

◆ $mob_usage_repo

◆ $modal_show_signal

◆ $modal_suffix

◆ $ui

◆ $user