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

Collaboration diagram for ilSurveyImporter:

Public Member Functions
	__construct ()
	init ()
	setSurvey (ilObjSurvey $a_val)
	Set current survey object (being imported). More...
	getSurvey ()
	importXmlRepresentation (string $a_entity, string $a_id, string $a_xml, ilImportMapping $a_mapping)
	Import XML. More...
Public Member Functions inherited from ilXmlImporter
	__construct ()
	setImport (ilImport $a_val)
	getImport ()
	init ()
	setInstallId (string $a_val)
	getInstallId ()
	setInstallUrl (string $a_val)
	getInstallUrl ()
	setSchemaVersion (string $a_val)
	getSchemaVersion ()
	setImportDirectory (string $a_val)
	getImportDirectory ()
	setSkipEntities (array $a_val)
	getSkipEntities ()
	exportedFromSameInstallation ()
	importXmlRepresentation (string $a_entity, string $a_id, string $a_xml, ilImportMapping $a_mapping)
	finalProcessing (ilImportMapping $a_mapping)
	afterContainerImportProcessing (ilImportMapping $mapping)

Protected Member Functions
	parseXmlFileNames ()
	Create qti and xml file name. More...

Protected Attributes
ilSurveyDataSet	$ds
ilLogger	$log
ilLogger	$svy_log
ILIAS SurveyQuestionPool Export ImportManager	$spl_import_manager
Protected Attributes inherited from ilXmlImporter
array	$skip_entities = array()
ilImport	$imp
string	$install_id
string	$install_url
string	$schema_version
string	$import_directory

Static Protected Attributes
static ilObjSurvey	$survey

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 Importer class for files

Author

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

Definition at line 23 of file class.ilSurveyImporter.php.

Constructor & Destructor Documentation

__construct()

ilSurveyImporter::__construct

(

)

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct();
        global $DIC;

        $this->log = $DIC["ilLog"];

        $this->spl_import_manager = $DIC->surveyQuestionPool()
            ->internal()
            ->domain()
            ->import();
    }

Here is the call graph for this function:

Member Function Documentation

getSurvey()

ilSurveyImporter::getSurvey

(

)

Definition at line 65 of file class.ilSurveyImporter.php.

                               : ilObjSurvey
    {
        return self::$survey;
    }

importXmlRepresentation()

ilSurveyImporter::importXmlRepresentation	(	string	$a_entity,
		string	$a_id,
		string	$a_xml,
		ilImportMapping	$a_mapping
	)

Import XML.

Exceptions

ilDatabaseException
ilImportException
ilObjectNotFoundException

Definition at line 76 of file class.ilSurveyImporter.php.

References $GLOBALS, ilImportMapping\addMapping(), ilXmlImporter\getImport(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), ilXmlImporter\getSchemaVersion(), parseXmlFileNames(), and setSurvey().

     : void {
        if ($a_entity === "svy") {

            // container import
            if ($new_id = $a_mapping->getMapping('components/ILIAS/Container', 'objs', $a_id)) {
                $newObj = ilObjectFactory::getInstanceByObjId((int) $new_id, false);
            } else {
                $newObj = new ilObjSurvey();    // direct survey import
                $newObj->setType('svy');
                $newObj->setTitle("dummy");
                $newObj->create(true);
            }
            $a_mapping->addMapping('components/ILIAS/Survey', 'svy', $a_id, (string) $newObj->getId());
            $this->setSurvey($newObj);


            [$xml_file] = $this->parseXmlFileNames();

            if (!file_exists($xml_file)) {
                $GLOBALS['ilLog']->write(__METHOD__ . ': Cannot find xml definition: ' . $xml_file);
                return;
            }
            $GLOBALS['ilLog']->write("getQuestionPoolID = " . $this->getImport()->getConfig("components/ILIAS/Survey")->getQuestionPoolID());

            $import = new SurveyImportParser(
                $this->getImport()->getConfig("components/ILIAS/Survey")->getQuestionPoolID(),
                $xml_file,
                true,
                $a_mapping
            );

            $import->setSurveyObject($newObj);
            $import->startParsing();

            $a_mapping->addMapping("components/ILIAS/Survey", "svy", (int) $a_id, $newObj->getId());
            $a_mapping->addMapping(
                "components/ILIAS/MetaData",
                "md",
                $a_id . ":0:svy",
                $newObj->getId() . ":0:svy"
            );
        } else {
            $parser = new ilDataSetImportParser(
                $a_entity,
                $this->getSchemaVersion(),
                $a_xml,
                $this->ds,
                $a_mapping
            );
        }
    }

Here is the call graph for this function:

init()

ilSurveyImporter::init

(

)

Definition at line 45 of file class.ilSurveyImporter.php.

References ilLoggerFactory\getLogger().

                          : void
    {
        $this->ds = new ilSurveyDataSet();
        $this->ds->setDSPrefix("ds");
        $this->ds->setImport($this);

        $this->svy_log = ilLoggerFactory::getLogger("svy");
    }

Here is the call graph for this function:

parseXmlFileNames()

ilSurveyImporter::parseXmlFileNames ( )

protected

Create qti and xml file name.

Definition at line 137 of file class.ilSurveyImporter.php.

References $GLOBALS, and ilXmlImporter\getImportDirectory().

Referenced by importXmlRepresentation().

                                          : array
    {
        $GLOBALS['ilLog']->write(__METHOD__ . ': ' . $this->getImportDirectory());

        $basename = basename($this->getImportDirectory());
        $xml = $this->getImportDirectory() . '/' . $basename . '.xml';

        return array($xml);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSurvey()

ilSurveyImporter::setSurvey

(

ilObjSurvey

$a_val

)

Set current survey object (being imported).

This is done statically, since the survey import uses multiple input files being processed for every survey and all of these need the current survey object (ilSurveyImporter is intantiated multiple times)

Definition at line 60 of file class.ilSurveyImporter.php.

Referenced by importXmlRepresentation().

                                                 : void
    {
        self::$survey = $a_val;
    }

Here is the caller graph for this function:

Field Documentation

$ds

ilSurveyDataSet ilSurveyImporter::$ds

protected

Definition at line 25 of file class.ilSurveyImporter.php.

$log

ilLogger ilSurveyImporter::$log

protected

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

$spl_import_manager

ILIAS SurveyQuestionPool Export ImportManager ilSurveyImporter::$spl_import_manager

protected

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

$survey

ilObjSurvey ilSurveyImporter::$survey

staticprotected

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

$svy_log

ilLogger ilSurveyImporter::$svy_log

protected

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

---

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

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