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

Collaboration diagram for ilDataSet:

Public Member Functions
	__construct ()
	init (string $a_entity, string $a_schema_version)
	Init. More...
	getSupportedVersions ()
	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from DB. More...
	setExportDirectories (string $a_relative, string $a_absolute)
	setImportDirectory (string $a_val)
	getImportDirectory ()
	setDSPrefix (string $a_val)
	getDSPrefix ()
	getDSPrefixString ()
	getDirectDataFromQuery (string $a_query, bool $a_convert_to_leading_upper=true, bool $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...
	convertToLeadingUpper (string $a_str)
	Make xyz_abc a XyzAbc string. More...
	getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $a_omit_types=false)
	Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text" > <ftype name="field_2" type="date" > <ftype name="field_3" type="integer" > </types> <types ...> ... </types> <set entity="table_name"> <rec> <field_1>content</field_1> <field_2>my_date</field_2> <field_3>my_number</field_3> </rec> ... </set> </dataset> More...
	addRecordsXml (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="")
	afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)
	getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version)
	getXmlRecord (string $a_entity, string $a_version, array $a_set)
	Get xml record for version. More...
	getXmlTypes (string $a_entity, string $a_version)
	Get xml types. More...
	getXMLEntityName (string $a_entity, string $a_version)
	Get entity name for xml (may be overwritten) More...
	getXMLEntityTag (string $a_entity, string $a_schema_version)
	Get entity tag. More...
	setImport (ilSurveyImporter $a_val)
	getImport ()
	setCurrentInstallationId (string $a_val)
	getCurrentInstallationId ()
	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...

Data Fields
const	EXPORT_NO_INST_ID = 1
const	EXPORT_ID_ILIAS_LOCAL = 2
const	EXPORT_ID_ILIAS_LOCAL_INVALID = 3
const	EXPORT_ID_ILIAS_REMOTE = 4
const	EXPORT_ID_ILIAS_REMOTE_INVALID = 5
const	EXPORT_ID = 6
const	EXPORT_ID_INVALID = 7
int	$dircnt = 0

Protected Member Functions
	getTypes (string $a_entity, string $a_version)
	Get (abstract) types for (abstract) field names. More...
	getXmlNamespace (string $a_entity, string $a_schema_version)
	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
	createObjectExportId (string $a_type, string $a_id)
	Build ilias export id. More...
	parseObjectExportId (string $a_id, ?string $a_fallback_id=null)
	Parse export id. More...
	stripTags (array $rec, array $omit_keys=[])

Protected Attributes
string	$current_installation_id = ""
array	$data = []
ilDBInterface	$db
ilLogger	$ds_log
string	$import_directory = ""
string	$entity = ""
string	$schema_version = ""
string	$relative_export_dir = ""
string	$absolute_export_dir = ""
string	$ds_prefix = "ds"
string	$version = ""
ilSurveyImporter	$import

Private Member Functions
	addTypesXml (ilXmlWriter $a_writer, string $a_entity, string $a_schema_version)

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 A dataset contains in data in a common structure that can be shared and transformed for different purposes easily, examples

• transform associative arrays into (set-)xml and back (e.g. for import/export)
• transform assiciative arrays into json and back (e.g. for ajax requests)

The general structure is:

• entity name (many times this corresponds to a table name)
• structure (this is a set of field names and types pairs) currently supported types: text, integer, timestamp planned: date, time, clob types correspond to db types, see http://www.ilias.de/docu/goto.php?target=pg_25354_42&client_id=docu
• records (similar to records of a database query; associative arrays)

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilDataSet::__construct

(

)

Reimplemented in ilBibliographicDataSet, ilBlogDataSet, ilDataCollectionDataSet, ilGlossaryDataSet, ilIndividualAssessmentDataSetWrapper, ilLearningModuleDataSet, ilPollDataSet, ilPortfolioDataSet, ilScormAiccDataSet, ilSessionDataSet, ilWikiDataSet, ilMediaObjectDataSet, ilNotesDataSet, ilSkillDataSet, and ilStyleDataSet.

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->ds_log = ilLoggerFactory::getLogger('ds');
    }

