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

Inheritance diagram for ilMediaPoolDataSet:

Collaboration diagram for ilMediaPoolDataSet:

Public Member Functions
	getSupportedVersions ()

	setMasterLanguageOnly (bool $a_val)
	Set master language only (export) More...

	getMasterLanguageOnly ()

	setTranslationImportMode (?ilObjMediaPool $a_mep, string $a_lang="")

	getTranslationImportMode ()

	getTranslationMep ()
	Get translation pool (import) More...

	getTranslationLang ()

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

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

	initByExporter (ilXmlExporter $xml_exporter)

	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)

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

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)

	getExportDirInContainer (string $exp_dir)

	getIRSSContainerExportConfig (StorableResource $source_container, string $source_path, string $target_path="")

	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
ilObjMediaPool	$current_obj = null

bool	$master_lang_only = false

bool	$transl_into = false

ilObjMediaPool	$transl_into_mep = null

string	$transl_lang = ""

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	$component_export_dir = ""

string	$ds_prefix = "ds"

string	$version = ""

ilSurveyImporter	$import

ilExport	$export

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:

mep_data: data from table mep_data
mep_tree: data from a join on mep_tree and mep_item

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

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

Member Function Documentation

◆ getDependencies()

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

protected

Definition at line 228 of file class.ilMediaPoolDataSet.php.

References null.

      : array {
         switch ($a_entity) {
             case "mep":
                 return array(
                     "mep_tree" => array("ids" => $a_rec["Id"] ?? null)
                 );
         }
         return [];
     }

◆ getMasterLanguageOnly()

ilMediaPoolDataSet::getMasterLanguageOnly ( )

Definition at line 57 of file class.ilMediaPoolDataSet.php.

References $master_lang_only.

Referenced by readData().

                                            : bool
     {
         return $this->master_lang_only;
     }

Here is the caller graph for this function:

◆ getSupportedVersions()

ilMediaPoolDataSet::getSupportedVersions ( )

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

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

◆ getTranslationImportMode()

ilMediaPoolDataSet::getTranslationImportMode ( )

Definition at line 75 of file class.ilMediaPoolDataSet.php.

References $transl_into.

Referenced by importRecord().

                                               : bool
     {
         return $this->transl_into;
     }

Here is the caller graph for this function:

◆ getTranslationLang()

ilMediaPoolDataSet::getTranslationLang ( )

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

References $transl_lang.

                                         : string
     {
         return $this->transl_lang;
     }

◆ getTranslationMep()

ilMediaPoolDataSet::getTranslationMep ( )

Get translation pool (import)

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

References $transl_into_mep.

Referenced by importRecord().

                                        : ?ilObjMediaPool
     {
         return $this->transl_into_mep;
     }

Here is the caller graph for this function:

◆ getTypes()

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

protected

Definition at line 93 of file class.ilMediaPoolDataSet.php.

                                                                     : array
     {
         // mep
         if ($a_entity === "mep") {
             switch ($a_version) {
                 case "4.1.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "DefaultWidth" => "integer",
                         "DefaultHeight" => "integer");
 
                 case "5.1.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "DefaultWidth" => "integer",
                         "DefaultHeight" => "integer",
                         "ForTranslation" => "integer"
                     );
             }
         }
 
         // mep_tree
         if ($a_entity === "mep_tree") {
             switch ($a_version) {
                 case "4.1.0":
                 case "5.1.0":
                     return array(
                         "MepId" => "integer",
                         "Child" => "integer",
                         "Parent" => "integer",
                         "Depth" => "integer",
                         "Type" => "text",
                         "Title" => "text",
                         "ForeignId" => "integer",
                         "ImportId" => "text"
                     );
             }
         }
         return [];
     }

◆ getXmlNamespace()

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

protected

Definition at line 44 of file class.ilMediaPoolDataSet.php.

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

◆ importRecord()

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

Definition at line 243 of file class.ilMediaPoolDataSet.php.

