Inheritance diagram for ilPCMediaObject:

Collaboration diagram for ilPCMediaObject:

Public Member Functions
	init ()
	Init page content component. More...

	readMediaObject ($a_mob_id=0)
	Read/get Media Object. More...

	setNode ($a_node)

	setDom (&$a_dom)
	set dom object More...

	setHierId ($a_hier_id)
	set hierarchical edit id More...

	setMediaObject ($a_mediaobject)
	Set Media Object. More...

	getMediaObject ()
	Get Media Object. More...

	createMediaObject ()

	create (&$a_pg_obj, $a_hier_id)
	Create pc media object. More...

	createAlias (&$a_pg_obj, $a_hier_id, $a_pc_id="")
	Create an media alias in page. More...

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

	dumpXML ()
	Dump node xml. More...

	setClass ($a_class)
	Set Style Class of table. More...

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

	modifyPageContentPostXsl ($a_html, $a_mode)
	Modify page content after xsl. More...

Public Member Functions inherited from ilPageContent
	__construct ($a_pg_obj)
	Constructor. More...

	setPage ($a_val)
	Set page. More...

	getPage ()
	Get page. More...

	init ()
	Init object. More...

	getType ()
	Get type of page content. More...

	setNode ($a_node)
	Set xml node of page content. More...

&	getNode ()
	Get xml node of page content. More...

	getJavascriptFiles ($a_mode)
	Get Javascript files. More...

	getCssFiles ($a_mode)
	Get css files. More...

	getOnloadCode ($a_mode)
	Get on load code. More...

	setHierId ($a_hier_id)
	Set hierarchical ID in xml structure. More...

	getHierId ()
	Get hierarchical id. More...

	lookupHierId ()
	Get hierarchical id from dom. More...

	readHierId ()
	Read PC Id. More...

	setPcId ($a_pcid)
	Set PC Id. More...

	getPCId ()
	Get PC Id. More...

	setFileDownloadLink ($a_download_link)
	Set file download link. More...

	getFileDownloadLink ()
	Get file download link. More...

	setFullscreenLink ($a_fullscreen_link)
	Set fullscreen link. More...

	getFullscreenLink ()
	Get fullscreen link. More...

	setSourcecodeDownloadScript ($script_name)
	Set sourcecode download script. More...

	getSourcecodeDownloadScript ()
	Get sourcecode download script. More...

	readPCId ()
	Read PC Id. More...

	writePCId ($a_pc_id)
	Write pc id. More...

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

	enable ()
	Enable page content. More...

	disable ()
	Disable page content. More...

	isEnabled ()
	Check whether page content is enabled. More...

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

	modifyPageContentPostXsl ($a_output, $a_mode)
	Modify page content after xsl. More...

Static Public Member Functions
static	getLangVars ()
	Get lang vars needed for editing. More...

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

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

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

static	saveMobUsage ($a_page, $a_domdoc, $a_old_nr=0)
	Save all usages of media objects (media aliases, media objects, internal links) More...

Static Public Member Functions inherited from ilPageContent
static	incEdId ($ed_id)
	Increases an hierarchical editing id at lowest level (last number) More...

static	decEdId ($ed_id)
	Decreases an hierarchical editing id at lowest level (last number) More...

static	haveSameContainer ($ed_id1, $ed_id2)
	Check, if two ids are in same container. More...

static	sortHierIds ($a_array)
	Sort an array of Hier IDS in ascending order. More...

static	isGreaterHierId ($a, $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, $a_self_ass=true, $a_clone_mobs=false)
	Handle copied content. More...

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

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

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

Protected Attributes
	$user

	$mob_node

Protected Attributes inherited from ilPageContent
	$file_download_link

	$fullscreen_link

	$sourcecode_download_script

	$log

Additional Inherited Members
Data Fields inherited from ilPageContent
	$hier_id

	$node

	$dom

	$page_lang

Protected Member Functions inherited from ilPageContent
	setType ($a_type)
	Set Type. More...

Detailed Description

Class ilPCMediaObject.

Media content object (see ILIAS DTD)

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

Member Function Documentation

◆ afterPageHistoryEntry()

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

static

After page history entry has been created.

Parameters

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

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

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

◆ afterPageUpdate()

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

static

After page has been updated (or created)

Parameters

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

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