References $DIC, and ilLoggerFactory\getLogger().

Here is the call graph for this function:

Member Function Documentation

addRecordsXml()

ilDataSet::addRecordsXml	(	ilXmlWriter	$a_writer,
		array	$a_prefixes,
		string	$a_entity,
		string	$a_schema_version,
		array	$a_ids,
		?string	$a_field = ""
	)

Definition at line 261 of file class.ilDataSet.php.

     : void {
        $types = $this->getXmlTypes($a_entity, $a_schema_version);
 
        $this->ds_log->debug("...read data");
        $this->readData($a_entity, $a_schema_version, $a_ids);
        $this->ds_log->debug("...data: " . print_r($this->data, true));
        foreach ($this->data as $d) {
            $a_writer->xmlStartTag(
                $this->getDSPrefixString() . "Rec",
                array("Entity" => $this->getXMLEntityName($a_entity, $a_schema_version))
            );
            $a_writer->xmlStartTag($this->getXMLEntityTag($a_entity, ''));
            $rec = $this->getXmlRecord($a_entity, $a_schema_version, $d);
            foreach ($rec as $f => $c) {
                if ((($types[$f] ?? "") == "directory") && $this->absolute_export_dir !== "" && $this->relative_export_dir !== "") {
                    ilFileUtils::makeDirParents($this->absolute_export_dir . "/dsDir_" . $this->dircnt);
                    $sdir = realpath($c);
                    $tdir = realpath($this->absolute_export_dir . "/dsDir_" . $this->dircnt);
                    try {
                        ilFileUtils::rCopy($sdir, $tdir);
                    } catch (\ILIAS\Filesystem\Exception\FileNotFoundException $e) {
                        $this->ds_log->error($e->getMessage());
                    }
                    $c = $this->relative_export_dir . "/dsDir_" . $this->dircnt;
                    $this->dircnt++;
                }
                // this changes schema/dtd
                //$a_writer->xmlElement($a_prefixes[$a_entity].":".$f,
                //      array(), $c);
                $a_writer->xmlElement($f, array(), $c);
            }
 
            $a_writer->xmlEndTag($this->getXMLEntityTag($a_entity, ''));
            $a_writer->xmlEndTag($this->getDSPrefixString() . "Rec");
 
            $this->afterXmlRecordWriting($a_entity, $a_schema_version, $d);
 
            // foreach record records of dependent entities
            $this->ds_log->debug("...get dependencies");
            $deps = $this->getDependencies($a_entity, $a_schema_version, $rec, $a_ids);
            $this->ds_log->debug("...dependencies: " . print_r($deps, true));
            foreach ($deps as $dp => $par) {
                $ids = !is_array($par["ids"])
                    ? [$par["ids"]]
                    : $par["ids"];
                $this->addRecordsXml($a_writer, $a_prefixes, $dp, $a_schema_version, $ids, $par["field"] ?? null);
            }
        }
    }

addTypesXml()

ilDataSet::addTypesXml ( ilXmlWriter  $a_writer, string  $a_entity, string  $a_schema_version  )

private

Definition at line 333 of file class.ilDataSet.php.

                                                                                                   : void
    {
        $types = $this->getXmlTypes($a_entity, $a_schema_version);
 
        // add types of current entity
        if (count($types) > 0) {
            $a_writer->xmlStartTag(
                $this->getDSPrefixString() . "Types",
                array("Entity" => $this->getXMLEntityName($a_entity, $a_schema_version),
                    "SchemaVersion" => $a_schema_version)
            );
            foreach ($this->getXmlTypes($a_entity, $a_schema_version) as $f => $t) {
                $a_writer->xmlElement(
                    $this->getDSPrefixString() . 'FieldType',
                    array("Name" => $f, "Type" => $t)
                );
            }
            $a_writer->xmlEndTag($this->getDSPrefixString() . "Types");
        }
 
        // add types of dependent entities
        $deps = $this->getDependencies($a_entity, $a_schema_version, null, null);
        foreach ($deps as $dp => $w) {
            $this->addTypesXml($a_writer, $dp, $a_schema_version);
        }
    }

