ilTestExporter Class Reference

Used for container export with tests. More...

Inheritance diagram for ilTestExporter:

Collaboration diagram for ilTestExporter:

Public Member Functions
	__construct ()
	init ()
	Initialisation. More...
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $id)
	getXmlExportHeadDependencies (string $entity, string $target_release, array $ids)
	getXmlExportTailDependencies (string $a_entity, string $a_target_release, array $a_ids)
	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)

Private Member Functions
	getDependingTaxonomyIds (array $test_obj_ids)

Private Attributes
readonly ilLanguage	$lng
readonly ExportImportFactory	$export_factory
readonly TestLogger	$logger
readonly ilTree	$tree
readonly ilCtrl	$ctrl
readonly ilComponentRepository	$component_repository
readonly GeneralQuestionPropertiesRepository	$questionrepository

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
ilExport	$exp

Detailed Description

Used for container export with tests.

Author

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

Version

$Id$ \

Definition at line 34 of file class.ilTestExporter.php.

Constructor & Destructor Documentation

__construct()

ilTestExporter::__construct

(

)

Definition at line 44 of file class.ilTestExporter.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\logger().

    {
        global $DIC;
        $this->lng = $DIC['lng'];
        $local_dic = TestDIC::dic();
        $this->export_factory = $local_dic['exportimport.factory'];
        $this->logger = $local_dic['logging.logger'];
        $this->questionrepository = $local_dic['question.general_properties.repository'];
        $this->tree = $DIC['tree'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->component_repository = $DIC['component.repository'];

        parent::__construct();
    }

Here is the call graph for this function:

Member Function Documentation

getDependingTaxonomyIds()

ilTestExporter::getDependingTaxonomyIds ( array  $test_obj_ids )

private

Parameters

array<int>

$testObjIds

Returns

array<int> $taxIds

Definition at line 171 of file class.ilTestExporter.php.

References ilObjTaxonomy\getUsageOfObject().

Referenced by getXmlExportTailDependencies().

                                                                 : array
    {
        $tax_ids = [];

        foreach ($test_obj_ids as $test_obj_id) {
            foreach (ilObjTaxonomy::getUsageOfObject($test_obj_id) as $tax_id) {
                $tax_ids[$tax_id] = $tax_id;
            }
        }

        return $tax_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getValidSchemaVersions()

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

Parameters

string

$a_entity

Returns

array

Definition at line 191 of file class.ilTestExporter.php.

                                                            : array
    {
        return [
            '4.1.0' => [
                'namespace' => 'http://www.ilias.de/Modules/Test/htlm/4_1',
                'xsd_file' => 'ilias_tst_4_1.xsd',
                'uses_dataset' => false,
                'min' => '4.1.0',
                'max' => ''
            ]
        ];
    }

getXmlExportHeadDependencies()

ilTestExporter::getXmlExportHeadDependencies	(	string	$entity,
		string	$target_release,
		array	$ids
	)

Definition at line 84 of file class.ilTestExporter.php.

References $id, ilObjMediaObject\_getMobsOfObject(), and null.

                                                                                                    : array
    {
        if ($entity === 'tst') {
            $mobs = [];
            $files = [];
            foreach ($ids as $id) {
                $tst = new ilObjTest((int) $id, false);
                $tst->read();

                $intro_page_id = $tst->getMainSettings()->getIntroductionSettings()->getIntroductionPageId();
                if ($intro_page_id !== null) {
                    $mobs = array_merge($mobs, ilObjMediaObject::_getMobsOfObject('tst:pg', $intro_page_id));
                    $files = array_merge($files, ilObjFile::_getFilesOfObject('tst:pg', $intro_page_id));
                }

                $concluding_remarks_page_id = $tst->getMainSettings()->getFinishingSettings()->getConcludingRemarksPageId();
                if ($concluding_remarks_page_id !== null) {
                    $mobs = array_merge($mobs, ilObjMediaObject::_getMobsOfObject('tst:pg', $concluding_remarks_page_id));
                    $files = array_merge($files, ilObjFile::_getFilesOfObject('tst:pg', $concluding_remarks_page_id));
                }
            }

            return [
                [
                    'component' => 'components/ILIAS/MediaObjects',
                    'entity' => 'mob',
                    'ids' => $mobs
                ],
                [
                    'component' => 'components/ILIAS/File',
                    'entity' => 'file',
                    'ids' => $files
                ]
            ];
        }

        return parent::getXmlExportTailDependencies($entity, $target_release, $ids);
    }

Here is the call graph for this function:

getXmlExportTailDependencies()

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

Parameters

array<int>

ids

Returns

array<array> array of array with keys 'component', 'entity', 'ids'

Definition at line 127 of file class.ilTestExporter.php.

References $id, and getDependingTaxonomyIds().

                                                                                                          : array
    {
        if ($a_entity == 'tst') {
            $deps = [];

            $tax_ids = $this->getDependingTaxonomyIds($a_ids);

            if (count($tax_ids)) {
                $deps[] = [
                    'component' => 'components/ILIAS/Taxonomy',
                    'entity' => 'tax',
                    'ids' => $tax_ids
                ];
            }

            $deps[] = [
                'component' => 'components/ILIAS/ILIASObject',
                'entity' => 'common',
                'ids' => $a_ids
            ];


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

            return $deps;
        }

        return parent::getXmlExportTailDependencies($a_entity, $a_target_release, $a_ids);
    }

Here is the call graph for this function:

getXmlRepresentation()

ilTestExporter::getXmlRepresentation	(	string	$a_entity,
		string	$a_schema_version,
		string	$id
	)

Definition at line 66 of file class.ilTestExporter.php.

References ILIAS\Repository\ctrl(), ilXmlExporter\getAbsoluteExportDirectory(), and ILIAS\Repository\logger().

                                                                                                : string
    {
        $parameters = $this->ctrl->getParameterArrayByClass(ilTestExportGUI::class);
        $export_type = ExportImportTypes::XML;
        if (!empty($parameters['export_results'])) {
            $export_type = ExportImportTypes::XML_WITH_RESULTS;
            $this->ctrl->clearParameterByClass(ilTestExportGUI::class, 'export_results');
        }
        $tst = new ilObjTest((int) $id, false);
        $tst->read();
        $zip = $this->export_factory->getExporter($tst, $export_type)
            ->withExportDirInfo($this->getAbsoluteExportDirectory())
            ->write();

        $this->logger->info(__METHOD__ . ': Created zip file ' . $zip);
        return '';
    }

Here is the call graph for this function:

init()

ilTestExporter::init

(

)

Initialisation.

Definition at line 62 of file class.ilTestExporter.php.

                          : void
    {
    }

Field Documentation

$component_repository

readonly ilComponentRepository ilTestExporter::$component_repository

private

Definition at line 41 of file class.ilTestExporter.php.

$ctrl

readonly ilCtrl ilTestExporter::$ctrl

private

Definition at line 40 of file class.ilTestExporter.php.

$export_factory

readonly ExportImportFactory ilTestExporter::$export_factory

private

Definition at line 37 of file class.ilTestExporter.php.

$lng

readonly ilLanguage ilTestExporter::$lng

private

Definition at line 36 of file class.ilTestExporter.php.

$logger

readonly TestLogger ilTestExporter::$logger

private

Definition at line 38 of file class.ilTestExporter.php.

$questionrepository

readonly GeneralQuestionPropertiesRepository ilTestExporter::$questionrepository

private

Definition at line 42 of file class.ilTestExporter.php.

$tree

readonly ilTree ilTestExporter::$tree

private

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

---

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

• components/ILIAS/Test/classes/class.ilTestExporter.php