Media Pool Data set class. More...

Inheritance diagram for ilMediaObjectDataSet:

Collaboration diagram for ilMediaObjectDataSet:

Public Member Functions
	__construct ()
	Constructor. More...

	setUsePreviousImportIds ($a_val)
	Set use previous import ids. More...

	getUsePreviousImportIds ()
	Get use previous import ids. More...

	getSupportedVersions ()
	Get supported versions. More...

	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...

	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data. More...

	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record. More...

	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record. More...

Public Member Functions inherited from ilDataSet
	__construct ()
	Constructor. More...

	init ($a_entity, $a_schema_version)
	Init. More...

	getSupportedVersions ()
	Get supported version. More...

	readData ($a_entity, $a_version, $a_ids)
	Read data from DB. More...

	setExportDirectories ($a_relative, $a_absolute)
	Set export directories. More...

	setImportDirectory ($a_val)
	Set import directory. More...

	getImportDirectory ()
	Get import directory. More...

	setDSPrefix ($a_val)
	Set XML dataset namespace prefix. More...

	getDSPrefix ()
	Get XML dataset namespace prefix. More...

	getDSPrefixString ()

	getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true, $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...

	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string. More...

	getJsonRepresentation ()
	Get json representation. More...

	getXmlRepresentation ( $a_entity, $a_schema_version, $a_ids, $a_field="", $a_omit_header=false, $a_omit_types=false)
	Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text"> <ftype name="field_2" type="date"> <ftype name="field_3" type="integer"> </types> <types ...> ... More...

	addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
	Add records xml. More...

	afterXmlRecordWriting ($a_entity, $a_version, $a_set)
	After xml record writing hook record. More...

	getNamespaces (&$namespaces, $a_entity, $a_schema_version)
	Get xml namespaces. More...

	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record for version. More...

	getJsonRecord ($a_set)
	Get json record for version. More...

	getXmlTypes ($a_entity, $a_version)
	Get xml types. More...

	getJsonTypes ($a_entity, $a_version)
	Get json types. More...

	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten) More...

	getXMLEntityTag ($a_entity, $a_schema_version)
	Get entity tag. More...

	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten) More...

	setImport ($a_val)
	Set import object. More...

	getImport ()
	Get import object. More...

	setCurrentInstallationId ($a_val)
	Set current installation id. More...

	getCurrentInstallationId ()
	Get current installation id. More...

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Get field types for entity. More...

	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data. More...

Protected Member Functions inherited from ilDataSet
	getTypes ($a_entity, $a_version)
	Get (abstract) types for (abstract) field names. More...

	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...

	createObjectExportId ($a_type, $a_id)
	Build ilias export id. More...

	parseObjectExportId ($a_id, $a_fallback_id=null)
	Parse export id. More...

Protected Attributes
	$use_previous_import_ids = false

Protected Attributes inherited from ilDataSet
	$current_installation_id = ""

	$db

	$ds_log

Additional Inherited Members
Data Fields inherited from ilDataSet
	$dircnt

const	EXPORT_NO_INST_ID = 1

const	EXPORT_ID_ILIAS_LOCAL = 2

const	EXPORT_ID_ILIAS_LOCAL_INVALID = 3

const	EXPORT_ID_ILIAS_REMOTE = 4

const	EXPORT_ID_ILIAS_REMOTE_INVALID = 5

const	EXPORT_ID = 6

const	EXPORT_ID_INVALID = 7

Detailed Description

Media Pool Data set class.

This class implements the following entities:

mob: object data
mob_media_item: data from table media_item
mob_mi_map_area: data from a table map_area
mob_mi_parameter: data from a table mob_parameter

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

Version: $Id$

Definition at line 19 of file class.ilMediaObjectDataSet.php.

Constructor & Destructor Documentation

◆ __construct()

ilMediaObjectDataSet::__construct ( )

Constructor.

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