References Vendor\Package\$f, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Here is the call graph for this function:

afterXmlRecordWriting()

ilDataSet::afterXmlRecordWriting	(	string	$a_entity,
		string	$a_version,
		array	$a_set
	)

Reimplemented in ilScorm2004DataSet, and ilUserDataSet.

Definition at line 328 of file class.ilDataSet.php.

                                                                                            : void
    {
    }

convertToLeadingUpper()

ilDataSet::convertToLeadingUpper

(

string

$a_str

)

Make xyz_abc a XyzAbc string.

Definition at line 179 of file class.ilDataSet.php.

                                                        : string
    {
        $a_str = strtoupper(substr($a_str, 0, 1)) . substr($a_str, 1);
        while (($pos = strpos($a_str, "_")) !== false) {
            $a_str = substr($a_str, 0, $pos) .
                strtoupper(substr($a_str, $pos + 1, 1)) .
                substr($a_str, $pos + 2);
        }
        return $a_str;
    }

Referenced by ilUserDataSet\importRecord().

Here is the caller graph for this function:

createObjectExportId()

ilDataSet::createObjectExportId ( string  $a_type, string  $a_id  )

protected

Build ilias export id.

Definition at line 432 of file class.ilDataSet.php.

                                                                         : string
    {
        return "il_" . IL_INST_ID . "_" . $a_type . "_" . $a_id;
    }

References IL_INST_ID.

getCurrentInstallationId()

ilDataSet::getCurrentInstallationId

(

)

Definition at line 424 of file class.ilDataSet.php.

                                              : string
    {
        return $this->current_installation_id;
    }

getDependencies()

ilDataSet::getDependencies ( string  $a_entity, string  $a_version, ?array  $a_rec = null, ?array  $a_ids = null  )

protected

Reimplemented in ilBibliographicDataSet, ilBlogDataSet, ilCmiXapiDataSet, ilDataCollectionDataSet, ilExerciseDataSet, ilGlossaryDataSet, ilIndividualAssessmentDataSet, ilItemGroupDataSet, ilLearningModuleDataSet, ilMediaCastDataSet, ilMediaPoolDataSet, ilPollDataSet, ilPortfolioDataSet, ilScormAiccDataSet, ilSessionDataSet, ilSurveyDataSet, ilWikiDataSet, ilCalendarDataSet, ilCOPageDataSet, ilMediaObjectDataSet, ilRatingDataSet, ilSkillDataSet, ilStyleDataSet, ilTaxonomyDataSet, and ilObjectDataSet.

Definition at line 318 of file class.ilDataSet.php.

     : array {
        return [];
    }

getDirectDataFromQuery()

ilDataSet::getDirectDataFromQuery	(	string	$a_query,
		bool	$a_convert_to_leading_upper = true,
		bool	$a_set = true
	)

Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields.

Definition at line 148 of file class.ilDataSet.php.

     : array {
        $ilDB = $this->db;
 
        $set = $ilDB->query($a_query);
        $this->data = array();
        $ret = [];
        while ($rec = $ilDB->fetchAssoc($set)) {
            if ($a_convert_to_leading_upper) {
                $tmp = array();
                foreach ($rec as $k => $v) {
                    $tmp[$this->convertToLeadingUpper($k)]
                        = $v;
                }
                $rec = $tmp;
            }
 
            if ($a_set) {
                $this->data[] = $rec;
            }
            $ret[] = $rec;
        }
        return $ret;
    }

