ilDataSet Class Reference

A dataset contains in data in a common structure that can be shared and transformed for different purposes easily, examples. 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...
	initByExporter (ilXmlExporter $xml_exporter)
	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 ...> ... 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...
	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)
	getContainerExportConfig (array $record, string $entity, string $schema_version, string $field, string $value)

Data Fields
const	DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3'
const	DATASET_NS_PREFIX = 'ds'
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)
	getExportDirInContainer (string $exp_dir)
	getIRSSContainerExportConfig (StorableResource $source_container, string $source_path, string $target_path="")
	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
ILIAS ResourceStorage Services	$irss
string	$current_installation_id = ""
array	$data = []
ilDBInterface	$db
ilLogger	$ds_log
string	$import_directory = ""
string	$entity = ""
string	$schema_version = ""
string	$component_export_dir = ""
string	$ds_prefix = "ds"
string	$version = ""
ilSurveyImporter	$import
ilExport	$export

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

Detailed Description

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 42 of file class.ilDataSet.php.

Constructor & Destructor Documentation

__construct()

ilDataSet::__construct

(

)

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

References $DIC, and ilLoggerFactory\getLogger().

    {
        global $DIC;

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

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 287 of file class.ilDataSet.php.

References $c, Vendor\Package\$d, $dircnt, Vendor\Package\$f, afterXmlRecordWriting(), getCollection(), getContainerExportConfig(), getDependencies(), getDSPrefixString(), getExportDirInContainer(), getIRSSContainerExportConfig(), getXMLEntityName(), getXMLEntityTag(), getXmlRecord(), getXmlTypes(), null, readData(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getXmlRepresentation().

     : 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 (isset($this->export) and ($types[$f] ?? "") === "directory") {
                    $sdir = realpath($c);
                    $path_in_container = $this->export->getPathToComponentExpDirInContainer() . "/dsDir_" . $this->dircnt;
                    $this->export->getExportWriter()->writeDirectory(
                        $sdir,
                        $path_in_container
                    );
                    $c = $this->getExportDirInContainer($path_in_container);  // note: this corrects the path, see above
                    $this->dircnt++;
                }
                if (isset($this->export) and ($types[$f] ?? "") === "rscollection") {
                    $path_in_container = $this->export->getPathToComponentExpDirInContainer() . "/dsDir_" . $this->dircnt;
                    $collection = $this->getCollection($rec, $a_entity, $a_schema_version, $f, $c);
                    if (!is_null($collection)) {
                        $this->export->getExportWriter()->writeFilesByResourceCollection(
                            $collection,
                            $path_in_container
                        );
                    }

                    $c = $this->getExportDirInContainer($path_in_container);  // note: this corrects the path, see above
                    $this->dircnt++;
                }
                if (isset($this->export) and ($types[$f] ?? "") === "rscontainer") {
                    $path_in_container = $this->export->getPathToComponentExpDirInContainer() . "/dsDir_" . $this->dircnt;
                    if ($config = $this->getContainerExportConfig($rec, $a_entity, $a_schema_version, $f, $c)) {
                        $this->export->getExportWriter()->writeFilesByResourceContainer(
                            $this->getIRSSContainerExportConfig(
                                $config->getSourceContainer(),
                                $config->getSourcePath(),
                                $path_in_container
                            )
                        );
                    }
                    $c = $this->getExportDirInContainer($path_in_container);  // note: this corrects the path, see above
                    $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);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addTypesXml()

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

private

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

References Vendor\Package\$f, getDependencies(), getDSPrefixString(), getXMLEntityName(), getXmlTypes(), null, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getXmlRepresentation().

                                                                                                   : 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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

afterXmlRecordWriting()

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

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

Referenced by addRecordsXml().

                                                                                            : void
    {
    }

Here is the caller graph for this function:

convertToLeadingUpper()

ilDataSet::convertToLeadingUpper

(

string

$a_str

)

Make xyz_abc a XyzAbc string.

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

Referenced by getDirectDataFromQuery(), getXMLEntityTag(), ilUserDataSet\importRecord(), ilMediaPoolDataSet\readData(), and ilLearningModuleDataSet\readData().

                                                        : 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;
    }

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 495 of file class.ilDataSet.php.

References IL_INST_ID.

Referenced by ilBlogDataSet\readData().

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

Here is the caller graph for this function:

getCollection()

ilDataSet::getCollection	(	array	$record,
		string	$entity,
		string	$schema_version,
		string	$field,
		string	$value
	)

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

References null.

Referenced by addRecordsXml().

     : ?ResourceCollection {
        return null;
    }

Here is the caller graph for this function:

getContainerExportConfig()

ilDataSet::getContainerExportConfig	(	array	$record,
		string	$entity,
		string	$schema_version,
		string	$field,
		string	$value
	)

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

References null.

Referenced by addRecordsXml().

     : ?IRSSContainerExportConfig {
        return null;
    }

Here is the caller graph for this function:

getCurrentInstallationId()

ilDataSet::getCurrentInstallationId

(

)

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

References $current_installation_id.

Referenced by ilSurveyDataSet\importRecord(), ilGlossaryDataSet\importRecord(), ilMediaObjectDataSet\importRecord(), ilLearningModuleDataSet\importRecord(), and ilSkillDataSet\importRecord().

                                              : string
    {
        return $this->current_installation_id;
    }

Here is the caller graph for this function:

getDependencies()

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

protected

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

Referenced by addRecordsXml(), addTypesXml(), and getNamespaces().

     : array {
        return [];
    }

Here is the caller graph for this function:

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 158 of file class.ilDataSet.php.

References $db, $ilDB, and convertToLeadingUpper().

Referenced by ilObjectDataSet\getTypes(), ilCmiXapiDataSet\getTypes(), ilHTMLLearningModuleDataSet\readData(), ilRatingDataSet\readData(), ilItemGroupDataSet\readData(), ilCOPageDataSet\readData(), ilSurveyDataSet\readData(), ilNewsDataSet\readData(), ilNotesDataSet\readData(), ilMediaCastDataSet\readData(), ilHelpDataSet\readData(), ilPortfolioDataSet\readData(), ilTaxonomyDataSet\readData(), ilCalendarDataSet\readData(), ilGlossaryDataSet\readData(), ilMediaPoolDataSet\readData(), ilPollDataSet\readData(), ilUserDataSet\readData(), ilMediaObjectDataSet\readData(), ilSessionDataSet\readData(), ilWikiDataSet\readData(), ilBlogDataSet\readData(), ilSkillDataSet\readData(), ilStyleDataSet\readData(), ilLearningModuleDataSet\readData(), and ilExerciseDataSet\readData().

     : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDSPrefix()

ilDataSet::getDSPrefix

(

)

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

References $ds_prefix.

Referenced by getDSPrefixString(), and getXmlRepresentation().

                                 : string
    {
        return $this->ds_prefix;
    }

Here is the caller graph for this function:

getDSPrefixString()

ilDataSet::getDSPrefixString

(

)

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

References getDSPrefix().

Referenced by addRecordsXml(), addTypesXml(), and getXmlRepresentation().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getExportDirInContainer()

ilDataSet::getExportDirInContainer ( string  $exp_dir )

protected

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

Referenced by addRecordsXml().

                                                               : string
    {
        // note, the export returns in ILIAS 10 (Jan 2024) something like
        // 1737382047__0__cat_436/components/ILIAS/Style/set_0/dsDir_1
        // whereas ILIAS 9 returned
        // Services/Style/set_1/expDir_1/dsDir_1
        // thus we skip the 1737382047__0__cat_436/ part since it would be redundant
        // an make import fail
        if (str_contains($exp_dir, "components/")) {
            $exp_dir = substr($exp_dir, strpos($exp_dir, "components/"));
        }
        return $exp_dir;
    }

Here is the caller graph for this function:

getImport()

ilDataSet::getImport

(

)

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

References $import.

Referenced by ilSurveyDataSet\importRecord().

                               : ilSurveyImporter
    {
        return $this->import;
    }

Here is the caller graph for this function:

getImportDirectory()

ilDataSet::getImportDirectory

(

)

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

References $import_directory.

Referenced by ilObjectDataSet\getDependencies(), ilHTMLLearningModuleDataSet\getXmlRecord(), ilPollDataSet\getXmlRecord(), ilBibliographicDataSet\importLibraryFile(), ilUserDataSet\importRecord(), ilMediaObjectDataSet\importRecord(), ilStyleDataSet\importRecord(), and ilExerciseDataSet\importRecord().

                                        : string
    {
        return $this->import_directory;
    }

Here is the caller graph for this function:

getIRSSContainerExportConfig()

ilDataSet::getIRSSContainerExportConfig ( StorableResource  $source_container, string  $source_path, string  $target_path = ""  )

protected

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

Referenced by addRecordsXml(), ilMediaObjectDataSet\getContainerExportConfig(), and ilStyleDataSet\getContainerExportConfig().

     : IRSSContainerExportConfig {
        return new IRSSContainerExportConfig(
            $source_container,
            $source_path,
            $target_path
        );
    }

Here is the caller graph for this function:

getNamespaces()

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

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

References getDependencies(), getXmlNamespace(), and null.

Referenced by getXmlRepresentation().

                                                                                                 : 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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSupportedVersions()

ilDataSet::getSupportedVersions ( )

abstract

Referenced by init().

Here is the caller graph for this function:

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", ...)

Referenced by getXmlTypes(), and init().

Here is the caller graph for this function:

getXMLEntityName()

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

Get entity name for xml (may be overwritten)

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

Referenced by addRecordsXml(), and addTypesXml().

                                                                         : string
    {
        return $a_entity;
    }

Here is the caller graph for this function:

getXMLEntityTag()

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

Get entity tag.

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

References convertToLeadingUpper().

Referenced by addRecordsXml().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getXmlNamespace()

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

abstractprotected

Referenced by getNamespaces(), and init().

Here is the caller graph for this function:

getXmlRecord()

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

Get xml record for version.

Parameters

array

$a_set

abstract data record

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

Referenced by addRecordsXml().

                                                                                   : array
    {
        return $a_set;
    }

Here is the caller graph for this function:

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 222 of file class.ilDataSet.php.

References $entity, addRecordsXml(), addTypesXml(), getDSPrefix(), getDSPrefixString(), getNamespaces(), and IL_INST_ID.

     : 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));

        if ($this->getDSPrefix() !== '') {
            $atts['xmlns:' . $this->getDSPrefix()] = self::DATASET_NS;
        } else {
            $atts['xmlns'] = self::DATASET_NS;
        }
        $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);
    }

