ilSurveyExporter Class Reference

Used for container export with tests. More...

Inheritance diagram for ilSurveyExporter:

Collaboration diagram for ilSurveyExporter:

Public Member Functions
	init ()
	getXmlRepresentation (string $a_entity, string $a_schema_version, string $a_id)
	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...
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
InternalDomainService	$domain
Protected Attributes inherited from ilXmlExporter
ilExport	$exp

Private Attributes
ilSurveyDataSet	$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

Used for container export with tests.

Author

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

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

Member Function Documentation

getValidSchemaVersions()

ilSurveyExporter::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. Example: return array ( "4.1.0" => array( "namespace" => "http://www.ilias.de/Services/MetaData/md/4_1", "xsd_file" => "ilias_md_4_1.xsd", "min" => "4.1.0", "max" => "") );

Reimplemented from ilXmlExporter.

Definition at line 112 of file class.ilSurveyExporter.php.

     : array {
        if ($a_entity === "svy") {
            return array(
                    "4.1.0" => array(
                            "namespace" => "https://www.ilias.de/Modules/Survey/htlm/4_1",
                            "xsd_file" => "ilias_svy_4_1.xsd",
                            "uses_dataset" => false,
                            "min" => "4.1.0",
                            "max" => "")
            );
        } else {
            return array(
                    "5.1.0" => array(
                            "namespace" => "https://www.ilias.de/Modules/Survey/svy/5_1",
                            "xsd_file" => "ilias_svy_5_1.xsd",
                            "uses_dataset" => true,
                            "min" => "5.1.0",
                            "max" => "")
            );
        }
    }

getXmlExportTailDependencies()

ilSurveyExporter::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 72 of file class.ilSurveyExporter.php.

     : array {
        if ($a_entity === "svy") {
            $dependencies = [
                [
                    "component" => "components/ILIAS/Survey",
                    "entity" => "svy_quest_skill",
                    "ids" => $a_ids
                ],
                [
                    "component" => "components/ILIAS/Survey",
                    "entity" => "svy_skill_threshold",
                    "ids" => $a_ids
                ],
                [
                    "component" => "components/ILIAS/ILIASObject",
                    "entity" => "common",
                    "ids" => $a_ids
                ]
            ];
 
            $md_ids = [];
            foreach ($a_ids as $id) {
                $md_ids[] = $id . ":0:svy";
            }
            if ($md_ids !== []) {
                $dependencies[] = [
                    "component" => "components/ILIAS/MetaData",
                    "entity" => "md",
                    "ids" => $md_ids
                ];
            }
            return $dependencies;
        }
        return array();
    }

References $id.

getXmlRepresentation()

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

Reimplemented from ilXmlExporter.

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

     : string {
        if ($a_entity === "svy") {
            $svy = new ilObjSurvey($a_id, false);
            $svy->loadFromDb();
 
            $svy_exp = new ilSurveyExport($svy, 'xml');
            $zip = $svy_exp->buildExportFile();
 
            // Unzip, since survey deletes this dir
            $this->domain->resources()->zip()->unzipFile($zip);
 
            // unzip does not extract the included directory
            // Modules/Survey/set_1 anymore (since 7/2023)
            $missing = $svy_exp->export_dir . "/" . $svy_exp->subdir .
                "/components/ILIAS/Survey/set_1";
            ilFileUtils::makeDirParents($missing);
 
            // here: svy_data/svy_301/export/1698817474__0__svy_301
            //       svy_301/export/1698817474__0__svy_301/Modules/Survey/set_1
            //       svy_data/svy_301/export/1698817474__0__svy_301.zip
            $GLOBALS['ilLog']->write(__METHOD__ . ': Created zip file ' . $zip);
            return "";
        } else {
            return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, [$a_id], "", true, true);
        }
    }

References $GLOBALS, and ilFileUtils\makeDirParents().

Here is the call graph for this function:

init()

ilSurveyExporter::init

(

)

Reimplemented from ilXmlExporter.

Definition at line 31 of file class.ilSurveyExporter.php.

                          : void
    {
        global $DIC;
 
        $this->domain = $DIC->survey()->internal()->domain();
        $this->ds = new ilSurveyDataSet();
        $this->ds->initByExporter($this);
        $this->ds->setDSPrefix("ds");
    }

References $DIC.

Field Documentation

$domain

InternalDomainService ilSurveyExporter::$domain

protected

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

$ds

ilSurveyDataSet ilSurveyExporter::$ds

private

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

---

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

• components/ILIAS/Survey/Export/class.ilSurveyExporter.php