Referenced by ilExerciseDataSet\readData(), ilGlossaryDataSet\readData(), ilHTMLLearningModuleDataSet\readData(), ilItemGroupDataSet\readData(), ilMediaCastDataSet\readData(), ilPollDataSet\readData(), ilPortfolioDataSet\readData(), ilSessionDataSet\readData(), ilSurveyDataSet\readData(), ilWikiDataSet\readData(), ilCalendarDataSet\readData(), ilCOPageDataSet\readData(), ilHelpDataSet\readData(), ilNewsDataSet\readData(), ilRatingDataSet\readData(), ilSkillDataSet\readData(), ilStyleDataSet\readData(), ilTaxonomyDataSet\readData(), and ilUserDataSet\readData().

Here is the caller graph for this function:

getDSPrefix()

ilDataSet::getDSPrefix

(

)

Definition at line 131 of file class.ilDataSet.php.

                                 : string
    {
        return $this->ds_prefix;
    }

References $ds_prefix.

Referenced by getDSPrefixString().

Here is the caller graph for this function:

getDSPrefixString()

ilDataSet::getDSPrefixString

(

)

Definition at line 136 of file class.ilDataSet.php.

                                       : string
    {
        if ($this->getDSPrefix() !== "") {
            return $this->getDSPrefix() . ":";
        }
        return "";
    }

References getDSPrefix().

Here is the call graph for this function:

getImport()

ilDataSet::getImport

(

)

Definition at line 414 of file class.ilDataSet.php.

                               : ilSurveyImporter
    {
        return $this->import;
    }

getImportDirectory()

ilDataSet::getImportDirectory

(

)

Definition at line 121 of file class.ilDataSet.php.

                                        : string
    {
        return $this->import_directory;
    }

References $import_directory.

Referenced by ilUserDataSet\importRecord().

Here is the caller graph for this function:

getNamespaces()

ilDataSet::getNamespaces	(	array &	$namespaces,
		string	$a_entity,
		string	$a_schema_version
	)

Definition at line 361 of file class.ilDataSet.php.

                                                                                                 : void
    {
        $ns = $this->getXmlNamespace($a_entity, $a_schema_version);
        if ($ns !== "") {
            $namespaces[$a_entity] = $ns;
        }
        // add types of dependent entities
        $deps = $this->getDependencies($a_entity, $a_schema_version, null, null);
        foreach ($deps as $dp => $w) {
            $this->getNamespaces($namespaces, $dp, $a_schema_version);
        }
    }

getSupportedVersions()

ilDataSet::getSupportedVersions ( )

abstract

Reimplemented in ilBibliographicDataSet, ilBlogDataSet, ilCmiXapiDataSet, ilContentPageDataSet, ilDataCollectionDataSet, ilExerciseDataSet, ilGlossaryDataSet, ilHTMLLearningModuleDataSet, ilIndividualAssessmentDataSet, ilItemGroupDataSet, ilLearningModuleDataSet, ilMediaCastDataSet, ilMediaPoolDataSet, ilPollDataSet, ilPortfolioDataSet, ilScorm2004DataSet, ilScormAiccDataSet, ilSessionDataSet, ilSurveyDataSet, ilWikiDataSet, ilCalendarDataSet, ilCOPageDataSet, ilHelpDataSet, ilMediaObjectDataSet, ilNewsDataSet, ilNotesDataSet, ilObjectDataSet, ilRatingDataSet, ilSkillDataSet, ilStyleDataSet, ilTaxonomyDataSet, and ilUserDataSet.

getTypes()

ilDataSet::getTypes ( string  $a_entity, string  $a_version  )

abstractprotected

Get (abstract) types for (abstract) field names.

Please note that the abstract fields/types only depend on the version! Not on a choosen representation!

Returns

array types array, e.g. array("field_1" => "text", "field_2" => "integer", ...)

