Note class. More...

Collaboration diagram for ilNote:

Public Member Functions
	__construct ($a_id=0)
	constructor More...

	setId ($a_id)
	set id More...

	getId ()
	get id More...

	setObject ($a_obj_type, $a_rep_obj_id, $a_obj_id=0)
	set assigned object More...

	getObject ()

	setType ($a_type)
	set type More...

	getType ()
	get type More...

	setAuthor ($a_user_id)
	set author More...

	getAuthor ()
	get author More...

	setText ($a_text)
	set text More...

	getText ()
	get text More...

	setSubject ($a_subject)
	set subject More...

	getSubject ()
	get subject More...

	setCreationDate ($a_date)
	set creation date More...

	getCreationDate ()
	get creation date More...

	setUpdateDate ($a_date)
	set update date More...

	getUpdateDate ()
	get update date More...

	setLabel ($a_label)
	set label More...

	getLabel ()
	get label More...

	setInRepository ($a_value)
	set repository object status More...

	isInRepository ()
	belongs note to repository object? More...

	create ($a_use_provided_creation_date=false)

	update ()

	read ()

	delete ()
	delete note More...

	setAllData ($a_note_rec)
	set all note data by record array More...

	sendNotifications ($a_changed=false)
	Send notifications. More...

Static Public Member Functions
static	_lookupCreationDate ($a_id)
	lookup creation date of note More...

static	_lookupUpdateDate ($a_id)
	lookup update date of note More...

static	_getNotesOfObject ( $a_rep_obj_id, $a_obj_id, $a_obj_type, $a_type=IL_NOTE_PRIVATE, $a_incl_sub=false, $a_filter="", $a_all_public="y", $a_repository_mode=true, $a_sort_ascending=false)
	get all notes related to a specific object More...

static	_getLastNotesOfUser ()
	get last notes of current user More...

static	_getRelatedObjectsOfUser ($a_mode)
	get all related objects for user More...

static	getUserCount ($a_rep_obj_id, $a_obj_id, $a_type)
	How many users have attached a note/comment to a given object? More...

static	_countNotesAndCommentsMultiple ($a_rep_obj_ids, $a_no_sub_objs=false)
	Get all notes related to multiple objcts. More...

static	_countNotesAndComments ($a_rep_obj_id, $a_sub_obj_id=null)
	Get all notes related to a specific object. More...

static	activateComments ($a_rep_obj_id, $a_obj_id, $a_obj_type, $a_activate=true)
	Activate notes feature. More...

static	commentsActivated ($a_rep_obj_id, $a_obj_id, $a_obj_type)
	Are comments activated for object? More...

static	getRepObjActivation ($a_rep_obj_ids)
	Get activation for repository objects. More...

Protected Attributes
	$db

	$settings

	$access

Detailed Description

Note class.

Represents a single note.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 24 of file class.ilNote.php.

Constructor & Destructor Documentation

◆ __construct()

ilNote::__construct ( $a_id = 0 )

constructor

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

References $DIC, read(), and settings().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->settings = $DIC->settings();
         $this->access = $DIC->access();
         if ($a_id > 0) {
             $this->id = $a_id;
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ _countNotesAndComments()

static ilNote::_countNotesAndComments	(	$a_rep_obj_id,
		$a_sub_obj_id = `null`
	)

static

Get all notes related to a specific object.

Parameters

array	$a_rep_obj_ids	repository object IDs array
int	$a_sub_obj_id	sub objects (if null, all comments are counted)

Definition at line 684 of file class.ilNote.php.

References $DIC, $ilDB, $ilUser, array, IL_NOTE_PRIVATE, and IL_NOTE_PUBLIC.

Referenced by ilObjectListGUI\getHeaderAction(), and ilPollBlockGUI\getNumberOfComments().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
         
         $q = "SELECT count(id) c, rep_obj_id, type FROM note WHERE " .
             " ((type = " . $ilDB->quote(IL_NOTE_PRIVATE, "integer") . " AND " .
             "author = " . $ilDB->quote((int) $ilUser->getId(), "integer") . ") OR " .
             " type = " . $ilDB->quote(IL_NOTE_PUBLIC, "integer") . ") AND " .
             " rep_obj_id = " . $ilDB->quote($a_rep_obj_id, "integer");
         
         if ($a_sub_obj_id !== null) {
             $q .= " AND obj_id = " . $ilDB->quote($a_sub_obj_id, "integer");
         }
         
         $q .= " GROUP BY rep_obj_id, type ";
 
         $cnt = array();
         $set = $ilDB->query($q);
         while ($rec = $ilDB->fetchAssoc($set)) {
             $cnt[$rec["rep_obj_id"]][$rec["type"]] = $rec["c"];
         }
         
         return $cnt;
     }

Here is the caller graph for this function:

◆ _countNotesAndCommentsMultiple()

static ilNote::_countNotesAndCommentsMultiple	(	$a_rep_obj_ids,
		$a_no_sub_objs = `false`
	)

