Collaboration diagram for ILIAS\Notes\NoteDBRepository:

Public Member Functions
	__construct (InternalDataService $data, \ilDBInterface $db)

	createNote (Note $note)

	deleteNote (int $id)

	updateNoteText (int $id, string $text)

	getById (int $id)
	Get note by id. More...

	getNotesForContext (Context $context, int $type=Note::PRIVATE, bool $incl_sub=false, int $author=0, bool $ascending=false, string $since="", string $search_text="")
	Get all notes related to a specific object. More...

	getNotesForObjIds (array $obj_ids, int $type=Note::PRIVATE, bool $incl_sub=false, int $author=0, bool $ascending=false, string $since="", string $search_text="")
	Get all notes related to a specific object. More...

	getNrOfNotesForContext (Context $context, int $type=Note::PRIVATE, bool $incl_sub=false, int $author=0)

	getRelatedObjIdsOfUser (int $user_id, int $type)

	filterObjectsWithNotes (array $obj_ids, int $type)

	getUserCount (int $obj_id, int $sub_obj_id, string $obj_type)
	How many users have attached a note/comment to a given object? More...

	countNotesAndCommentsMultipleObjects (array $obj_ids, int $user_id, bool $no_sub_objs=false)
	Get all notes related to multiple repository objects. More...

Protected Member Functions
	getNoteFromRecord (array $rec)

	getQuery (?Context $context, int $type=Note::PRIVATE, bool $incl_sub=false, int $author=0, bool $ascending=false, bool $count=false, string $since="", array $obj_ids=[], string $search_text="")
	Get query. More...

Protected Attributes
ilDBInterface	$db

InternalDataService	$data

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Notes\NoteDBRepository::__construct	(	InternalDataService	$data,
		\ilDBInterface	$db
	)

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

References ILIAS\Notes\NoteDBRepository\$data, and ILIAS\Notes\NoteDBRepository\$db.

       {
         $this->db = $db;
         $this->data = $data;
     }

Member Function Documentation

◆ countNotesAndCommentsMultipleObjects()

ILIAS\Notes\NoteDBRepository::countNotesAndCommentsMultipleObjects	(	array	$obj_ids,
		int	$user_id,
		bool	$no_sub_objs = `false`
	)

Get all notes related to multiple repository objects.

Todo:: this is currently used to implement a caching in ilObjListGUI objects.

the caching should be moved into this repo instead

Definition at line 352 of file class.NoteDBRepository.php.

References ILIAS\Notes\NoteDBRepository\$db, $q, ILIAS\Notes\Note\PRIVATE, and ILIAS\Notes\Note\PUBLIC.

      : array {
         $db = $this->db;
 
         $q = "SELECT count(id) c, rep_obj_id, type FROM note WHERE " .
             " ((type = " . $db->quote(Note::PRIVATE, "integer") . " AND " .
             "author = " . $db->quote($user_id, "integer") . ") OR " .
             " type = " . $db->quote(Note::PUBLIC, "integer") . ") AND " .
             $db->in("rep_obj_id", $obj_ids, false, "integer");
 
         if ($no_sub_objs) {
             $q .= " AND obj_id = " . $db->quote(0, "integer");
         }
 
         $q .= " GROUP BY rep_obj_id, type ";
 
         $cnt = array();
         $set = $db->query($q);
         while ($rec = $db->fetchAssoc($set)) {
             $cnt[$rec["rep_obj_id"]][$rec["type"]] = $rec["c"];
         }
         return $cnt;
     }

◆ createNote()

ILIAS\Notes\NoteDBRepository::createNote ( Note $note )

Definition at line 39 of file class.NoteDBRepository.php.

References $context, ILIAS\Notes\NoteDBRepository\$db, $id, ILIAS\Notes\Note\getAuthor(), ILIAS\Notes\NoteDBRepository\getById(), ILIAS\Notes\Note\getContext(), ILIAS\Notes\Note\getCreationDate(), ILIAS\Notes\Note\getRecipient(), ILIAS\Notes\Note\getText(), and ILIAS\Notes\Note\getType().

      : Note {
         $db = $this->db;
 
         $id = $db->nextId("note");
         $context = $note->getContext();
         $db->insert("note", array(
             "id" => array("integer", $id),
             "rep_obj_id" => array("integer", $context->getObjId()),
             "obj_id" => array("integer", $context->getSubObjId()),
             "obj_type" => array("text", $context->getType()),
             "news_id" => array("integer", $context->getNewsId()),
             "type" => array("integer", $note->getType()),
             "author" => array("integer", $note->getAuthor()),
             "note_text" => array("clob", $note->getText()),
             "creation_date" => array("timestamp", $note->getCreationDate()),
             "no_repository" => array("integer", (int) !$context->getInRepository()),
             "recipient" => array("integer", $note->getRecipient()),
         ));
         return $this->getById($id);
     }