References ilImportMapping\addMapping(), ILIAS\Survey\Mode\getId(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), ilMediaPoolItem\getPoolForItemId(), getTranslationImportMode(), getTranslationMep(), IL_INST_ID, ILIAS\Repository\int(), null, and ilDataSet\stripTags().

      : void {
         $a_rec = $this->stripTags($a_rec);
 
         switch ($a_entity) {
             case "mep":
 
                 if ($this->getTranslationImportMode()) {
                     return;
                 }
 
                 if ($new_id = $a_mapping->getMapping('components/ILIAS/Container', 'objs', $a_rec['Id'])) {
                     $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                 } else {
                     $newObj = new ilObjMediaPool();
                     $newObj->setType("mep");
                     $newObj->create();
                 }
 
                 $newObj->setTitle($a_rec["Title"]);
                 $newObj->setDescription($a_rec["Description"]);
                 $newObj->setDefaultWidth((int) $a_rec["DefaultWidth"]);
                 $newObj->setDefaultHeight((int) $a_rec["DefaultHeight"]);
                 $newObj->setForTranslation((bool) ($a_rec["ForTranslation"] ?? false));
                 $newObj->update();
 
                 $this->current_obj = $newObj;
                 $a_mapping->addMapping("components/ILIAS/MediaPool", "mep", $a_rec["Id"], $newObj->getId());
                 $a_mapping->addMapping("components/ILIAS/ILIASObject", "obj", $a_rec["Id"], $newObj->getId());
                 $a_mapping->addMapping(
                     "components/ILIAS/MetaData",
                     "md",
                     $a_rec["Id"] . ":0:mep",
                     $newObj->getId() . ":0:mep"
                 );
                 break;
 
             case "mep_tree":
                 if (!$this->getTranslationImportMode()) {
                     switch ($a_rec["Type"]) {
                         case "fold":
                             $parent = (int) $a_mapping->getMapping("components/ILIAS/MediaPool", "mep_tree", $a_rec["Parent"]);
                             $fold_id =
                                 $this->current_obj->createFolder($a_rec["Title"], $parent);
                             $a_mapping->addMapping(
                                 "components/ILIAS/MediaPool",
                                 "mep_tree",
                                 $a_rec["Child"],
                                 $fold_id
                             );
                             break;
 
                         case "mob":
                             $parent = (int) $a_mapping->getMapping("components/ILIAS/MediaPool", "mep_tree", $a_rec["Parent"]);
                             $mob_id = (int) $a_mapping->getMapping("components/ILIAS/MediaObjects", "mob", $a_rec["ForeignId"]);
                             $item = new ilMediaPoolItem();
                             $item->setType("mob");
                             $item->setForeignId($mob_id);
                             $item->setImportId($a_rec["ImportId"]);
                             $item->setTitle($a_rec["Title"]);
                             $item->create();
                             if ($item->getId() > 0) {
                                 if ($parent === 0) {
                                     $parent = null;
                                 }
                                 $this->current_obj->insertInTree($item->getId(), $parent);
                             }
                             break;
 
                         case "pg":
                             $parent = (int) $a_mapping->getMapping("components/ILIAS/MediaPool", "mep_tree", $a_rec["Parent"]);
 
                             $item = new ilMediaPoolItem();
                             $item->setType("pg");
                             $item->setTitle($a_rec["Title"]);
                             $item->setImportId($a_rec["ImportId"]);
                             $item->create();
                             $a_mapping->addMapping("components/ILIAS/MediaPool", "pg", $a_rec["Child"], $item->getId());
                             $a_mapping->addMapping(
                                 "components/ILIAS/COPage",
                                 "pg",
                                 "mep:" . $a_rec["Child"],
                                 "mep:" . $item->getId()
                             );
                             if ($item->getId() > 0) {
                                 if ($parent === 0) {
                                     $parent = null;
                                 }
                                 $this->current_obj->insertInTree($item->getId(), $parent);
                             }
                             break;
                     }
                 } elseif ($a_rec["Type"] === "pg") {
                     $imp_id = explode("_", $a_rec["ImportId"]);
                     if ($imp_id[0] === "il" &&
                         (int) $imp_id[1] == (int) IL_INST_ID &&
                         $imp_id[2] === "pg"
                     ) {
                         $pg_id = $imp_id[3];
                         $pool = ilMediaPoolItem::getPoolForItemId($pg_id);
                         $pool = current($pool);
                         if ($pool == $this->getTranslationMep()->getId()) {
                             $a_mapping->addMapping("components/ILIAS/MediaPool", "pg", $a_rec["Child"], $pg_id);
                             $a_mapping->addMapping(
                                 "components/ILIAS/COPage",
                                 "pg",
                                 "mep:" . $a_rec["Child"],
                                 "mep:" . $pg_id
                             );
                         }
                     }
                 }
                 break;
         }
     }