static

Get all notes related to multiple objcts.

Parameters

array	$a_rep_obj_ids	repository object IDs array
boolean	$a_no_sub_objs	include subobjects true/false

Definition at line 650 of file class.ilNote.php.

References $DIC, $ilDB, $ilUser, array, IL_NOTE_PRIVATE, and IL_NOTE_PUBLIC.

Referenced by ilObjectListGUI\preloadCommonProperties().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
         
         $q = "SELECT count(id) c, rep_obj_id, type FROM note WHERE " .
             " ((type = " . $ilDB->quote(IL_NOTE_PRIVATE, "integer") . " AND " .
             "author = " . $ilDB->quote((int) $ilUser->getId(), "integer") . ") OR " .
             " type = " . $ilDB->quote(IL_NOTE_PUBLIC, "integer") . ") AND " .
             $ilDB->in("rep_obj_id", $a_rep_obj_ids, false, "integer");
         
         if ($a_no_sub_objs) {
             $q .= " AND obj_id = " . $ilDB->quote(0, "integer");
         }
         
         $q .= " GROUP BY rep_obj_id, type ";
         
         $cnt = array();
         $set = $ilDB->query($q);
         while ($rec = $ilDB->fetchAssoc($set)) {
             $cnt[$rec["rep_obj_id"]][$rec["type"]] = $rec["c"];
         }
         
         return $cnt;
     }

Here is the caller graph for this function:

◆ _getLastNotesOfUser()

static ilNote::_getLastNotesOfUser ( )

static

get last notes of current user

Definition at line 480 of file class.ilNote.php.

References $DIC, $ilDB, $ilUser, array, and IL_NOTE_PRIVATE.

Referenced by ilPDNotesBlockGUI\fillDataSection().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
         
         $q = "SELECT * FROM note WHERE " .
             " type = " . $ilDB->quote((int) IL_NOTE_PRIVATE, "integer") .
             " AND author = " . $ilDB->quote((int) $ilUser->getId(), "integer") .
             " AND (no_repository IS NULL OR no_repository < " . $ilDB->quote(1, "integer") . ")" .
             " ORDER BY creation_date DESC";
 
         $ilDB->quote($q);
         $set = $ilDB->query($q);
         $notes = array();
         while ($note_rec = $ilDB->fetchAssoc($set)) {
             $cnt = count($notes);
             $notes[$cnt] = new ilNote();
             $notes[$cnt]->setAllData($note_rec);
         }
         
         return $notes;
     }

Here is the caller graph for this function:

◆ _getNotesOfObject()

static ilNote::_getNotesOfObject	(	$a_rep_obj_id,
		$a_obj_id,
		$a_obj_type,
		$a_type = `IL_NOTE_PRIVATE`,
		$a_incl_sub = `false`,
		$a_filter = `""`,
		$a_all_public = `"y"`,
		$a_repository_mode = `true`,
		$a_sort_ascending = `false`
	)

static

get all notes related to a specific object

Definition at line 420 of file class.ilNote.php.

References $a_type, $DIC, $ilDB, $ilUser, array, and IL_NOTE_PRIVATE.

Referenced by ilDclBaseRecordModel\getComments(), ilNoteGUI\getNoteListHTML(), ilDclBaseRecordModel\getStandardFieldPlainText(), and ilObjBlogGUI\renderList().

       {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
         
         $author_where = ($a_type == IL_NOTE_PRIVATE || $a_all_public == "n")
             ? " AND author = " . $ilDB->quote((int) $ilUser->getId(), "integer")
             : "";
 
         $sub_where = (!$a_incl_sub)
             ? " AND obj_id = " . $ilDB->quote((int) $a_obj_id, "integer") .
               " AND obj_type = " . $ilDB->quote((string) $a_obj_type, "text")
             : "";
         
         if (!$a_repository_mode) {
             $sub_where .= " AND no_repository = " . $ilDB->quote(1, "integer");
         }
         
         $q = "SELECT * FROM note WHERE " .
             " rep_obj_id = " . $ilDB->quote((int) $a_rep_obj_id, "integer") .
             $sub_where .
             " AND type = " . $ilDB->quote((int) $a_type, "integer") .
             $author_where .
             " ORDER BY creation_date ";
         
         $q .= ((bool) $a_sort_ascending) ? "ASC" : "DESC";
         
         $set = $ilDB->query($q);
         $notes = array();
         while ($note_rec = $ilDB->fetchAssoc($set)) {
             if ($a_filter != "") {
                 if (!is_array($a_filter)) {
                     $a_filter = array($a_filter);
                 }
                 if (!in_array($note_rec["id"], $a_filter)) {
                     continue;
                 }
             }
             $cnt = count($notes);
             $notes[$cnt] = new ilNote();
             $notes[$cnt]->setAllData($note_rec);
         }
         
         return $notes;
     }

Here is the caller graph for this function:

◆ _getRelatedObjectsOfUser()

static ilNote::_getRelatedObjectsOfUser ( $a_mode )

static

get all related objects for user

Definition at line 508 of file class.ilNote.php.

References $DIC, $ilDB, $ilUser, $r, $type, ilObject\_getAllReferences(), ilObjUser\_lookupDesktopItems(), ilObject\_lookupType(), array, commentsActivated(), IL_NOTE_PRIVATE, IL_NOTE_PUBLIC, ilWorkspaceTree\lookupNodeId(), and ilPDNotesGUI\PRIVATE_NOTES.

Referenced by ilPDNotesGUI\view().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
         $tree = $DIC->repositoryTree();
         
         if ($a_mode == ilPDNotesGUI::PRIVATE_NOTES) {
             $q = "SELECT DISTINCT rep_obj_id FROM note WHERE " .
                 " type = " . $ilDB->quote((int) IL_NOTE_PRIVATE, "integer") .
                 " AND author = " . $ilDB->quote($ilUser->getId(), "integer") .
                 " AND (no_repository IS NULL OR no_repository < " . $ilDB->quote(1, "integer") . ")" .
                 " ORDER BY rep_obj_id";
     
             $ilDB->quote($q);
             $set = $ilDB->query($q);
             $reps = array();
             while ($rep_rec = $ilDB->fetchAssoc($set)) {
                 // #9343: deleted objects
                 if (ilObject::_lookupType($rep_rec["rep_obj_id"])) {
                     $reps[] = array("rep_obj_id" => $rep_rec["rep_obj_id"]);
                 }
             }
         } else {
             // all objects where the user wrote at least one comment
             $q = "SELECT DISTINCT rep_obj_id FROM note WHERE " .
                 " type = " . $ilDB->quote((int) IL_NOTE_PUBLIC, "integer") .
                 " AND author = " . $ilDB->quote($ilUser->getId(), "integer") .
                 " AND (no_repository IS NULL OR no_repository < " . $ilDB->quote(1, "integer") . ")" .
                 " ORDER BY rep_obj_id";
 
             $set = $ilDB->query($q);
             $reps = array();
             while ($rep_rec = $ilDB->fetchAssoc($set)) {
                 // #9343: deleted objects
                 if ($type = ilObject::_lookupType($rep_rec["rep_obj_id"])) {
                     if (ilNote::commentsActivated($rep_rec["rep_obj_id"], "", $type)) {
                         $reps[] = array("rep_obj_id" => $rep_rec["rep_obj_id"]);
                     }
                 }
             }
             
             // additionally all objects on the personal desktop of the user
             // that have at least on comment
             $dis = ilObjUser::_lookupDesktopItems($ilUser->getId());
             $obj_ids = array();
             foreach ($dis as $di) {
                 $obj_ids[] = $di["obj_id"];
             }
             if (count($obj_ids) > 0) {
                 $q = "SELECT DISTINCT rep_obj_id FROM note WHERE " .
                     $ilDB->in("rep_obj_id", $obj_ids, false, "integer") .
                     " AND (no_repository IS NULL OR no_repository < " . $ilDB->quote(1, "integer") . ")";
 
                 $set = $ilDB->query($q);
                 while ($rec = $ilDB->fetchAssoc($set)) {
                     $add = true;
                     reset($reps);
                     foreach ($reps as $r) {
                         if ($r["rep_obj_id"] == $rec["rep_obj_id"]) {
                             $add = false;
                         }
                     }
                     if ($add) {
                         $type = ilObject::_lookupType($rec["rep_obj_id"]);
                         if (ilNote::commentsActivated($rec["rep_obj_id"], "", $type)) {
                             $reps[] = array("rep_obj_id" => $rec["rep_obj_id"]);
                         }
                     }
                 }
             }
         }
                 
         if (sizeof($reps)) {
             // check if notes/comments belong to objects in trash
             // see ilNoteGUI::showTargets()
             foreach ($reps as $idx => $rep) {
                 $has_active_ref = false;
                 
                 // repository?
                 $ref_ids = ilObject::_getAllReferences($rep["rep_obj_id"]);
                 if ($ref_ids) {
                     $reps[$idx]["ref_ids"] = array_values($ref_ids);
                     
                     foreach ($ref_ids as $ref_id) {
                         if (!$tree->isDeleted($ref_id)) {
                             $has_active_ref = true;
                             break;
                         }
                     }
                 } else {
                     // personal workspace?
                     include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
                     include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceAccessHandler.php";
                     $wsp_tree = new ilWorkspaceTree($ilUser->getId());
                     $node_id = $wsp_tree->lookupNodeId($rep["rep_obj_id"]);
                     if ($node_id) {
                         $reps[$idx]["wsp_id"] = $node_id;
                         
                         $has_active_ref = true;
                     }
                 }
                 
                 if (!$has_active_ref) {
                     unset($reps[$idx]);
                 }
             }
         }
         
         return $reps;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupCreationDate()

