ilDataCollectionDataSet Class Reference

DataCollection dataset class. More...

Inheritance diagram for ilDataCollectionDataSet:

Collaboration diagram for ilDataCollectionDataSet:

Public Member Functions
	__construct ()
	getSupportedVersions ()
	getCache ($a_entity)
	Get cached data from a given entity. More...
	getXmlNamespace ($a_entity, $a_schema_version)
	readData ($a_entity, $a_version, $a_ids)
	Read data from Cache for a given entity and ID(s) More...
Public Member Functions inherited from ilDataSet
	__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 ...> ... 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...

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Map XML attributes of entities to datatypes (text, integer...) More...
	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Return dependencies form entities to other entities (in our case these are all the DB relations) More...
	_readData ($a_entity, $a_ids)
	Build data array, data is read from cache except dcl object itself. More...
	buildCache ($a_entity, $set)
	Helper method to build cache for data of all entities. More...
Protected Member Functions inherited from ilDataSet
	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
	$db
	$data = array()
	$record_field_ids_2_storage = array()
	$caches
	$import_dc_object
	$count_imported_tables = 0
	$import_record_field_cache = array()
	$user
	$import_temp_refs = array()
	$import_temp_refs_props = array()
	$import_temp_new_mob_ids = array()
Protected Attributes inherited from ilDataSet
	$current_installation_id = ""
	$db
	$ds_log
	$ds_namespace = 'ds'

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

Detailed Description

DataCollection dataset class.

Author

Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

__construct()

ilDataCollectionDataSet::__construct

(

)

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

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

    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];
        parent::__construct();
        $this->db = $ilDB;
        $this->user = $ilUser;
    }

Here is the call graph for this function:

Member Function Documentation

_readData()

ilDataCollectionDataSet::_readData (   $a_entity,   $a_ids  )

protected

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

Parameters

$a_entity
$a_ids

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

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