Reimplemented in ilBibliographicDataSet, ilBlogDataSet, ilCmiXapiDataSet, ilContentPageDataSet, ilDataCollectionDataSet, ilExerciseDataSet, ilGlossaryDataSet, ilHTMLLearningModuleDataSet, ilIndividualAssessmentDataSet, ilItemGroupDataSet, ilLearningModuleDataSet, ilMediaCastDataSet, ilMediaPoolDataSet, ilPollDataSet, ilPortfolioDataSet, ilScorm2004DataSet, ilScormAiccDataSet, ilSessionDataSet, ilSurveyDataSet, ilWikiDataSet, ilCalendarDataSet, ilCOPageDataSet, ilHelpDataSet, ilMediaObjectDataSet, ilNewsDataSet, ilNotesDataSet, ilRatingDataSet, ilSkillDataSet, ilStyleDataSet, ilTaxonomyDataSet, ilUserDataSet, and ilObjectDataSet.

getXMLEntityName()

ilDataSet::getXMLEntityName	(	string	$a_entity,
		string	$a_version
	)

Get entity name for xml (may be overwritten)

Definition at line 396 of file class.ilDataSet.php.

                                                                         : string
    {
        return $a_entity;
    }

getXMLEntityTag()

ilDataSet::getXMLEntityTag	(	string	$a_entity,
		string	$a_schema_version
	)

Get entity tag.

Definition at line 404 of file class.ilDataSet.php.

                                                                               : string
    {
        return $this->convertToLeadingUpper($a_entity);
    }

getXmlNamespace()

ilDataSet::getXmlNamespace ( string  $a_entity, string  $a_schema_version  )

abstractprotected

Reimplemented in ilBibliographicDataSet, ilBlogDataSet, ilCmiXapiDataSet, ilContentPageDataSet, ilDataCollectionDataSet, ilExerciseDataSet, ilGlossaryDataSet, ilHTMLLearningModuleDataSet, ilIndividualAssessmentDataSet, ilItemGroupDataSet, ilLearningModuleDataSet, ilMediaCastDataSet, ilMediaPoolDataSet, ilPollDataSet, ilPortfolioDataSet, ilScorm2004DataSet, ilScormAiccDataSet, ilSessionDataSet, ilSurveyDataSet, ilWikiDataSet, ilCalendarDataSet, ilCOPageDataSet, ilHelpDataSet, ilMediaObjectDataSet, ilNewsDataSet, ilNotesDataSet, ilRatingDataSet, ilSkillDataSet, ilStyleDataSet, ilTaxonomyDataSet, ilUserDataSet, and ilObjectDataSet.

getXmlRecord()

ilDataSet::getXmlRecord	(	string	$a_entity,
		string	$a_version,
		array	$a_set
	)

Get xml record for version.

Parameters

array

$a_set

abstract data record

Reimplemented in ilBlogDataSet, ilExerciseDataSet, ilHTMLLearningModuleDataSet, ilItemGroupDataSet, ilPollDataSet, ilPortfolioDataSet, ilSessionDataSet, ilMediaObjectDataSet, ilStyleDataSet, and ilUserDataSet.

Definition at line 378 of file class.ilDataSet.php.

                                                                                   : array
    {
        return $a_set;
    }

getXmlRepresentation()

ilDataSet::getXmlRepresentation ( string  $a_entity, string  $a_schema_version, ?array  $a_ids, string  $a_field = "", bool  $a_omit_header = false, bool  $a_omit_types = false  )

final

Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text" > <ftype name="field_2" type="date" > <ftype name="field_3" type="integer" > </types> <types ...> ... </types> <set entity="table_name"> <rec> <field_1>content</field_1> <field_2>my_date</field_2> <field_3>my_number</field_3> </rec> ... </set> </dataset>

