Notes Data set class. More...

Inheritance diagram for ilNotesDataSet:

Collaboration diagram for ilNotesDataSet:

Public Member Functions
	__construct ()

	getSupportedVersions ()

	readData (string $a_entity, string $a_version, array $a_ids)
	Read data from DB. More...

	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...

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...

	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 ...> ... </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...

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

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

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

	getTypes (string $a_entity, string $a_version)
	Get (abstract) types for (abstract) field names. 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)

	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 Notes InternalDataService	$notes_data

ILIAS Notes NotesManager	$notes_manager

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

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

Detailed Description

Notes Data set class.

Entities

user_notes: All personal notes of a user (do not use this for object related queries. Add a new entity for this purpose.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilNotesDataSet::__construct ( )

Reimplemented from ilDataSet.

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

    {
        global $DIC;
 
        parent::__construct();
        $this->notes_manager = $DIC->notes()->internal()->domain()->notes();
        $this->notes_data = $DIC->notes()->internal()->data();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getSupportedVersions()

ilNotesDataSet::getSupportedVersions ( )

Reimplemented from ilDataSet.

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

                                          : array
    {
        return array("4.3.0", "10.0");
    }

◆ getTypes()

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

protected

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 from ilDataSet.

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

     : array {
        // user notes
        if ($a_entity === "user_notes") {
            switch ($a_version) {
                case "4.3.0":
                case "10.0":
                    return array(
                        "Id" => "integer",
                        "RepObjId" => "integer",
                        "ObjId" => "integer",
                        "ObjType" => "text",
                        "Type" => "integer",
                        "Author" => "integer",
                        "CreationDate" => "timestamp",
                        "NoteText" => "text",
                        "Label" => "integer",
                        "Subject" => "text",
                        "NoRepository" => "integer"
                    );
            }
        }
        if ($a_entity === "comments_settings") {
            switch ($a_version) {
                case "10.0":
                    return array(
                        "Id" => "integer",
                        "Active" => "integer"
                    );
            }
        }
        return [];
    }

◆ getXmlNamespace()

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

protected

Reimplemented from ilDataSet.

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

                                                                                  : string
    {
        return "https://www.ilias.de/xml/Services/Notes/" . $a_entity;
    }

◆ importRecord()

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

Needs to be overwritten for import use case.

Reimplemented from ilDataSet.

Definition at line 124 of file class.ilNotesDataSet.php.

     : void {
        $a_rec = $this->stripTags($a_rec);
        switch ($a_entity) {
            case "user_notes":
                $usr_id = $a_mapping->getMapping("components/ILIAS/User", "usr", $a_rec["Author"]);
                if ($usr_id > 0) {
                    // only import real user (assigned to personal desktop) notes
                    // here.
                    if ((int) $a_rec["RepObjId"] === 0 &&
                        $a_rec["ObjId"] == $a_rec["Author"] &&
                        $a_rec["Type"] == Note::PRIVATE &&
                        $a_rec["ObjType"] === "pd") {
                        $context = $this->notes_data->context(
                            0,
                            (int) $usr_id,
                            "pd"
                        );
 
                        $note = $this->notes_data->note(
                            0,
                            $context,
                            $a_rec["NoteText"],
                            (int) $usr_id,
                            Note::PRIVATE,
                            $a_rec["CreationDate"]
                        );
                        $this->notes_manager->createNote(
                            $note,
                            [],
                            true
                        );
                    }
                }
                break;
            case "comments_settings":
                $obj_id = (int) $a_mapping->getMapping("components/ILIAS/ILIASObject", "obj", $a_rec["Id"]);
                if ($obj_id > 0 && ((bool) ($a_rec["Active"] ?? false) === true)) {
                    $this->notes_manager->activateComments($obj_id, true);
                }
                break;
        }
    }

References $context, ilImportMapping\getMapping(), and ILIAS\Repository\int().

Here is the call graph for this function:

◆ readData()

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

Read data from DB.

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

Reimplemented from ilDataSet.

Definition at line 89 of file class.ilNotesDataSet.php.

     : void {
        $ilDB = $this->db;
 
        // user notes
        if ($a_entity === "user_notes") {
            switch ($a_version) {
                case "4.3.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT id, rep_obj_id, obj_id, obj_type, type, " .
                        " author, note_text, creation_date, label, subject, no_repository " .
                        " FROM note " .
                        " WHERE " .
                        $ilDB->in("author", $a_ids, false, "integer") .
                        " AND obj_type = " . $ilDB->quote("pd", "text"));
                    break;
            }
        }
        if ($a_entity === "comments_settings") {
            switch ($a_version) {
                case "10.0":
                    foreach($a_ids as $id) {
                        $this->data[] = [
                            "Id" => $id,
                            "Active" => (int) $this->notes_manager->commentsActive((int) $id)
                        ];
                    }
                    break;
            }
        }
    }

References $ilDB.

Field Documentation

◆ $notes_data

ILIAS Notes InternalDataService ilNotesDataSet::$notes_data

protected

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

◆ $notes_manager

ILIAS Notes NotesManager ilNotesDataSet::$notes_manager

protected

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

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

components/ILIAS/Notes/Export/class.ilNotesDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()

Field Documentation

◆ $notes_data

◆ $notes_manager