Exporter class for sessions. More...

Inheritance diagram for ilForumExporter:

Collaboration diagram for ilForumExporter:

Public Member Functions
	init ()

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

	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)

	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)

Protected Attributes
ILIAS Style Content DomainService	$content_style_domain

Protected Attributes inherited from ilXmlExporter
string	$dir_relative = ""

string	$dir_absolute = ""

ilExport	$exp

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="")

Data Fields inherited from ilForumObjectConstants
const	OBJ_TYPE = 'frm'

const	UI_TAB_ID_INFO = 'info_short'

const	UI_TAB_ID_SETTINGS = 'settings'

const	UI_TAB_ID_MODERATORS = 'frm_moderators'

const	UI_TAB_ID_THREADS = 'forums_threads'

const	UI_TAB_ID_STATS = 'frm_statistics'

const	UI_TAB_ID_EXPORT = 'export'

const	UI_TAB_ID_PERMISSIONS = 'perm_settings'

const	UI_SUB_TAB_ID_BASIC_SETTINGS = 'basic_settings'

const	UI_SUB_TAB_ID_NOTIFICATIONS = 'notifications'

const	UI_SUB_TAB_ID_NEWS = 'cont_news_settings'

const	UI_SUB_TAB_ID_STYLE = 'cont_style'

const	UI_CMD_COPAGE_DOWNLOAD_FILE = 'downloadFile'

const	UI_CMD_COPAGE_DISPLAY_FULLSCREEN = 'displayMediaFullscreen'

const	UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH = 'download_paragraph'

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 27 of file class.ilForumExporter.php.

Member Function Documentation

◆ getValidSchemaVersions()

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

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

                                                             : array
     {
         return [
             "4.1.0" => [
                 "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" => [
                 "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" => [
                 "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" => "7.999"
             ],
             "8.0" => [
                 "namespace" => "http://www.ilias.de/Modules/Forum/frm/8",
                 "xsd_file" => "ilias_frm_8.xsd",
                 "uses_dataset" => false,
                 "min" => "8.0",
                 "max" => ""
             ]
         ];
     }

◆ getXmlExportTailDependencies()

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

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

References ilObjectFactory\getInstanceByObjId().

                                                                                                           : array
     {
         $deps = [];
 
         if ('frm' === $a_entity) {
             $deps[] = [
                 'component' => 'Services/Object',
                 'entity' => 'common',
                 'ids' => $a_ids
             ];
 
             $deps[] = [
                 "component" => "Services/News",
                 "entity" => "news_settings",
                 "ids" => $a_ids
             ];
         }
 
         $pageObjectIds = [];
         $styleIds = [];
 
         foreach ($a_ids as $frmObjId) {
             $frm = ilObjectFactory::getInstanceByObjId($frmObjId, false);
             if (!$frm || !($frm instanceof ilObjForum)) {
                 continue;
             }
 
             $frmPageObjIds = $frm->getPageObjIds();
             foreach ($frmPageObjIds as $frmPageObjId) {
                 $pageObjectIds[] = self::OBJ_TYPE . ':' . $frmPageObjId;
             }
 
             $style_id = $this->content_style_domain->styleForObjId((int) $frmObjId)->getStyleId();
             if ($style_id > 0) {
                 $styleIds[$style_id] = $style_id;
             }
         }
 
         if (count($pageObjectIds) > 0) {
             $deps[] = [
                 'component' => 'Services/COPage',
                 'entity' => 'pg',
                 'ids' => $pageObjectIds,
             ];
         }
 
         if (count($styleIds) > 0) {
             $deps[] = [
                 'component' => 'Services/Style',
                 'entity' => 'sty',
                 'ids' => array_values($styleIds),
             ];
         }
 
         return $deps;
     }

Here is the call graph for this function:

◆ getXmlRepresentation()

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

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

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

                                                                                                   : string
     {
         $xml = '';
 
         if (ilObject::_lookupType((int) $a_id) === 'frm') {
             $writer = new ilForumXMLWriter();
             $writer->setForumId((int) $a_id);
             ilFileUtils::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 ( )

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

References $DIC.

                           : void
     {
         global $DIC;
         $this->content_style_domain = $DIC
             ->contentStyle()
             ->domain();
     }

Field Documentation

◆ $content_style_domain

ILIAS Style Content DomainService ilForumExporter::$content_style_domain

protected

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

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

Modules/Forum/classes/class.ilForumExporter.php

Public Member Functions

Protected Attributes

Additional Inherited Members