References ilLoggerFactory\getLogger().

     {
         parent::__construct();
         $this->mob_log = ilLoggerFactory::getLogger('mob');
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDependencies()

ilMediaObjectDataSet::getDependencies	(	$a_entity,
		$a_version,
		$a_rec,
		$a_ids
	)

protected

Determine the dependent sets of data.

Definition at line 299 of file class.ilMediaObjectDataSet.php.

     {
         switch ($a_entity) {
             case "mob":
                 return array(
                     "mob_media_item" => array("ids" => $a_rec["Id"])
                 );
                 
             case "mob_media_item":
                 return array(
                     "mob_mi_map_area" => array("ids" => $a_rec["Id"]),
                     "mob_mi_parameter" => array("ids" => $a_rec["Id"])
                 );
         }
         return false;
     }

◆ getSupportedVersions()

ilMediaObjectDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

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

     {
         return array("5.1.0", "4.3.0", "4.1.0");
     }

◆ getTypes()

ilMediaObjectDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

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

     {
         // mob
         if ($a_entity == "mob") {
             switch ($a_version) {
                 case "4.1.0":
                 case "4.3.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "Dir" => "directory"
                     );
 
                 case "5.1.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "Dir" => "directory",
                         "ImportId" => "text"
                     );
             }
         }
         
         // media item
         if ($a_entity == "mob_media_item") {
             switch ($a_version) {
                 case "4.1.0":
                     return array(
                         "Id" => "integer",
                         "MobId" => "integer",
                         "Width" => "integer",
                         "Height" => "integer",
                         "Halign" => "text",
                         "Caption" => "text",
                         "Nr" => "integer",
                         "Purpose" => "text",
                         "Location" => "text",
                         "LocationType" => "text",
                         "Format" => "text",
                         "TextRepresentation" => "text"
                     );
 
                 case "4.3.0":
                 case "5.1.0":
                     return array(
                         "Id" => "integer",
                         "MobId" => "integer",
                         "Width" => "integer",
                         "Height" => "integer",
                         "Halign" => "text",
                         "Caption" => "text",
                         "Nr" => "integer",
                         "Purpose" => "text",
                         "Location" => "text",
                         "LocationType" => "text",
                         "Format" => "text",
                         "TextRepresentation" => "text"
                     );
             }
         }
 
         // map areas
         if ($a_entity == "mob_mi_map_area") {
             switch ($a_version) {
                 case "4.1.0":
                 case "4.3.0":
                 case "5.1.0":
                         return array(
                             "MiId" => "integer",
                             "Nr" => "integer",
                             "Shape" => "text",
                             "Coords" => "text",
                             "LinkType" => "text",
                             "Title" => "text",
                             "Href" => "text",
                             "Target" => "text",
                             "Type" => "text",
                             "TargetFrame" => "text",
                             "HighlightMode" => "text",
                             "HighlightText" => "text"
                         );
             }
         }
 
         // media item parameter
         if ($a_entity == "mob_mi_parameter") {
             switch ($a_version) {
                 case "4.1.0":
                 case "4.3.0":
                 case "5.1.0":
                         return array(
                             "MiId" => "integer",
                             "Name" => "text",
                             "Value" => "text"
                         );
             }
         }
     }

◆ getUsePreviousImportIds()

ilMediaObjectDataSet::getUsePreviousImportIds ( )

Get use previous import ids.

Returns: bool use previous import ids

Definition at line 47 of file class.ilMediaObjectDataSet.php.

References $use_previous_import_ids.

Referenced by importRecord().

     {
         return $this->use_previous_import_ids;
     }

Here is the caller graph for this function:

◆ getXmlNamespace()

ilMediaObjectDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

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

     {
         return "http://www.ilias.de/xml/Services/MediaObject/" . $a_entity;
     }

◆ getXmlRecord()

ilMediaObjectDataSet::getXmlRecord	(	$a_entity,
		$a_version,
		$a_set
	)

Get xml record.

Parameters

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

References ilObjMediaObject\_getDirectory().

     {
         if ($a_entity == "mob") {
             include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
             $dir = ilObjMediaObject::_getDirectory($a_set["Id"]);
             $a_set["Dir"] = $dir;
         }
 
         return $a_set;
     }

Here is the call graph for this function:

◆ importRecord()

ilMediaObjectDataSet::importRecord	(	$a_entity,
		$a_types,
		$a_rec,
		$a_mapping,
		$a_schema_version
	)

Import record.

Parameters

Definition at line 339 of file class.ilMediaObjectDataSet.php.

