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

Collaboration diagram for ilContainerReferenceExporter:

Public Member Functions
	getXmlExportHeadDependencies (string $a_entity, string $a_target_release, array $a_ids)
	Get head dependencies. More...
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	getValidSchemaVersions (string $a_entity)
	init ()
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 Member Functions
	initWriter (ilContainerReference $ref)

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="")
Protected Attributes inherited from ilXmlExporter
string	$dir_relative = ""
string	$dir_absolute = ""
ilExport	$exp

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 Class for category export

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Member Function Documentation

getValidSchemaVersions()

ilContainerReferenceExporter::getValidSchemaVersions

(

string

$a_entity

)

Returns

array[]

Reimplemented from ilXmlExporter.

Definition at line 79 of file class.ilContainerReferenceExporter.php.

                                                            : array
    {
        return [
            "4.3.0" => [
                "namespace" => "https://www.ilias.de/Modules/CategoryReference/catr/4_3",
                "xsd_file" => "ilias_catr_4_3.xsd",
                "uses_dataset" => false,
                "min" => "4.3.0",
                "max" => ""
            ]
        ];
    }

getXmlExportHeadDependencies()

ilContainerReferenceExporter::getXmlExportHeadDependencies	(	string	$a_entity,
		string	$a_target_release,
		array	$a_ids
	)

Get head dependencies.

Returns

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

Reimplemented from ilXmlExporter.

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

                                                                                                          : array
    {
        global $DIC;
 
        $log = $DIC->logger()->root();
 
        $eo = ilExportOptions::getInstance();
 
        $obj_id = end($a_ids);
 
        $log->debug(__METHOD__ . ': ' . $obj_id);
        if ($eo->getOption(ilExportOptions::KEY_ROOT) != $obj_id) {
            return [];
        }
        if (count(ilExportOptions::getInstance()->getSubitemsForExport()) > 1) {
            return [
                [
                    'component' => 'Services/Container',
                    'entity' => 'struct',
                    'ids' => $a_ids
                ]
            ];
        }
        return [];
    }

References $DIC, $log, ilExportOptions\getInstance(), and ilExportOptions\KEY_ROOT.

Here is the call graph for this function:

getXmlRepresentation()

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

Reimplemented from ilXmlExporter.

Definition at line 56 of file class.ilContainerReferenceExporter.php.

                                                                                                  : string
    {
        global $DIC;
 
        $log = $DIC->logger()->root();
 
        $refs = ilObject::_getAllReferences((int) $a_id);
        $ref_ref_id = end($refs);
        $ref = ilObjectFactory::getInstanceByRefId($ref_ref_id, false);
 
        if (!$ref instanceof ilContainerReference) {
            $log->debug(__METHOD__ . $a_id . ' is not instance of type category!');
            return '';
        }
        $writer = $this->initWriter($ref);
        $writer->setMode(ilContainerReferenceXmlWriter::MODE_EXPORT);
        $writer->export(false);
        return $writer->getXml();
    }

References $DIC, $log, ilObject\_getAllReferences(), ilObjectFactory\getInstanceByRefId(), initWriter(), and ilContainerReferenceXmlWriter\MODE_EXPORT.

Here is the call graph for this function:

init()

ilContainerReferenceExporter::init

(

)

Reimplemented from ilXmlExporter.

Definition at line 92 of file class.ilContainerReferenceExporter.php.

                          : void
    {
    }

initWriter()

ilContainerReferenceExporter::initWriter ( ilContainerReference  $ref )

abstractprotected

Reimplemented in ilCourseReferenceExporter, and ilGroupReferenceExporter.

Referenced by getXmlRepresentation().

Here is the caller graph for this function:

---

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

• Services/ContainerReference/classes/class.ilContainerReferenceExporter.php