Definition at line 212 of file class.ilDataSet.php.

     : string {
        $this->dircnt = 1;
 
        // init writer
        $writer = new ilXmlWriter();
        if (!$a_omit_header) {
            $writer->xmlHeader();
        }
 
        // collect namespaces
        $namespaces = $prefixes = array();
        $this->getNamespaces($namespaces, $a_entity, $a_schema_version);
        $atts = array("InstallationId" => IL_INST_ID,
            "InstallationUrl" => ILIAS_HTTP_PATH, "TopEntity" => $a_entity);
        $cnt = 1;
        foreach ($namespaces as $entity => $ns) {
            $prefix = "ns" . $cnt;
            $prefixes[$entity] = $prefix;
            //                  $atts["xmlns:".$prefix] = $ns;
            $cnt++;
        }
 
        $this->ds_log->debug("Start writing Dataset, entity: " . $a_entity . ", schema version: " . $a_schema_version .
            ", ids: " . print_r($a_ids, true));
        $writer->xmlStartTag($this->getDSPrefixString() . 'DataSet', $atts);
 
        // add types
        if (!$a_omit_types) {
            $this->ds_log->debug("...write types");
            $this->addTypesXml($writer, $a_entity, $a_schema_version);
        }
 
        // add records
        $this->ds_log->debug("...write records");
        $this->addRecordsXml($writer, $prefixes, $a_entity, $a_schema_version, $a_ids, $a_field);
 
        $writer->xmlEndTag($this->getDSPrefixString() . "DataSet");
 
        return $writer->xmlDumpMem(false);
    }

getXmlTypes()

ilDataSet::getXmlTypes	(	string	$a_entity,
		string	$a_version
	)

Get xml types.

Returns

array types array for xml/version set in constructor

Definition at line 387 of file class.ilDataSet.php.

                                                                    : array
    {
        return $this->getTypes($a_entity, $a_version);
    }

importRecord()

ilDataSet::importRecord	(	string	$a_entity,
		array	$a_types,
		array	$a_rec,
		ilImportMapping	$a_mapping,
		string	$a_schema_version
	)

Needs to be overwritten for import use case.

Reimplemented in ilBlogDataSet, ilCmiXapiDataSet, ilContentPageDataSet, ilExerciseDataSet, ilGlossaryDataSet, ilIndividualAssessmentDataSet, ilLearningModuleDataSet, ilMediaCastDataSet, ilMediaPoolDataSet, ilPortfolioDataSet, ilSessionDataSet, ilSurveyDataSet, ilWikiDataSet, ilCalendarDataSet, ilCOPageDataSet, ilHelpDataSet, ilMediaObjectDataSet, ilNewsDataSet, ilNotesDataSet, ilRatingDataSet, ilSkillDataSet, ilStyleDataSet, ilTaxonomyDataSet, and ilUserDataSet.

Definition at line 495 of file class.ilDataSet.php.

     : void {
    }

init()

ilDataSet::init ( string  $a_entity, string  $a_schema_version  )

final

Init.

Parameters

string	(abstract) entity name
string	version string, always the ILIAS release versions that defined the a structure or made changes to it, never use another version. Example: structure is defined in 4.1.0 and changed in 4.3.0 -> use these values only, not 4.2.0 (ask for the 4.1.0 version in ILIAS 4.2.0)

Definition at line 80 of file class.ilDataSet.php.

                                                                          : void
    {
        $this->entity = $a_entity;
        $this->schema_version = $a_schema_version;
        $this->data = array();
    }

parseObjectExportId()

ilDataSet::parseObjectExportId ( string  $a_id, ?string  $a_fallback_id = null  )

protected

Parse export id.

Returns

array type, id

