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

Inheritance diagram for ilMediaObjectDataSet:

Collaboration diagram for ilMediaObjectDataSet:

Public Member Functions
	__construct ()

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

	getUsePreviousImportIds ()

	getSupportedVersions ()

	readData (string $a_entity, string $a_version, array $a_ids)

	getXmlRecord (string $a_entity, string $a_version, array $a_set)

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)

Public Member Functions inherited from ilDataSet
	__construct ()

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

	getSupportedVersions ()

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

	setExportDirectories (string $a_relative, string $a_absolute)

	setImportDirectory (string $a_val)

	getImportDirectory ()

	setDSPrefix (string $a_val)

	getDSPrefix ()

	getDSPrefixString ()

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

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

	getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $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 (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="")

	afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)

	getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version)

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

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

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

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

	setImport (ilSurveyImporter $a_val)

	getImport ()

	setCurrentInstallationId (string $a_val)

	getCurrentInstallationId ()

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...

	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)

Protected Member Functions
	getXmlNamespace (string $a_entity, string $a_schema_version)

	getTypes (string $a_entity, string $a_version)

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
	Determine the dependent sets of data. More...

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

	getXmlNamespace (string $a_entity, string $a_schema_version)

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)

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

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

	stripTags (array $rec, array $omit_keys=[])

Protected Attributes
ilMediaItem	$current_media_item

ilObjMediaObject	$current_mob

ilLogger	$mob_log

bool	$use_previous_import_ids = false

Protected Attributes inherited from ilDataSet
ILIAS ResourceStorage Services	$irss

string	$current_installation_id = ""

array	$data = []

ilDBInterface	$db

ilLogger	$ds_log

string	$import_directory = ""

string	$entity = ""

string	$schema_version = ""

string	$relative_export_dir = ""

string	$absolute_export_dir = ""

string	$ds_prefix = "ds"

string	$version = ""

ilSurveyImporter	$import

Additional Inherited Members
Data Fields inherited from ilDataSet
const	DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3'

const	DATASET_NS_PREFIX = 'ds'

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

int	$dircnt = 0

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 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: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilMediaObjectDataSet::__construct ( )

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

References ILIAS\MetaData\Repository\Validation\Data\__construct(), and ilLoggerFactory\getLogger().

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

Here is the call graph for this function:

Member Function Documentation

◆ getDependencies()

ilMediaObjectDataSet::getDependencies	(	string	$a_entity,
		string	$a_version,
		?array	$a_rec = `null`,
		?array	$a_ids = `null`
	)

protected

Determine the dependent sets of data.

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

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

◆ getSupportedVersions()

ilMediaObjectDataSet::getSupportedVersions ( )

Returns: string[]

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

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

◆ getTypes()

ilMediaObjectDataSet::getTypes	(	string	$a_entity,
		string	$a_version
	)

protected

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

                                                                     : array
     {
         // 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 "5.1.0":
                 case "4.3.0":
                 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"
                     );
             }
         }
 
         // 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"
                     );
             }
         }
         return [];
     }

◆ getUsePreviousImportIds()

ilMediaObjectDataSet::getUsePreviousImportIds ( )

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

References $use_previous_import_ids.

Referenced by importRecord().

                                              : bool
     {
         return $this->use_previous_import_ids;
     }

Here is the caller graph for this function:

◆ getXmlNamespace()

ilMediaObjectDataSet::getXmlNamespace	(	string	$a_entity,
		string	$a_schema_version
	)

protected

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

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

◆ getXmlRecord()

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

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

References ilObjMediaObject\_getDirectory(), and ilFileUtils\makeDirParents().

      : array {
         if ($a_entity == "mob") {
             $dir = ilObjMediaObject::_getDirectory($a_set["Id"]);
             if (!is_dir($dir)) {
                 ilFileUtils::makeDirParents($dir);
             }
             $a_set["Dir"] = $dir;
         }
 
         return $a_set;
     }

Here is the call graph for this function:

◆ importRecord()

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

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

References $current_media_item, $current_mob, ilObjMediaObject\_createThumbnailDirectory(), ilObjMediaObject\_getDirectory(), ilImportMapping\addMapping(), ilDataSet\getCurrentInstallationId(), ilDataSet\getImportDirectory(), ilImportMapping\getMapping(), getUsePreviousImportIds(), ILIAS\Repository\int(), ilFileUtils\rCopy(), ilObjMediaObject\renameExecutables(), ilMediaSvgSanitizer\sanitizeDir(), and ilDataSet\stripTags().

      : void {
         $a_rec = $this->stripTags($a_rec);
         switch ($a_entity) {
             case "mob":
 
                 $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-");
                     ilFileUtils::rCopy($source_dir, $target_dir);
                     ilObjMediaObject::renameExecutables($target_dir);
                     ilMediaSvgSanitizer::sanitizeDir($target_dir);      // see #20339
                 }
 
                 $a_mapping->addMapping("Services/MediaObjects", "mob", $a_rec["Id"], $newObj->getId());
                 $a_mapping->addMapping(
                     "Services/MetaData",
                     "md",
                     "0:" . $a_rec["Id"] . ":mob",
                     "0:" . $newObj->getId() . ":mob"
                 );
                 break;
 
             case "mob_media_item":
 
                 // determine parent mob
                 $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);
                 }
 
                 $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
                 $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
                 $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);
                 }
 
                 $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	(	string	$a_entity,
		string	$a_version,
		array	$a_ids
	)

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

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

      : void {
         $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 "5.1.0":
                 case "4.3.0":
                 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;
             }
         }
 
 
         // 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((string) ($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 ( bool $a_val )

Set use previous import ids.

Parameters

bool $a_val use previous import ids

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

                                                         : void
     {
         $this->use_previous_import_ids = $a_val;
     }

Field Documentation

◆ $current_media_item

ilMediaItem ilMediaObjectDataSet::$current_media_item

protected

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

Referenced by importRecord().

◆ $current_mob

ilObjMediaObject ilMediaObjectDataSet::$current_mob

protected

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

Referenced by importRecord().

◆ $mob_log

ilLogger ilMediaObjectDataSet::$mob_log

protected

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

◆ $use_previous_import_ids

bool ilMediaObjectDataSet::$use_previous_import_ids = false

protected

Definition at line 35 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

◆ $current_media_item

◆ $current_mob

◆ $mob_log

◆ $use_previous_import_ids