Collaboration diagram for ILIAS\Notes\NotesManager:

Public Member Functions
	__construct (InternalDataService $data, InternalRepoService $repo, InternalDomainService $domain)

	setSortAscending (bool $asc)

	getSortAscending ()

	createNote (Note $note, array $observer, bool $use_provided_creation_date=false)

	deleteNote (Note $note, int $user_id, $public_deletion_enabled=false)

	updateNoteText (int $id, string $text, array $observer)

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

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

	getNotesForRepositoryObjIds (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 repository object. More...

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

	getRelatedObjectsOfUser (int $type)
	Get all untrashed objects that have either notes/comments of the user attached, or are favourites of the user and have at least one comment (of any user) More...

	getById (int $id)

	commentsActive (int $obj_id)
	Are comments activated for object? More...

	commentsActiveMultiple (array $obj_ids)

	activateComments (int $obj_id, bool $a_activate=true)
	Activate notes feature. More...

	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, bool $no_sub_objs=false)
	Get all notes related to multiple repository objects (current user) More...

Protected Attributes
NotificationsManager	$notification

AccessManager	$note_access

NoteSettingsDBRepository	$db_settings_repo

NoteDBRepository	$db_repo

InternalDomainService	$domain

InternalRepoService	$repo

InternalDataService	$data

NotesSessionRepository	$sess_repo

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Notes\NotesManager::__construct	(	InternalDataService	$data,
		InternalRepoService	$repo,
		InternalDomainService	$domain
	)

Definition at line 37 of file class.NotesManager.php.

References ILIAS\Notes\NotesManager\$data, ILIAS\Notes\NotesManager\$domain, ILIAS\Notes\NotesManager\$repo, and ILIAS\UI\examples\Symbol\Glyph\Notification\notification().

       {
         $this->data = $data;
         $this->repo = $repo;
         $this->domain = $domain;
         $this->sess_repo = $repo->notesSession();
         $this->db_repo = $repo->note();
         $this->db_settings_repo = $repo->settings();
         $this->note_access = $domain->noteAccess();
         $this->notification = $domain->notification();
     }

Here is the call graph for this function:

Member Function Documentation

◆ activateComments()

ILIAS\Notes\NotesManager::activateComments	(	int	$obj_id,
		bool	$a_activate = `true`
	)

Activate notes feature.

Definition at line 261 of file class.NotesManager.php.

References ilObject\_lookupType().

      : void {
         $this->db_settings_repo->activateComments(
             $obj_id,
             0,
             \ilObject::_lookupType($obj_id),
             $a_activate
         );
     }

Here is the call graph for this function:

◆ commentsActive()

ILIAS\Notes\NotesManager::commentsActive ( int $obj_id )

Are comments activated for object?

Definition at line 246 of file class.NotesManager.php.

Referenced by ILIAS\Notes\NotesManager\getRelatedObjectsOfUser().

      : bool {
         return $this->db_settings_repo->commentsActive($obj_id);
     }

Here is the caller graph for this function:

◆ commentsActiveMultiple()

ILIAS\Notes\NotesManager::commentsActiveMultiple ( array $obj_ids )

Definition at line 252 of file class.NotesManager.php.

      : array {
         return $this->db_settings_repo->commentsActiveMultiple($obj_ids);
     }

◆ countNotesAndCommentsMultipleObjects()

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

Get all notes related to multiple repository objects (current user)

Todo:: see comment in db repo class

Definition at line 288 of file class.NotesManager.php.

      : array {
         return $this->db_repo->countNotesAndCommentsMultipleObjects(
             $obj_ids,
             $this->domain->user()->getId(),
             $no_sub_objs
         );
     }

◆ createNote()

ILIAS\Notes\NotesManager::createNote	(	Note	$note,
		array	$observer,
		bool	$use_provided_creation_date = `false`
	)

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