Definition at line 441 of file class.ilDataSet.php.

                                                                                       : array
    {
        // ilias export id?
        if (strpos($a_id, "il_") === 0) {
            $parts = explode("_", $a_id);
            if (count($parts) !== 4) {
                throw new ilException("Invalid import ID '" . $a_id . "'.");
            }
            $inst_id = $parts[1];
            $type = $parts[2];
            $id = $parts[3];
 
            // missing installation ids?
            if (($inst_id == 0 || IL_INST_ID === "0") && !DEVMODE) {
                return array("type" => self::EXPORT_NO_INST_ID, "id" => $a_fallback_id);
            }
 
            // same installation?
            if ($inst_id == IL_INST_ID) {
                // still existing?
                if (ilObject::_lookupType($id) === $type) {
                    return array("type" => self::EXPORT_ID_ILIAS_LOCAL, "id" => $id);
                }
                // not found
                else {
                    return array("type" => self::EXPORT_ID_ILIAS_LOCAL_INVALID, "id" => $a_fallback_id);
                }
            }
            // different installation
            else {
                $id = ilObject::_getIdForImportId($a_id);
                // matching type?
                if ($id && ilObject::_lookupType($id) === $type) {
                    return array("type" => self::EXPORT_ID_ILIAS_REMOTE, "id" => $id);
                }
                // not found
                else {
                    return array("type" => self::EXPORT_ID_ILIAS_REMOTE_INVALID, "id" => $a_fallback_id);
                }
            }
        } else {
            // external id
            $id = ilObject::_getIdForImportId($a_id);
            if ($id) {
                return array("type" => self::EXPORT_ID, "id" => $id);
            } else {
                return array("type" => self::EXPORT_ID_INVALID, "id" => $a_fallback_id);
            }
        }
    }

References $id, $parts, $type, ilObject\_getIdForImportId(), ilObject\_lookupType(), and IL_INST_ID.

Here is the call graph for this function:

readData()

ilDataSet::readData ( string  $a_entity, string  $a_version, array  $a_ids  )

abstract

Read data from DB.

This should result in the abstract field structure of the version set in the constructor.

Reimplemented in ilBibliographicDataSet, ilBlogDataSet, ilContentPageDataSet, ilDataCollectionDataSet, ilExerciseDataSet, ilGlossaryDataSet, ilHTMLLearningModuleDataSet, ilIndividualAssessmentDataSet, ilItemGroupDataSet, ilLearningModuleDataSet, ilMediaCastDataSet, ilMediaPoolDataSet, ilPollDataSet, ilPortfolioDataSet, ilScorm2004DataSet, ilSessionDataSet, ilSurveyDataSet, ilWikiDataSet, ilCalendarDataSet, ilCOPageDataSet, ilHelpDataSet, ilMediaObjectDataSet, ilNewsDataSet, ilNotesDataSet, ilRatingDataSet, ilSkillDataSet, ilStyleDataSet, ilTaxonomyDataSet, and ilUserDataSet.

setCurrentInstallationId()

ilDataSet::setCurrentInstallationId

(

string

$a_val

)

Definition at line 419 of file class.ilDataSet.php.

                                                           : void
    {
        $this->current_installation_id = $a_val;
    }

setDSPrefix()

ilDataSet::setDSPrefix

(

string

$a_val

)

Definition at line 126 of file class.ilDataSet.php.

                                              : void
    {
        $this->ds_prefix = $a_val;
    }

setExportDirectories()

ilDataSet::setExportDirectories	(	string	$a_relative,
		string	$a_absolute
	)

Definition at line 110 of file class.ilDataSet.php.

                                                                                : void
    {
        $this->relative_export_dir = $a_relative;
        $this->absolute_export_dir = $a_absolute;
    }

setImport()

ilDataSet::setImport

(

ilSurveyImporter

$a_val

)

Definition at line 409 of file class.ilDataSet.php.

                                                      : void
    {
        $this->import = $a_val;
    }

setImportDirectory()

ilDataSet::setImportDirectory

(

string

$a_val

)

Definition at line 116 of file class.ilDataSet.php.

                                                     : void
    {
        $this->import_directory = $a_val;
    }

stripTags()

ilDataSet::stripTags ( array  $rec, array  $omit_keys = []  )

protected

