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 ()
	Constructor. More...
	init ($a_entity, $a_schema_version)
	Init. More...
	getSupportedVersions ()
	Get supported version. More...
	readData ($a_entity, $a_version, $a_ids)
	Read data from DB. More...
	setExportDirectories ($a_relative, $a_absolute)
	Set export directories. More...
	setImportDirectory ($a_val)
	Set import directory. More...
	getImportDirectory ()
	Get import directory. More...
	setDSPrefix ($a_val)
	Set XML dataset namespace prefix. More...
	getDSPrefix ()
	Get XML dataset namespace prefix. More...
	getDSPrefixString ()
	getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true, $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...
	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string. More...
	getJsonRepresentation ()
	Get json representation. More...
	getXmlRepresentation ( $a_entity, $a_schema_version, $a_ids, $a_field="", $a_omit_header=false, $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 ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
	Add records xml. More...
	afterXmlRecordWriting ($a_entity, $a_version, $a_set)
	After xml record writing hook record. More...
	getNamespaces (&$namespaces, $a_entity, $a_schema_version)
	Get xml namespaces. More...
	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record for version. More...
	getJsonRecord ($a_set)
	Get json record for version. More...
	getXmlTypes ($a_entity, $a_version)
	Get xml types. More...
	getJsonTypes ($a_entity, $a_version)
	Get json types. More...
	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten) More...
	getXMLEntityTag ($a_entity, $a_schema_version)
	Get entity tag. More...
	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten) More...
	setImport ($a_val)
	Set import object. More...
	getImport ()
	Get import object. More...
	setCurrentInstallationId ($a_val)
	Set current installation id. More...
	getCurrentInstallationId ()
	Get current installation id. More...

Data Fields
	$dircnt
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

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

Protected Attributes
	$current_installation_id = ""
	$db
	$ds_log
	$ds_namespace = 'ds'

Private Member Functions
	addTypesXml ($a_writer, $a_entity, $a_schema_version)
	Add types to xml writer. More...

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

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilDataSet::__construct

(

)

Constructor.

Reimplemented in ilBibliographicDataSet, ilDataCollectionDataSet, ilGlossaryDataSet, ilLearningModuleDataSet, ilSessionDataSet, ilWikiDataSet, ilMediaObjectDataSet, ilSkillDataSet, and ilStyleDataSet.

Definition at line 55 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	(		$a_writer,
			$a_prefixes,
			$a_entity,
			$a_schema_version,
			$a_ids,
			$a_field = ""
	)

Add records xml.

Parameters

return

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

    {
        $types = $this->getXmlTypes($a_entity, $a_schema_version);
 
        $this->ds_log->debug("...read data");
        $this->readData($a_entity, $a_schema_version, $a_ids, $a_field);
        $this->ds_log->debug("...data: " . print_r($this->data, true));
        if (is_array($this->data)) {
            foreach ($this->data as $d) {
                $a_writer->xmlStartTag(
                    $this->getDSPrefixString() . "Rec",
                    array("Entity" => $this->getXmlEntityName($a_entity, $a_schema_version))
                );
 
                // entity tag
                $a_writer->xmlStartTag($this->getXmlEntityTag($a_entity, $a_schema_version));
 
                $rec = $this->getXmlRecord($a_entity, $a_schema_version, $d);
                foreach ($rec as $f => $c) {
                    switch ($types[$f]) {
                        case "directory":
                            if ($this->absolute_export_dir != "" && $this->relative_export_dir != "") {
                                ilUtil::makeDirParents($this->absolute_export_dir . "/dsDir_" . $this->dircnt);
                                ilUtil::rCopy($c, $this->absolute_export_dir . "/dsDir_" . $this->dircnt);
                                //echo "<br>copy-".$c."-".$this->absolute_export_dir."/dsDir_".$this->dircnt."-";
                                $c = $this->relative_export_dir . "/dsDir_" . $this->dircnt;
                                $this->dircnt++;
                            }
                            break;
                    }
                    // 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_schema_version));
 
                $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));
                if (is_array($deps)) {
                    foreach ($deps as $dp => $par) {
                        $this->addRecordsXml($a_writer, $a_prefixes, $dp, $a_schema_version, $par["ids"], $par["field"]);
                    }
                }
            }
        } elseif ($this->data === false) {
            // false -> add records of dependent entities (no record)
            $this->ds_log->debug("...get dependencies (no record)");
            $deps = $this->getDependencies($a_entity, $a_schema_version, null, $a_ids);
            if (is_array($deps)) {
                foreach ($deps as $dp => $par) {
                    $this->addRecordsXml($a_writer, $a_prefixes, $dp, $a_schema_version, $par["ids"], $par["field"]);
                }
            }
        }
    }

