This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilDataCollectionDataSet:

Collaboration diagram for ilDataCollectionDataSet:

Public Member Functions
	__construct ()

	getSupportedVersions ()

	getCache (string $a_entity)
	Get cached data from a given entity. More...

	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from Cache for a given entity and ID(s) More...

Public Member Functions inherited from ilDataSet
	__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...

Protected Member Functions
	getXmlNamespace (string $a_entity, string $a_schema_version)

	escapeArray (array $array)

	getTypes (string $a_entity, string $a_version)
	Map XML attributes of entities to datatypes (text, integer...) More...

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
	Return dependencies form entities to other entities (in our case these are all the DB relations) More...

	_readData (string $a_entity, array $a_ids)
	Build data array, data is read from cache except dcl object itself. More...

	buildCache (string $a_entity, object $set)
	Helper method to build cache for data of all entities. More...

Protected Member Functions inherited from ilDataSet
	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
array	$record_field_ids_2_storage = []

array	$caches

ilObjDataCollection	$import_dc_object

array	$import_record_field_cache = []
	Caches ilDclBaseRecordFieldModel objects. More...

ilObjUser	$user

array	$import_temp_refs = []

array	$import_temp_refs_props = []

array	$import_temp_new_mob_ids = []

Protected Attributes inherited from ilDataSet
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

Additional Inherited Members
Data Fields inherited from ilDataSet
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

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

Definition at line 19 of file class.ilDataCollectionDataSet.php.

Constructor & Destructor Documentation

◆ __construct()

ilDataCollectionDataSet::__construct ( )

Reimplemented from ilDataSet.