Definition at line 504 of file class.ilDataSet.php.

                                                                   : array
    {
        $ret_rec = [];
        foreach ($rec as $k => $v) {
            if (in_array($k, $omit_keys, true)) {
                $ret_rec[$k] = $v;
            } else {
                $ret_rec[$k] = ilUtil::stripSlashes($v);
            }
        }
        return $ret_rec;
    }

References ilUtil\stripSlashes().

Referenced by ilNewsDataSet\importRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$absolute_export_dir

string ilDataSet::$absolute_export_dir = ""

protected

Definition at line 55 of file class.ilDataSet.php.

$current_installation_id

string ilDataSet::$current_installation_id = ""

protected

Definition at line 47 of file class.ilDataSet.php.

$data

array ilDataSet::$data = []

protected

Definition at line 48 of file class.ilDataSet.php.

$db

ilDBInterface ilDataSet::$db

protected

Definition at line 49 of file class.ilDataSet.php.

Referenced by ilExerciseDataSet\readData(), ilGlossaryDataSet\readData(), ilHTMLLearningModuleDataSet\readData(), ilItemGroupDataSet\readData(), ilPollDataSet\readData(), ilPortfolioDataSet\readData(), ilScorm2004DataSet\readData(), ilSessionDataSet\readData(), ilSurveyDataSet\readData(), ilWikiDataSet\readData(), ilCOPageDataSet\readData(), ilHelpDataSet\readData(), ilNewsDataSet\readData(), ilRatingDataSet\readData(), ilSkillDataSet\readData(), ilStyleDataSet\readData(), and ilTaxonomyDataSet\readData().

$dircnt

int ilDataSet::$dircnt = 0

Definition at line 46 of file class.ilDataSet.php.

$ds_log

ilLogger ilDataSet::$ds_log

protected

Definition at line 50 of file class.ilDataSet.php.

$ds_prefix

string ilDataSet::$ds_prefix = "ds"

protected

Definition at line 56 of file class.ilDataSet.php.

Referenced by getDSPrefix().

$entity

string ilDataSet::$entity = ""

protected

Definition at line 52 of file class.ilDataSet.php.

Referenced by ilObjectDataSet\getTypes(), and ilObjectDataSet\getXmlNamespace().

$import

ilSurveyImporter ilDataSet::$import

protected

Definition at line 58 of file class.ilDataSet.php.

$import_directory

string ilDataSet::$import_directory = ""

protected

Definition at line 51 of file class.ilDataSet.php.

Referenced by getImportDirectory().

$relative_export_dir

string ilDataSet::$relative_export_dir = ""

protected

Definition at line 54 of file class.ilDataSet.php.

$schema_version

string ilDataSet::$schema_version = ""

protected

Definition at line 53 of file class.ilDataSet.php.

$version

string ilDataSet::$version = ""

protected

Definition at line 57 of file class.ilDataSet.php.

Referenced by ilObjectDataSet\getTypes(), and ilIndividualAssessmentDataSetWrapper\getTypesWrapper().

EXPORT_ID

const ilDataSet::EXPORT_ID = 6

Definition at line 43 of file class.ilDataSet.php.

EXPORT_ID_ILIAS_LOCAL

const ilDataSet::EXPORT_ID_ILIAS_LOCAL = 2

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

EXPORT_ID_ILIAS_LOCAL_INVALID

const ilDataSet::EXPORT_ID_ILIAS_LOCAL_INVALID = 3

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

EXPORT_ID_ILIAS_REMOTE

const ilDataSet::EXPORT_ID_ILIAS_REMOTE = 4

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

EXPORT_ID_ILIAS_REMOTE_INVALID

const ilDataSet::EXPORT_ID_ILIAS_REMOTE_INVALID = 5

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

EXPORT_ID_INVALID

const ilDataSet::EXPORT_ID_INVALID = 7

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

EXPORT_NO_INST_ID

const ilDataSet::EXPORT_NO_INST_ID = 1

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

---

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

• Services/DataSet/classes/class.ilDataSet.php