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

Inheritance diagram for ilMediaCastDataSet:

Collaboration diagram for ilMediaCastDataSet:

Public Member Functions
	getSupportedVersions ()

	getXmlNamespace (string $a_entity, string $a_schema_version)

	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)

	getOrder ()

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

Protected Member Functions
	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)

	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
ilObjMediaCast	$current_obj

array	$order = array()

Protected Attributes inherited from ilDataSet
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	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 cast data set class

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

Definition at line 24 of file class.ilMediaCastDataSet.php.

Member Function Documentation

◆ getDependencies()

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

protected

Definition at line 167 of file class.ilMediaCastDataSet.php.

      : array {
         return [];
     }

◆ getOrder()

ilMediaCastDataSet::getOrder ( )

Definition at line 244 of file class.ilMediaCastDataSet.php.

References $order.

                               : array
     {
         return $this->order;
     }

◆ getSupportedVersions()

ilMediaCastDataSet::getSupportedVersions ( )

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

                                           : array
     {
         return array("8.0", "5.0.0", "4.1.0");
     }

◆ getTypes()

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

protected

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

                                                                     : array
     {
         if ($a_entity == "mcst") {
             switch ($a_version) {
                 case "4.1.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "PublicFiles" => "integer",
                         "Downloadable" => "integer",
                         "DefaultAccess" => "integer");
 
                 case "5.0.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "PublicFiles" => "integer",
                         "Downloadable" => "integer",
                         "DefaultAccess" => "integer",
                         "Sortmode" => "integer",
                         "Viewmode" => "text",
                         "PublicFeed" => "integer",
                         "KeepRssMin" => "integer",
                         "Order" => "text"
                     );
 
                 case "8.0":
                     return array(
                         "Id" => "integer",
                         "Title" => "text",
                         "Description" => "text",
                         "PublicFiles" => "integer",
                         "Downloadable" => "integer",
                         "DefaultAccess" => "integer",
                         "Sortmode" => "integer",
                         "Viewmode" => "text",
                         "PublicFeed" => "integer",
                         "KeepRssMin" => "integer",
                         "Order" => "text",
                         "Autoplaymode" => "integer",
                         "NrInitialVideos" => "integer",
                         "NewItemsInLp" => "integer"
                     );
             }
         }
         return [];
     }

◆ getXmlNamespace()

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

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

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

◆ importRecord()

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

Definition at line 176 of file class.ilMediaCastDataSet.php.

References ilBlockSetting\_write(), ilImportMapping\addMapping(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), and ilDataSet\stripTags().

      : void {
         $a_rec = $this->stripTags($a_rec);
         switch ($a_entity) {
             case "mcst":
 
                 if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_rec['Id'])) {
                     $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                 } else {
                     $newObj = new ilObjMediaCast();
                     $newObj->setType("mcst");
                     $newObj->create();
                 }
 
                 $newObj->setTitle($a_rec["Title"] ?? "");
                 $newObj->setDescription($a_rec["Description"] ?? "");
                 $newObj->setDefaultAccess((int) ($a_rec["DefaultAccess"] ?? 0));
                 $newObj->setDownloadable((bool) (int) ($a_rec["Downloadable"] ?? false));
                 $newObj->setPublicFiles((bool) (int) ($a_rec["PublicFiles"] ?? false));
 
                 if (in_array($a_schema_version, ["5.0.0", "8.0"])) {
                     $newObj->setOrder((int) ($a_rec["Sortmode"] ?? 0));
                     $newObj->setViewMode((string) ($a_rec["Viewmode"] ?? ""));
 
                     if ($a_rec["Order"] ?? false) {
                         $this->order[$newObj->getId()] = explode(";", $a_rec["Order"]);
                     }
 
                     ilBlockSetting::_write(
                         "news",
                         "public_feed",
                         $a_rec["PublicFeed"],
                         0,
                         $newObj->getId()
                     );
 
                     ilBlockSetting::_write(
                         "news",
                         "keep_rss_min",
                         $a_rec["KeepRssMin"],
                         0,
                         $newObj->getId()
                     );
                 }
                 if (in_array($a_schema_version, ["8.0"])) {
                     $newObj->setAutoplayMode((int) ($a_rec["Autoplaymode"] ?? 0));
                     $newObj->setNumberInitialVideos((int) ($a_rec["NrInitialVideos"] ?? 0));
                     $newObj->setNewItemsInLearningProgress((bool) (int) ($a_rec["NewItemsInLp"] ?? false));
                 }
 
                 $newObj->update();
                 $this->current_obj = $newObj;
                 $a_mapping->addMapping("Modules/MediaCast", "mcst", $a_rec["Id"], $newObj->getId());
                 $a_mapping->addMapping(
                     "Services/News",
                     "news_context",
                     $a_rec["Id"] . ":mcst:0:",
                     $newObj->getId() . ":mcst:0:"
                 );
                 break;
         }
     }

