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

Collaboration diagram for ilCategoryExporter:

Public Member Functions
	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...
	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...
	init ()
	Init method. 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)

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.ilCategoryExporter.php.

Member Function Documentation

getValidSchemaVersions()

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

Reimplemented from ilXmlExporter.

Definition at line 96 of file class.ilCategoryExporter.php.

                                                            : array
    {
        return [
            "7.0.0" => [
                'namespace' => 'https://www.ilias.de/Modules/Category/cat/7_0',
                'xsd_file' => 'ilias_cat_7_0.xsd',
                'uses_dataset' => false,
                'min' => '7.0',
                'max' => ''
            ],
            "4.3.0" => [
                "namespace" => "https://www.ilias.de/Modules/Category/cat/4_3",
                "xsd_file" => "ilias_cat_4_3.xsd",
                "uses_dataset" => false,
                "min" => "4.3.0",
                "max" => ""
            ]
        ];
    }

getXmlExportHeadDependencies()

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

Get head 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 35 of file class.ilCategoryExporter.php.

                                                                                                          : array
    {
        // always trigger container because of co-page(s)
        return [
            [
                'component' => 'Services/Container',
                'entity' => 'struct',
                'ids' => $a_ids
            ]
        ];
    }

getXmlExportTailDependencies()

ilCategoryExporter::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 47 of file class.ilCategoryExporter.php.

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

References $id, and ilObjTaxonomy\getUsageOfObject().

Here is the call graph for this function:

getXmlRepresentation()

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

Exceptions

ilDatabaseException
ilObjectNotFoundException

Reimplemented from ilXmlExporter.

Definition at line 73 of file class.ilCategoryExporter.php.

                                                                                                  : string
    {
        $all_ref = ilObject::_getAllReferences((int) $a_id);
        $cat_ref_id = end($all_ref);
        $category = ilObjectFactory::getInstanceByRefId($cat_ref_id, false);
 
        if (!$category instanceof ilObjCategory) {
            $GLOBALS['ilLog']->write(__METHOD__ . $a_id . ' is not instance of type category!');
            return '';
        }
 
 
        $writer = new ilCategoryXmlWriter($category);
        $writer->setMode(ilCategoryXmlWriter::MODE_EXPORT);
        $writer->export(false);
        return $writer->getXml();
    }

References $GLOBALS, ilObject\_getAllReferences(), ilObjectFactory\getInstanceByRefId(), and ilCategoryXmlWriter\MODE_EXPORT.

Here is the call graph for this function:

init()

ilCategoryExporter::init

(

)

Init method.

Reimplemented from ilXmlExporter.

Definition at line 119 of file class.ilCategoryExporter.php.

                          : void
    {
    }

---

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

• Modules/Category/Export/class.ilCategoryExporter.php