static ilNote::_lookupCreationDate ( $a_id )

static

lookup creation date of note

Definition at line 386 of file class.ilNote.php.

References $DIC, and $ilDB.

Referenced by create().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $q = "SELECT * FROM note WHERE id = " .
             $ilDB->quote((int) $a_id, "integer");
         $set = $ilDB->query($q);
         $note_rec = $ilDB->fetchAssoc($set);
 
         return $note_rec["creation_date"];
     }

Here is the caller graph for this function:

◆ _lookupUpdateDate()

static ilNote::_lookupUpdateDate ( $a_id )

static

lookup update date of note

Definition at line 403 of file class.ilNote.php.

References $DIC, and $ilDB.

Referenced by update().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $q = "SELECT * FROM note WHERE id = " .
             $ilDB->quote((int) $a_id, "integer");
         $set = $ilDB->query($q);
         $note_rec = $ilDB->fetchAssoc($set);
 
         return $note_rec["update_date"];
     }

Here is the caller graph for this function:

◆ activateComments()

static ilNote::activateComments	(	$a_rep_obj_id,
		$a_obj_id,
		$a_obj_type,
		$a_activate = `true`
	)

static

Activate notes feature.

Parameters

Definition at line 718 of file class.ilNote.php.

References $DIC, and $ilDB.

Referenced by ilNoteGUI\activateComments(), ilObjContentObject\createProperties(), ilNoteGUI\deactivateComments(), ilObjBlog\doCreate(), ilObjBlog\doUpdate(), ilObjPortfolioBase\doUpdate(), ilObjPoll\doUpdate(), ilLearningModuleDataSet\importRecord(), and ilObjContentObject\updateProperties().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         if ($a_obj_type == "") {
             $a_obj_type = "-";
         }
         $set = $ilDB->query(
             "SELECT * FROM note_settings " .
             " WHERE rep_obj_id = " . $ilDB->quote((int) $a_rep_obj_id, "integer") .
             " AND obj_id = " . $ilDB->quote((int) $a_obj_id, "integer") .
             " AND obj_type = " . $ilDB->quote($a_obj_type, "text")
         );
         if ($rec = $ilDB->fetchAssoc($set)) {
             if (($rec["activated"] == 0 && $a_activate) ||
                 ($rec["activated"] == 1 && !$a_activate)) {
                 $ilDB->manipulate(
                     "UPDATE note_settings SET " .
                     " activated = " . $ilDB->quote((int) $a_activate, "integer") .
                     " WHERE rep_obj_id = " . $ilDB->quote((int) $a_rep_obj_id, "integer") .
                     " AND obj_id = " . $ilDB->quote((int) $a_obj_id, "integer") .
                     " AND obj_type = " . $ilDB->quote($a_obj_type, "text")
                 );
             }
         } else {
             if ($a_activate) {
                 $q = "INSERT INTO note_settings " .
                     "(rep_obj_id, obj_id, obj_type, activated) VALUES (" .
                     $ilDB->quote((int) $a_rep_obj_id, "integer") . "," .
                     $ilDB->quote((int) $a_obj_id, "integer") . "," .
                     $ilDB->quote($a_obj_type, "text") . "," .
                     $ilDB->quote(1, "integer") .
                     ")";
                 $ilDB->manipulate($q);
             }
         }
     }

Here is the caller graph for this function:

◆ commentsActivated()

static ilNote::commentsActivated	(	$a_rep_obj_id,
		$a_obj_id,
		$a_obj_type
	)

static

Are comments activated for object?

Parameters

Definition at line 764 of file class.ilNote.php.

References $DIC, and $ilDB.

Referenced by ilNoteGUI\__construct(), _getRelatedObjectsOfUser(), ilObjBlog\doRead(), ilObjPortfolioBase\doRead(), ilObjPoll\doRead(), ilNoteGUI\getNotesHTML(), ilPortfolioDataSet\getXmlRecord(), ilPollDataSet\getXmlRecord(), ilBlogDataSet\getXmlRecord(), ilObjectGUI\initHeaderAction(), ilObjectListGUI\isCommentsActivated(), ilLearningModuleDataSet\readData(), and ilObjContentObject\readProperties().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         if ($a_obj_type == "") {
             $a_obj_type = "-";
         }
         $set = $ilDB->query(
             "SELECT * FROM note_settings " .
             " WHERE rep_obj_id = " . $ilDB->quote((int) $a_rep_obj_id, "integer") .
             " AND obj_id = " . $ilDB->quote((int) $a_obj_id, "integer") .
             " AND obj_type = " . $ilDB->quote($a_obj_type, "text")
         );
         $rec = $ilDB->fetchAssoc($set);
         return $rec["activated"];
     }

Here is the caller graph for this function:

◆ create()

ilNote::create ( $a_use_provided_creation_date = false )

Definition at line 265 of file class.ilNote.php.