References ilObjMediaObject\_createThumbnailDirectory(), ilObjMediaObject\_getDirectory(), ilDataSet\getCurrentInstallationId(), ilDataSet\getImportDirectory(), getUsePreviousImportIds(), ilUtil\rCopy(), ilObjMediaObject\renameExecutables(), and ilMediaSvgSanitizer\sanitizeDir().

     {
         //echo $a_entity;
         //var_dump($a_rec);
 
         switch ($a_entity) {
             case "mob":
 
 //var_dump($a_rec);
 
                 include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                 $newObj = new ilObjMediaObject();
                 $newObj->setType("mob");
                 $newObj->setTitle($a_rec["Title"]);
                 $newObj->setDescription($a_rec["Description"]);
                 // on translation re-import we are interested in the "previous" import id
                 if ($this->getUsePreviousImportIds()) {
                     $newObj->setImportId($a_rec["ImportId"]);
                 } else {
                     $newObj->setImportId("il_" . $this->getCurrentInstallationId() . "_mob_" . $a_rec["Id"]);
                 }
                 $newObj->create();
                 $newObj->createDirectory();
                 ilObjMediaObject::_createThumbnailDirectory($newObj->getId());
                 $this->current_mob = $newObj;
 
                 $dir = str_replace("..", "", $a_rec["Dir"]);
                 if ($dir != "" && $this->getImportDirectory() != "") {
                     $source_dir = $this->getImportDirectory() . "/" . $dir;
                     $target_dir = $dir = ilObjMediaObject::_getDirectory($newObj->getId());
                     $this->mob_log->debug("s:-$source_dir-,t:-$target_dir-");
                     ilUtil::rCopy($source_dir, $target_dir);
                     ilObjMediaObject::renameExecutables($target_dir);
                     include_once("./Services/MediaObjects/classes/class.ilMediaSvgSanitizer.php");
                     ilMediaSvgSanitizer::sanitizeDir($target_dir);      // see #20339
                 }
 
                 $a_mapping->addMapping("Services/MediaObjects", "mob", $a_rec["Id"], $newObj->getId());
 //echo "<br>++add++"."0:".$a_rec["Id"].":mob+0:".$newObj->getId().":mob"."+";
                 $a_mapping->addMapping(
                     "Services/MetaData",
                     "md",
                     "0:" . $a_rec["Id"] . ":mob",
                     "0:" . $newObj->getId() . ":mob"
                 );
                 break;
 
             case "mob_media_item":
 
                 // determine parent mob
                 include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                 $mob_id = (int) $a_mapping->getMapping("Services/MediaObjects", "mob", $a_rec["MobId"]);
                 if (is_object($this->current_mob) && $this->current_mob->getId() == $mob_id) {
                     $mob = $this->current_mob;
                 } else {
                     $mob = new ilObjMediaObject($mob_id);
                 }
 
                 include_once("./Services/MediaObjects/classes/class.ilMediaItem.php");
                 $newObj = new ilMediaItem();
                 $newObj->setMobId($mob_id);
                 $newObj->setWidth($a_rec["Width"]);
                 $newObj->setHeight($a_rec["Height"]);
                 $newObj->setCaption($a_rec["Caption"]);
                 $newObj->setNr($a_rec["Nr"]);
                 $newObj->setPurpose($a_rec["Purpose"]);
                 $newObj->setLocation($a_rec["Location"]);
                 $newObj->setLocationType($a_rec["LocationType"]);
                 $newObj->setFormat($a_rec["Format"]);
                 $newObj->setTextRepresentation($a_rec["TextRepresentation"]);
                 $newObj->create();
                 $this->current_media_item = $newObj;
 
                 $a_mapping->addMapping("Services/MediaObjects", "mob_media_item", $a_rec["Id"], $newObj->getId());
 
                 break;
 
             case "mob_mi_parameter":
 
                 // get media item
                 include_once("./Services/MediaObjects/classes/class.ilMediaItem.php");
                 $med_id = (int) $a_mapping->getMapping("Services/MediaObjects", "mob_media_item", $a_rec["MiId"]);
                 if (is_object($this->current_media_item) && $this->current_media_item->getId() == $med_id) {
                     $med = $this->current_media_item;
                 } else {
                     $med = new ilMediaItem($med_id);
                 }
                 $med->writeParameter($a_rec["Name"], $a_rec["Value"]);
 
                 break;
 
             case "mob_mi_map_area":
                 // get media item
                 include_once("./Services/MediaObjects/classes/class.ilMediaItem.php");
                 $med_id = (int) $a_mapping->getMapping("Services/MediaObjects", "mob_media_item", $a_rec["MiId"]);
                 if (is_object($this->current_media_item) && $this->current_media_item->getId() == $med_id) {
                     $med = $this->current_media_item;
                 } else {
                     $med = new ilMediaItem($med_id);
                 }
 
                 include_once("./Services/MediaObjects/classes/class.ilMapArea.php");
                 $map_area = new ilMapArea();
                 $map_area->setItemId($med_id);
                 $map_area->setNr($a_rec["Nr"]);
                 $map_area->setShape($a_rec["Shape"]);
                 $map_area->setCoords($a_rec["Coords"]);
                 $map_area->setLinkType($a_rec["LinkType"]);
                 $map_area->setTitle($a_rec["Title"]);
                 $map_area->setHref($a_rec["Href"]);
                 $map_area->setTarget($a_rec["Target"]);
                 $map_area->setType($a_rec["Type"]);
                 $map_area->setTargetFrame($a_rec["TargetFrame"]);
                 $map_area->setHighlightMode($a_rec["HighlightMode"]);
                 $map_area->setHighlightClass($a_rec["HighlightClass"]);
                 $map_area->create();
                 
                 break;
         }
     }

Here is the call graph for this function:

◆ readData()

ilMediaObjectDataSet::readData	(	$a_entity,
		$a_version,
		$a_ids,
		$a_field = `""`
	)