References $c, $d, $dircnt, Vendor\Package\$f, addRecordsXml(), afterXmlRecordWriting(), getDSPrefixString(), getXmlRecord(), getXmlTypes(), ilUtil\makeDirParents(), ilUtil\rCopy(), and readData().

Referenced by addRecordsXml(), and getXmlRepresentation().

Here is the call graph for this function:

Here is the caller graph for this function:

addTypesXml()

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

private

Add types to xml writer.

Parameters

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

    {
        $types = $this->getXmlTypes($a_entity, $a_schema_version);
        
        // add types of current entity
        if (is_array($types)) {
            $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);
        if (is_array($deps)) {
            foreach ($deps as $dp => $w) {
                $this->addTypesXml($a_writer, $dp, $a_schema_version);
            }
        }
    }

References Vendor\Package\$f, addTypesXml(), getDSPrefixString(), and getXmlTypes().

Referenced by addTypesXml(), and getXmlRepresentation().

Here is the call graph for this function:

Here is the caller graph for this function:

afterXmlRecordWriting()

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

After xml record writing hook record.

Parameters

return

Reimplemented in ilScorm2004DataSet, and ilUserDataSet.

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

    {
    }

Referenced by addRecordsXml().

Here is the caller graph for this function:

convertToLeadingUpper()

ilDataSet::convertToLeadingUpper

(

$a_str

)

Make xyz_abc a XyzAbc string.

Parameters

return

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

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

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

Here is the caller graph for this function:

createObjectExportId()

ilDataSet::createObjectExportId (   $a_type,   $a_id  )

protected

Build ilias export id.

Parameters

string	$a_type
int	$a_id

Returns

string

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

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

References IL_INST_ID.

Referenced by ilBlogDataSet\readData().

Here is the caller graph for this function:

getCurrentInstallationId()

ilDataSet::getCurrentInstallationId

(

)

Get current installation id.

Returns

string current installation id

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

    {
        return $this->current_installation_id;
    }

References $current_installation_id.

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

Here is the caller graph for this function:

getDirectDataFromQuery()

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

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

Parameters

string	$a_query
bool	$a_convert_to_leading_upper
bool	$a_set	should internal data array already be set?

Returns

array

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

    {
        $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;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getDSPrefix()

ilDataSet::getDSPrefix

(

)

Get XML dataset namespace prefix.

Returns

string XML dataset namespace prefix

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

    {
        return $this->ds_namespace;
    }

References $ds_namespace.

Referenced by getDSPrefixString().

Here is the caller graph for this function:

getDSPrefixString()

ilDataSet::getDSPrefixString

(

)

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

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

References getDSPrefix().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getImport()

ilDataSet::getImport

(

)

Get import object.

Returns

object import object

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

    {
        return $this->import;
    }

Referenced by ilSurveyDataSet\importRecord().

Here is the caller graph for this function:

getImportDirectory()

ilDataSet::getImportDirectory

(

)

Get import directory.

Returns

string import directory

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

    {
        return $this->import_directory;
    }

Referenced by ilBibliographicDataSet\importLibraryFile(), ilBlogDataSet\importRecord(), ilExerciseDataSet\importRecord(), ilHTMLLearningModuleDataSet\importRecord(), ilPollDataSet\importRecord(), ilPortfolioDataSet\importRecord(), ilScorm2004DataSet\importRecord(), ilMediaObjectDataSet\importRecord(), ilObjectDataSet\importRecord(), ilStyleDataSet\importRecord(), and ilUserDataSet\importRecord().

Here is the caller graph for this function:

getJsonEntityName()

ilDataSet::getJsonEntityName	(		$a_entity,
			$a_version
	)

Get entity name for json (may be overwritten)

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

    {
        return $a_entity;
    }

Referenced by getJsonRepresentation().

Here is the caller graph for this function:

getJsonRecord()

ilDataSet::getJsonRecord

(

$a_set

)

Get json record for version.

Parameters

array

abstract data record

Returns

array json record

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

    {
        return $a_set;
    }

Referenced by getJsonRepresentation().

Here is the caller graph for this function:

getJsonRepresentation()

ilDataSet::getJsonRepresentation ( )

final

Get json representation.

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

    {
        if ($this->version === false) {
            return false;
        }
        
        $arr["entity"] = $this->getJsonEntityName();
        $arr["version"] = $this->version;
        $arr["install_id"] = IL_INST_ID;
        $arr["install_url"] = ILIAS_HTTP_PATH;
        $arr["types"] = $this->getJsonTypes();
        $arr["set"] = array();
        foreach ($this->data as $d) {
            $arr["set"][] = $this->getJsonRecord($d);
        }
        
        include_once("./Services/JSON/classes/class.ilJsonUtil.php");
 
        return ilJsonUtil::encode($arr);
    }

References $d, ilJsonUtil\encode(), getJsonEntityName(), getJsonRecord(), getJsonTypes(), and IL_INST_ID.

Here is the call graph for this function:

getJsonTypes()

ilDataSet::getJsonTypes	(		$a_entity,
			$a_version
	)

Get json types.

Returns

array types array for json/version set in constructor

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

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

References getTypes().

Referenced by getJsonRepresentation().

Here is the call graph for this function:

Here is the caller graph for this function:

getNamespaces()

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

Get xml namespaces.

Parameters

array	namespaces per entity
string	entity
string	target release

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

    {
        $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);
        if (is_array($deps)) {
            foreach ($deps as $dp => $w) {
                $this->getNamespaces($namespaces, $dp, $a_schema_version);
            }
        }
    }