References ilObject\_exists(), ilObjMediaObject\_getMobsOfObject(), and ilObject\_lookupType().

     {
         if (!$a_page->getImportMode()) {
             include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
             $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 ( $a_page )

static

Before page is being deleted.

Parameters

object $a_page page object

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

References ilObjMediaObject\_deleteAllUsages(), ilObject\_exists(), ilObjMediaObject\_getMobsOfObject(), and ilObject\_lookupType().

     {
         include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
         $mob_ids = ilObjMediaObject::_getMobsOfObject(
             $a_page->getParentType() . ":pg",
             $a_page->getId(),
             0,
             $a_page->getLanguage()
         );
 
         ilObjMediaObject::_deleteAllUsages(
             $a_page->getParentType() . ":pg",
             $a_page->getId(),
             false,
             $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	(	&	$a_pg_obj,
			$a_hier_id
	)

Create pc media object.

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

References ilPageContent\createPageContentNode().

     {
         $this->node = $this->createPageContentNode();
     }

Here is the call graph for this function:

◆ createAlias()

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

Create an media alias in page.

Parameters

object	$a_pg_obj	page object
string	$a_hier_id	hierarchical ID w

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

References getMediaObject(), and IL_INSERT_AFTER.

     {
         $this->node = $this->dom->create_element("PageContent");
         $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
         $this->mob_node = $this->dom->create_element("MediaObject");
         $this->mob_node = $this->node->append_child($this->mob_node);
         $this->mal_node = $this->dom->create_element("MediaAlias");
         $this->mal_node = $this->mob_node->append_child($this->mal_node);
         $this->mal_node->set_attribute("OriginId", "il__mob_" . $this->getMediaObject()->getId());
 
         // standard view
         $item_node = $this->dom->create_element("MediaAliasItem");
         $item_node = $this->mob_node->append_child($item_node);
         $item_node->set_attribute("Purpose", "Standard");
         $media_item = $this->getMediaObject()->getMediaItem("Standard");
 
         $layout_node = $this->dom->create_element("Layout");
         $layout_node = $item_node->append_child($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->set_attribute("HorizontalAlign", "Left");
 
         // caption
         if ($media_item->getCaption() != "") {
             $cap_node = $this->dom->create_element("Caption");
             $cap_node = $item_node->append_child($cap_node);
             $cap_node->set_attribute("Align", "bottom");
             $cap_node->set_content($media_item->getCaption());
         }
 
         // text representation
         if ($media_item->getTextRepresentation() != "") {
             $tr_node = $this->dom->create_element("TextRepresentation");
             $tr_node = $item_node->append_child($tr_node);
             $tr_node->set_content($media_item->getTextRepresentation());
         }
 
         $pars = $media_item->getParameters();
         foreach ($pars as $par => $val) {
             $par_node = $this->dom->create_element("Parameter");
             $par_node = $item_node->append_child($par_node);
             $par_node->set_attribute("Name", $par);
             $par_node->set_attribute("Value", $val);
         }
 
         // fullscreen view
         $fullscreen_item = $this->getMediaObject()->getMediaItem("Fullscreen");
         if (is_object($fullscreen_item)) {
             $item_node = $this->dom->create_element("MediaAliasItem");
             $item_node = $this->mob_node->append_child($item_node);
             $item_node->set_attribute("Purpose", "Fullscreen");
 
             // width and height
             $layout_node = $this->dom->create_element("Layout");
             $layout_node = $item_node->append_child($layout_node);
             if ($fullscreen_item->getWidth() > 0) {
                 $layout_node->set_attribute("Width", $fullscreen_item->getWidth());
             }
             if ($fullscreen_item->getHeight() > 0) {
                 $layout_node->set_attribute("Height", $fullscreen_item->getHeight());
             }
 
             // caption
             if ($fullscreen_item->getCaption() != "") {
                 $cap_node = $this->dom->create_element("Caption");
                 $cap_node = $item_node->append_child($cap_node);
                 $cap_node->set_attribute("Align", "bottom");
                 $cap_node->set_content($fullscreen_item->getCaption());
             }
 
             // text representation
             if ($fullscreen_item->getTextRepresentation() != "") {
                 $tr_node = $this->dom->create_element("TextRepresentation");
                 $tr_node = $item_node->append_child($tr_node);
                 $tr_node->set_content($fullscreen_item->getTextRepresentation());
             }
 
             $pars = $fullscreen_item->getParameters();
             foreach ($pars as $par => $val) {
                 $par_node = $this->dom->create_element("Parameter");
                 $par_node = $item_node->append_child($par_node);
                 $par_node->set_attribute("Name", $par);
                 $par_node->set_attribute("Value", $val);
             }
         }
     }

Here is the call graph for this function:

◆ createMediaObject()

ilPCMediaObject::createMediaObject ( )

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

References setMediaObject().

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

Here is the call graph for this function:

◆ dumpXML()

ilPCMediaObject::dumpXML ( )

Dump node xml.

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

References $xml.

     {
         $xml = $this->dom->dump_node($this->node);
         return $xml;
     }

◆ getClass()

ilPCMediaObject::getClass ( )

Get characteristic of section.

Returns: string characteristic

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

     {
         if (is_object($this->mob_node)) {
             $mal_node = $this->mob_node->first_child();
             if (is_object($mal_node)) {
                 $class =  $mal_node->get_attribute("Class");
                 return $class;
             }
         }
     }

◆ getLangVars()

static ilPCMediaObject::getLangVars ( )

static

Get lang vars needed for editing.

Returns: array array of lang var keys

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

References array.

     {
         return array("pc_mob");
     }

◆ getMediaObject()

ilPCMediaObject::getMediaObject ( )

Get Media Object.

Returns: object Media Object

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

Referenced by createAlias(), and updateObjectReference().

     {
         return $this->mediaobject;
     }

Here is the caller graph for this function:

◆ init()

ilPCMediaObject::init ( )

Init page content component.

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

References $DIC, ilPageContent\setType(), and user().

     {
         global $DIC;
 
         $this->user = $DIC->user();
         $this->setType("media");
     }

Here is the call graph for this function:

◆ modifyPageContentPostXsl()

ilPCMediaObject::modifyPageContentPostXsl	(	$a_html,
		$a_mode
	)

Modify page content after xsl.

Parameters

string $a_output

Returns: string

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

References $ilUser, $user, ilObjMediaObject\_getDirectory(), ilObjMediaObject\_getMobsOfObject(), and ilPageContent\getPage().

     {
         $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_html = str_replace("[[[[[mobsubtitle;il__mob_" . $mob->getId() . "_Standard]]]]]", $srt_content, $a_html);
                     }
                 }
             }
         }
 
         return $a_html;
     }

Here is the call graph for this function:

◆ readMediaObject()

ilPCMediaObject::readMediaObject ( $a_mob_id = 0 )

Read/get Media Object.

Parameters

int	media object ID

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

References setMediaObject().

     {
         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	(	$a_page,
		$a_domdoc,
		$a_old_nr = `0`
	)

static

Save all usages of media objects (media aliases, media objects, internal links)

Parameters

string $a_xml xml data of page

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

References ilPageContent\$node, ilObjMediaObject\_deleteAllUsages(), ilObject\_lookupType(), ilObjMediaObject\_saveUsage(), and 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;
             }
         }
 
         include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
         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:

