ilForumExporter Class Reference

Exporter class for sessions. More...

Inheritance diagram for ilForumExporter:

Collaboration diagram for ilForumExporter:

Public Member Functions
	init ()
	Initialisation. More...
	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml representation. More...
	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...
Public Member Functions inherited from ilXmlExporter
	__construct ()
	Constructor. More...
	setExport (ilExport $a_exp)
	Set export object. More...
	getExport ()
	Get export. More...
	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml representation. More...
	init ()
	setExportDirectories ($a_dir_relative, $a_dir_absolute)
	Export directories. More...
	getRelativeExportDirectory ()
	Get relative export directory. More...
	getAbsoluteExportDirectory ()
	Get absolute export directory. More...
	getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
	Get head dependencies. More...
	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. More...
	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...
	determineSchemaVersion ($a_entity, $a_target_release)
	Determine schema version. More...

Private Attributes
	$ds

Additional Inherited Members
Static Public Member Functions inherited from ilXmlExporter
static	lookupExportDirectory ($a_obj_type, $a_obj_id, $a_export_type='xml', $a_entity="")
	export directory lookup More...
Protected Attributes inherited from ilXmlExporter
	$dir_relative
	$dir_absolute
	$exp

Detailed Description

Exporter class for sessions.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id

Definition at line 11 of file class.ilForumExporter.php.

Member Function Documentation

getValidSchemaVersions()

ilForumExporter::getValidSchemaVersions

(

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

Returns

Definition at line 79 of file class.ilForumExporter.php.

    {
        return array(
            "4.1.0" => array(
                "namespace" => "http://www.ilias.de/Modules/Forum/frm/4_1",
                "xsd_file" => "ilias_frm_4_1.xsd",
                "uses_dataset" => false,
                "min" => "4.1.0",
                "max" => "4.4.999"
            ),
            "4.5.0" => array(
                "namespace" => "http://www.ilias.de/Modules/Forum/frm/4_5",
                "xsd_file" => "ilias_frm_4_5.xsd",
                "uses_dataset" => false,
                "min" => "4.5.0",
                "max" => "5.0.999"
            ),
            "5.1.0" => array(
                "namespace" => "http://www.ilias.de/Modules/Forum/frm/5_1",
                "xsd_file" => "ilias_frm_5_1.xsd",
                "uses_dataset" => false,
                "min" => "5.1.0",
                "max" => ""
            )
        );
    }

getXmlExportTailDependencies()

ilForumExporter::getXmlExportTailDependencies	(		$a_entity,
			$a_target_release,
			$a_ids
	)

Definition at line 50 of file class.ilForumExporter.php.

    {
        $deps = [];

        if ('frm' === $a_entity) {
            $deps[] = [
                'component' => 'Services/Object',
                'entity' => 'common',
                'ids' => $a_ids
            ];

            // news settings
            $deps[] = [
                "component" => "Services/News",
                "entity" => "news_settings",
                "ids" => $a_ids
            ];
        }

        return $deps;
    }

getXmlRepresentation()

ilForumExporter::getXmlRepresentation	(		$a_entity,
			$a_schema_version,
			$a_id
	)

Get xml representation.

Parameters

string	entity
string	target release
string	id

Returns

string xml string

Definition at line 31 of file class.ilForumExporter.php.

References $xml, ilObject\_lookupType(), ilXmlExporter\getAbsoluteExportDirectory(), ilXmlExporter\getRelativeExportDirectory(), and ilUtil\makeDirParents().

    {
        $xml = '';

        if (ilObject::_lookupType($a_id) == 'frm') {
            $writer = new ilForumXMLWriter();
            $writer->setForumId($a_id);
            ilUtil::makeDirParents($this->getAbsoluteExportDirectory());
            $writer->setFileTargetDirectories($this->getRelativeExportDirectory(), $this->getAbsoluteExportDirectory());
            $writer->start();
            $xml .= $writer->getXml();
        }

        return $xml;
    }

Here is the call graph for this function:

init()

ilForumExporter::init

(

)

Initialisation.

Definition at line 18 of file class.ilForumExporter.php.

    {
    }

Field Documentation

$ds

ilForumExporter::$ds

private

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

---

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

• Modules/Forum/classes/class.ilForumExporter.php