Here is the call graph for this function:

◆ readData()

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

Definition at line 89 of file class.ilMediaCastDataSet.php.

References ilDataSet\$db, $ilDB, ilBlockSetting\_lookup(), ilDataSet\getDirectDataFromQuery(), and ILIAS\Repository\int().

      : void {
         $ilDB = $this->db;
 
 
         if ($a_entity == "mcst") {
             switch ($a_version) {
                 case "4.1.0":
                     $this->getDirectDataFromQuery("SELECT id, title, description, " .
                         " public_files, downloadable, def_access default_access" .
                         " FROM il_media_cast_data JOIN object_data ON (il_media_cast_data.id = object_data.obj_id) " .
                         "WHERE " .
                         $ilDB->in("id", $a_ids, false, "integer"));
                     break;
 
                 case "5.0.0":
                     $this->getDirectDataFromQuery("SELECT id, title, description, " .
                         " public_files, downloadable, def_access default_access, sortmode, viewmode" .
                         " FROM il_media_cast_data JOIN object_data ON (il_media_cast_data.id = object_data.obj_id) " .
                         "WHERE " .
                         $ilDB->in("id", $a_ids, false, "integer"));
 
                     // #17174 - manual order?
                     $order = array();
                     $set = $ilDB->query("SELECT * FROM il_media_cast_data_ord" .
                         " WHERE " . $ilDB->in("obj_id", $a_ids, false, "integer") .
                         " ORDER BY pos");
                     while ($row = $ilDB->fetchAssoc($set)) {
                         $order[$row["obj_id"]][] = $row["item_id"];
                     }
 
                     foreach ($this->data as $k => $v) {
                         $this->data[$k]["PublicFeed"] = ilBlockSetting::_lookup("news", "public_feed", 0, $v["Id"]);
                         $this->data[$k]["KeepRssMin"] = (int) ilBlockSetting::_lookup("news", "keep_rss_min", 0, $v["Id"]);
 
                         // manual order?
                         if ($this->data[$k]["Sortmode"] == 4 &&
                             array_key_exists($v["Id"], $order)) {
                             $this->data[$k]["Order"] = implode(";", $order[$v["Id"]]);
                         }
                     }
                     break;
 
                 case "8.0":
                     $this->getDirectDataFromQuery("SELECT id, title, description, " .
                         " public_files, downloadable, def_access default_access, sortmode, viewmode," .
                         " autoplaymode,nr_initial_videos,new_items_in_lp" .
                         " FROM il_media_cast_data JOIN object_data ON (il_media_cast_data.id = object_data.obj_id) " .
                         "WHERE " .
                         $ilDB->in("id", $a_ids, false, "integer"));
 
                     // #17174 - manual order?
                     $order = array();
                     $set = $ilDB->query("SELECT * FROM il_media_cast_data_ord" .
                         " WHERE " . $ilDB->in("obj_id", $a_ids, false, "integer") .
                         " ORDER BY pos");
                     while ($row = $ilDB->fetchAssoc($set)) {
                         $order[$row["obj_id"]][] = $row["item_id"];
                     }
 
                     foreach ($this->data as $k => $v) {
                         $this->data[$k]["PublicFeed"] = ilBlockSetting::_lookup("news", "public_feed", 0, $v["Id"]);
                         $this->data[$k]["KeepRssMin"] = (int) ilBlockSetting::_lookup("news", "keep_rss_min", 0, $v["Id"]);
 
                         // manual order?
                         if ($this->data[$k]["Sortmode"] == 4 &&
                             array_key_exists($v["Id"], $order)) {
                             $this->data[$k]["Order"] = implode(";", $order[$v["Id"]]);
                         }
                     }
                     break;
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $current_obj

ilObjMediaCast ilMediaCastDataSet::$current_obj

protected

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

◆ $order

array ilMediaCastDataSet::$order = array()

protected

Definition at line 27 of file class.ilMediaCastDataSet.php.

Referenced by getOrder().

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

Modules/MediaCast/classes/class.ilMediaCastDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getOrder()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()

Field Documentation

◆ $current_obj

◆ $order