◆ setClass()

ilPCMediaObject::setClass ( $a_class )

Set Style Class of table.

Parameters

string $a_class class

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

     {
         if (is_object($this->mob_node)) {
             $mal_node = $this->mob_node->first_child();
             if (is_object($mal_node)) {
                 if (!empty($a_class)) {
                     $mal_node->set_attribute("Class", $a_class);
                 } else {
                     if ($mal_node->has_attribute("Class")) {
                         $mal_node->remove_attribute("Class");
                     }
                 }
             }
         }
     }

◆ setDom()

ilPCMediaObject::setDom ( & $a_dom )

set dom object

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

     {
         $this->dom = $a_dom;
     }

◆ setHierId()

ilPCMediaObject::setHierId ( $a_hier_id )

set hierarchical edit id

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

     {
         $this->hier_id = $a_hier_id;
     }

◆ setMediaObject()

ilPCMediaObject::setMediaObject ( $a_mediaobject )

Set Media Object.

Parameters

object $a_mediaobject Media Object

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

Referenced by createMediaObject(), and readMediaObject().

     {
         $this->mediaobject = $a_mediaobject;
     }

Here is the caller graph for this function:

◆ setNode()

ilPCMediaObject::setNode ( $a_node )

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

     {
         parent::setNode($a_node);               // this is the PageContent node
         $this->mob_node = $a_node->first_child();
     }

◆ 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 206 of file class.ilPCMediaObject.php.

References getMediaObject().

     {
         if (is_object($this->mob_node)) {
             $this->mal_node = $this->mob_node->first_child();
             if (is_object($this->mal_node) && $this->mal_node->node_name() == "MediaAlias") {
                 $this->mal_node->set_attribute("OriginId", "il__mob_" . $this->getMediaObject()->getId());
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $mob_node

ilPCMediaObject::$mob_node

protected

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

◆ $user

ilPCMediaObject::$user

protected

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

Referenced by modifyPageContentPostXsl().

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

Services/COPage/classes/class.ilPCMediaObject.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ afterPageHistoryEntry()

◆ afterPageUpdate()

◆ beforePageDelete()

◆ create()

◆ createAlias()

◆ createMediaObject()

◆ dumpXML()

◆ getClass()

◆ getLangVars()

◆ getMediaObject()

◆ init()

◆ modifyPageContentPostXsl()

◆ readMediaObject()

◆ saveMobUsage()

◆ setClass()

◆ setDom()

◆ setHierId()

◆ setMediaObject()

◆ setNode()

◆ updateObjectReference()

Field Documentation

◆ $mob_node

◆ $user