Read data.

Parameters

Definition at line 187 of file class.ilMediaObjectDataSet.php.

References ilDataSet\$db, $id, $ilDB, $r, ilObject\_lookupDescription(), ilObject\_lookupImportId(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), data, ilDataSet\getDirectDataFromQuery(), and ilUtil\insertInstIntoID().

     {
         $ilDB = $this->db;
 
         if (!is_array($a_ids)) {
             $a_ids = array($a_ids);
         }
 
         // mob
         if ($a_entity == "mob") {
             $this->data = array();
 
             switch ($a_version) {
                 case "4.1.0":
                 case "4.3.0":
                     foreach ($a_ids as $mob_id) {
                         if (ilObject::_lookupType($mob_id) == "mob") {
                             $this->data[] = array("Id" => $mob_id,
                                 "Title" => ilObject::_lookupTitle($mob_id),
                                 "Description" => ilObject::_lookupDescription($mob_id)
                             );
                         }
                     }
                     break;
 
                 case "5.1.0":
                     foreach ($a_ids as $mob_id) {
                         if (ilObject::_lookupType($mob_id) == "mob") {
                             $this->data[] = array("Id" => $mob_id,
                                 "Title" => ilObject::_lookupTitle($mob_id),
                                 "Description" => ilObject::_lookupDescription($mob_id),
                                 "ImportId" => ilObject::_lookupImportId($mob_id)
                             );
                         }
                     }
                     break;
             }
         }
 
         // media item
         if ($a_entity == "mob_media_item") {
             switch ($a_version) {
                 case "4.1.0":
                     $this->getDirectDataFromQuery("SELECT id, mob_id, width, height, halign," .
                         "caption, nr, purpose, location, location_type, format, text_representation" .
                         " FROM media_item WHERE " .
                         $ilDB->in("mob_id", $a_ids, false, "integer"));
                     break;
 
                 case "4.3.0":
                 case "5.1.0":
                     $this->getDirectDataFromQuery("SELECT id, mob_id, width, height, halign," .
                         "caption, nr, purpose, location, location_type, format, text_representation" .
                         " FROM media_item WHERE " .
                         $ilDB->in("mob_id", $a_ids, false, "integer"));
                     break;
             }
         }
 
         
         // media item map area
         if ($a_entity == "mob_mi_map_area") {
             switch ($a_version) {
                 case "4.1.0":
                 case "4.3.0":
                 case "5.1.0":
                     foreach ($this->getDirectDataFromQuery("SELECT item_id mi_id, nr" .
                         " ,shape, coords, link_type, title, href, target, type, target_frame, " .
                         " highlight_mode, highlight_class" .
                         " FROM map_area " .
                         " WHERE " .
                         $ilDB->in("item_id", $a_ids, false, "integer") .
                         " ORDER BY nr", true, false) as $r) {
                         $r["Target"] = ilUtil::insertInstIntoID($r["Target"]);
 
                         // see ilPageObject::insertInstIntoIDs
                         if ($r["Type"] == "RepositoryItem") {
                             $id_arr = explode("_", $r["Target"]);
                             $ref_id = $id_arr[3];
                             $obj_id = ilObject::_lookupObjId($id_arr[3]);
 
                             $otype = ilObject::_lookupType($obj_id);
                             if ($obj_id > 0) {
                                 $id = $otype . "_" . $obj_id . "_" . $ref_id;
                                 $r["Target"] = "il_" . $id_arr[1] . "_" . $id;
                             }
                         }
 
                         $this->data[] = $r;
                     }
                     break;
             }
         }
 
         // media item parameter
         if ($a_entity == "mob_mi_parameter") {
             switch ($a_version) {
                 case "4.1.0":
                 case "4.3.0":
                 case "5.1.0":
                     $this->getDirectDataFromQuery("SELECT med_item_id mi_id, name, value" .
                         " FROM mob_parameter " .
                         " WHERE " .
                         $ilDB->in("med_item_id", $a_ids, false, "integer"));
                     break;
             }
         }
     }

Here is the call graph for this function:

◆ setUsePreviousImportIds()

ilMediaObjectDataSet::setUsePreviousImportIds ( $a_val )

Set use previous import ids.

Parameters

bool $a_val use previous import ids

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

     {
         $this->use_previous_import_ids = $a_val;
     }

Field Documentation

◆ $use_previous_import_ids

ilMediaObjectDataSet::$use_previous_import_ids = false

protected

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

Referenced by getUsePreviousImportIds().

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

Services/MediaObjects/classes/class.ilMediaObjectDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getUsePreviousImportIds()

◆ getXmlNamespace()

◆ getXmlRecord()

◆ importRecord()

◆ readData()

◆ setUsePreviousImportIds()

Field Documentation

◆ $use_previous_import_ids