ilNewsExporter Class Reference

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

Inheritance diagram for ilNewsExporter:

Collaboration diagram for ilNewsExporter:

Public Member Functions
	init ()
	getXmlExportHeadDependencies (string $a_entity, string $a_target_release, array $a_ids)
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	getValidSchemaVersions (string $a_entity)
	Returns schema versions that the component can export to. More...
Public Member Functions inherited from ilXmlExporter
	__construct ()
	setExport (ilExport $a_exp)
	getExport ()
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	init ()
	setExportDirectories (string $a_dir_relative, string $a_dir_absolute)
	getRelativeExportDirectory ()
	getAbsoluteExportDirectory ()
	getXmlExportHeadDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get tail dependencies. More...
	getValidSchemaVersions (string $a_entity)
	Returns schema versions that the component can export to. More...
	determineSchemaVersion (string $a_entity, string $a_target_release)

Private Attributes
ilNewsDataSet	$ds

Additional Inherited Members
Static Public Member Functions inherited from ilXmlExporter
static	lookupExportDirectory (string $a_obj_type, int $a_obj_id, string $a_export_type='xml', string $a_entity="")
Protected Attributes inherited from ilXmlExporter
ilExport	$exp

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 Exporter class for news

Author

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

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

Member Function Documentation

getValidSchemaVersions()

ilNewsExporter::getValidSchemaVersions

(

string

$a_entity

)

Returns schema versions that the component can export to.

ILIAS chooses the first one, that has min/max constraints which fit to the target release. Please put the newest on top. Example: return array ( "4.1.0" => array( "namespace" => "http://www.ilias.de/Services/MetaData/md/4_1", "xsd_file" => "ilias_md_4_1.xsd", "min" => "4.1.0", "max" => "") );

Reimplemented from ilXmlExporter.

Definition at line 63 of file class.ilNewsExporter.php.

                                                            : array
    {
        return [
            "5.4.0" => [
                "namespace" => "https://www.ilias.de/Services/News/news/5_4",
                "xsd_file" => "ilias_news_5_4.xsd",
                "uses_dataset" => true,
                "min" => "5.4.0",
                "max" => ""
            ],
            "4.1.0" => [
                "namespace" => "https://www.ilias.de/Services/News/news/4_1",
                "xsd_file" => "ilias_news_4_1.xsd",
                "uses_dataset" => true,
                "min" => "4.1.0",
                "max" => ""
            ]
        ];
    }

getXmlExportHeadDependencies()

ilNewsExporter::getXmlExportHeadDependencies	(	string	$a_entity,
		string	$a_target_release,
		array	$a_ids
	)

Returns

array array of array with keys "component", entity", "ids"

Reimplemented from ilXmlExporter.

Definition at line 38 of file class.ilNewsExporter.php.

                                                                                                          : array
    {
        $mob_ids = [];
 
        foreach ($a_ids as $id) {
            $mob_id = ilNewsItem::_lookupMobId((int) $id);
            if ($mob_id > 0) {
                $mob_ids[$mob_id] = $mob_id;
            }
        }
 
        return [
            [
                "component" => "components/ILIAS/MediaObjects",
                "entity" => "mob",
                "ids" => $mob_ids
            ]
        ];
    }

References $id, and ilNewsItem\_lookupMobId().

Here is the call graph for this function:

getXmlRepresentation()

ilNewsExporter::getXmlRepresentation	(	string	$a_entity,
		string	$a_schema_version,
		string	$a_id
	)

Reimplemented from ilXmlExporter.

Definition at line 58 of file class.ilNewsExporter.php.

                                                                                                  : string
    {
        return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, [$a_id], "", true, true);
    }

init()

ilNewsExporter::init

(

)

Reimplemented from ilXmlExporter.

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

                          : void
    {
        $this->ds = new ilNewsDataSet();
        $this->ds->initByExporter($this);
        $this->ds->setDSPrefix("ds");
    }

Field Documentation

$ds

ilNewsDataSet ilNewsExporter::$ds

private

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

---

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

• components/ILIAS/News/classes/class.ilNewsExporter.php