References $db, $ilDB, _lookupCreationDate(), array, getCreationDate(), getId(), ilUtil\now(), and sendNotifications().

     {
         $ilDB = $this->db;
         
         $cd = ($a_use_provided_creation_date)
             ? $this->getCreationDate()
             : ilUtil::now();
         
         $this->id = $ilDB->nextId("note");
         /*$q = "INSERT INTO note (id, rep_obj_id, obj_id, obj_type, type,".
             "author, note_text, subject, label, creation_date) VALUES (".
             $ilDB->quote($this->id, "integer").",".
             $ilDB->quote((int) $this->rep_obj_id, "integer").",".
             $ilDB->quote((int) $this->obj_id, "integer").",".
             $ilDB->quote((string) $this->obj_type, "text").",".
             $ilDB->quote((int) $this->type, "integer").",".
             $ilDB->quote((int) $this->author, "integer").",".
             $ilDB->quote((string) $this->text, "clob").",".
             $ilDB->quote((string) $this->subject, "text").",".
             $ilDB->quote((int) $this->label, "integer").",".
             $ilDB->now().")";
         $ilDB->manipulate($q);*/
         
         $ilDB->insert("note", array(
             "id" => array("integer", $this->id),
             "rep_obj_id" => array("integer", (int) $this->rep_obj_id),
             "obj_id" => array("integer", (int) $this->obj_id),
             "obj_type" => array("text", (string) $this->obj_type),
             "type" => array("integer", (int) $this->type),
             "author" => array("integer", (int) $this->author),
             "note_text" => array("clob", (string) $this->text),
             "subject" => array("text", (string) $this->subject),
             "label" => array("integer", (int) $this->label),
             "creation_date" => array("timestamp", $cd),
             "no_repository" => array("integer", $this->no_repository)
             ));
 
         $this->sendNotifications();
         
         $this->creation_date = ilNote::_lookupCreationDate($this->getId());
     }

Here is the call graph for this function:

◆ delete()

ilNote::delete ( )

delete note

Definition at line 357 of file class.ilNote.php.

References $db, $ilDB, and getId().

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

Here is the call graph for this function:

◆ getAuthor()

ilNote::getAuthor ( )

get author

Returns: int user id

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

Referenced by sendNotifications().

     {
         return $this->author;
     }

Here is the caller graph for this function:

◆ getCreationDate()

ilNote::getCreationDate ( )

get creation date

Returns: string creation date

Definition at line 198 of file class.ilNote.php.

Referenced by create().

     {
         return $this->creation_date;
     }

Here is the caller graph for this function:

◆ getId()

ilNote::getId ( )

get id

Returns: int note id

Definition at line 73 of file class.ilNote.php.

References $id.

Referenced by create(), delete(), read(), and update().

     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getLabel()

ilNote::getLabel ( )

get label

Returns: int IL_NOTE_UNLABELED | IL_NOTE_IMPORTANT | IL_NOTE_QUESTION | IL_NOTE_PRO | IL_NOTE_CONTRA

Definition at line 240 of file class.ilNote.php.

     {
         return $this->label;
     }

◆ getObject()

ilNote::getObject ( )

Definition at line 95 of file class.ilNote.php.

References array.

Referenced by sendNotifications().

     {
         return array("rep_obj_id" => $this->rep_obj_id,
             "obj_id" => $this->obj_id,
             "obj_type" => $this->obj_type);
     }

Here is the caller graph for this function:

◆ getRepObjActivation()

static ilNote::getRepObjActivation ( $a_rep_obj_ids )

static

Get activation for repository objects.

Parameters

Definition at line 789 of file class.ilNote.php.

References $DIC, $ilDB, and array.

Referenced by ilObjectListGUI\preloadCommonProperties().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $set = $ilDB->query("SELECT * FROM note_settings " .
             " WHERE " . $ilDB->in("rep_obj_id", $a_rep_obj_ids, false, "integer") .
             " AND obj_id = 0 ");
         $activations = array();
         while ($rec = $ilDB->fetchAssoc($set)) {
             if ($rec["activated"]) {
                 $activations[$rec["rep_obj_id"]][$rec["obj_type"]] = true;
             }
         }
 
         return $activations;
     }

Here is the caller graph for this function:

◆ getSubject()

ilNote::getSubject ( )

get subject

Returns: string subject

Definition at line 178 of file class.ilNote.php.

     {
         return $this->subject;
     }

◆ getText()

ilNote::getText ( )

get text

Returns: string text

Definition at line 158 of file class.ilNote.php.

References $text.

Referenced by sendNotifications().

     {
         return $this->text;
     }

Here is the caller graph for this function:

◆ getType()

ilNote::getType ( )

get type

Returns: int IL_NOTE_PUBLIC | IL_NOTE_PRIVATE

Definition at line 118 of file class.ilNote.php.

References $type.

Referenced by sendNotifications().

     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ getUpdateDate()

ilNote::getUpdateDate ( )

get update date

Returns: string update date