References ILIAS\UI\examples\Symbol\Glyph\Notification\notification(), ilUtil\now(), and ILIAS\Notes\Note\withCreationDate().

      : void {
         if (!$use_provided_creation_date) {
             $note = $note->withCreationDate(\ilUtil::now());
         }
         $note = $this->db_repo->createNote($note);
         $this->notification->sendNotifications($note, false);
         $this->notification->notifyObserver($observer, "new", $note);
     }

Here is the call graph for this function:

◆ deleteNote()

ILIAS\Notes\NotesManager::deleteNote	(	Note	$note,
		int	$user_id,
			$public_deletion_enabled = `false`
	)

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

References ILIAS\Notes\Note\getId().

                                                                                           : void
     {
         if ($this->note_access->canDelete($note, $user_id, $public_deletion_enabled)) {
             $this->db_repo->deleteNote($note->getId());
         }
     }

Here is the call graph for this function:

◆ getById()

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

Exceptions

NoteNotFoundException

Definition at line 238 of file class.NotesManager.php.

                                     : Note
     {
         return $this->db_repo->getById($id);
     }

◆ getNotesForContext()

ILIAS\Notes\NotesManager::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 context.

Returns: Note[]

Definition at line 100 of file class.NotesManager.php.

      : array {
         return $this->db_repo->getNotesForContext(
             $context,
             $type,
             $incl_sub,
             $author,
             $ascending,
             $since,
             $search_text
         );
     }

◆ getNotesForRepositoryObjId()

ILIAS\Notes\NotesManager::getNotesForRepositoryObjId	(	int	$obj_id,
		int	$type = `Note::PRIVATE`,
		bool	$incl_sub = `false`,
		int	$author = `0`,
		bool	$ascending = `false`,
		string	$since = `""`
	)

Get all notes related to a specific repository object.

Returns: Note[]

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

References $context.

      : array {
         $context = $this->data->context(
             $obj_id,
             0,
             ""
         );
         return $this->db_repo->getNotesForContext(
             $context,
             $type,
             $incl_sub,
             $author,
             $ascending,
             $since
         );
     }

◆ getNotesForRepositoryObjIds()

