Inheritance diagram for ilContentPageExporter:

Collaboration diagram for ilContentPageExporter:

Public Member Functions
	init ()

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

	getValidSchemaVersions (string $a_entity)

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

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
ilContentPageDataSet	$ds

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 ilContentPageObjectConstants
const	OBJ_TYPE = 'copa'

const	HTTP_PARAM_PAGE_EDITOR_STYLE_CONTEXT = 'page_editor_style'

const	UI_CMD_VIEW = 'view'

const	UI_CMD_EDIT = 'edit'

const	UI_CMD_UPDATE = 'update'

const	UI_CMD_COPAGE_DOWNLOAD_FILE = 'downloadFile'

const	UI_CMD_COPAGE_DISPLAY_FULLSCREEN = 'displayMediaFullscreen'

const	UI_CMD_COPAGE_DISPLAY_MEDIA = 'displayMedia'

const	UI_CMD_COPAGE_DOWNLOAD_PARAGRAPH = 'download_paragraph'

const	UI_CMD_COPAGE_EDIT = 'edit'

const	UI_CMD_STYLES_EDIT = 'editStyleProperties'

const	UI_TAB_ID_CONTENT = 'content'

const	UI_TAB_ID_INFO = 'info_short'

const	UI_TAB_ID_SETTINGS = 'settings'

const	UI_TAB_ID_STYLE = 'style'

const	UI_TAB_ID_I18N = 'i18n'

const	UI_TAB_ID_LP = 'learning_progress'

const	UI_TAB_ID_EXPORT = 'export'

const	UI_TAB_ID_PERMISSIONS = 'perm_settings'

Detailed Description

Definition at line 23 of file class.ilContentPageExporter.php.

Member Function Documentation

◆ getValidSchemaVersions()

ilContentPageExporter::getValidSchemaVersions ( string $a_entity )

Definition at line 46 of file class.ilContentPageExporter.php.

                                                             : array
     {
         return [
             '5.4.0' => [
                 'namespace' => 'http://www.ilias.de/Modules/ContentPage/' . self::OBJ_TYPE . '/5_4',
                 'xsd_file' => 'ilias_' . self::OBJ_TYPE . '_5_4.xsd',
                 'uses_dataset' => true,
                 'min' => '5.4.0',
                 'max' => '',
             ],
         ];
     }

◆ getXmlExportTailDependencies()

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

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

References ilObjectFactory\getInstanceByObjId().

                                                                                                           : array
     {
         $pageObjectIds = [];
         $styleIds = [];
 
         foreach ($a_ids as $copaObjId) {
             $copa = ilObjectFactory::getInstanceByObjId($copaObjId, false);
             if (!$copa || !($copa instanceof ilObjContentPage)) {
                 continue;
             }
 
             $copaPageObjIds = $copa->getPageObjIds();
             foreach ($copaPageObjIds as $copaPageObjId) {
                 $pageObjectIds[] = self::OBJ_TYPE . ':' . $copaPageObjId;
             }
 
             $style_id = $this->content_style_domain
                 ->styleForObjId($copa->getId())
                 ->getStyleId();
             if ($style_id > 0) {
                 $styleIds[$style_id] = $style_id;
             }
         }
 
         $deps = [];
 
         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),
             ];
         }
 
         if (self::OBJ_TYPE === $a_entity) {
             $deps[] = [
                 'component' => 'Services/Object',
                 'entity' => 'common',
                 'ids' => $a_ids
             ];
         }
 
         return $deps;
     }

Here is the call graph for this function:

◆ getXmlRepresentation()

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

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

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

                                                                                                   : string
     {
         ilFileUtils::makeDirParents($this->getAbsoluteExportDirectory());
         $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
 
         return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, [$a_id], '', true, true);
     }

Here is the call graph for this function:

◆ init()

ilContentPageExporter::init ( )

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

References $DIC.

                           : void
     {
         global $DIC;
 
         $this->ds = new ilContentPageDataSet();
         $this->ds->setDSPrefix('ds');
         $this->content_style_domain = $DIC->contentStyle()
                                           ->domain();
     }

Field Documentation

◆ $content_style_domain

DomainService ilContentPageExporter::$content_style_domain

protected

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

◆ $ds

ilContentPageDataSet ilContentPageExporter::$ds

protected

Definition at line 25 of file class.ilContentPageExporter.php.

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

Modules/ContentPage/classes/class.ilContentPageExporter.php

Public Member Functions

Protected Attributes

Additional Inherited Members