Definition at line 73 of file class.ilDataCollectionDataSet.php.

    {
        global $DIC;
        parent::__construct();
        $this->db = $DIC->database();
        $this->user = $DIC->user();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ _readData()

ilDataCollectionDataSet::_readData	(	string	$a_entity,
		array	$a_ids
	)

protected

Build data array, data is read from cache except dcl object itself.

Parameters

$a_entity
$a_ids

Definition at line 870 of file class.ilDataCollectionDataSet.php.

                                                                : void
    {
        switch ($a_entity) {
            case 'dcl':
                foreach ($a_ids as $dcl_id) {
                    if (ilObject::_lookupType($dcl_id) === 'dcl') {
                        $obj = new ilObjDataCollection((int) $dcl_id, false);
                        $data = [
                            'id' => $dcl_id,
                            'title' => $obj->getTitle(),
                            'description' => $obj->getDescription(),
                            'is_online' => $obj->getOnline(),
                            'rating' => $obj->getRating(),
                            'public_notes' => $obj->getPublicNotes(),
                            'approval' => $obj->getApproval(),
                            'notification' => $obj->getNotification(),
                        ];
                        $this->caches['dcl'][$dcl_id] = $data;
                        $this->data[] = $data;
                    }
                }
                break;
            default:
                $data = $this->getCache($a_entity);
                foreach ($a_ids as $id) {
                    $this->data[] = $data[$id];
                }
        }
    }

References $data, $id, and ilObject\_lookupType().

Here is the call graph for this function:

◆ buildCache()

ilDataCollectionDataSet::buildCache	(	string	$a_entity,
		object	$set
	)

protected

Helper method to build cache for data of all entities.

Parameters

	$a_entity
Object	$set	ilDB->query() object

Returns: array of newly added IDs

Definition at line 907 of file class.ilDataCollectionDataSet.php.

                                                                : array
    {
        $fields = array_keys($this->getTypes($a_entity, ''));
        $ids = [];
        while ($rec = $this->db->fetchObject($set)) {
            $data = [];
            foreach ($fields as $field) {
                $data[$field] = $rec->{$field};
            }
            $id = $rec->id;
            $this->caches[$a_entity][$id] = $data;
            $ids[] = $id;
        }
 
        return $ids;
    }

References $data, and $id.

◆ escapeArray()

ilDataCollectionDataSet::escapeArray ( array $array )

protected

Definition at line 492 of file class.ilDataCollectionDataSet.php.

                                                : array
    {
        $new = [];
        foreach ($array as $key => $value) {
            $newkey = $key;
            if (is_string($key)) {
                $newkey = htmlspecialchars($key, ENT_QUOTES | ENT_SUBSTITUTE, 'utf-8');
            }
            $newvalue = $value;
            if (is_string($value)) {
                $newvalue = htmlspecialchars($value, ENT_QUOTES | ENT_SUBSTITUTE, 'utf-8');
            }
            if (is_array($value)) {
                $newvalue = $this->escapeArray($value);
            }
            $new[$newkey] = $newvalue;
        }
        return $new;
    }

References ILIAS\LTI\ToolProvider\$key.

◆ getCache()

ilDataCollectionDataSet::getCache ( string $a_entity )

Get cached data from a given entity.

Exceptions

ilException

Definition at line 90 of file class.ilDataCollectionDataSet.php.

                                              : array
    {
        if (!in_array($a_entity, array_keys($this->caches))) {
            throw new ilException("Entity '$a_entity' does not exist in Cache");
        }
 
        return $this->caches[$a_entity];
    }

◆ getDependencies()

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

protected

Return dependencies form entities to other entities (in our case these are all the DB relations)

Parameters

string	$a_entity
string	$a_version
array \| null	$a_rec
array \| null	$a_ids

Returns: array

Reimplemented from ilDataSet.

Definition at line 693 of file class.ilDataCollectionDataSet.php.

     : array {
        if (!$a_rec && !$a_ids) {
            return [];
        }
        switch ($a_entity) {
            case 'dcl':
                $set = $this->db->query('SELECT * FROM il_dcl_table WHERE obj_id = ' . $this->db->quote(
                    $a_rec['id'],
                    'integer'
                ) . ' ORDER BY id');
                $ids = $this->buildCache('il_dcl_table', $set);
 
                return [
                    'il_dcl_table' => ['ids' => $ids],
                ];
            case 'il_dcl_table':
                $set = $this->db->query('SELECT * FROM il_dcl_record WHERE table_id = ' . $this->db->quote(
                    $a_rec['id'],
                    'integer'
                ));
                $ids_records = $this->buildCache('il_dcl_record', $set);
                $set = $this->db->query('SELECT il_dcl_field.*, il_dcl_datatype.title as datatype_title FROM il_dcl_field INNER JOIN il_dcl_datatype ON il_dcl_field.datatype_id = il_dcl_datatype.id WHERE table_id = ' . $this->db->quote(
                    $a_rec['id'],
                    'integer'
                ));
                $ids_fields = $this->buildCache('il_dcl_field', $set);
                $set = $this->db->query('SELECT * FROM il_dcl_tableview WHERE table_id = ' . $this->db->quote(
                    $a_rec['id'],
                    'integer'
                ));
                $ids_tableviews = $this->buildCache('il_dcl_tableview', $set);
                $set = $this->db->query('SELECT * FROM il_dcl_tfield_set WHERE table_id = ' . $this->db->quote(
                    $a_rec['id'],
                    'integer'
                ));
                $ids_tablefield_settings = $this->buildCache('il_dcl_tfield_set', $set);
 
                return [
                    'il_dcl_field' => ['ids' => $ids_fields],
                    'il_dcl_record' => ['ids' => $ids_records],
                    'il_dcl_tableview' => ['ids' => $ids_tableviews],
                    'il_dcl_tfield_set' => ['ids' => $ids_tablefield_settings],
                ];
            case 'il_dcl_field':
                $set = $this->db->query('SELECT * FROM il_dcl_field_prop WHERE field_id = ' . $this->db->quote(
                    $a_rec['id'],
                    'integer'
                ));
                $prop_ids = $this->buildCache('il_dcl_field_prop', $set);
 
                $set = $this->db->query('SELECT * FROM il_dcl_sel_opts WHERE field_id = ' . $this->db->quote(
                    $a_rec['id'],
                    'integer'
                ));
                $opt_ids = $this->buildCache('il_dcl_sel_opts', $set);
 
                return [
                    'il_dcl_field_prop' => ['ids' => $prop_ids],
                    'il_dcl_sel_opts' => ['ids' => $opt_ids],
                ];
            case 'il_dcl_record':
                $sql = 'SELECT rf.*, d.storage_location FROM il_dcl_record_field AS rf' . ' INNER JOIN il_dcl_field AS f ON (f.id = rf.field_id)'
                    . ' INNER JOIN il_dcl_datatype AS d ON (f.datatype_id = d.id) ' . ' WHERE rf.record_id = '
                    . $this->db->quote($a_rec['id'], 'integer');
                $set = $this->db->query($sql);
                $ids = $this->buildCache('il_dcl_record_field', $set);
 
                $set = $this->db->query($sql);
                while ($rec = $this->db->fetchObject($set)) {
                    $this->record_field_ids_2_storage[$rec->id] = ilDclCache::getFieldCache($rec->field_id)->getStorageLocation();
                }
                // Also build a cache of all values, no matter in which table they are (il_dcl_stloc(1|2|3)_value)
                $sql
                    = 'SELECT rf.id AS record_field_id, st1.value AS value1, st2.value AS value2, st3.value AS value3 FROM il_dcl_record_field AS rf '
                    . 'LEFT JOIN il_dcl_stloc1_value AS st1 ON (st1.record_field_id = rf.id) '
                    . 'LEFT JOIN il_dcl_stloc2_value AS st2 ON (st2.record_field_id = rf.id) '
                    . 'LEFT JOIN il_dcl_stloc3_value AS st3 ON (st3.record_field_id = rf.id) ' . 'WHERE rf.record_id = '
                    . $this->db->quote($a_rec['id'], 'integer');
                $set = $this->db->query($sql);
 
                while ($rec = $this->db->fetchObject($set)) {
                    $stloc = $this->record_field_ids_2_storage[$rec->record_field_id];
                    $value = null;
                    if ($stloc != 0) {
                        $value = "value{$stloc}";
                        $value = $rec->{$value};
                    }
                    // Save reocrd field id. Internal ID is not used currently
                    $this->caches["il_dcl_stloc{$stloc}_value"][$rec->record_field_id] = [
                        'record_field_id' => $rec->record_field_id,
                        'value' => $value,
                    ];
                }
 
                return [
                    'il_dcl_record_field' => ['ids' => $ids],
                ];
            case 'il_dcl_tableview':
                $set = $this->db->query('SELECT * FROM il_dcl_tview_set WHERE tableview_id = ' . $this->db->quote(
                    $a_rec['id'],
                    'integer'
                ));
                $ids = $this->buildCache('il_dcl_tview_set', $set);
 
                return [
                    'il_dcl_tview_set' => ['ids' => $ids],
                ];
            case 'il_dcl_tview_set':
                if (!(int) $a_rec['field'] > 0) {
                    break;
                }
                // Also build a cache of all values, no matter in which table they are (il_dcl_stloc(1|2|3)_value)
                $sql
                    = '
                        SELECT tview_set.id AS tview_set_id, st1.value AS value1, st2.value AS value2, st3.value AS value3, 
                        st1.id AS id1, st2.id AS id2, st3.id AS id3
                        FROM il_dcl_tview_set AS tview_set 
                            LEFT JOIN il_dcl_stloc1_default AS st1 ON (st1.tview_set_id = tview_set.id)
                            LEFT JOIN il_dcl_stloc2_default AS st2 ON (st2.tview_set_id = tview_set.id)
                            LEFT JOIN il_dcl_stloc3_default AS st3 ON (st3.tview_set_id = tview_set.id)
                            WHERE tview_set.id = ' . $this->db->quote($a_rec['id'], 'integer');
                $set = $this->db->query($sql);
 
                while ($rec = $this->db->fetchObject($set)) {
                    $stloc = ilDclCache::getFieldCache($a_rec['field'])->getStorageLocation();
                    if ($stloc != 0) {
                        $value_str = "value{$stloc}";
                        $value = $rec->{$value_str};
                        $id_str = "id{$stloc}";
                        $id = $rec->{$id_str};
                        $tview_set_id = $rec->tview_set_id;
 
                        // Save reocrd field id. Internal ID is not used currently
                        $this->caches["il_dcl_stloc{$stloc}_default"][$rec->tview_set_id] = [
                            'id' => $id,
                            'tview_set_id' => $rec->tview_set_id,
                            'value' => $value,
                        ];
 
                        return [
                            "il_dcl_stloc{$stloc}_default" => ['ids' => [$tview_set_id]],
                        ];
                    }
                }
                break;
            case 'il_dcl_record_field':
                $record_field_id = $a_rec['id'];
                $storage_loc = $this->record_field_ids_2_storage[$record_field_id];
 
                return [
                    "il_dcl_stloc{$storage_loc}_value" => ['ids' => [$record_field_id]],
                ];
        }
 
        return [];
    }

◆ getSupportedVersions()

ilDataCollectionDataSet::getSupportedVersions ( )

Reimplemented from ilDataSet.

Definition at line 81 of file class.ilDataCollectionDataSet.php.

                                          : array
    {
        return ['4.5.0', '8.13'];
    }

◆ getTypes()

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

protected

Map XML attributes of entities to datatypes (text, integer...)

Reimplemented from ilDataSet.

Definition at line 551 of file class.ilDataCollectionDataSet.php.

                                                                    : array
    {
        switch ($a_entity) {
            case 'dcl':
                return [
                    "id" => "integer",
                    "title" => "text",
                    "description" => "text",
                    'is_online' => 'integer',
                    'rating' => 'integer',
                    'public_notes' => 'integer',
                    'approval' => 'integer',
                    'notification' => 'integer',
                ];
            case 'il_dcl_table':
                return [
                    'id' => 'integer',
                    'obj_id' => 'integer',
                    'title' => 'text',
                    'add_perm' => 'integer',
                    'edit_perm' => 'integer',
                    'delete_perm' => 'integer',
                    'edit_by_owner' => 'integer',
                    'limited' => 'integer',
                    'limit_start' => 'text',
                    'limit_end' => 'text',
                    'is_visible' => 'integer',
                    'export_enabled' => 'integer',
                    'import_enabled' => 'integer',
                    'default_sort_field_id' => 'text',
                    'default_sort_field_order' => 'text',
                    'description' => 'text',
                    'public_comments' => 'integer',
                    'view_own_records_perm' => 'integer',
                    'delete_by_owner' => 'integer',
                    'save_confirmation' => 'integer',
                    'table_order' => 'integer',
                ];
            case 'il_dcl_tableview':
                return [
                    'id' => 'integer',
                    'table_id' => 'integer',
                    'title' => 'text',
                    'roles' => 'text',
                    'step_vs' => 'integer',
                    'step_c' => 'integer',
                    'step_e' => 'integer',
                    'step_o' => 'integer',
                    'step_s' => 'integer',
                    'description' => 'text',
                    'tableview_order' => 'integer',
                ];
            case 'il_dcl_field':
                return [
                    'id' => 'integer',
                    'table_id' => 'integer',
                    'title' => 'text',
                    'description' => 'text',
                    'datatype_id' => 'integer',
                    'datatype_title' => 'text',
                    'is_unique' => 'integer',
                ];
            case 'il_dcl_tview_set':
                return [
                    'id' => 'integer',
                    'tableview_id' => 'integer',
                    'field' => 'text',
                    'visible' => 'integer',
                    'in_filter' => 'integer',
                    'filter_value' => 'text',
                    'filter_changeable' => 'integer',
                    'required_create' => 'integer',
                    'required_edit' => 'integer',
                    'locked_create' => 'integer',
                    'locked_edit' => 'integer',
                    'visible_create' => 'integer',
                    'visible_edit' => 'integer',
                    'default_value' => 'text',
                ];
            case 'il_dcl_tfield_set':
                return [
                    'id' => 'integer',
                    'table_id' => 'integer',
                    'field' => 'text',
                    'field_order' => 'integer',
                    'exportable' => 'integer',
                ];
            case 'il_dcl_field_prop':
                return [
                    'id' => 'integer',
                    'field_id' => 'integer',
                    'name' => 'text',
                    'value' => 'integer',
                ];
            case 'il_dcl_sel_opts':
                return [
                    'id' => 'integer',
                    'field_id' => 'integer',
                    'opt_id' => 'integer',
                    'sorting' => 'integer',
                    'value' => 'text',
                ];
            case 'il_dcl_record':
                return [
                    'id' => 'integer',
                    'table_id' => 'integer',
                ];
            case 'il_dcl_record_field':
                return [
                    'id' => 'integer',
                    'record_id' => 'integer',
                    'field_id' => 'integer',
                ];
            case 'il_dcl_stloc1_value':
            case 'il_dcl_stloc2_value':
            case 'il_dcl_stloc3_value':
                return [
                    'id' => 'integer',
                    'record_field_id' => 'integer',
                    'value' => 'text',
                ];
            case 'il_dcl_stloc1_default':
            case 'il_dcl_stloc2_default':
            case 'il_dcl_stloc3_default':
                return [
                    'id' => 'integer',
                    'tview_set_id' => 'integer',
                    'value' => 'text',
                ];
            default:
                return [];
        }
    }

◆ getXmlNamespace()

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

protected

Reimplemented from ilDataSet.

Definition at line 99 of file class.ilDataCollectionDataSet.php.

                                                                                  : string
    {
        return 'https://www.ilias.de/xml/Modules/DataCollection/' . $a_entity;
    }

◆ readData()

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

Read data from Cache for a given entity and ID(s)

Parameters

array $a_ids one or multiple ids

Reimplemented from ilDataSet.

Definition at line 859 of file class.ilDataCollectionDataSet.php.

                                                                               : void
    {
        $this->data = [];
        $this->_readData($a_entity, $a_ids);
    }

Field Documentation

◆ $caches

array ilDataCollectionDataSet::$caches

protected

Initial value:

= [
            'dcl' => [],
            'il_dcl_table' => [],
            'il_dcl_field' => [],
            'il_dcl_field_prop' => [],
            'il_dcl_sel_opts' => [],
            'il_dcl_record' => [],
            'il_dcl_record_field' => [],
            'il_dcl_stloc1_value' => [],
            'il_dcl_stloc2_value' => [],
            'il_dcl_stloc3_value' => [],
            'il_dcl_stloc1_default' => [],
            'il_dcl_stloc2_default' => [],
            'il_dcl_stloc3_default' => [],
            'il_dcl_tfield_set' => [],
            'il_dcl_tableview' => [],
            'il_dcl_tview_set' => [],
        ]