Here is the call graph for this function:

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 450 of file class.ilDataSet.php.

References getTypes().

Referenced by addRecordsXml(), and addTypesXml().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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.

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

Referenced by ilItemGroupDataSet\getDependencies(), ilObjectDataSet\getDependencies(), ilBibliographicDataSet\getXmlNamespace(), ilDataCollectionDataSet\getXmlNamespace(), ilHTMLLearningModuleDataSet\getXmlRecord(), and ilPollDataSet\getXmlRecord().

     : void {
    }

Here is the caller graph for this function:

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 91 of file class.ilDataSet.php.

References getSupportedVersions(), getTypes(), getXmlNamespace(), and readData().

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

Here is the call graph for this function:

initByExporter()

ilDataSet::initByExporter

(

ilXmlExporter

$xml_exporter

)

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

References ilXmlExporter\getExport().

                                                               : void
    {
        $this->export = $xml_exporter->getExport();
    }

Here is the call graph for this function:

parseObjectExportId()

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

protected

Parse export id.

Returns

array type, id

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

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

Referenced by ilBlogDataSet\importRecord().

                                                                                       : 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);
            }
        }
    }

Here is the call graph for this function:

Here is the caller 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.

Referenced by addRecordsXml(), ilCmiXapiDataSet\getDependencies(), ilObjectDataSet\getTypes(), ilCmiXapiDataSet\getTypes(), and init().

