container structure export More...

Inheritance diagram for ilContainerExporter:

Collaboration diagram for ilContainerExporter:

Public Member Functions
	__construct ()
	Constructor. More...

	init ()
	Init export. More...

	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. More...

	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml. More...

	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
	$writer = null

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

container structure export

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerExporter::__construct ( )

Constructor.

Reimplemented from ilXmlExporter.

Definition at line 24 of file class.ilContainerExporter.php.

25 {

26 }

Member Function Documentation

◆ getValidSchemaVersions()

ilContainerExporter::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

Reimplemented from ilXmlExporter.

Definition at line 135 of file class.ilContainerExporter.php.

    {
        return array(
            "4.1.0" => array(
                "namespace" => "http://www.ilias.de/Modules/Folder/fold/4_1",
                "xsd_file" => "ilias_fold_4_1.xsd",
                "uses_dataset" => false,
                "min" => "4.1.0",
                "max" => "")
        );
    }

◆ getXmlExportTailDependencies()

ilContainerExporter::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 36 of file class.ilContainerExporter.php.

    {
        if ($a_entity != 'struct') {
            return;
        }
        
        
        $res = array();
        
        // pages
        
        $pg_ids = array();
        
        // container pages
        include_once("./Services/Container/classes/class.ilContainerPage.php");
        foreach ($a_ids as $id) {
            if (ilContainerPage::_exists("cont", $id)) {
                $pg_ids[] = "cont:" . $id;
            }
        }
        
        // container start objects pages
        include_once("./Services/Container/classes/class.ilContainerStartObjectsPage.php");
        foreach ($a_ids as $id) {
            if (ilContainerStartObjectsPage::_exists("cstr", $id)) {
                $pg_ids[] = "cstr:" . $id;
            }
        }
        
        if (sizeof($pg_ids)) {
            $res[] = array(
                "component" => "Services/COPage",
                "entity" => "pg",
                "ids" => $pg_ids
            );
        }
        
        // style
        $style_ids = array();
        foreach ($a_ids as $id) {
            include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
            $style_id = ilObjStyleSheet::lookupObjectStyle($id);
            // see #24888
            $style_id = ilObjStyleSheet::getEffectiveContentStyleId($style_id);
            if ($style_id > 0) {
                $style_ids[] = $style_id;
            }
        }
        if (sizeof($style_ids)) {
            $res[] = array(
                "component" => "Services/Style",
                "entity" => "sty",
                "ids" => $style_ids
            );
        }
 
        // service settings
        $res[] = array(
            "component" => "Services/Object",
            "entity" => "common",
            "ids" => $a_ids);
 
        // news settings
        $res[] = [
            "component" => "Services/News",
            "entity" => "news_settings",
            "ids" => $a_ids
        ];
 
        return $res;
    }

References $id, $res, ilPageObject\_exists(), ilObjStyleSheet\getEffectiveContentStyleId(), and ilObjStyleSheet\lookupObjectStyle().

Here is the call graph for this function:

◆ getXmlRepresentation()

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

Get xml.

Parameters

object	$a_entity
object	$a_schema_version
object	$a_id

Returns

Reimplemented from ilXmlExporter.

Definition at line 115 of file class.ilContainerExporter.php.

    {
        global $DIC;
 
        $log = $DIC->logger()->root();
        if ($a_entity == 'struct') {
            $log->debug(__METHOD__ . ': Received id = ' . $a_id);
            $writer = new ilContainerXmlWriter(end(ilObject::_getAllReferences($a_id)));
            $writer->write();
            return $writer->xmlDumpMem(false);
        }
    }