Here is the call graph for this function:

◆ deleteNote()

ILIAS\Notes\NoteDBRepository::deleteNote ( int $id )

Definition at line 62 of file class.NoteDBRepository.php.

References ILIAS\Notes\NoteDBRepository\$db, and $q.

                                        : void
     {
         $db = $this->db;
         $q = "DELETE FROM note WHERE id = " .
             $db->quote($id, "integer");
         $db->manipulate($q);
     }

◆ filterObjectsWithNotes()

ILIAS\Notes\NoteDBRepository::filterObjectsWithNotes	(	array	$obj_ids,
		int	$type
	)

Parameters

int[] $obj_ids

Returns: int[]

Definition at line 310 of file class.NoteDBRepository.php.

References ILIAS\Notes\NoteDBRepository\$db, $q, and ILIAS\Repository\int().

                                                                      : array
     {
         $db = $this->db;
 
         $q = "SELECT DISTINCT rep_obj_id FROM note WHERE " .
             $db->in("rep_obj_id", $obj_ids, false, "integer") .
             " AND type = " . $db->quote($type, "integer") .
             " AND (no_repository IS NULL OR no_repository < " . $db->quote(1, "integer") . ")";
 
         $set = $db->query($q);
         $ids = [];
         while ($rec = $db->fetchAssoc($set)) {
             $ids[] = (int) $rec["rep_obj_id"];
         }
         return $ids;
     }

Here is the call graph for this function:

◆ getById()

ILIAS\Notes\NoteDBRepository::getById ( int $id )

Get note by id.

Exceptions

NoteNotFoundException

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

References ILIAS\Notes\NoteDBRepository\$db, ILIAS\Notes\NoteDBRepository\getNoteFromRecord(), and ilDBInterface\queryF().