Here is the caller graph for this function:

setCurrentInstallationId()

ilDataSet::setCurrentInstallationId

(

string

$a_val

)

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

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

setDSPrefix()

ilDataSet::setDSPrefix

(

string

$a_val

)

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

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

setImport()

ilDataSet::setImport

(

ilSurveyImporter

$a_val

)

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

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

setImportDirectory()

ilDataSet::setImportDirectory

(

string

$a_val

)

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

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

stripTags()

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

protected

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

References ilUtil\stripSlashes().

Referenced by ilItemGroupDataSet\getDependencies(), ilHTMLLearningModuleDataSet\getXmlRecord(), ilPollDataSet\getXmlRecord(), ilRatingDataSet\importRecord(), ilNotesDataSet\importRecord(), ilCOPageDataSet\importRecord(), ilNewsDataSet\importRecord(), ilSurveyDataSet\importRecord(), ilHelpDataSet\importRecord(), ilPortfolioDataSet\importRecord(), ilMediaCastDataSet\importRecord(), ilTaxonomyDataSet\importRecord(), ilMediaPoolDataSet\importRecord(), ilGlossaryDataSet\importRecord(), ilBlogDataSet\importRecord(), ilWikiDataSet\importRecord(), ilMediaObjectDataSet\importRecord(), ilStyleDataSet\importRecord(), ilLearningModuleDataSet\importRecord(), and ilExerciseDataSet\importRecord().

                                                                   : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$component_export_dir

