class.ilNotesDataSet.php

Go to the documentation of this file.

<?php

use ILIAS\Notes\InternalService;
use ILIAS\Notes\Note;

class ilNotesDataSet extends ilDataSet
{
    protected \ILIAS\Notes\InternalDataService $notes_data;
    protected \ILIAS\Notes\NotesManager $notes_manager;

    public function __construct()
    {
        global $DIC;

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

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

    protected function getXmlNamespace(string $a_entity, string $a_schema_version): string
    {
        return "https://www.ilias.de/xml/Services/Notes/" . $a_entity;
    }

    protected function getTypes(
        string $a_entity,
        string $a_version
    ): 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 [];
    }

    public function readData(
        string $a_entity,
        string $a_version,
        array $a_ids
    ): 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;
            }
        }
    }

    public function importRecord(
        string $a_entity,
        array $a_types,
        array $a_rec,
        ilImportMapping $a_mapping,
        string $a_schema_version
    ): 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;
        }
    }
}