ilContainerExporter Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilContainerExporter:

Collaboration diagram for ilContainerExporter:

Public Member Functions
	__construct ()
	init ()
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get tail dependencies. More...
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	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="")

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning container structure export

Author

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

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

Constructor & Destructor Documentation

__construct()

ilContainerExporter::__construct

(

)

Reimplemented from ilXmlExporter.

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

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

References $DIC.

Member Function Documentation

getValidSchemaVersions()

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

Returns

array[]

Reimplemented from ilXmlExporter.

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

                                                            : array
    {
        return [
            "4.1.0" => [
                "namespace" => "https://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	(	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 39 of file class.ilContainerExporter.php.

                                                                                                          : array
    {
        if ($a_entity !== 'struct') {
            return [];
        }
 
 
        $res = [];
 
        // pages
 
        $pg_ids = [];
 
        // container pages
        foreach ($a_ids as $id) {
            if (ilContainerPage::_exists("cont", (int) $id)) {
                $pg_ids[] = "cont:" . $id;
            }
        }
 
        // container start objects pages
        foreach ($a_ids as $id) {
            if (ilContainerStartObjectsPage::_exists("cstr", (int) $id)) {
                $pg_ids[] = "cstr:" . $id;
            }
        }
 
        if (count($pg_ids)) {
            $res[] = [
                "component" => "components/ILIAS/COPage",
                "entity" => "pg",
                "ids" => $pg_ids
            ];
        }
 
        // style
        $style_ids = [];
        foreach ($a_ids as $id) {
            // see #24888
            $style = $this->content_style_domain->styleForObjId((int) $id);
            $style_id = $style->getExportStyleId();
            if ($style_id > 0) {
                $style_ids[] = $style_id;
            }
        }
        if (count($style_ids)) {
            $res[] = [
                "component" => "components/ILIAS/Style",
                "entity" => "sty",
                "ids" => $style_ids
            ];
        }
 
        // service settings
        $res[] = [
            "component" => "components/ILIAS/ILIASObject",
            "entity" => "common",
            "ids" => $a_ids
        ];
 
        // skill profiles
        $res[] = [
            "component" => "components/ILIAS/Skill",
            "entity" => "skl_local_prof",
            "ids" => $a_ids
        ];
 
        // news settings
        $res[] = [
            "component" => "components/ILIAS/News",
            "entity" => "news_settings",
            "ids" => $a_ids
        ];
 
        return $res;
    }

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

Here is the call graph for this function:

getXmlRepresentation()

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

Reimplemented from ilXmlExporter.

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

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

References $DIC, $log, and ilObject\_getAllReferences().

Here is the call graph for this function:

init()

ilContainerExporter::init

(

)

Reimplemented from ilXmlExporter.

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

                          : void
    {
    }

Field Documentation

$content_style_domain

ILIAS Style Content DomainService ilContainerExporter::$content_style_domain

protected

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

---

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

• components/ILIAS/Container/Export/class.ilContainerExporter.php