Definition at line 218 of file class.ilNote.php.

     {
         return $this->update_date;
     }

◆ getUserCount()

static ilNote::getUserCount	(	$a_rep_obj_id,
		$a_obj_id,
		$a_type
	)

static

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

Parameters

int	$a_rep_obj_id	object id (as in object data)
int	$a_obj_id	(sub) object id
string	$a_type	(sub) object type

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

References $a_type, $DIC, $ilDB, and array.

Referenced by ilBlogPostingGUI\deleteBlogPostingConfirmationScreen(), and ilWikiPageGUI\deleteWikiPageConfirmationScreen().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $set = $ilDB->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((int) $a_rep_obj_id, (int) $a_obj_id, (string) $a_type)
         );
         $rec = $ilDB->fetchAssoc($set);
         return (int) $rec["cnt"];
     }

Here is the caller graph for this function:

◆ isInRepository()

ilNote::isInRepository ( )

belongs note to repository object?

Returns: bool

Definition at line 260 of file class.ilNote.php.

     {
         return !$this->no_repository;
     }

◆ read()

ilNote::read ( )

Definition at line 343 of file class.ilNote.php.

References $db, $ilDB, getId(), and setAllData().

Referenced by __construct().

     {
         $ilDB = $this->db;
         
         $q = "SELECT * FROM note WHERE id = " .
             $ilDB->quote((int) $this->getId(), "integer");
         $set = $ilDB->query($q);
         $note_rec = $ilDB->fetchAssoc($set);
         $this->setAllData($note_rec);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendNotifications()

ilNote::sendNotifications ( $a_changed = false )

Send notifications.

Definition at line 812 of file class.ilNote.php.

References $access, $ilSetting, $message, $r, $settings, $title, $type, ilObject\_getAllReferences(), ilLanguageFactory\_getLanguageOfUser(), ilLink\_getLink(), ilLink\_getStaticLink(), ilObjUser\_lookupFullname(), ilObjUser\_lookupId(), ilObjUser\_lookupLogin(), ilObject\_lookupTitle(), array, getAuthor(), ilUserUtil\getNamePresentation(), getObject(), getText(), getType(), IL_NOTE_PRIVATE, ilWikiPage\lookupTitle(), and ilWikiUtil\makeUrlTitle().

Referenced by create(), and update().

     {
         $ilSetting = $this->settings;
         $ilAccess = $this->access;
 
         // no notifications for notes
         if ($this->getType() == IL_NOTE_PRIVATE) {
             return;
         }
 
         $recipients = $ilSetting->get("comments_noti_recip");
         $recipients = explode(",", $recipients);
 
         // blog: blog_id, 0, "blog"
         // lm: lm_id, page_id, "pg" (ok)
         // sahs: sahs_id, node_id, node_type
         // info_screen: obj_id, 0, obj_type (ok)
         // portfolio: port_id, page_id, "portfolio_page" (ok)
         // wiki: wiki_id, wiki_page_id, "wpg" (ok)
 
         $obj = $this->getObject();
         $rep_obj_id = $obj["rep_obj_id"];
         $sub_obj_id = $obj["obj_id"];
         $type = $obj["obj_type"];
 
         include_once("./Services/Language/classes/class.ilLanguageFactory.php");
         include_once("./Services/User/classes/class.ilUserUtil.php");
         include_once("./Services/Mail/classes/class.ilMail.php");
 
         // repository objects, no blogs
         $ref_ids = array();
         if (($sub_obj_id == 0 and $type != "blp") ||
             in_array($type, array("pg", "wpg"))) {
             $obj_title = ilObject::_lookupTitle($rep_obj_id);
             $type_lv = "obj_" . $type;
             $ref_ids = ilObject::_getAllReferences($rep_obj_id);
         }
 
         if ($type == "wpg") {
             $type_lv = "obj_wiki";
         }
         if ($type == "pg") {
             $type_lv = "obj_lm";
         }
         if ($type == "blp") {
             $obj_title = ilObject::_lookupTitle($rep_obj_id);
             $type_lv = "obj_blog";
         }
         if ($type == "pfpg") {
             $obj_title = ilObject::_lookupTitle($rep_obj_id);
             $type_lv = "portfolio";
         }
         if ($type == "dcl") {
             $obj_title = ilObject::_lookupTitle($rep_obj_id);
             $type_lv = "obj_dcl";
         }
 
         include_once("./Services/Link/classes/class.ilLink.php");
         foreach ($recipients as $r) {
             $login = trim($r);
             if (($user_id = ilObjUser::_lookupId($login)) > 0) {
                 $link = "";
                 foreach ($ref_ids as $r) {
                     if ($ilAccess->checkAccessOfUser($user_id, "read", "", $r)) {
                         if ($sub_obj_id == 0 and $type != "blog") {
                             $link = ilLink::_getLink($r);
                         } elseif ($type == "wpg") {
                             include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
                             include_once("./Modules/Wiki/classes/class.ilWikiUtil.php");
                             $title = ilWikiPage::lookupTitle($sub_obj_id);
                             $link = ilLink::_getStaticLink(
                                 $r,
                                 "wiki",
                                 true,
                                 "_" . ilWikiUtil::makeUrlTitle($title)
                             );
                         } elseif ($type == "pg") {
                             $link = ILIAS_HTTP_PATH . '/goto.php?client_id=' . CLIENT_ID . "&target=pg_" . $sub_obj_id . "_" . $r;
                         }
                     }
                 }
                 if ($type == "blp") {
                     // todo
                 }
                 if ($type == "pfpg") {
                     $link = ILIAS_HTTP_PATH . '/goto.php?client_id=' . CLIENT_ID . "&target=prtf_" . $rep_obj_id;
                 }
 
                 // use language of recipient to compose message
                 $ulng = ilLanguageFactory::_getLanguageOfUser($user_id);
                 $ulng->loadLanguageModule('note');
 
                 if ($a_changed) {
                     $subject = sprintf($ulng->txt('note_comment_notification_subjectc'), $obj_title . " (" . $ulng->txt($type_lv) . ")");
                 } else {
                     $subject = sprintf($ulng->txt('note_comment_notification_subject'), $obj_title . " (" . $ulng->txt($type_lv) . ")");
                 }
                 $message = sprintf($ulng->txt('note_comment_notification_salutation'), ilObjUser::_lookupFullname($user_id)) . "\n\n";
 
                 $message.= sprintf($ulng->txt('note_comment_notification_user_has_written'), ilUserUtil::getNamePresentation($this->getAuthor())) . "\n\n";
 
                 $message .= $this->getText() . "\n\n";
 
                 if ($link != "") {
                     $message .= $ulng->txt('note_comment_notification_link') . ": " . $link . "\n\n";
                 }
 
                 $message .= $ulng->txt('note_comment_notification_reason') . "\n\n";
 
                 $mail_obj = new ilMail(ANONYMOUS_USER_ID);
                 $mail_obj->appendInstallationSignature(true);
                 $mail_obj->sendMail(
                     ilObjUser::_lookupLogin($user_id),
                     "",
                     "",
                     $subject,
                     $message,
                     array(),
                     array("system")
                 );
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAllData()

ilNote::setAllData ( $a_note_rec )

set all note data by record array

Definition at line 369 of file class.ilNote.php.

References setAuthor(), setCreationDate(), setId(), setInRepository(), setLabel(), setObject(), setSubject(), setText(), setType(), and setUpdateDate().

Referenced by read().

     {
         $this->setId($a_note_rec["id"]);
         $this->setObject($a_note_rec["obj_type"], $a_note_rec["rep_obj_id"], $a_note_rec["obj_id"]);
         $this->setType($a_note_rec["type"]);
         $this->setAuthor($a_note_rec["author"]);
         $this->setText($a_note_rec["note_text"]);
         $this->setSubject($a_note_rec["subject"]);
         $this->setLabel($a_note_rec["label"]);
         $this->setCreationDate($a_note_rec["creation_date"]);
         $this->setUpdateDate($a_note_rec["update_date"]);
         $this->setInRepository(!(bool) $a_note_rec["no_repository"]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAuthor()

ilNote::setAuthor ( $a_user_id )

set author

Parameters

int	author user id

Definition at line 128 of file class.ilNote.php.

Referenced by setAllData().

     {
         $this->author = $a_user_id;
     }

Here is the caller graph for this function:

◆ setCreationDate()

ilNote::setCreationDate ( $a_date )

set creation date

Parameters

string creation date

Definition at line 188 of file class.ilNote.php.

Referenced by setAllData().

     {
         $this->creation_date = $a_date;
     }

Here is the caller graph for this function:

◆ setId()

ilNote::setId ( $a_id )

set id

Parameters

int note id

Definition at line 63 of file class.ilNote.php.

Referenced by setAllData().

     {
         $this->id = $a_id;
     }

Here is the caller graph for this function:

◆ setInRepository()

ilNote::setInRepository ( $a_value )

set repository object status

Parameters

bool

Definition at line 250 of file class.ilNote.php.

Referenced by setAllData().

     {
         return $this->no_repository = !(bool) $a_value;
     }

Here is the caller graph for this function:

◆ setLabel()

ilNote::setLabel ( $a_label )

set label

Parameters

int	IL_NOTE_UNLABELED \| IL_NOTE_IMPORTANT \| IL_NOTE_QUESTION \| IL_NOTE_PRO \| IL_NOTE_CONTRA

Definition at line 229 of file class.ilNote.php.

Referenced by setAllData().

     {
         return $this->label = $a_label;
     }

Here is the caller graph for this function:

◆ setObject()

ilNote::setObject	(	$a_obj_type,
		$a_rep_obj_id,
		$a_obj_id = `0`
	)

set assigned object

Parameters

$a_type	string type of the object (e.g st,pg,crs ...)
$a_rep_obj_id	int object id (NOT ref_id!) of repository object (e.g for page objects the obj_id of the learning module; for personal desktop this is set to 0)
$a_obj_id	int object id (e.g for page objects the obj_id of the page object) for, this is set to 0 for normal repository objects like forums ...

Definition at line 88 of file class.ilNote.php.

Referenced by setAllData().

     {
         $this->rep_obj_id = $a_rep_obj_id;
         $this->obj_id = $a_obj_id;
         $this->obj_type = $a_obj_type;
     }

Here is the caller graph for this function:

◆ setSubject()

ilNote::setSubject ( $a_subject )

set subject

Parameters

string text

Definition at line 168 of file class.ilNote.php.

Referenced by setAllData().

     {
         $this->subject = $a_subject;
     }

Here is the caller graph for this function:

◆ setText()

ilNote::setText ( $a_text )

set text

Parameters

string text

Definition at line 148 of file class.ilNote.php.

Referenced by setAllData().

     {
         $this->text = $a_text;
     }

Here is the caller graph for this function:

◆ setType()

ilNote::setType ( $a_type )

set type

Parameters

int	IL_NOTE_PUBLIC \| IL_NOTE_PRIVATE

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

References $a_type.

Referenced by setAllData().

     {
         $this->type = $a_type;
     }

Here is the caller graph for this function:

◆ setUpdateDate()

ilNote::setUpdateDate ( $a_date )

set update date

Parameters

string update date

Definition at line 208 of file class.ilNote.php.

Referenced by setAllData().

     {
         $this->update_date = $a_date;
     }

Here is the caller graph for this function:

◆ update()

ilNote::update ( )

Definition at line 307 of file class.ilNote.php.

References $db, $ilDB, _lookupUpdateDate(), array, getId(), ilUtil\now(), and sendNotifications().

     {
         $ilDB = $this->db;
         
         /*$q = "UPDATE note SET ".
             "rep_obj_id = ".$ilDB->quote((int) $this->rep_obj_id, "integer").",".
             "obj_id = ".$ilDB->quote((int) $this->obj_id, "integer").",".
             "obj_type = ".$ilDB->quote((string) $this->obj_type, "text").",".
             "type = ".$ilDB->quote((int) $this->type, "integer").",".
             "author = ".$ilDB->quote((int) $this->author,"integer").",".
             "note_text = ".$ilDB->quote((string) $this->text, "clob").",".
             "subject = ".$ilDB->quote((string) $this->subject, "text").",".
             "update_date = ".$ilDB->now().",".
             "label = ".$ilDB->quote((int) $this->label, "integer").
             "WHERE id =".$ilDB->quote((int) $this->getId(), "integer");
         $ilDB->manipulate($q);*/
         $ilDB->update("note", array(
             "rep_obj_id" => array("integer", (int) $this->rep_obj_id),
             "obj_id" => array("integer", (int) $this->obj_id),
             "obj_type" => array("text", (string) $this->obj_type),
             "type" => array("integer", (int) $this->type),
             "author" => array("integer", (int) $this->author),
             "note_text" => array("clob", (string) $this->text),
             "subject" => array("text", (string) $this->subject),
             "label" => array("integer", (int) $this->label),
             "update_date" => array("timestamp", ilUtil::now()),
             "no_repository" => array("integer", $this->no_repository)
             ), array(
             "id" => array("integer", $this->getId())
             ));
         
         $this->update_date = ilNote::_lookupUpdateDate($this->getId());
 
         $this->sendNotifications(true);
     }

Here is the call graph for this function:

Field Documentation

◆ $access

ilNote::$access

protected

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

Referenced by sendNotifications().

◆ $db

ilNote::$db

protected

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

Referenced by create(), delete(), read(), and update().

◆ $settings

ilNote::$settings

protected

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

Referenced by sendNotifications().

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

Services/Notes/classes/class.ilNote.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _countNotesAndComments()

◆ _countNotesAndCommentsMultiple()

◆ _getLastNotesOfUser()

◆ _getNotesOfObject()

◆ _getRelatedObjectsOfUser()

◆ _lookupCreationDate()

◆ _lookupUpdateDate()

◆ activateComments()

◆ commentsActivated()

◆ create()

◆ delete()

◆ getAuthor()

◆ getCreationDate()

◆ getId()

◆ getLabel()

◆ getObject()

◆ getRepObjActivation()

◆ getSubject()

◆ getText()

◆ getType()

◆ getUpdateDate()

◆ getUserCount()

◆ isInRepository()

◆ read()

◆ sendNotifications()

◆ setAllData()

◆ setAuthor()

◆ setCreationDate()

◆ setId()

◆ setInRepository()

◆ setLabel()

◆ setObject()

◆ setSubject()

◆ setText()

◆ setType()

◆ setUpdateDate()

◆ update()

Field Documentation

◆ $access

◆ $db

◆ $settings