News data set class. More...

Inheritance diagram for ilNewsDataSet:

Collaboration diagram for ilNewsDataSet:

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

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 ...> ... </types> <set entity="table_name"> <rec> <field_1>content</field_1> <field_2>my_date</field_2> <field_3>my_number</field_3> </rec> ... </set> </dataset> 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...

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

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

Protected Attributes inherited from ilDataSet
	$current_installation_id = ""

	$db

	$ds_log

	$ds_namespace = 'ds'

Detailed Description

News 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.ilNewsDataSet.php.

Member Function Documentation

◆ getDependencies()

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

protected

Determine the dependent sets of data.

Definition at line 131 of file class.ilNewsDataSet.php.

    {
        return false;
    }

◆ getSupportedVersions()

ilNewsDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

return

Reimplemented from ilDataSet.

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

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

◆ getTypes()

ilNewsDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 43 of file class.ilNewsDataSet.php.

    {
        if ($a_entity == "news") {
            switch ($a_version) {
                case "4.1.0":
                case "5.4.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Content" => "text",
                        "Priority" => "integer",
                        "ContextObjId" => "integer",
                        "ContextObjType" => "text",
                        "ContextSubObjId" => "integer",
                        "ContextSubObjType" => "text",
                        "ContentType" => "text",
                        "Visibility" => "text",
                        "ContentLong" => "text",
                        "ContentIsLangVar" => "integer",
                        "MobId" => "integer",
                        "Playtime" => "text"
                        );
            }
        }
        if ($a_entity == "news_settings") {
            switch ($a_version) {
                case "5.4.0":
                    return array(
                        "ObjId" => "integer",
                        "PublicFeed" => "integer",
                        "DefaultVisibility" => "text",
                        "KeepRssMin" => "integer",
                        "HideNewsPerDate" => "integer",
                        "HideNewsDate" => "text",
                        "PublicNotifications" => "integer"
                    );
            }
        }
    }

◆ getXmlNamespace()

ilNewsDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

return

Reimplemented from ilDataSet.

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

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

◆ importRecord()

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

Import record.

Parameters

return

Definition at line 143 of file class.ilNewsDataSet.php.

    {
        $a_rec = $this->stripTags($a_rec);
 
        switch ($a_entity) {
            case "news":
                $mob_id = null;
                if ($a_rec["MobId"] > 0) {
                    $mob_id = $a_mapping->getMapping("Services/MediaObjects", "mob", $a_rec["MobId"]);
                }
                $c = (int) $a_rec["ContextObjId"] . ":" . $a_rec["ContextObjType"] . ":" . (int) $a_rec["ContextSubObjId"] .
                    ":" . $a_rec["ContextSubObjType"];
                $context = $a_mapping->getMapping("Services/News", "news_context", $c);
                $context = explode(":", $context);
//var_dump($c);
//var_dump($a_mapping->mappings["Services/News"]["news_context"]);
                include_once("./Services/News/classes/class.ilNewsItem.php");
                $newObj = new ilNewsItem();
                $newObj->setTitle($a_rec["Title"]);
                $newObj->setContent($a_rec["Content"]);
                $newObj->setPriority($a_rec["Priority"]);
                $newObj->setContextObjId($context[0]);
                $newObj->setContextObjType($context[1]);
                $newObj->setContextSubObjId($context[2]);
                $newObj->setContextSubObjType($context[3]);
                $newObj->setContentType($a_rec["ContentType"]);
                $newObj->setVisibility($a_rec["Visibility"]);
                $newObj->setContentLong($a_rec["ContentLong"]);
                $newObj->setContentIsLangVar($a_rec["ContentIsLangVar"]);
                $newObj->setMobId($mob_id);
                $newObj->setPlaytime($a_rec["Playtime"]);
                $newObj->create();
                $a_mapping->addMapping("Services/News", "news", $a_rec["Id"], $newObj->getId());
                break;
 
            case "news_settings":
 
                $dummy_dataset = new ilObjectDataSet();
                $new_obj_id = $dummy_dataset->getNewObjId($a_mapping, $a_rec["ObjId"]);
 
                if ($new_obj_id > 0 && $a_schema_version == "5.4.0") {
                    foreach ([
                        "public_feed" => "PublicFeed",
                        "keep_rss_min" => "KeepRssMin",
                        "default_visibility" => "DefaultVisibility",
                        "hide_news_per_date" => "HideNewsPerDate",
                        "hide_news_date" => "HideNewsDate",
                        "public_notifications" => "PublicNotifications"
                         ] as $set => $field) {
                        ilBlockSetting::_write(
                            "news",
                            $set,
                            $a_rec[$field],
                            0,
                            $new_obj_id
                        );
                    }
                }
                break;
 
        }
    }

References $c, $context, ilBlockSetting\_write(), and ilDataSet\stripTags().

Here is the call graph for this function:

◆ readData()

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

Read data.

Parameters

return

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

    {
        $ilDB = $this->db;
 
        if (!is_array($a_ids)) {
            $a_ids = array($a_ids);
        }
                
        if ($a_entity == "news") {
            switch ($a_version) {
                case "4.1.0":
                case "5.4.0":
                    $this->getDirectDataFromQuery("SELECT id, title, content, priority," .
                        " context_obj_id, context_obj_type, context_sub_obj_id, context_sub_obj_type, " .
                        " content_type, visibility, content_long, content_is_lang_var, mob_id, playtime" .
                        " FROM il_news_item " .
                        "WHERE " .
                        $ilDB->in("id", $a_ids, false, "integer"));
                    break;
            }
        }
 
        if ($a_entity == "news_settings") {
            switch ($a_version) {
                case "5.4.0":
                    foreach ($a_ids as $obj_id) {
                        $this->data[$obj_id]["ObjId"] = $obj_id;
                        $this->data[$obj_id]["PublicFeed"] = ilBlockSetting::_lookup("news", "public_feed", 0, $obj_id);
                        $this->data[$obj_id]["KeepRssMin"] = (int) ilBlockSetting::_lookup("news", "keep_rss_min", 0, $obj_id);
                        $this->data[$obj_id]["DefaultVisibility"] = ilBlockSetting::_lookup("news", "default_visibility", 0, $obj_id);
                        $this->data[$obj_id]["HideNewsPerDate"] = (int) ilBlockSetting::_lookup("news", "hide_news_per_date", 0, $obj_id);
                        $this->data[$obj_id]["HideNewsDate"] = ilBlockSetting::_lookup("news", "hide_news_date", 0, $obj_id);
                        $this->data[$obj_id]["PublicNotifications"] = (int) ilBlockSetting::_lookup("news", "public_notifications", 0, $obj_id);
                    }
                    break;
            }
        }
    }

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

Here is the call graph for this function:

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

Services/News/classes/class.ilNewsDataSet.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()