References getNamespaces(), and getXmlNamespace().

Referenced by getNamespaces(), and getXmlRepresentation().

Here is the call graph for this function:

Here is the caller graph for this function:

getSupportedVersions()

ilDataSet::getSupportedVersions ( )

abstract

Get supported version.

Returns

array array of supported version

Reimplemented in ilBibliographicDataSet, ilBlogDataSet, ilCmiXapiDataSet, ilContentPageDataSet, ilDataCollectionDataSet, ilExerciseDataSet, ilExternalFeedDataSet, 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 (   $a_entity,   $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, ilExternalFeedDataSet, ilGlossaryDataSet, ilHTMLLearningModuleDataSet, ilItemGroupDataSet, ilLearningModuleDataSet, ilMediaCastDataSet, ilMediaPoolDataSet, ilPollDataSet, ilPortfolioDataSet, ilScorm2004DataSet, ilScormAiccDataSet, ilSessionDataSet, ilSurveyDataSet, ilWikiDataSet, ilCalendarDataSet, ilCOPageDataSet, ilHelpDataSet, ilMediaObjectDataSet, ilNewsDataSet, ilNotesDataSet, ilObjectDataSet, ilRatingDataSet, ilSkillDataSet, ilStyleDataSet, ilTaxonomyDataSet, ilUserDataSet, and ilIndividualAssessmentDataSet.

Referenced by getJsonTypes(), and getXmlTypes().

Here is the caller graph for this function:

getXMLEntityName()

ilDataSet::getXMLEntityName	(		$a_entity,
			$a_version
	)

Get entity name for xml (may be overwritten)

Returns

string

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

    {
        return $a_entity;
    }

getXMLEntityTag()

ilDataSet::getXMLEntityTag	(		$a_entity,
			$a_schema_version
	)

Get entity tag.

Parameters

return

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

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

References convertToLeadingUpper().

Here is the call graph for this function:

getXmlNamespace()

ilDataSet::getXmlNamespace (   $a_entity,   $a_schema_version  )

abstractprotected

Get xml namespace.

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

Referenced by getNamespaces().

Here is the caller graph for this function:

getXmlRecord()

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

Get xml record for version.

Parameters

array

abstract data record

Returns

array xml record

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

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

    {
        return $a_set;
    }

Referenced by addRecordsXml().

Here is the caller graph for this function:

getXmlRepresentation()

ilDataSet::getXmlRepresentation (   $a_entity,   $a_schema_version,   $a_ids,   $a_field = "",   $a_omit_header = false,   $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 268 of file class.ilDataSet.php.

      {
        $this->dircnt = 1;
        
        // step 1: check target release and supported versions
        
        
        
        // step 2: init writer
        include_once "./Services/Xml/classes/class.ilXmlWriter.php";
        $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");
        //if ($a_entity == "mep")
        //{
        //      echo "<pre>".htmlentities($writer->xmlDumpMem(true))."</pre>"; exit;
        //}
        return $writer->xmlDumpMem(false);
    }

References addRecordsXml(), addTypesXml(), getDSPrefixString(), getNamespaces(), and IL_INST_ID.

Here is the call graph for this function:

getXmlTypes()

ilDataSet::getXmlTypes	(		$a_entity,
			$a_version
	)

Get xml types.

Returns

array types array for xml/version set in constructor

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

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

References getTypes().

Referenced by addRecordsXml(), and addTypesXml().

Here is the call graph for this function:

Here is the caller graph for this function:

init()

ilDataSet::init (   $a_entity,   $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 75 of file class.ilDataSet.php.

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

parseObjectExportId()

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

protected

Parse export id.

Parameters

string	$a_id
int	$a_fallback_id

Returns

array type, id

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

    {
        // ilias export id?
        if (substr($a_id, 0, 3) == "il_") {
            $parts = explode("_", $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);
                }
            }
        }
        
        // 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 $type, ilObject\_getIdForImportId(), ilObject\_lookupType(), and IL_INST_ID.

Referenced by ilBlogDataSet\importRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

readData()

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

abstract

Read data from DB.

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

Parameters

array

one or multiple ids

Reimplemented in ilBibliographicDataSet, ilContentPageDataSet, ilDataCollectionDataSet, ilExternalFeedDataSet, and ilIndividualAssessmentDataSet.

Referenced by addRecordsXml().

Here is the caller graph for this function:

setCurrentInstallationId()

ilDataSet::setCurrentInstallationId

(

$a_val

)

Set current installation id.

Parameters

string

$a_val

current installation id

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

    {
        $this->current_installation_id = $a_val;
    }

setDSPrefix()

ilDataSet::setDSPrefix

(

$a_val

)

Set XML dataset namespace prefix.

Parameters

string

XML dataset namespace prefix

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

    {
        $this->ds_namespace = $a_val;
    }

setExportDirectories()

ilDataSet::setExportDirectories	(		$a_relative,
			$a_absolute
	)

Set export directories.

Parameters

return

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

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

setImport()

ilDataSet::setImport

(

$a_val

)

Set import object.

Parameters

object

import object

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

    {
        $this->import = $a_val;
    }

setImportDirectory()

ilDataSet::setImportDirectory

(

$a_val

)

Set import directory.

Parameters

string

import directory

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

    {
        $this->import_directory = $a_val;
    }

stripTags()

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

protected

Definition at line 642 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 ilBlogDataSet\importRecord(), ilExerciseDataSet\importRecord(), ilGlossaryDataSet\importRecord(), ilHTMLLearningModuleDataSet\importRecord(), ilItemGroupDataSet\importRecord(), ilLearningModuleDataSet\importRecord(), ilMediaCastDataSet\importRecord(), ilMediaPoolDataSet\importRecord(), ilPortfolioDataSet\importRecord(), ilSurveyDataSet\importRecord(), ilWikiDataSet\importRecord(), ilCOPageDataSet\importRecord(), ilHelpDataSet\importRecord(), ilMediaObjectDataSet\importRecord(), ilNewsDataSet\importRecord(), ilNotesDataSet\importRecord(), ilRatingDataSet\importRecord(), ilStyleDataSet\importRecord(), and ilTaxonomyDataSet\importRecord().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$current_installation_id

ilDataSet::$current_installation_id = ""

protected

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

Referenced by getCurrentInstallationId().

$db

ilDataSet::$db

protected

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

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

$dircnt

ilDataSet::$dircnt

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

Referenced by addRecordsXml().

$ds_log

ilDataSet::$ds_log

protected

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

$ds_namespace

ilDataSet::$ds_namespace = 'ds'

protected

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

Referenced by getDSPrefix().

EXPORT_ID

const ilDataSet::EXPORT_ID = 6

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

EXPORT_ID_ILIAS_LOCAL

const ilDataSet::EXPORT_ID_ILIAS_LOCAL = 2

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

EXPORT_ID_ILIAS_LOCAL_INVALID

const ilDataSet::EXPORT_ID_ILIAS_LOCAL_INVALID = 3

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

EXPORT_ID_ILIAS_REMOTE

const ilDataSet::EXPORT_ID_ILIAS_REMOTE = 4

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

EXPORT_ID_ILIAS_REMOTE_INVALID

const ilDataSet::EXPORT_ID_ILIAS_REMOTE_INVALID = 5

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

EXPORT_ID_INVALID

const ilDataSet::EXPORT_ID_INVALID = 7

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

EXPORT_NO_INST_ID

const ilDataSet::EXPORT_NO_INST_ID = 1

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

---

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

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