ilForumExporter Class Reference

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)
	Get tail dependencies. More...
	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
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 = 'general'
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.

Reimplemented from ilXmlExporter.

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

                                                            : array
    {
        return [
            "5.1.0" => [
                "namespace" => "http://www.ilias.de/Modules/Forum/frm/5_1",
                "xsd_file" => "ilias_frm_5_1.xsd",
                "uses_dataset" => false,
                "min" => "7.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" => "8.999"
            ],
            "9.0" => [
                "namespace" => "http://www.ilias.de/Modules/Forum/frm/9",
                "xsd_file" => "ilias_frm_9.xsd",
                "uses_dataset" => false,
                "min" => "9.0",
                "max" => ""
            ]
        ];
    }

getXmlExportTailDependencies()

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

Get tail dependencies.

Returns

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

Reimplemented from ilXmlExporter.

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

                                                                                                          : array
    {
        $deps = [];
 
        if ('frm' === $a_entity) {
            $deps[] = [
                'component' => 'components/ILIAS/ILIASObject',
                'entity' => 'common',
                'ids' => $a_ids
            ];
 
            $deps[] = [
                "component" => "components/ILIAS/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 ($pageObjectIds !== []) {
            $deps[] = [
                'component' => 'components/ILIAS/COPage',
                'entity' => 'pg',
                'ids' => $pageObjectIds,
            ];
        }
 
        if ($styleIds !== []) {
            $deps[] = [
                'component' => 'components/ILIAS/Style',
                'entity' => 'sty',
                'ids' => array_values($styleIds),
            ];
        }
 
        return $deps;
    }

References ilObjectFactory\getInstanceByObjId().

Here is the call graph for this function:

getXmlRepresentation()

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

Reimplemented from ilXmlExporter.

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

                                                                                                  : string
    {
        $xml = '';
 
        if (ilObject::_lookupType((int) $a_id) === 'frm') {
            $writer = new ilForumXMLWriter();
            $writer->setForumId((int) $a_id);
            ilFileUtils::makeDirParents($this->getAbsoluteExportDirectory());
            $writer->setFileTargetDirectories(
                $this->exp->getExportDirInContainer(),
                $this->getAbsoluteExportDirectory()
            );
            $writer->start();
            $xml .= $writer->getXML();
        }
 
        return $xml;
    }

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

Here is the call graph for this function:

init()

ilForumExporter::init

(

)

Reimplemented from ilXmlExporter.

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

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

References $DIC.

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:

• components/ILIAS/Forum/classes/class.ilForumExporter.php