Referenced by readData().

    {
        switch ($a_entity) {
            case 'dcl':
                foreach ($a_ids as $dcl_id) {
                    if (ilObject::_lookupType($dcl_id) == 'dcl') {
                        $obj = new ilObjDataCollection($dcl_id, false);
                        $data = array(
                            '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];
                }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildCache()

ilDataCollectionDataSet::buildCache (   $a_entity,   $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 785 of file class.ilDataCollectionDataSet.php.

References $data, and getTypes().

Referenced by getDependencies().

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

        return $ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCache()

ilDataCollectionDataSet::getCache

(

$a_entity

)

Get cached data from a given entity.

Parameters

$a_entity

Returns

mixed

Exceptions

ilException

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

Referenced by _readData().

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

Here is the caller graph for this function:

getDependencies()

ilDataCollectionDataSet::getDependencies (   $a_entity,   $a_version,   $a_rec,   $a_ids  )

protected

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

Parameters

$a_entity
$a_version
$a_rec
$a_ids

Returns

array

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

References buildCache(), and ilDclCache\getFieldCache().

    {
        if (!$a_rec && !$a_ids) {
            return false;
        }
        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 array(
                    'il_dcl_table' => array('ids' => $ids),
                );
                break;
            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 * FROM il_dcl_field 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 array(
                    'il_dcl_field' => array('ids' => $ids_fields),
                    'il_dcl_record' => array('ids' => $ids_records),
                    'il_dcl_tableview' => array('ids' => $ids_tableviews),
                    'il_dcl_tfield_set' => array('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 array(
                    'il_dcl_field_prop' => array('ids' => $prop_ids),
                    'il_dcl_sel_opts' => array('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 = "value{$stloc}";
                    // Save reocrd field id. Internal ID is not used currently
                    $this->caches["il_dcl_stloc{$stloc}_value"][$rec->record_field_id] = array(
                        'record_field_id' => $rec->record_field_id,
                        'value' => $rec->{$value},
                    );
                }

                return array(
                    'il_dcl_record_field' => array('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 array(
                    'il_dcl_tview_set' => array('ids' => $ids),
                );
            case 'il_dcl_record_field':
                $record_field_id = $a_rec['id'];
                $storage_loc = $this->record_field_ids_2_storage[$record_field_id];

                return array(
                    "il_dcl_stloc{$storage_loc}_value" => array('ids' => array($record_field_id)),
                );
        }

        return false;
    }

Here is the call graph for this function:

getSupportedVersions()

ilDataCollectionDataSet::getSupportedVersions

(

)

Returns

array

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

    {
        return array('4.5.0');
    }

getTypes()

ilDataCollectionDataSet::getTypes (   $a_entity,   $a_version  )

protected

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

Parameters

string	$a_entity
string	$a_version

Returns

array

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

Referenced by buildCache().

    {
        switch ($a_entity) {
            case 'dcl':
                return array(
                    "id" => "integer",
                    "title" => "text",
                    "description" => "text",
                    'is_online' => 'integer',
                    'rating' => 'integer',
                    'public_notes' => 'integer',
                    'approval' => 'integer',
                    'notification' => 'integer',
                );
            case 'il_dcl_table':
                return array(
                    '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 array(
                    '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 array(
                    'id' => 'integer',
                    'table_id' => 'integer',
                    'title' => 'text',
                    'description' => 'text',
                    'datatype_id' => 'integer',
                    'is_unique' => 'integer',
                );
            case 'il_dcl_tview_set':
                return array(
                    '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 array(
                    'id' => 'integer',
                    'table_id' => 'integer',
                    'field' => 'text',
                    'field_order' => 'integer',
                    'exportable' => 'integer',
                );
            case 'il_dcl_field_prop':
                return array(
                    'id' => 'integer',
                    'field_id' => 'integer',
                    'name' => 'text',
                    'value' => 'integer',
                );
            case 'il_dcl_sel_opts':
                return array(
                    'id' => 'integer',
                    'field_id' => 'integer',
                    'opt_id' => 'integer',
                    'sorting' => 'integer',
                    'value' => 'text',
                );
            case 'il_dcl_record':
                return array(
                    'id' => 'integer',
                    'table_id' => 'integer',
                );
            case 'il_dcl_record_field':
                return array(
                    'id' => 'integer',
                    'record_id' => 'integer',
                    'field_id' => 'integer',
                );
            case 'il_dcl_stloc1_value':
                return array(
                    'id' => 'integer',
                    'record_field_id' => 'integer',
                    'value' => 'text',
                );
            case 'il_dcl_stloc2_value':
                return array(
                    'id' => 'integer',
                    'record_field_id' => 'integer',
                    'value' => 'text',
                );
            case 'il_dcl_stloc3_value':
                return array(
                    'id' => 'integer',
                    'record_field_id' => 'integer',
                    'value' => 'text',
                );
            default:
                return array();
        }
    }

Here is the caller graph for this function:

getXmlNamespace()

ilDataCollectionDataSet::getXmlNamespace	(		$a_entity,
			$a_schema_version
	)

Parameters

string	$a_entity
string	$a_schema_version

Returns

string

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

References $name, ilObjMediaObject\_saveUsage(), ilDclTableView\createOrGetStandardView(), ilDclCache\getFieldCache(), ilDclTableFieldSetting\getInstance(), ilDclTableViewFieldSetting\getInstance(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), ilDclCache\getRecordCache(), ilDclCache\getTableCache(), ilImportMapping\getTargetId(), IL_CAL_UNIX, ilDclDatatype\INPUTFORMAT_FILE, ilDclDatatype\INPUTFORMAT_ILIAS_REF, ilDclDatatype\INPUTFORMAT_MOB, ilDclDatatype\INPUTFORMAT_REFERENCE, ilDclDatatype\INPUTFORMAT_REFERENCELIST, ilDclBaseFieldModel\PROP_N_REFERENCE, ilDclBaseFieldModel\PROP_REFERENCE, and user().

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

Here is the call graph for this function:

readData()

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

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

Parameters

string	$a_entity
string	$a_version
array	$a_ids	one or multiple ids

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

References _readData().

    {
        $this->data = array();
        if (!is_array($a_ids)) {
            $a_ids = array($a_ids);
        }
        $this->_readData($a_entity, $a_ids);
    }

Here is the call graph for this function:

Field Documentation

$caches

ilDataCollectionDataSet::$caches

protected

Initial value:

= array(
            'dcl' => array(),
            'il_dcl_table' => array(),
            'il_dcl_field' => array(),
            'il_dcl_field_prop' => array(),
            'il_dcl_sel_opts' => array(),
            'il_dcl_record' => array(),
            'il_dcl_record_field' => array(),
            'il_dcl_stloc1_value' => array(),
            'il_dcl_stloc2_value' => array(),
            'il_dcl_stloc3_value' => array(),
            'il_dcl_tfield_set' => array(),
            'il_dcl_tableview' => array(),
            'il_dcl_tview_set' => array(),
        )

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

$count_imported_tables

ilDataCollectionDataSet::$count_imported_tables = 0

protected

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

$data

ilDataCollectionDataSet::$data = array()

protected

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

Referenced by _readData(), and buildCache().

$db

ilDataCollectionDataSet::$db

protected

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

$import_dc_object

ilDataCollectionDataSet::$import_dc_object

protected

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

$import_record_field_cache

ilDataCollectionDataSet::$import_record_field_cache = array()

protected

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

$import_temp_new_mob_ids

ilDataCollectionDataSet::$import_temp_new_mob_ids = array()

protected

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

$import_temp_refs

ilDataCollectionDataSet::$import_temp_refs = array()

protected

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

$import_temp_refs_props

ilDataCollectionDataSet::$import_temp_refs_props = array()

protected

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

$record_field_ids_2_storage

ilDataCollectionDataSet::$record_field_ids_2_storage = array()

protected

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

$user

ilDataCollectionDataSet::$user

protected

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

---

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

• Modules/DataCollection/classes/class.ilDataCollectionDataSet.php