Here is the call graph for this function:

◆ readData()

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

Definition at line 138 of file class.ilMediaPoolDataSet.php.

References ilDataSet\$db, $ilDB, $q, ilDataSet\convertToLeadingUpper(), ilDataSet\getDirectDataFromQuery(), getMasterLanguageOnly(), and IL_INST_ID.

                                                                                : void
     {
         $ilDB = $this->db;
 
         // mep_data
         if ($a_entity === "mep") {
             switch ($a_version) {
                 case "4.1.0":
                     $this->getDirectDataFromQuery("SELECT id, title, description, " .
                         " default_width, default_height" .
                         " FROM mep_data JOIN object_data ON (mep_data.id = object_data.obj_id) " .
                         "WHERE " .
                         $ilDB->in("id", $a_ids, false, "integer"));
                     break;
 
                 case "5.1.0":
                     $q = "SELECT id, title, description, " .
                         " default_width, default_height" .
                         " FROM mep_data JOIN object_data ON (mep_data.id = object_data.obj_id) " .
                         "WHERE " .
                         $ilDB->in("id", $a_ids, false, "integer");
 
                     $set = $ilDB->query($q);
                     $this->data = array();
                     while ($rec = $ilDB->fetchAssoc($set)) {
                         if ($this->getMasterLanguageOnly()) {
                             $rec["for_translation"] = 1;
                         }
                         $tmp = array();
                         foreach ($rec as $k => $v) {
                             $tmp[$this->convertToLeadingUpper($k)]
                                 = $v;
                         }
                         $rec = $tmp;
 
                         $this->data[] = $rec;
                     }
                     break;
             }
         }
 
         // mep_tree
         if ($a_entity === "mep_tree") {
             switch ($a_version) {
                 case "4.1.0":
                     $this->getDirectDataFromQuery("SELECT mep_id, child " .
                         " ,parent,depth,type,title,foreign_id " .
                         " FROM mep_tree JOIN mep_item ON (child = obj_id) " .
                         " WHERE " .
                         $ilDB->in("mep_id", $a_ids, false, "integer") .
                         " ORDER BY depth");
                     break;
 
                 case "5.1.0":
                     $type = "";
                     if ($this->getMasterLanguageOnly()) {
                         $type = " AND type <> " . $ilDB->quote("mob", "text");
                     }
 
                     $q = "SELECT mep_id, child " .
                         " ,parent,depth,type,title,foreign_id, import_id " .
                         " FROM mep_tree JOIN mep_item ON (child = obj_id) " .
                         " WHERE " .
                         $ilDB->in("mep_id", $a_ids, false, "integer") .
                         $type .
                         " ORDER BY depth";
 
                     $set = $ilDB->query($q);
                     $this->data = array();
                     while ($rec = $ilDB->fetchAssoc($set)) {
                         $set2 = $ilDB->query("SELECT for_translation FROM mep_data WHERE id = " . $ilDB->quote($rec["mep_id"], true));
                         $rec2 = $ilDB->fetchAssoc($set2);
                         if (!$rec2["for_translation"]) {
                             $rec["import_id"] = "il_" . IL_INST_ID . "_" . $rec["type"] . "_" . $rec["child"];
                         }
                         $tmp = array();
                         foreach ($rec as $k => $v) {
                             $tmp[$this->convertToLeadingUpper($k)]
                                 = $v;
                         }
                         $rec = $tmp;
 
                         $this->data[] = $rec;
                     }
 
                     break;
             }
         }
     }

Here is the call graph for this function:

◆ setMasterLanguageOnly()

ilMediaPoolDataSet::setMasterLanguageOnly ( bool $a_val )

Set master language only (export)

Definition at line 52 of file class.ilMediaPoolDataSet.php.

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

◆ setTranslationImportMode()

ilMediaPoolDataSet::setTranslationImportMode	(	?ilObjMediaPool	$a_mep,
		string	$a_lang = `""`
	)

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

References null.

      : void {
         if ($a_mep !== null) {
             $this->transl_into = true;
             $this->transl_into_mep = $a_mep;
             $this->transl_lang = $a_lang;
         } else {
             $this->transl_into = false;
         }
     }