ilSurveyExporter 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 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)

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="")
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 Used for container export with tests

Author

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

Definition at line 24 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 90 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 66 of file class.ilSurveyExporter.php.

     : array {
        if ($a_entity === "svy") {
            return array(
                    array(
                            "component" => "Modules/Survey",
                            "entity" => "svy_quest_skill",
                            "ids" => $a_ids),
                    array(
                            "component" => "Modules/Survey",
                            "entity" => "svy_skill_threshold",
                            "ids" => $a_ids),
                    array(
                            "component" => "Services/Object",
                            "entity" => "common",
                            "ids" => $a_ids)
            );
        }
        return array();
    }

getXmlRepresentation()

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

Reimplemented from ilXmlExporter.

Definition at line 35 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
            ilFileUtils::unzip($zip);
 
            // unzip does not extract the included directory
            // Modules/Survey/set_1 anymore (since 7/2023)
            $missing = $svy_exp->export_dir . "/" . $svy_exp->subdir .
                "/Modules/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, ilFileUtils\makeDirParents(), and ilFileUtils\unzip().

Here is the call graph for this function:

init()

ilSurveyExporter::init

(

)

Reimplemented from ilXmlExporter.

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

                          : void
    {
        $this->ds = new ilSurveyDataSet();
        $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
        $this->ds->setDSPrefix("ds");
    }

Field Documentation

$ds

ilSurveyDataSet ilSurveyExporter::$ds

private

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

---

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

• Modules/Survey/Export/class.ilSurveyExporter.php