string ilDataSet::$component_export_dir = ""

protected

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

$current_installation_id

string ilDataSet::$current_installation_id = ""

protected

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

Referenced by getCurrentInstallationId().

$data

array ilDataSet::$data = []

protected

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

Referenced by ilIndividualAssessmentDataSet\_readData(), ilBibliographicDataSet\_readData(), ilDataCollectionDataSet\_readData(), ilDataCollectionDataSet\buildCache(), ilCmiXapiDataSet\getTypes(), and ilBlogDataSet\importRecord().

$db

ilDBInterface ilDataSet::$db

protected

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

Referenced by ilSurveyDataSet\getDependencies(), ilSkillDataSet\getDependencies(), getDirectDataFromQuery(), ilHTMLLearningModuleDataSet\readData(), ilRatingDataSet\readData(), ilScorm2004DataSet\readData(), ilItemGroupDataSet\readData(), ilCOPageDataSet\readData(), ilSurveyDataSet\readData(), ilNewsDataSet\readData(), ilNotesDataSet\readData(), ilMediaCastDataSet\readData(), ilHelpDataSet\readData(), ilPortfolioDataSet\readData(), ilTaxonomyDataSet\readData(), ilGlossaryDataSet\readData(), ilMediaPoolDataSet\readData(), ilPollDataSet\readData(), ilMediaObjectDataSet\readData(), ilWikiDataSet\readData(), ilBlogDataSet\readData(), ilSessionDataSet\readData(), ilSkillDataSet\readData(), ilStyleDataSet\readData(), ilLearningModuleDataSet\readData(), and ilExerciseDataSet\readData().

$dircnt

int ilDataSet::$dircnt = 0

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

Referenced by addRecordsXml().

$ds_log

ilLogger ilDataSet::$ds_log

protected

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

$ds_prefix

string ilDataSet::$ds_prefix = "ds"

protected

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

Referenced by getDSPrefix().

$entity

string ilDataSet::$entity = ""

protected

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

Referenced by ilObjectDataSet\getTypes(), ilObjectDataSet\getXmlNamespace(), getXmlRepresentation(), and ilContentPageDataSet\readData().

$export

ilExport ilDataSet::$export

protected

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

$import

ilSurveyImporter ilDataSet::$import

protected

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

Referenced by getImport().

$import_directory

string ilDataSet::$import_directory = ""

protected

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

Referenced by getImportDirectory().

$irss

ILIAS ResourceStorage Services ilDataSet::$irss

protected

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

$schema_version

string ilDataSet::$schema_version = ""

protected

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

Referenced by ilObjectDataSet\getDependencies().

$version

string ilDataSet::$version = ""

protected

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

Referenced by ilObjectDataSet\getTypes().

DATASET_NS

const ilDataSet::DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3'

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

Referenced by ILIAS\Export\ImportHandler\File\XML\Export\Handler\hasComponentRootNode().

DATASET_NS_PREFIX

const ilDataSet::DATASET_NS_PREFIX = 'ds'

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

Referenced by ILIAS\Export\ImportHandler\File\XML\Export\Handler\hasComponentRootNode().

EXPORT_ID

const ilDataSet::EXPORT_ID = 6

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

EXPORT_ID_ILIAS_LOCAL

const ilDataSet::EXPORT_ID_ILIAS_LOCAL = 2

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

EXPORT_ID_ILIAS_LOCAL_INVALID

const ilDataSet::EXPORT_ID_ILIAS_LOCAL_INVALID = 3

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

EXPORT_ID_ILIAS_REMOTE

const ilDataSet::EXPORT_ID_ILIAS_REMOTE = 4

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

EXPORT_ID_ILIAS_REMOTE_INVALID

const ilDataSet::EXPORT_ID_ILIAS_REMOTE_INVALID = 5

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

EXPORT_ID_INVALID

const ilDataSet::EXPORT_ID_INVALID = 7

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

EXPORT_NO_INST_ID

const ilDataSet::EXPORT_NO_INST_ID = 1

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

---

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

• components/ILIAS/DataSet/classes/class.ilDataSet.php