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

Collaboration diagram for ilGlossaryExporter:

Public Member Functions
	init ()
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	getValidSchemaVersions (string $a_entity)
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
	getActiveAdvMDRecords (int $a_id)

Protected Attributes
ILIAS Glossary Metadata MetadataManager	$metadata
Protected Attributes inherited from ilXmlExporter
ilExport	$exp

Private Attributes
ilGlossaryDataSet	$ds

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 Glossary XML export

Author

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

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

getActiveAdvMDRecords()

ilGlossaryExporter::getActiveAdvMDRecords ( int  $a_id )

protected

Definition at line 143 of file class.ilGlossaryExporter.php.

References $ref_id, ilAdvancedMDRecord\_getActivatedRecordsByObjectType(), ilObject\_getAllReferences(), and ilAdvancedMDRecord\getObjRecSelection().

Referenced by getXmlExportTailDependencies().

                                                       : array
    {
        $active = [];
        foreach (ilObject::_getAllReferences($a_id) as $ref_id) {
            foreach ($this->metadata->getActiveAdvMDRecords($ref_id) as $rec) {
                $active[$rec->getRecordId()] = $rec;
            }
        }
        return $active;

        $active = array();
        // selected globals
        $sel_globals = ilAdvancedMDRecord::getObjRecSelection($a_id, "term");

        foreach (ilAdvancedMDRecord::_getActivatedRecordsByObjectType("glo", "term") as $record_obj) {
            // local ones and globally activated for the object
            if ($record_obj->getParentObject() == $a_id || in_array($record_obj->getRecordId(), $sel_globals)) {
                $active[] = $record_obj->getRecordId();
            }
        }

        return $active;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getValidSchemaVersions()

ilGlossaryExporter::getValidSchemaVersions

(

string

$a_entity

)

Definition at line 175 of file class.ilGlossaryExporter.php.

                                                            : array
    {
        return array(
            "9.0.0" => array(
                "namespace" => "https://www.ilias.de/Modules/Glossary/htlm/9_0",
                "xsd_file" => "ilias_glo_9_0.xsd",
                "uses_dataset" => true,
                "min" => "9.0.0",
                "max" => ""),
            "5.4.0" => array(
                "namespace" => "https://www.ilias.de/Modules/Glossary/htlm/5_4",
                "xsd_file" => "ilias_glo_5_4.xsd",
                "uses_dataset" => true,
                "min" => "5.4.0",
                "max" => ""),
            "5.1.0" => array(
                "namespace" => "https://www.ilias.de/Modules/Glossary/htlm/5_1",
                "xsd_file" => "ilias_glo_5_1.xsd",
                "uses_dataset" => true,
                "min" => "5.1.0",
                "max" => ""),
            "4.1.0" => array(
                "namespace" => "https://www.ilias.de/Modules/Glossary/htlm/4_1",
                "xsd_file" => "ilias_glo_4_1.xsd",
                "uses_dataset" => false,
                "min" => "4.1.0",
                "max" => "")
            );
    }

getXmlExportTailDependencies()

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

Definition at line 39 of file class.ilGlossaryExporter.php.

References $id, $ref_id, ilObject\_getAllReferences(), getActiveAdvMDRecords(), ilGlossaryTerm\getTermList(), ilObjTaxonomy\getUsageOfObject(), and null.

     : array {
        if ($a_entity == "glo") {
            // definition related ids
            $page_ids = array();
            foreach ($a_ids as $id) {
                // workaround for #0023923
                $all_refs = ilObject::_getAllReferences($id);
                $ref_id = current($all_refs);

                // see #29014, we include referenced terms in the export as well
                $terms = ilGlossaryTerm::getTermList(
                    [$ref_id],
                    "",
                    "",
                    "",
                    0,
                    false,
                    null,
                    true
                );

                foreach ($terms as $t) {
                    $page_ids[] = "term:" . $t["id"];
                }
            }
            // definition pages and their metadat
            $deps = array(
                array(
                    "component" => "components/ILIAS/COPage",
                    "entity" => "pg",
                    "ids" => $page_ids)
            );

            // taxonomy
            $tax_ids = array();
            foreach ($a_ids as $id) {
                $t_ids = ilObjTaxonomy::getUsageOfObject((int) $id);
                if (count($t_ids) > 0) {
                    $tax_ids[$t_ids[0]] = $t_ids[0];
                }
            }
            if (count($tax_ids)) {
                $deps[] = array(
                    "component" => "components/ILIAS/Taxonomy",
                    "entity" => "tax",
                    "ids" => $tax_ids
                );
            }

            // advanced metadata
            $advmd_ids = array();
            foreach ($a_ids as $id) {
                $rec_ids = $this->getActiveAdvMDRecords($id);
                if (count($rec_ids)) {
                    foreach ($rec_ids as $rec_id) {
                        $advmd_ids[] = $id . ":" . $rec_id->getRecordId();
                    }
                }
            }
            if (count($advmd_ids)) {
                $deps[] = array(
                    "component" => "components/ILIAS/AdvancedMetaData",
                    "entity" => "advmd",
                    "ids" => $advmd_ids
                );
            }

            // style
            $obj_ids = (is_array($a_ids))
                ? $a_ids
                : array($a_ids);
            $deps[] = array(
                "component" => "components/ILIAS/Style",
                "entity" => "object_style",
                "ids" => $obj_ids
            );

            // service settings
            $deps[] = array(
                "component" => "components/ILIAS/ILIASObject",
                "entity" => "common",
                "ids" => $a_ids);

            $md_ids = [];
            foreach ($a_ids as $crs_id) {
                $md_ids[] = $crs_id . ":0:glo";
            }
            if ($md_ids !== []) {
                $deps[] = [
                    "component" => "components/ILIAS/MetaData",
                    "entity" => "md",
                    "ids" => $md_ids
                ];
            }

            return $deps;
        }
        return array();
    }

Here is the call graph for this function:

getXmlRepresentation()

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

Definition at line 167 of file class.ilGlossaryExporter.php.

     : string {
        return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, [$a_id], "", true, true);
    }

init()

ilGlossaryExporter::init

(

)

Definition at line 29 of file class.ilGlossaryExporter.php.

References $DIC.

                          : void
    {
        global $DIC;

        $this->ds = new ilGlossaryDataSet();
        $this->ds->initByExporter($this);
        $this->ds->setDSPrefix("ds");
        $this->metadata = $DIC->glossary()->internal()->domain()->metadata();
    }

Field Documentation

$ds

ilGlossaryDataSet ilGlossaryExporter::$ds

private

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

$metadata

ILIAS Glossary Metadata MetadataManager ilGlossaryExporter::$metadata

protected

Definition at line 27 of file class.ilGlossaryExporter.php.

---

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

• components/ILIAS/Glossary/Export/class.ilGlossaryExporter.php