Referenced by ILIAS\Notes\NoteDBRepository\createNote().

      : Note {
         $db = $this->db;
 
         $set = $db->queryF(
             "SELECT * FROM note " .
             " WHERE id = %s ",
             ["integer"],
             [$id]
         );
         if ($rec = $db->fetchAssoc($set)) {
             return $this->getNoteFromRecord($rec);
         }
         throw new NoteNotFoundException("Note with ID $id not found.");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNoteFromRecord()

ILIAS\Notes\NoteDBRepository::getNoteFromRecord ( array $rec )

protected

Definition at line 106 of file class.NoteDBRepository.php.

References ILIAS\Repository\int().

Referenced by ILIAS\Notes\NoteDBRepository\getById(), ILIAS\Notes\NoteDBRepository\getNotesForContext(), and ILIAS\Notes\NoteDBRepository\getNotesForObjIds().

                                                     : Note
     {
         return $this->data->note(
             (int) $rec["id"],
             $this->data->context(
                 (int) $rec["rep_obj_id"],
                 (int) $rec["obj_id"],
                 $rec["obj_type"],
                 (int) $rec["news_id"],
                 !$rec["no_repository"]
             ),
             (string) $rec["note_text"],
             (int) $rec["author"],
             (int) $rec["type"],
             $rec["creation_date"],
             $rec["update_date"],
             (int) $rec["recipient"]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNotesForContext()

ILIAS\Notes\NoteDBRepository::getNotesForContext	(	Context	$context,
		int	$type = `Note::PRIVATE`,
		bool	$incl_sub = `false`,
		int	$author = `0`,
		bool	$ascending = `false`,
		string	$since = `""`,
		string	$search_text = `""`
	)

Get all notes related to a specific object.

Returns: Note[]

Definition at line 196 of file class.NoteDBRepository.php.

References ILIAS\Notes\NoteDBRepository\$db, ILIAS\Notes\NoteDBRepository\getNoteFromRecord(), and ILIAS\Notes\NoteDBRepository\getQuery().

      : array {
         $db = $this->db;
 
         $query = $this->getQuery(
             $context,
             $type,
             $incl_sub,
             $author,
             $ascending,
             false,
             $since,
             [],
             $search_text
         );
 
         $set = $db->query($query);
         $notes = [];
         while ($note_rec = $db->fetchAssoc($set)) {
             $notes[] = $this->getNoteFromRecord($note_rec);
         }
         return $notes;
     }

Here is the call graph for this function:

◆ getNotesForObjIds()

ILIAS\Notes\NoteDBRepository::getNotesForObjIds	(	array	$obj_ids,
		int	$type = `Note::PRIVATE`,
		bool	$incl_sub = `false`,
		int	$author = `0`,
		bool	$ascending = `false`,
		string	$since = `""`,
		string	$search_text = `""`
	)

Get all notes related to a specific object.

Returns: Note[]

Definition at line 231 of file class.NoteDBRepository.php.

References ILIAS\Notes\NoteDBRepository\$db, ILIAS\Notes\NoteDBRepository\getNoteFromRecord(), ILIAS\Notes\NoteDBRepository\getQuery(), and null.

      : array {
         $db = $this->db;
 
         $query = $this->getQuery(
             null,
             $type,
             $incl_sub,
             $author,
             $ascending,
             false,
             $since,
             $obj_ids,
             $search_text
         );
 
         $set = $db->query($query);
         $notes = [];
         while ($note_rec = $db->fetchAssoc($set)) {
             $notes[] = $this->getNoteFromRecord($note_rec);
         }
         return $notes;
     }

Here is the call graph for this function:

◆ getNrOfNotesForContext()

ILIAS\Notes\NoteDBRepository::getNrOfNotesForContext	(	Context	$context,
		int	$type = `Note::PRIVATE`,
		bool	$incl_sub = `false`,
		int	$author = `0`
	)

Definition at line 262 of file class.NoteDBRepository.php.

References ILIAS\Notes\NoteDBRepository\$db, and ILIAS\Notes\NoteDBRepository\getQuery().

      : int {
         $db = $this->db;
 
         $query = $this->getQuery(
             $context,
             $type,
             $incl_sub,
             $author,
             false,
             true
         );
 
         $set = $db->query($query);
         $rec = $db->fetchAssoc($set);
         return (int) $rec["cnt"];
     }

Here is the call graph for this function:

◆ getQuery()

ILIAS\Notes\NoteDBRepository::getQuery	(	?Context	$context,
		int	$type = `Note::PRIVATE`,
		bool	$incl_sub = `false`,
		int	$author = `0`,
		bool	$ascending = `false`,
		bool	$count = `false`,
		string	$since = `""`,
		array	$obj_ids = `[]`,
		string	$search_text = `""`
	)

protected

Get query.

Returns: string

Definition at line 130 of file class.NoteDBRepository.php.

References $context, ILIAS\Notes\NoteDBRepository\$db, ILIAS\Notes\Context\getInRepository(), ILIAS\Notes\Context\getNewsId(), ILIAS\Notes\Context\getObjId(), ILIAS\Notes\Context\getSubObjId(), ILIAS\Notes\Context\getType(), and ilDBInterface\quote().

Referenced by ILIAS\Notes\NoteDBRepository\getNotesForContext(), ILIAS\Notes\NoteDBRepository\getNotesForObjIds(), and ILIAS\Notes\NoteDBRepository\getNrOfNotesForContext().

      : string {
         $db = $this->db;
 
         $author_where = ($author > 0)
             ? " AND author = " . $db->quote($author, "integer")
             : "";
 
         $sub_where = ($context)
             ? " rep_obj_id = " . $db->quote($context->getObjId(), "integer")
             : " " . $db->in("rep_obj_id", $obj_ids, false, "integer");
 
         $sub_where .= ($context && !$incl_sub)
             ? " AND note.obj_id = " . $db->quote($context->getSubObjId(), "integer") .
             " AND note.obj_type = " . $db->quote($context->getType(), "text")
             : "";
 
         if ($since !== "") {
             $sub_where .= " AND creation_date > " . $db->quote($since, "timestamp");
         }
 
         $news_where = "";
         if ($context) {
             $news_where =
                 " AND news_id = " . $db->quote($context->getNewsId(), "integer");
 
             $sub_where .= " AND no_repository = " . $db->quote(!$context->getInRepository(), "integer");
         }
 
         // search text
         $join = "";
         if ($search_text !== "") {
             $sub_where .= " AND (" . $db->like("note_text", "text", "%" . $search_text . "%");
             $join = " JOIN usr_data ud ON (author = ud.usr_id)";
             $join .= " LEFT JOIN object_data od ON (rep_obj_id = od.obj_id)";
             $sub_where .= " OR " . $db->like("ud.lastname", "text", "%" . $search_text . "%");
             $sub_where .= " OR " . $db->like("ud.firstname", "text", "%" . $search_text . "%");
             $sub_where .= " OR " . $db->like("ud.login", "text", "%" . $search_text . "%");
             $sub_where .= " OR " . $db->like("od.title", "text", "%" . $search_text . "%");
             $sub_where .= ")";
         }
 
         $fields = $count ? "count(*) cnt" : "note.*";
         $query = "SELECT $fields FROM note $join WHERE " .
             $sub_where .
             " AND note.type = " . $db->quote($type, "integer") .
             $author_where .
             $news_where .
             " ORDER BY creation_date ";
         $query .= ($ascending) ? "ASC" : "DESC";
         return $query;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRelatedObjIdsOfUser()

ILIAS\Notes\NoteDBRepository::getRelatedObjIdsOfUser	(	int	$user_id,
		int	$type
	)

Returns: int[]

Definition at line 287 of file class.NoteDBRepository.php.

References ILIAS\Notes\NoteDBRepository\$db, $q, and ILIAS\Repository\int().

      : array {
         $db = $this->db;
 
         $q = "SELECT DISTINCT rep_obj_id FROM note WHERE " .
             " type = " . $db->quote($type, "integer") .
             " AND author = " . $db->quote($user_id, "integer") .
             " AND (no_repository IS NULL OR no_repository < " . $db->quote(1, "integer") . ")";
 
         $set = $db->query($q);
         $ids = [];
         while ($rec = $db->fetchAssoc($set)) {
             $ids[] = (int) $rec["rep_obj_id"];
         }
         return $ids;
     }

Here is the call graph for this function:

◆ getUserCount()

ILIAS\Notes\NoteDBRepository::getUserCount	(	int	$obj_id,
		int	$sub_obj_id,
		string	$obj_type
	)

How many users have attached a note/comment to a given object?

Definition at line 330 of file class.NoteDBRepository.php.

References ILIAS\Notes\NoteDBRepository\$db, and ilDBInterface\queryF().

      : int {
         $db = $this->db;
 
         $set = $db->queryF(
             "SELECT count(DISTINCT author) cnt FROM note WHERE " .
             "rep_obj_id = %s AND obj_id = %s AND obj_type = %s",
             array("integer", "integer", "text"),
             array($obj_id, $sub_obj_id, $obj_type)
         );
         $rec = $db->fetchAssoc($set);
         return (int) $rec["cnt"];
     }

Here is the call graph for this function:

◆ updateNoteText()

ILIAS\Notes\NoteDBRepository::updateNoteText	(	int	$id,
		string	$text
	)

Definition at line 70 of file class.NoteDBRepository.php.

References ILIAS\Notes\NoteDBRepository\$db, and ilUtil\now().

      : void {
         $db = $this->db;
 
         $update_date = \ilUtil::now();
         $db->update("note", array(
             "note_text" => array("clob", $text),
             "update_date" => array("timestamp", $update_date),
         ), array(
             "id" => array("integer", $id)
         ));
     }

Here is the call graph for this function:

Field Documentation

◆ $data

InternalDataService ILIAS\Notes\NoteDBRepository::$data

protected

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

Referenced by ILIAS\Notes\NoteDBRepository\__construct().

◆ $db

ilDBInterface ILIAS\Notes\NoteDBRepository::$db

protected

Definition at line 28 of file class.NoteDBRepository.php.

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

components/ILIAS/Notes/Note/class.NoteDBRepository.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ countNotesAndCommentsMultipleObjects()

◆ createNote()

◆ deleteNote()

◆ filterObjectsWithNotes()

◆ getById()

◆ getNoteFromRecord()

◆ getNotesForContext()

◆ getNotesForObjIds()

◆ getNrOfNotesForContext()

◆ getQuery()

◆ getRelatedObjIdsOfUser()

◆ getUserCount()

◆ updateNoteText()

Field Documentation

◆ $data

◆ $db