ilContentPageExporter Class Reference

Class ilContentPageExporter. More...

Inheritance diagram for ilContentPageExporter:

Collaboration diagram for ilContentPageExporter:

Public Member Functions
	init ()
	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml representation. Parameters string entity string schema version string id Returns string xml string More...
	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. 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" => "") ); Returns array More...
	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. Parameters string entity string target release array ids Returns array array of array with keys "component", entity", "ids" 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...

Protected Attributes
	$ds
Protected Attributes inherited from ilXmlExporter
	$dir_relative
	$dir_absolute
	$exp

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...
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_EDIT = 'edit'
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_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_ICON = 'icon'
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

Class ilContentPageExporter.

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

Member Function Documentation

getValidSchemaVersions()

ilContentPageExporter::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. 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" => "")
    );

Returns

array

Reimplemented from ilXmlExporter.

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

    {
        return array(
            '5.4.0' => array(
                '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	(		$a_entity,
			$a_target_release,
			$a_ids
	)

Get tail dependencies.

Parameters

string	entity
string	target release
array	ids

Returns

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

Reimplemented from ilXmlExporter.

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

    {
        $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;
            }
 
            if ($copa->getStyleSheetId() > 0) {
                $styleIds[$copa->getStyleSheetId()] = $copa->getStyleSheetId();
            }
        }
 
        $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;
    }

References ilObjectFactory\getInstanceByObjId().

Here is the call graph for this function:

getXmlRepresentation()

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

Get xml representation.

Parameters

string	entity
string	schema version
string	id

Returns

string xml string

Reimplemented from ilXmlExporter.

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

    {
        ilUtil::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);
    }

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

Here is the call graph for this function:

init()

ilContentPageExporter::init

(

)

Reimplemented from ilXmlExporter.

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

    {
        $this->ds = new ilContentPageDataSet();
        $this->ds->setDSPrefix('ds');
    }

Field Documentation

$ds

ilContentPageExporter::$ds

protected

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

---

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

• Modules/ContentPage/classes/class.ilContentPageExporter.php