Notes Data set class. More...

Inheritance diagram for ilNotesDataSet:

Collaboration diagram for ilNotesDataSet:

Public Member Functions
	getSupportedVersions ()
	Get supported versions. More...

	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...

	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data. More...

	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record. 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)
	Get field types for entity. More...

	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data. 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...

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

Protected Attributes inherited from ilDataSet
	$current_installation_id = ""

	$db

	$ds_log

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: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Member Function Documentation

◆ getDependencies()

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

protected

Determine the dependent sets of data.

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

     {
         return false;
     }

◆ getSupportedVersions()

ilNotesDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

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

     {
         return array("4.3.0");
     }

◆ getTypes()

ilNotesDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

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

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

◆ getXmlNamespace()

ilNotesDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

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

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

◆ importRecord()

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

Import record.

Parameters

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

References IL_NOTE_PRIVATE.

     {
         switch ($a_entity) {
             case "user_notes":
                 $usr_id = $a_mapping->getMapping("Services/User", "usr", $a_rec["Author"]);
                 if ($usr_id > 0) {
                     include_once("./Services/Notes/classes/class.ilNote.php");
                     
                     // 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"] == IL_NOTE_PRIVATE &&
                         $a_rec["ObjType"] == "pd") {
                         $note = new ilNote();
                         $note->setObject("pd", 0, $usr_id);
                         $note->setType(IL_NOTE_PRIVATE);
                         $note->setAuthor($usr_id);
                         $note->setText($a_rec["NoteText"]);
                         $note->setSubject($a_rec["Subject"]);
                         $note->setCreationDate($a_rec["CreationDate"]);
                         $note->setLabel($a_rec["Label"]);
                         $note->create(true);
                     }
                 }
                 break;
         }
     }

◆ readData()

ilNotesDataSet::readData	(	$a_entity,
		$a_version,
		$a_ids,
		$a_field = `""`
	)

Read data.

Parameters

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

References ilDataSet\$db, $ilDB, and ilDataSet\getDirectDataFromQuery().

     {
         $ilDB = $this->db;
 
         if (!is_array($a_ids)) {
             $a_ids = array($a_ids);
         }
 
         // user notes
         if ($a_entity == "user_notes") {
             switch ($a_version) {
                 case "4.3.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;
             }
         }
     }

Here is the call graph for this function:

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

Services/Notes/classes/class.ilNotesDataSet.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ importRecord()

◆ readData()