Media cast data set class. More...

Inheritance diagram for ilMediaCastDataSet:

Collaboration diagram for ilMediaCastDataSet:

Public Member Functions
	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...

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

	getOrder ()

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
	$order = array()

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 cast data set class.

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

Version: $Id$

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

Member Function Documentation

◆ getDependencies()

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

protected

Determine the dependent sets of data.

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

     {
         return false;
     }

◆ getOrder()

ilMediaCastDataSet::getOrder ( )

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

References $order.

     {
         return $this->order;
     }

◆ getSupportedVersions()

ilMediaCastDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

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

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

◆ getTypes()

ilMediaCastDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

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

     {
         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"
                     );
             }
         }
     }

◆ getXmlNamespace()

ilMediaCastDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

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

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

◆ importRecord()

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

Import record.

Parameters

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

References ilBlockSetting\_write(), and ilObjectFactory\getInstanceByObjId().

     {
         //echo $a_entity;
         //var_dump($a_rec);
 
         switch ($a_entity) {
             case "mcst":
                 include_once("./Modules/MediaCast/classes/class.ilObjMediaCast.php");
                 
                 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(true);
                 }
                 
                 $newObj->setTitle($a_rec["Title"]);
                 $newObj->setDescription($a_rec["Description"]);
                 $newObj->setDefaultAccess($a_rec["DefaultAccess"]);
                 $newObj->setDownloadable($a_rec["Downloadable"]);
                 $newObj->setPublicFiles($a_rec["PublicFiles"]);
 
                 if ($a_schema_version == "5.0.0") {
                     $newObj->setOrder($a_rec["Sortmode"]);
                     $newObj->setViewMode($a_rec["Viewmode"]);
                     
                     if ($a_rec["Order"]) {
                         $this->order[$newObj->getId()] = explode(";", $a_rec["Order"]);
                     }
 
                     include_once("./Services/Block/classes/class.ilBlockSetting.php");
                     ilBlockSetting::_write(
                         "news",
                         "public_feed",
                         $a_rec["PublicFeed"],
                         0,
                         $newObj->getId()
                     );
 
                     ilBlockSetting::_write(
                         "news",
                         "keep_rss_min",
                         $a_rec["KeepRssMin"],
                         0,
                         $newObj->getId()
                     );
                 }
 
                 $newObj->update(true);
                 $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:"
                 );
 //var_dump($a_mapping->mappings["Services/News"]["news_context"]);
                 break;
         }
     }

Here is the call graph for this function:

◆ readData()

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

Read data.

Parameters

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

References ilDataSet\$db, $ilDB, $order, $row, ilBlockSetting\_lookup(), data, and ilDataSet\getDirectDataFromQuery().

     {
         $ilDB = $this->db;
 
         if (!is_array($a_ids)) {
             $a_ids = array($a_ids);
         }
                 
         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"];
                     }
                     
                     include_once("./Services/Block/classes/class.ilBlockSetting.php");
                     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

◆ $order

ilMediaCastDataSet::$order = array()

protected

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

Referenced by getOrder(), and readData().

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

◆ $order