ILIAS\Notes\NotesManager::getNotesForRepositoryObjIds	(	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 repository object.

Parameters

array $obj_ids

Returns: Note[]

Definition at line 152 of file class.NotesManager.php.

      : array {
         return $this->db_repo->getNotesForObjIds(
             $obj_ids,
             $type,
             $incl_sub,
             $author,
             $ascending,
             $since,
             $search_text
         );
     }

◆ getNrOfNotesForContext()

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

Definition at line 173 of file class.NotesManager.php.

      : int {
         return $this->db_repo->getNrOfNotesForContext(
             $context,
             $type,
             $incl_sub,
             $author
         );
     }

◆ getRelatedObjectsOfUser()

ILIAS\Notes\NotesManager::getRelatedObjectsOfUser ( int $type )

Get all untrashed objects that have either notes/comments of the user attached, or are favourites of the user and have at least one comment (of any user)

Parameters

int $type Note::PRIVATE | Note::PUBLIC

Returns: int[]

Definition at line 193 of file class.NotesManager.php.

References $id, $user_id, ilObject\_hasUntrashedReference(), ILIAS\Notes\NotesManager\commentsActive(), and ILIAS\Notes\Note\PUBLIC.

                                                       : array
     {
         $tree = $this->domain->repositoryTree();
         $user_id = $this->domain->user()->getId();
         $fav_rep = new \ilFavouritesDBRepository();
 
         $ids = $this->db_repo->getRelatedObjIdsOfUser($user_id, $type);
         $ids = array_filter($ids, function ($id) {
             return \ilObject::_exists($id);
         });
 
         if ($type === Note::PUBLIC) {
             // additionally all objects on the personal desktop of the user
             // that have at least on comment
             $fav_obj_ids = array_map(function ($i) {
                 return $i["obj_id"];
             }, $fav_rep->getFavouritesOfUser($user_id));
             if (count($fav_obj_ids) > 0) {
                 $fav_obj_ids = $this->db_repo->filterObjectsWithNotes($fav_obj_ids, Note::PUBLIC);
                 $ids = array_unique(array_merge($ids, $fav_obj_ids));
             }
 
             $ids = array_filter($ids, function ($id) {
                 return $this->commentsActive($id);
             });
         }
 
         $wsp_tree = new \ilWorkspaceTree($user_id);
 
         $ids = array_filter($ids, function ($id) use ($wsp_tree) {
             if (\ilObject::_hasUntrashedReference($id)) {
                 return true;
             }
             if ($wsp_tree->lookupNodeId($id) > 0) {
                 return true;
             }
             return false;
         });
 
         return $ids;
     }

Here is the call graph for this function:

◆ getSortAscending()

ILIAS\Notes\NotesManager::getSortAscending ( )

Definition at line 57 of file class.NotesManager.php.

                                       : bool
     {
         return $this->sess_repo->getSortAscending();
     }

◆ getUserCount()

ILIAS\Notes\NotesManager::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 276 of file class.NotesManager.php.

      : int {
         return $this->db_repo->getUserCount($obj_id, $sub_obj_id, $obj_type);
     }

◆ setSortAscending()

ILIAS\Notes\NotesManager::setSortAscending ( bool $asc )

Definition at line 52 of file class.NotesManager.php.

                                                : void
     {
         $this->sess_repo->setSortAscending($asc);
     }

◆ updateNoteText()

ILIAS\Notes\NotesManager::updateNoteText	(	int	$id,
		string	$text,
		array	$observer
	)

Definition at line 82 of file class.NotesManager.php.

References ILIAS\UI\examples\Symbol\Glyph\Notification\notification().

      : void {
         $note = $this->db_repo->getById($id);
         if ($this->note_access->canEdit($note)) {
             $this->db_repo->updateNoteText($id, $text);
             $note = $this->db_repo->getById($id);
             $this->notification->sendNotifications($note, true);
             $this->notification->notifyObserver($observer, "update", $note);
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $data

InternalDataService ILIAS\Notes\NotesManager::$data

protected

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

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

◆ $db_repo

NoteDBRepository ILIAS\Notes\NotesManager::$db_repo

protected

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

◆ $db_settings_repo

NoteSettingsDBRepository ILIAS\Notes\NotesManager::$db_settings_repo

protected

Definition at line 30 of file class.NotesManager.php.

◆ $domain

InternalDomainService ILIAS\Notes\NotesManager::$domain

protected

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

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

◆ $note_access

AccessManager ILIAS\Notes\NotesManager::$note_access

protected

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

◆ $notification

NotificationsManager ILIAS\Notes\NotesManager::$notification

protected

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

◆ $repo

InternalRepoService ILIAS\Notes\NotesManager::$repo

protected

Definition at line 33 of file class.NotesManager.php.

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

◆ $sess_repo

NotesSessionRepository ILIAS\Notes\NotesManager::$sess_repo

protected

Definition at line 35 of file class.NotesManager.php.

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateComments()

◆ commentsActive()

◆ commentsActiveMultiple()

◆ countNotesAndCommentsMultipleObjects()

◆ createNote()

◆ deleteNote()

◆ getById()

◆ getNotesForContext()

◆ getNotesForRepositoryObjId()

◆ getNotesForRepositoryObjIds()

◆ getNrOfNotesForContext()

◆ getRelatedObjectsOfUser()

◆ getSortAscending()

◆ getUserCount()

◆ setSortAscending()

◆ updateNoteText()

Field Documentation

◆ $data

◆ $db_repo

◆ $db_settings_repo

◆ $domain

◆ $note_access

◆ $notification

◆ $repo

◆ $sess_repo