Notes GUI class. More...

Collaboration diagram for ilNoteGUI:

Public Member Functions
	__construct ( $a_rep_obj_id=0, int $a_obj_id=0, string $a_obj_type="", bool $a_include_subobjects=false, int $a_news_id=0, bool $ajax=true, string $search_text="")

	setShowEmptyListMessage (bool $a_val)

	getShowEmptyListMessage ()

	setShowHeader (bool $a_val)

	getShowHeader ()

	setUseObjectTitleHeader (bool $a_val)

	getUseObjectTitleHeader ()

	setDefaultCommand (string $a_val)

	setHideNewForm (bool $a_val)

	getDefaultCommand ()

	executeCommand ()

	enablePrivateNotes (bool $a_enable=true)

	enablePublicNotes (bool $a_enable=true)

	enableCommentsSettings (bool $a_enable=true)

	enablePublicNotesDeletion (bool $a_enable=true)

	enableTargets (bool $a_enable=true)

	setRepositoryMode (bool $a_value)

	getNotesHTML ()

	getCommentsHTML ()

	getListHTML (bool $a_init_form=true)

	activateComments ()

	deactivateComments ()

	getNoteListHTML (int $a_type=Note::PRIVATE, bool $a_init_form=true)

	getTarget (Note $note)
	show related objects as links More...

	addNoteForm (bool $a_init_form=true)
	get notes list including add note area More...

	cancelAddNote ()
	cancel add note More...

	cancelUpdateNote ()
	cancel edit note More...

	addNote ()
	add note More...

	updateNote ()

	editNoteForm (bool $a_init_form=true)
	get notes list including add note area More...

	renderContent (string $content)
	Render content into notes wrapper. More...

	cancelDelete ()

	confirmDelete ()

	exportNotesHTML ()
	export selected notes to html More...

	getShyButton (string $a_var, string $a_txt, string $a_cmd, string $a_anchor="", int $note_id=0)

	getButton (string $a_var, string $a_txt, string $a_cmd, string $a_anchor="")

	addObserver (callable $a_callback)
	Add observer. More...

	getHTML ()
	Get HTML. More...

	setExportMode ()

Static Public Member Functions
static	getListNotesJSCall (string $a_hash, string $a_update_code=null)
	Get list notes js call. More...

static	getListCommentsJSCall (string $a_hash, string $a_update_code=null)
	Get list comments js call. More...

Data Fields
bool	$public_deletion_enabled = false

bool	$repository_mode = false

bool	$old = false

Protected Member Functions
	renderComponents (array $components)

	getNotes (int $a_type)

	getSortationControl ()

	getItemGroupTitle (int $obj_id=0)

	getItemForNote (Note $note, bool $actions=true)

	getNoteTextPlaceholder (Note $note)

	getNoteText (Note $note)

	getSubObjectTitle (int $parent_obj_id, int $sub_obj_id)
	Get sub object title if available with callback. More...

	getNoteForm (string $mode, int $type, Note $note=null)

	deleteNote ()

	listSortAsc ()

	listSortDesc ()

	getCommentsWidget ()

	updateWidget ()

	getOriginHeader ()

Protected Attributes
array	$notes = null

ILIAS Notes InternalGUIService	$gui

string	$search_text

ILIAS Notes AccessManager	$notes_access

ILIAS Notes InternalDataService	$data

ilWorkspaceAccessHandler	$wsp_access_handler

ilWorkspaceTree	$wsp_tree

bool	$public_enabled

StandardGUIRequest	$request

NotesManager	$manager

bool	$targets_enabled = false

bool	$export_html = false

bool	$print = false

bool	$comments_settings = false

string	$obj_type

bool	$private_enabled

bool	$edit_note_form

bool	$add_note_form

bool	$ajax

bool	$inc_sub

int	$obj_id

	$rep_obj_id

ilCtrl	$ctrl

ilLanguage	$lng

ilObjUser	$user

ilSetting	$settings

ilObjectDefinition	$obj_definition

ilTree	$tree

ilAccessHandler	$access

string	$default_command = "getListHTML"

array	$observer = []

ILIAS DI UIServices	$ui

int	$news_id = 0

bool	$hide_new_form = false

bool	$only_latest = false

string	$widget_header = ""

bool	$no_actions = false

bool	$enable_sorting = true

bool	$user_img_export_html = false

ilLogger	$log

ilTemplate	$form_tpl

int	$requested_note_type = 0

int	$requested_note_id = 0

string	$requested_note_mess = ""

int	$requested_news_id = 0

bool	$delete_note = false

string	$note_mess = ""

array	$item_list_gui = []

bool	$use_obj_title_header = true

bool	$show_empty_list_message = true

bool	$show_header = true

Detailed Description

Notes GUI class.

An instance of this class handles all notes (and their lists) of an object.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilNoteGUI::__construct	(		$a_rep_obj_id = `0`,
		int	$a_obj_id = `0`,
		string	$a_obj_type = `""`,
		bool	$a_include_subobjects = `false`,
		int	$a_news_id = `0`,
		bool	$ajax = `true`,
		string	$search_text = `""`
	)

Parameters

int \| int[]	$a_rep_obj_id	object id of repository object (0 for personal desktop)
int	$a_obj_id	sub-object id (0 for repository items, user id for personal desktop)
string	$a_obj_type	"pd" for personal desktop
bool	$a_include_subobjects	include all subobjects of rep object (e.g. pages)
int	$a_news_id
bool	$ajax

Exceptions

ilCtrlException

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

      {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->settings = $DIC->settings();
        $this->obj_definition = $DIC["objDefinition"];
        $this->tree = $DIC->repositoryTree();
        $this->access = $DIC->access();
        $this->ui = $DIC->ui();
        $ilCtrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->log = ilLoggerFactory::getLogger('note');
        $this->search_text = $search_text;
 
        $ns = $DIC->notes()->internal();
        $this->manager = $ns
            ->domain()
            ->notes();
        $this->request = $ns
            ->gui()
            ->standardRequest();
        $this->data = $ns->data();
        $this->gui = $ns->gui();
        $this->notes_access = $ns->domain()->noteAccess();
 
        $this->lng->loadLanguageModule("notes");
 
        $ilCtrl->saveParameter($this, "notes_only");
 
        $this->rep_obj_id = $a_rep_obj_id;
        $this->obj_id = $a_obj_id;
        $this->obj_type = $a_obj_type;
        $this->inc_sub = $a_include_subobjects;
        $this->news_id = $a_news_id;
 
        // auto-detect object type
        if (!is_array($a_rep_obj_id) && !$this->obj_type && $a_rep_obj_id) {
            $this->obj_type = ilObject::_lookupType($a_rep_obj_id);
        }
 
        $this->ajax = $ajax;
 
        $this->ctrl = $ilCtrl;
 
        $this->add_note_form = false;
        $this->edit_note_form = false;
        $this->private_enabled = false;
 
        if (!is_array($this->rep_obj_id)) {
            if ($this->manager->commentsActive($this->rep_obj_id)) {
                $this->public_enabled = true;
            } else {
                $this->public_enabled = false;
            }
        }
        $this->targets_enabled = false;
        $this->export_html = false;
        $this->print = false;
        $this->comments_settings = false;
 
        // default: notes for repository objects
        $this->setRepositoryMode(true);
 
        $this->ctrl->saveParameter($this, "note_type");
        $this->requested_note_type = $this->request->getNoteType();
        $this->requested_note_id = $this->request->getNoteId();
        $this->requested_note_mess = $this->request->getNoteMess();
        $this->requested_news_id = $this->request->getNewsId();
    }

References $ajax, $DIC, $search_text, ilObject\_lookupType(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilLoggerFactory\getLogger(), ILIAS\Repository\lng(), setRepositoryMode(), ILIAS\Repository\settings(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ activateComments()

ilNoteGUI::activateComments ( )

Definition at line 354 of file class.ilNoteGUI.php.

                                      : void
    {
        $ilCtrl = $this->ctrl;
 
        if ($this->comments_settings) {
            $this->manager->activateComments($this->rep_obj_id, true);
        }
 
        $ilCtrl->redirectByClass("ilnotegui", "getCommentsHTML", "", $this->ajax);
    }

References $ctrl, and ilCtrl\redirectByClass().

Here is the call graph for this function:

◆ addNote()

ilNoteGUI::addNote ( )

add note

Definition at line 1001 of file class.ilNoteGUI.php.

                             : void
    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
 
        $text = $this->getNoteForm(
            "create",
            $this->requested_note_type
        )->getData("note") ?? "";
 
        //if ($this->form->checkInput())
        if ($text !== "" && !is_array($this->rep_obj_id)) {
            $context = $this->data->context(
                $this->rep_obj_id,
                $this->obj_id,
                $this->obj_type,
                $this->news_id,
                $this->repository_mode
            );
            $note = $this->data->note(
                0,
                $context,
                $text,
                $ilUser->getId(),
                $this->requested_note_type
            );
            $this->manager->createNote(
                $note,
                $this->observer
            );
 
            $ilCtrl->setParameter($this, "note_mess", "mod");
        }
        $ilCtrl->redirect($this, "getListHTML", "", $this->ctrl->isAsynch());
    }

References $context, $ilUser, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ addNoteForm()

ilNoteGUI::addNoteForm ( bool $a_init_form = true )

get notes list including add note area

Definition at line 975 of file class.ilNoteGUI.php.

     : string {
        $this->add_note_form = true;
        return $this->getListHTML($a_init_form);
    }

◆ addObserver()

ilNoteGUI::addObserver ( callable $a_callback )

Add observer.

Definition at line 1283 of file class.ilNoteGUI.php.

     : void {
        $this->observer[] = $a_callback;
    }

◆ cancelAddNote()

ilNoteGUI::cancelAddNote ( )

cancel add note

Definition at line 985 of file class.ilNoteGUI.php.

                                   : string
    {
        return $this->getListHTML();
    }

◆ cancelDelete()

ilNoteGUI::cancelDelete ( )

Definition at line 1136 of file class.ilNoteGUI.php.

                                  : string
    {
        return $this->getListHTML();
    }

◆ cancelUpdateNote()

ilNoteGUI::cancelUpdateNote ( )

cancel edit note

Definition at line 993 of file class.ilNoteGUI.php.

                                      : string
    {
        return $this->getListHTML();
    }

◆ confirmDelete()

ilNoteGUI::confirmDelete ( )

Definition at line 1141 of file class.ilNoteGUI.php.

                                   : void
    {
        $ilCtrl = $this->ctrl;
 
        $cnt = 0;
        $ids = [$this->request->getNoteId()];
        foreach ($ids as $id) {
            $note = $this->manager->getById($id);
            if ($this->notes_access->canDelete($note, $this->user->getId(), $this->public_deletion_enabled)) {
                $this->manager->deleteNote($note, $this->user->getId(), $this->public_deletion_enabled);
                $cnt++;
            }
        }
        if ($cnt > 1) {
            $ilCtrl->setParameter($this, "note_mess", "ntsdel");
        } else {
            $ilCtrl->setParameter($this, "note_mess", "ntdel");
        }
        $ilCtrl->redirect($this, "getListHTML", "", $this->ajax);
    }

References $id, ILIAS\Notes\Note\getId(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ deactivateComments()

ilNoteGUI::deactivateComments ( )

Definition at line 365 of file class.ilNoteGUI.php.

                                        : void
    {
        $ilCtrl = $this->ctrl;
 
        if ($this->comments_settings) {
            $this->manager->activateComments($this->rep_obj_id, false);
        }
 
        $ilCtrl->redirectByClass("ilnotegui", "getCommentsHTML", "", $this->ajax);
    }

References $ctrl, and ilCtrl\redirectByClass().

Here is the call graph for this function:

◆ deleteNote()

ilNoteGUI::deleteNote ( )

protected

Definition at line 1098 of file class.ilNoteGUI.php.

                                   : string
    {
        $reldates = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);
 
        $f = $this->ui->factory();
        $ctrl = $this->ctrl;
        $ctrl->setParameter($this, "note_id", $this->requested_note_id);
        $note = $this->manager->getById($this->requested_note_id);
 
        $text = ($this->requested_note_type === Note::PRIVATE)
            ? $this->lng->txt("notes_delete_note")
            : $this->lng->txt("notes_delete_comment");
 
        $mess = $f->messageBox()->confirmation($text);
        $item = $this->getItemForNote($note, false);
 
        $b1 = $this->getButton(
            "",
            $this->lng->txt("cancel"),
            "cancelDelete"
        );
        $b2 = $this->getButton(
            "",
            $this->lng->txt("delete"),
            "confirmDelete"
        );
 
        $it_group_title = $this->getItemGroupTitle($note->getContext()->getObjId());
        $item_groups = [$f->item()->group($it_group_title, [$item])];
        $panel = $f->panel()->listing()->standard("", $item_groups);
 
        $html = $this->renderComponents([$mess, $panel, $b2, $b1]);
        $html = str_replace($this->getNoteTextPlaceholder($note), $this->getNoteText($note), $html);
 
        return $this->renderContent($html);
    }

References Vendor\Package\$f, $panel, ILIAS\Notes\Note\getContext(), ILIAS\Repository\lng(), ilCtrl\setParameter(), ilDatePresentation\setUseRelativeDates(), ILIAS\Repository\ui(), and ilDatePresentation\useRelativeDates().

Here is the call graph for this function:

◆ editNoteForm()

ilNoteGUI::editNoteForm ( bool $a_init_form = true )

get notes list including add note area

Definition at line 1061 of file class.ilNoteGUI.php.

     : string {
        $this->edit_note_form = true;
 
        return $this->getListHTML($a_init_form);
    }

◆ enableCommentsSettings()

ilNoteGUI::enableCommentsSettings ( bool $a_enable = true )

Definition at line 244 of file class.ilNoteGUI.php.

                                                                 : void
    {
        $this->comments_settings = $a_enable;
    }

◆ enablePrivateNotes()

ilNoteGUI::enablePrivateNotes ( bool $a_enable = true )

Definition at line 234 of file class.ilNoteGUI.php.

                                                             : void
    {
        $this->private_enabled = $a_enable;
    }

◆ enablePublicNotes()

ilNoteGUI::enablePublicNotes ( bool $a_enable = true )

Definition at line 239 of file class.ilNoteGUI.php.

                                                            : void
    {
        $this->public_enabled = $a_enable;
    }

◆ enablePublicNotesDeletion()

ilNoteGUI::enablePublicNotesDeletion ( bool $a_enable = true )

Definition at line 249 of file class.ilNoteGUI.php.

                                                                    : void
    {
        $this->public_deletion_enabled = $a_enable;
    }

◆ enableTargets()

ilNoteGUI::enableTargets ( bool $a_enable = true )

Definition at line 255 of file class.ilNoteGUI.php.

                                                        : void
    {
        $this->targets_enabled = $a_enable;
    }

◆ executeCommand()

ilNoteGUI::executeCommand ( )

Definition at line 224 of file class.ilNoteGUI.php.

    {
        $cmd = $this->ctrl->getCmd($this->getDefaultCommand());
        $next_class = $this->ctrl->getNextClass($this);
        switch ($next_class) {
            default:
                return $this->$cmd();
        }
    }

References ILIAS\Repository\ctrl(), and getDefaultCommand().

Here is the call graph for this function:

◆ exportNotesHTML()

ilNoteGUI::exportNotesHTML ( )

export selected notes to html

Definition at line 1165 of file class.ilNoteGUI.php.

                                     : void
    {
        $tpl = new ilGlobalTemplate("tpl.main.html", true, true);
 
        $this->export_html = true;
        //$tpl->setVariable("CONTENT", $this->getListHTML());
        //ilUtil::deliverData($tpl->get(), "notes.html");
 
        $authors = array_unique(array_map(function (Note $note) {
            return $note->getAuthor();
        }, $this->getNotes($this->requested_note_type)));
        $export = new \ILIAS\Notes\Export\NotesHtmlExport(
            $this->requested_note_type,
            $this->user->getId(),
            $authors
        );
        $export->exportHTML($this->getListHTML());
    }

References $tpl, ILIAS\Notes\Note\getAuthor(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getButton()

ilNoteGUI::getButton	(	string	$a_var,
		string	$a_txt,
		string	$a_cmd,
		string	$a_anchor = `""`
	)

Exceptions

ilCtrlException

Definition at line 1252 of file class.ilNoteGUI.php.

     : \ILIAS\UI\Component\Button\Standard {
        $ctrl = $this->ctrl;
        $f = $this->ui->factory();
 
        if ($this->ajax) {
            $button = $f->button()->standard(
                $a_txt,
                "#"
            )->withOnLoadCode(function ($id) use ($ctrl, $a_cmd) {
                return
                    "$('#$id').on('click', () => { ilNotes.cmdAjaxLink(event, '" .
                    $ctrl->getLinkTargetByClass("ilnotegui", $a_cmd, "", true) .
                    "');});";
            });
        } else {
            $button = $f->button()->standard(
                $a_txt,
                $ctrl->getLinkTargetByClass("ilnotegui", $a_cmd, $a_anchor)
            );
        }
        return $button;
    }

References Vendor\Package\$f, $id, and ilCtrl\getLinkTargetByClass().

Here is the call graph for this function:

◆ getCommentsHTML()

ilNoteGUI::getCommentsHTML ( )

Definition at line 273 of file class.ilNoteGUI.php.

                                     : string
    {
        if ($this->ajax) {
            $this->gui->initJavascript();
        }
        $ilCtrl = $this->ctrl;
        $ilCtrl->setParameter($this, "notes_type", Note::PUBLIC);
        $this->requested_note_type = Note::PUBLIC;
        return $this->getListHTML($a_init_form = true);
    }

References $ctrl, getListHTML(), and ilCtrl\setParameter().

Here is the call graph for this function:

◆ getCommentsWidget()

ilNoteGUI::getCommentsWidget ( )

protected

Definition at line 1310 of file class.ilNoteGUI.php.

                                          : string
    {
        $f = $this->ui->factory();
        $r = $this->ui->renderer();
        $lng = $this->lng;
        $ctrl = $this->ctrl;
        $ctrl->setParameter($this, "news_id", $this->news_id);
        $hash = ilCommonActionDispatcherGUI::buildAjaxHash(
            ilCommonActionDispatcherGUI::TYPE_REPOSITORY,
            null,
            ilObject::_lookupType($this->rep_obj_id),
            $this->rep_obj_id,
            $this->obj_type,
            $this->obj_id,
            $this->news_id
        );
 
        $context = $this->data->context(
            $this->rep_obj_id,
            $this->obj_id,
            $this->obj_type,
            $this->news_id
        );
 
        $cnt[$this->rep_obj_id][Note::PUBLIC] = $this->manager->getNrOfNotesForContext($context, Note::PUBLIC);
        $cnt[$this->rep_obj_id][Note::PRIVATE] = $this->manager->getNrOfNotesForContext($context, Note::PRIVATE);
        $cnt = $cnt[$this->rep_obj_id][Note::PUBLIC] ?? 0;
 
        $tpl = new ilTemplate("tpl.note_widget_header.html", true, true, "Services/Notes");
        $widget_el_id = "notew_" . str_replace(";", "_", $hash);
        $ctrl->setParameter($this, "hash", $hash);
        $update_url = $ctrl->getLinkTarget($this, "updateWidget", "", true, false);
        $comps = array();
        if ($cnt > 0) {
            $c = $f->counter()->status((int) $cnt);
            $comps[] = $f->symbol()->glyph()->comment()->withCounter($c)->withAdditionalOnLoadCode(function ($id) use ($hash, $update_url, $widget_el_id) {
                return "$(\"#$id\").click(function(event) { " . self::getListCommentsJSCall($hash, "ilNotes.updateWidget(\"" . $widget_el_id . "\",\"" . $update_url . "\");") . "});";
            });
            $comps[] = $f->divider()->vertical();
            $tpl->setVariable("GLYPH", $r->render($comps));
            $tpl->setVariable("TXT_LATEST", $lng->txt("notes_latest_comment"));
        }
 
        $b = $f->button()->shy($lng->txt("notes_add_edit_comment"), "#")->withAdditionalOnLoadCode(function ($id) use ($hash, $update_url, $widget_el_id) {
            return "$(\"#$id\").click(function(event) { " . self::getListCommentsJSCall($hash, "ilNotes.updateWidget(\"" . $widget_el_id . "\",\"" . $update_url . "\");") . "});";
        });
        if ($ctrl->isAsynch()) {
            $tpl->setVariable("SHY_BUTTON", $r->renderAsync($b));
        } else {
            $tpl->setVariable("SHY_BUTTON", $r->render($b));
        }
 
        $this->widget_header = $tpl->get();
 
        $this->hide_new_form = true;
        $this->only_latest = true;
        $this->no_actions = true;
        $html = "<div id='" . $widget_el_id . "'>" . $this->getNoteListHTML(Note::PUBLIC) . "</div>";
        $ctrl->setParameter($this, "news_id", $this->requested_news_id);
        return $html;
    }

References Vendor\Package\$b, $c, $context, Vendor\Package\$f, $id, $lng, $tpl, ilObject\_lookupType(), ilCommonActionDispatcherGUI\buildAjaxHash(), ilCtrl\getLinkTarget(), ilCtrl\isAsynch(), ilCtrl\setParameter(), ilCommonActionDispatcherGUI\TYPE_REPOSITORY, ILIAS\Repository\ui(), and ILIAS\UI\Implementation\Component\withAdditionalOnLoadCode().

Here is the call graph for this function:

◆ getDefaultCommand()

ilNoteGUI::getDefaultCommand ( )

Definition at line 219 of file class.ilNoteGUI.php.

                                       : string
    {
        return $this->default_command;
    }

References $default_command.

Referenced by executeCommand().

Here is the caller graph for this function:

◆ getHTML()

ilNoteGUI::getHTML ( )

Get HTML.

Definition at line 1304 of file class.ilNoteGUI.php.

                             : string
    {
        $this->gui->initJavascript();
        return $this->getCommentsWidget();
    }

◆ getItemForNote()

ilNoteGUI::getItemForNote	(	Note	$note,
		bool	$actions = `true`
	)

protected

Exceptions

ilCtrlException
ilDateTimeException
ilWACException

Definition at line 722 of file class.ilNoteGUI.php.

     : \ILIAS\UI\Component\Item\Item {
        $f = $this->ui->factory();
        $ctrl = $this->ctrl;
 
 
        $dd_buttons = [];
 
        // edit note stuff for all private notes
        if ($actions && $this->notes_access->canEdit($note)) {
            if (!$this->export_html && !$this->print
                && !$this->edit_note_form && !$this->add_note_form && !$this->no_actions) {
                $ctrl->setParameterByClass("ilnotegui", "note_id", $note->getId());
                $dd_buttons[] = $this->getShyButton(
                    "edit_note",
                    $this->lng->txt("edit"),
                    "editNoteForm",
                    "note_" . $note->getId(),
                    $note->getId()
                );
            }
        }
 
        // delete note stuff for all private notes
        if ($actions && !$this->export_html && !$this->print
            && !$this->no_actions
            && $this->notes_access->canDelete($note)) {
            $ctrl->setParameterByClass("ilnotegui", "note_id", $note->getId());
            $dd_buttons[] = $this->getShyButton(
                "delete_note",
                $this->lng->txt("delete"),
                "deleteNote",
                "note_" . $note->getId(),
                $note->getId()
            );
        }
 
 
        $creation_date = ilDatePresentation::formatDate(new ilDate($note->getCreationDate(), IL_CAL_DATETIME));
 
        $properties = [];
 
        // origin
        if ($this->targets_enabled) {
            $target = $this->getTarget($note);
            if ($target["title"] !== "") {
                if ($target["link"] === "") {
                    $properties[$this->lng->txt("notes_origin")] = $target["title"];
                } else {
                    $properties[$this->lng->txt("notes_origin")] = $f
                        ->button()
                        ->shy(
                            $target["title"],
                            $target["link"]
                        );
                }
            }
        }
 
        // output author account and creation date
        $img_path = "";
        $img_alt = "";
        $avatar = null;
        if ($note->getType() === Note::PUBLIC) {
            $avatar = ilObjUser::_getAvatar($note->getAuthor());
            $title = ilUserUtil::getNamePresentation($note->getAuthor(), false, false);
            $properties[$this->lng->txt("create_date")] = $creation_date;
        } else {
            $title = $creation_date;
        }
 
        // last edited
        if ($note->getUpdateDate() !== null) {
            $properties[$this->lng->txt("last_edited_on")] = ilDatePresentation::formatDate(
                new ilDate(
                    $note->getUpdateDate(),
                    IL_CAL_DATETIME
                )
            );
        }
 
        $item = $f->item()->standard($title)
            ->withDescription($this->getNoteTextPlaceholder($note))
            ->withProperties($properties);
        if (!is_null($avatar)) {
            $item = $item->withLeadAvatar($avatar);
        }
        if (count($dd_buttons) > 0) {
            $item = $item->withActions(
                $f->dropdown()->standard($dd_buttons)
            );
        }
        return $item;
    }

References ILIAS\Notes\Note\getId(), ILIAS\Repository\lng(), and ilCtrl\setParameterByClass().

Here is the call graph for this function:

◆ getItemGroupTitle()

ilNoteGUI::getItemGroupTitle ( int $obj_id = 0 )

protected

Definition at line 700 of file class.ilNoteGUI.php.

                                                         : string
    {
        if (!$this->show_header) {
            return "";
        }
        if (!is_array($this->rep_obj_id) && !$this->getUseObjectTitleHeader()) {
            $it_group_title = ($this->requested_note_type === Note::PRIVATE)
                ? $this->lng->txt("notes")
                : $this->lng->txt("notes_comments");
        } else {
            $it_group_title = ($obj_id)
                ? ilObject::_lookupTitle($obj_id)
                : $this->lng->txt("note_without_object");
        }
        return $it_group_title;
    }

References ilObject\_lookupTitle(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getListCommentsJSCall()

static ilNoteGUI::getListCommentsJSCall	(	string	$a_hash,
		string	$a_update_code = `null`
	)

static

Get list comments js call.

Definition at line 1203 of file class.ilNoteGUI.php.

     : string {
        if ($a_update_code === null) {
            $a_update_code = "null";
        } else {
            $a_update_code = "'" . $a_update_code . "'";
        }
 
        return "ilNotes.listComments(event, '" . $a_hash . "', " . $a_update_code . ");";
    }

Referenced by ilPollBlockGUI\commentJSCall(), ilObjectListGUI\determineProperties(), ilQuestionBrowserTableGUI\getCommentsAjaxLink(), ilDclRecordListTableGUI\getCommentsAjaxLink(), ilObjectListGUI\getHeaderAction(), ilDclBaseRecordModel\getStandardFieldHTML(), and ilObjectListGUI\insertCommonSocialCommands().

Here is the caller graph for this function:

◆ getListHTML()

ilNoteGUI::getListHTML ( bool $a_init_form = true )

Definition at line 284 of file class.ilNoteGUI.php.

                                                         : string
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;
 
        $content = "";
        if ($this->requested_note_type === Note::PRIVATE && $ilUser->getId() !== ANONYMOUS_USER_ID) {
            $content = $this->getNoteListHTML(Note::PRIVATE, $a_init_form);
        }
        // #15948 - public enabled vs. comments_settings
        if ($this->requested_note_type === Note::PUBLIC) {
            $active = true;
            // news items (in timeline) do not check, if the object has news activated!
            if (!is_array($this->rep_obj_id) && $this->news_id === 0) {
 
                // if common object settings are used, we check for activation
                // 37713, 37701
                // removed setting check due to 41511
                //if ($this->comments_settings) {
                $active = $this->manager->commentsActive($this->rep_obj_id);
                //}
            }
            if ($active) {
                $content = $this->getNoteListHTML(Note::PUBLIC, $a_init_form);
            }
 
            // Comments Settings
            if (!is_array($this->rep_obj_id) && $this->comments_settings && $ilUser->getId() !== ANONYMOUS_USER_ID) {
                $active = $this->manager->commentsActive($this->rep_obj_id);
                if ($active) {
                    if ($this->news_id === 0) {
                        $content .= $this->renderComponents([$this->getShyButton(
                            "comments_settings",
                            $lng->txt("notes_deactivate_comments"),
                            "deactivateComments",
                            ""
                        )
                        ]);
                    }
                } else {
                    $content .= $this->renderComponents([$this->getShyButton(
                        "comments_settings",
                        $lng->txt("notes_activate_comments"),
                        "activateComments",
                        ""
                    )
                    ]);
                    /*
                    if ($this->ajax && !$comments_col) {
                        $ntpl->setVariable(
                            "COMMENTS_MESS",
                            ilUtil::getSystemMessageHTML($lng->txt("comments_feature_currently_not_activated_for_object"), "info")
                        );
                    }*/
                }
            }
        }
        return $this->renderContent($content);
    }

References $ctrl, $ilSetting, $ilUser, $lng, $settings, $user, ANONYMOUS_USER_ID, getNoteListHTML(), getShyButton(), renderComponents(), renderContent(), and ilLanguage\txt().

Referenced by getCommentsHTML(), and getNotesHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getListNotesJSCall()

static ilNoteGUI::getListNotesJSCall	(	string	$a_hash,
		string	$a_update_code = `null`
	)

static

Get list notes js call.

Definition at line 1187 of file class.ilNoteGUI.php.

     : string {
        if ($a_update_code === null) {
            $a_update_code = "null";
        } else {
            $a_update_code = "'" . $a_update_code . "'";
        }
 
        return "ilNotes.listNotes(event, '" . $a_hash . "', " . $a_update_code . ");";
    }

Referenced by ilObjectListGUI\determineProperties(), ilObjectListGUI\getHeaderAction(), and ilObjectListGUI\insertCommonSocialCommands().

Here is the caller graph for this function:

◆ getNoteForm()

ilNoteGUI::getNoteForm	(	string	$mode,
		int	$type,
		Note	$note = `null`
	)

protected

Definition at line 850 of file class.ilNoteGUI.php.

     : \ILIAS\Repository\Form\FormAdapterGUI {
        global $DIC;
 
        $label_key = "note";
        $label_key .= ($mode === "create")
            ? "_add"
            : "_update";
        $label_key .= ($type === Note::PUBLIC)
            ? "_comment"
            : "_note";
        $cmd = ($mode === "create")
            ? "addNote"
            : "updateNote";
 
        $value = ($note)
            ? $note->getText()
            : "";
        if ($cmd === "updateNote") {
            $this->ctrl->setParameter($this, "note_id", $this->requested_note_id);
        }
        $action = $this->ctrl->getFormAction($this, $cmd, "");
        $form = $this->gui->form(self::class, $action)
            ->section("props", $this->lng->txt($label_key))
            ->textarea("note", $this->lng->txt("note_text"), "", $value);
        return $form;
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getNoteListHTML()

ilNoteGUI::getNoteListHTML	(	int	$a_type = `Note::PRIVATE`,
		bool	$a_init_form = `true`
	)

Definition at line 432 of file class.ilNoteGUI.php.

     : string {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $f = $this->ui->factory();
        $ilUser = $this->user;
 
        $mtype = "";
 
        $suffix = ($a_type === Note::PRIVATE)
            ? "private"
            : "public";
 
        $notes = $this->getNotes($a_type);
 
        $tpl = new ilTemplate("tpl.notes_list.html", true, true, "Services/Notes");
 
        // show counter if notes are hidden
        $cnt_str = (count($notes) > 0)
            ? " (" . count($notes) . ")"
            : "";
 
        // origin header
        $origin_header = $this->getOriginHeader();
        if ($origin_header != "") {
            $tpl->setCurrentBlock("title");
            $tpl->setVariable("TITLE", $origin_header);
            $tpl->parseCurrentBlock();
        }
 
        if ($a_type === Note::PRIVATE) {
            $tpl->setVariable("TXT_NOTES", $lng->txt("private_notes") . $cnt_str);
            $ilCtrl->setParameterByClass("ilnotegui", "note_type", Note::PRIVATE);
        } else {
            $tpl->setVariable("TXT_NOTES", $lng->txt("notes_public_comments") . $cnt_str);
            $ilCtrl->setParameterByClass("ilnotegui", "note_type", Note::PUBLIC);
        }
        $anch = "";
 
        // show add new note text area
        if (!$this->edit_note_form && !is_array($this->rep_obj_id) &&
            !$this->hide_new_form && $ilUser->getId() !== ANONYMOUS_USER_ID) {
            $tpl->setCurrentBlock("edit_note_form");
            $b_caption = ($this->requested_note_type === Note::PRIVATE)
                ? $this->lng->txt("note_add_note")
                : $this->lng->txt("note_add_comment");
            $b = $this->ui->factory()->button()->standard(
                $b_caption,
                "#"
            );
            $tpl->setVariable("EDIT_STYLE", "display:none;");
            $tpl->setVariable(
                "EDIT_FORM_ACTION",
                $ilCtrl->getFormActionByClass("ilnotegui", "addNote", "", true)
            );
            $tpl->setVariable(
                "TXT_CANCEL",
                $this->lng->txt("cancel")
            );
            $tpl->setVariable(
                "EDIT_FORM_BUTTON",
                $this->renderComponents([$b])
            );
            $tpl->setVariable(
                "EDIT_FORM",
                $this->getNoteForm("create", $a_type)->render()
            );
            $tpl->parseCurrentBlock();
        }
 
        // list all notes
        $reldates = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);
 
        $notes_given = false;
 
        // edit form
        if ($this->edit_note_form && $a_type === $this->requested_note_type) {
            $note = $this->manager->getById($this->requested_note_id);
            $ilCtrl->setParameterByClass("ilnotegui", "note_id", $this->requested_note_id);
            $tpl->setVariable(
                "EDIT_FORM_ACTION",
                $ilCtrl->getFormActionByClass("ilnotegui", "updateNote", "", true)
            );
            $tpl->setVariable(
                "CANCEL_FORM_ACTION",
                $ilCtrl->getFormActionByClass("ilnotegui", "cancelUpdateNote", "", true)
            );
            $tpl->setVariable("NOTE_FOCUS", "1");
            $tpl->setVariable(
                "TXT_CANCEL",
                $this->lng->txt("cancel")
            );
            $tpl->setVariable(
                "EDIT_FORM",
                $this->getNoteForm("edit", $a_type, $note)->render()
            );
            $tpl->parseCurrentBlock();
        }
 
        $items = [];
        $item_groups = [];
        $text_placeholders = [];
        $texts = [];
        $last_obj_id = null;
        foreach ($notes as $note) {
            if ($this->only_latest && $notes_given) {
                continue;
            }
 
            $current_obj_id = $note->getContext()->getObjId();
            if ($last_obj_id !== null && $current_obj_id !== $last_obj_id) {
                $it_group_title = $this->getItemGroupTitle($last_obj_id);
                $item_groups[] = $f->item()->group($it_group_title, $items);
                $items = [];
            }
            $last_obj_id = $current_obj_id;
 
            $items[] = $this->getItemForNote($note);
            $notes_given = true;
 
            $text_placeholders[] = $this->getNoteTextPlaceholder($note);
            $texts[] = $this->getNoteText($note);
        }
 
        $it_group_title = $this->getItemGroupTitle((int) $last_obj_id);
        $item_groups[] = $f->item()->group($it_group_title, $items);
 
        if ($notes_given) {
            if (!is_array($this->rep_obj_id)) {
                $title = $item_groups[0]->getTitle();
                $item_groups[0] = $f->item()->group("", $item_groups[0]->getItems());
            } else {
                $title = "";
            }
            $panel = $f->panel()->listing()->standard($title, $item_groups);
            if (!is_array($this->rep_obj_id)) {
                $panel = $panel->withActions($this->getSortationControl());
            }
            $html = $this->renderComponents([$panel]);
            $html = str_replace($text_placeholders, $texts, $html);
            $tpl->setVariable("NOTES_LIST", $html);
        } elseif (!is_array($this->rep_obj_id)) {
            $it_group_title = $this->getItemGroupTitle($this->rep_obj_id);
            $item_groups = [$f->item()->group($it_group_title, [])];
            $panel = $f->panel()->listing()->standard("", $item_groups);
            $mess_txt = "";
            if ($this->show_empty_list_message) {
                if ($this->search_text === "") {
                    $mess_txt = ($this->requested_note_type === Note::PRIVATE)
                        ? $lng->txt("notes_no_notes")
                        : $lng->txt("notes_no_comments");
                } else {
                    $mess_txt = ($this->requested_note_type === Note::PRIVATE)
                        ? $lng->txt("notes_no_notes_found")
                        : $lng->txt("notes_no_comments_found");
                }
                $mess = $f->messageBox()->info($mess_txt);
                //$html = $this->renderComponents([$panel, $mess]);
                $html = $this->renderComponents([$mess]);
                $tpl->setVariable("NOTES_LIST", $html);
            }
        } elseif ($this->search_text !== "") {
            $mess_txt = ($this->requested_note_type === Note::PRIVATE)
                ? $lng->txt("notes_no_notes_found")
                : $lng->txt("notes_no_comments_found");
            $mess = $f->messageBox()->info($mess_txt);
            $tpl->setVariable("NOTES_LIST", $this->renderComponents([$mess]));
        }
 
        ilDatePresentation::setUseRelativeDates($reldates);
 
        // message
        $mtxt = "";
        switch ($this->requested_note_mess !== "" ? $this->requested_note_mess : $this->note_mess) {
            case "mod":
                $mtype = "success";
                $mtxt = $lng->txt("msg_obj_modified");
                break;
 
            case "ntsdel":
                $mtype = "success";
                $mtxt = ($a_type === Note::PRIVATE)
                    ? $lng->txt("notes_notes_deleted")
                    : $lng->txt("notes_comments_deleted");
                break;
 
            case "ntdel":
                $mtype = "success";
                $mtxt = ($a_type === Note::PRIVATE)
                    ? $lng->txt("notes_note_deleted")
                    : $lng->txt("notes_comment_deleted");
                break;
 
            case "frmfld":
                $mtype = "failure";
                $mtxt = $lng->txt("form_input_not_valid");
                break;
 
            case "qdel":
                $mtype = "question";
                $mtxt = $lng->txt("info_delete_sure");
                break;
 
            case "noc":
                $mtype = "failure";
                $mtxt = $lng->txt("no_checkbox");
                break;
        }
        if ($mtxt !== "") {
            $tpl->setVariable("MESS", ilUtil::getSystemMessageHTML($mtxt, $mtype));
        } else {
            $tpl->setVariable("MESS", "");
        }
 
        if ($this->widget_header !== "") {
            $tpl->setVariable("WIDGET_HEADER", $this->widget_header);
        }
 
        return $tpl->get();
    }

Referenced by getListHTML().

Here is the caller graph for this function:

◆ getNotes()

ilNoteGUI::getNotes ( int $a_type )

protected

Returns: Note[]

Definition at line 379 of file class.ilNoteGUI.php.

                                            : array
    {
        if ($this->notes === null) {
            $ilUser = $this->user;
            $filter = null;
            if ($this->export_html || $this->print) {
                if ($this->requested_note_id > 0) {
                    $filter = $this->requested_note_id;
                } else {
                    $filter = $this->request->getNoteText();
                }
            }
 
            $ascending = $this->manager->getSortAscending();
            if ($this->only_latest) {
                $order = false;
            }
            $author_id = ($a_type === Note::PRIVATE)
                ? $ilUser->getId()
                : 0;
 
            if (!is_array($this->rep_obj_id)) {
                $notes = $this->manager->getNotesForContext(
                    $this->data->context(
                        $this->rep_obj_id,
                        $this->obj_id,
                        $this->obj_type,
                        $this->news_id,
                        $this->repository_mode
                    ),
                    $a_type,
                    $this->inc_sub,
                    $author_id,
                    $ascending,
                    "",
                    $this->search_text
                );
            } else {
                $notes = $this->manager->getNotesForRepositoryObjIds(
                    $this->rep_obj_id,
                    $a_type,
                    $this->inc_sub,
                    $author_id,
                    $ascending,
                    "",
                    $this->search_text
                );
            }
            $this->notes = $notes;
        }
        return $this->notes;
    }

References $ilUser, $inc_sub, $notes, $requested_note_id, $search_text, and $user.

◆ getNotesHTML()

ilNoteGUI::getNotesHTML ( )

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

                                  : string
    {
        $ilCtrl = $this->ctrl;
        $ilCtrl->setParameter($this, "notes_type", Note::PRIVATE);
        $this->requested_note_type = Note::PRIVATE;
        return $this->getListHTML($a_init_form = true);
    }

References $ctrl, getListHTML(), and ilCtrl\setParameter().

Here is the call graph for this function:

◆ getNoteText()

ilNoteGUI::getNoteText ( Note $note )

protected

Definition at line 824 of file class.ilNoteGUI.php.

                                              : string
    {
        return (trim($note->getText()) !== "")
            ? nl2br(htmlentities($note->getText()))
            : $this->lng->txt("note_content_removed");
    }

References ILIAS\Notes\Note\getText(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getNoteTextPlaceholder()

ilNoteGUI::getNoteTextPlaceholder ( Note $note )

protected

Definition at line 819 of file class.ilNoteGUI.php.

                                                         : string
    {
        return "##note-text-" . $note->getId() . "##";
    }

References ILIAS\Notes\Note\getId().

Here is the call graph for this function:

◆ getOriginHeader()

ilNoteGUI::getOriginHeader ( )

protected

Definition at line 1386 of file class.ilNoteGUI.php.

                                        : string
    {
        if (!is_array($this->rep_obj_id) && !$this->only_latest && $this->ctrl->isAsynch()) {
            switch ($this->obj_type) {
                case "grpr":
                case "catr":
                case "crsr":
                    $title = ilContainerReference::_lookupTitle($this->rep_obj_id);
                    break;
 
                default:
                    $title = ilObject::_lookupTitle($this->rep_obj_id);
                    break;
            }
 
            $img = ilUtil::img(ilObject::_getIcon($this->rep_obj_id, "tiny"));
 
            // add sub-object if given
            if ($this->obj_id) {
                $sub_title = $this->getSubObjectTitle($this->rep_obj_id, $this->obj_id);
                if ($sub_title) {
                    $title .= " - " . $sub_title;
                }
            }
 
            return $img . " " . $title;
        }
        return "";
    }

References $img, ilObject\_getIcon(), ilContainerReference\_lookupTitle(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), and ilUtil\img().

Here is the call graph for this function:

◆ getShowEmptyListMessage()

ilNoteGUI::getShowEmptyListMessage ( )

Definition at line 183 of file class.ilNoteGUI.php.

                                             : bool
    {
        return $this->show_empty_list_message;
    }

References $show_empty_list_message.

◆ getShowHeader()

ilNoteGUI::getShowHeader ( )

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

                                   : bool
    {
        return $this->show_header;
    }

References $show_header.

◆ getShyButton()

ilNoteGUI::getShyButton	(	string	$a_var,
		string	$a_txt,
		string	$a_cmd,
		string	$a_anchor = `""`,
		int	$note_id = `0`
	)

Exceptions

ilCtrlException

Definition at line 1219 of file class.ilNoteGUI.php.

     : \ILIAS\UI\Component\Button\Shy {
        $ctrl = $this->ctrl;
        $f = $this->ui->factory();
 
        if ($this->ajax) {
            $button = $f->button()->shy(
                $a_txt,
                "#"
            )->withOnLoadCode(function ($id) use ($ctrl, $a_cmd, $note_id) {
                $ctrl->setParameterByClass("ilnotegui", "note_id", $note_id);
                return
                    "$('#$id').on('click', () => { ilNotes.cmdAjaxLink(event, '" .
                    $ctrl->getLinkTargetByClass("ilnotegui", $a_cmd, "", true) .
                    "');});";
            });
        } else {
            $button = $f->button()->shy(
                $a_txt,
                $ctrl->getLinkTargetByClass("ilnotegui", $a_cmd, $a_anchor)
            );
        }
        return $button;
    }

References Vendor\Package\$f, $id, ilCtrl\getLinkTargetByClass(), and ilCtrl\setParameterByClass().

Referenced by getListHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSortationControl()

ilNoteGUI::getSortationControl ( )

protected

Exceptions

ilCtrlException

Definition at line 660 of file class.ilNoteGUI.php.

                                            : \ILIAS\UI\Component\Dropdown\Standard
    {
        /*
        $c = $this->lng->txt("create_date") . ", ";
        $options = [
            'desc' => $c . $this->lng->txt("sorting_desc"),
            'asc' => $c . $this->lng->txt("sorting_asc")
        ];
        $select_option = (true)
            ? 'asc'
            : 'desc';
        $s = $this->ui->factory()->viewControl()->sortation($options)
                      ->withTargetURL($this->ctrl->getLinkTarget($this, "setSortation"), 'sortation')
                      ->withLabel($options[$select_option]);*/
        $dd_buttons = [];
        if ($this->manager->getSortAscending()) {
            $dd_buttons[] = $this->getShyButton(
                "sort",
                $this->lng->txt("notes_sort_desc"),
                "listSortDesc",
                "",
                0
            );
        } else {
            $dd_buttons[] = $this->getShyButton(
                "sort",
                $this->lng->txt("notes_sort_asc"),
                "listSortAsc",
                "",
                0
            );
        }
 
        $s = $this->ui->factory()->dropdown()->standard(
            $dd_buttons
        );
 
        return $s;
    }

References ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ getSubObjectTitle()

ilNoteGUI::getSubObjectTitle	(	int	$parent_obj_id,
		int	$sub_obj_id
	)

protected

Get sub object title if available with callback.

Definition at line 834 of file class.ilNoteGUI.php.

     : string {
        $objDefinition = $this->obj_definition;
        $parent_type = ilObject::_lookupType($parent_obj_id);
        if ($parent_type === "") {
            return "";
        }
        $parent_class = "ilObj" . $objDefinition->getClassName($parent_type) . "GUI";
        if (method_exists($parent_class, "lookupSubObjectTitle")) {
            return call_user_func_array(array($parent_class, "lookupSubObjectTitle"), array($parent_obj_id, $sub_obj_id));
        }
        return "";
    }

◆ getTarget()

ilNoteGUI::getTarget ( Note $note )

show related objects as links

Definition at line 884 of file class.ilNoteGUI.php.

     : array {
        $tree = $this->tree;
        $ilAccess = $this->access;
        $objDefinition = $this->obj_definition;
        $ilUser = $this->user;
 
        $title = "";
        $link = "";
 
        $a_note_id = $note->getId();
        $context = $note->getContext();
        $a_obj_type = $context->getType();
        $a_obj_id = $context->getSubObjId();
 
        if ($context->getObjId() > 0) {
 
            // get first visible reference
            $vis_ref_id = 0;
            $ref_ids = ilObject::_getAllReferences($context->getObjId());
            foreach ($ref_ids as $ref_id) {
                if ($vis_ref_id > 0) {
                    break;
                }
                if ($ilAccess->checkAccess("visible", "", $ref_id)) {
                    $vis_ref_id = $ref_id;
                }
            }
 
            // if we got the reference id
            if ($vis_ref_id > 0) {
                $type = ilObject::_lookupType($vis_ref_id, true);
                $title = ilObject::_lookupTitle($context->getObjId());
 
                if ($type === "poll") {
                    $link = ilLink::_getLink($vis_ref_id, "poll");
                } elseif ($a_obj_type !== "pg") {
                    if (!isset($this->item_list_gui[$type])) {
                        $class = $objDefinition->getClassName($type);
                        $full_class = "ilObj" . $class . "ListGUI";
                        $this->item_list_gui[$type] = new $full_class();
                    }
 
                    // for references, get original title
                    // (link will lead to orignal, which basically is wrong though)
                    if ($a_obj_type === "crsr" || $a_obj_type === "catr" || $a_obj_type === "grpr") {
                        $tgt_obj_id = ilContainerReference::_lookupTargetId($context->getObjId());
                        $title = ilObject::_lookupTitle($tgt_obj_id);
                    }
                    $this->item_list_gui[$type]->initItem($vis_ref_id, $context->getObjId(), $title, $a_obj_type);
                    $link = $this->item_list_gui[$type]->getCommandLink("infoScreen");
                    $link = $this->item_list_gui[$type]->appendRepositoryFrameParameter($link) . "#note_" . $a_note_id;
                } else {
                    $title = ilObject::_lookupTitle($context->getObjId());
                    $link = "goto.php?target=pg_" . $a_obj_id . "_" . $vis_ref_id;
                }
            } else {  // personal workspace
                // we only need 1 instance
                if (!isset($this->wsp_tree)) {
                    $this->wsp_tree = new ilWorkspaceTree($ilUser->getId());
                    $this->wsp_access_handler = new ilWorkspaceAccessHandler($this->wsp_tree);
                }
                $node_id = $this->wsp_tree->lookupNodeId($context->getObjId());
                if ($this->wsp_access_handler->checkAccess("visible", "", $node_id)) {
                    $path = $this->wsp_tree->getPathFull($node_id);
                    if ($path) {
                        $item = array_pop($path);
                        $title = $item["title"];
                        $link = ilWorkspaceAccessHandler::getGotoLink($node_id, $context->getObjId());
                    }
                    // shared resource
                    else {
                        $owner = ilObject::_lookupOwner($context->getObjId());
                        $title = ilObject::_lookupTitle($context->getObjId()) .
                            " (" . ilObject::_lookupOwnerName($owner) . ")";
                        $link = "ilias.php?baseClass=ilDashboardGUI&cmd=jumpToWorkspace&dsh=" .
                            $owner;
                    }
                }
            }
        }
        return [
            "title" => $title,
            "link" => $link,
        ];
    }

References $context, $ilUser, $path, $ref_id, $type, ilObject\_getAllReferences(), ilLink\_getLink(), ilObject\_lookupOwner(), ilObject\_lookupOwnerName(), ilContainerReference\_lookupTargetId(), ilObject\_lookupTitle(), ilObject\_lookupType(), and ilWorkspaceAccessHandler\getGotoLink().

Here is the call graph for this function:

◆ getUseObjectTitleHeader()

ilNoteGUI::getUseObjectTitleHeader ( )

Definition at line 204 of file class.ilNoteGUI.php.

                                             : bool
    {
        return $this->use_obj_title_header;
    }

References $use_obj_title_header.

◆ listSortAsc()

ilNoteGUI::listSortAsc ( )

protected

Definition at line 1289 of file class.ilNoteGUI.php.

                                    : string
    {
        $this->manager->setSortAscending(true);
        return $this->getListHTML();
    }

◆ listSortDesc()

ilNoteGUI::listSortDesc ( )

protected

Definition at line 1295 of file class.ilNoteGUI.php.

                                     : string
    {
        $this->manager->setSortAscending(false);
        return $this->getListHTML();
    }

◆ renderComponents()

ilNoteGUI::renderComponents ( array $components )

protected

Definition at line 346 of file class.ilNoteGUI.php.

                                                          : string
    {
        if ($this->ctrl->isAsynch()) {
            return $this->ui->renderer()->renderAsync($components);
        }
        return $this->ui->renderer()->render($components);
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\ui().

Referenced by getListHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderContent()

ilNoteGUI::renderContent ( string $content )

Render content into notes wrapper.

Definition at line 1072 of file class.ilNoteGUI.php.

                                                  : string
    {
        $lng = $this->lng;
        $ctrl = $this->ctrl;
 
        $ntpl = new ilTemplate(
            "tpl.notes_and_comments.html",
            true,
            true,
            "Services/Notes"
        );
 
        if (!$ctrl->isAsynch()) {
            $ntpl->setVariable("OUTER_ID", " id='notes_embedded_outer' ");
        }
 
        $ntpl->setVariable("CONTENT", $content);
 
        if ($ctrl->isAsynch() && !$this->request->isFilterCommand()) {
            echo $ntpl->get();
            exit;
        }
 
        return $ntpl->get();
    }

References $lng, exit, and ilCtrl\isAsynch().

Referenced by getListHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultCommand()

ilNoteGUI::setDefaultCommand ( string $a_val )

Definition at line 209 of file class.ilNoteGUI.php.

                                                    : void
    {
        $this->default_command = $a_val;
    }

◆ setExportMode()

ilNoteGUI::setExportMode ( )

Definition at line 1372 of file class.ilNoteGUI.php.

                                   : void
    {
        $this->hide_new_form = true;
        $this->no_actions = true;
        $this->enable_sorting = false;
        $this->user_img_export_html = true;
    }

◆ setHideNewForm()

ilNoteGUI::setHideNewForm ( bool $a_val )

Definition at line 214 of file class.ilNoteGUI.php.

                                               : void
    {
        $this->hide_new_form = $a_val;
    }

◆ setRepositoryMode()

ilNoteGUI::setRepositoryMode ( bool $a_value )

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

                                                    : void
    {
        $this->repository_mode = $a_value;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setShowEmptyListMessage()

ilNoteGUI::setShowEmptyListMessage ( bool $a_val )

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

                                                        : void
    {
        $this->show_empty_list_message = $a_val;
    }

◆ setShowHeader()

ilNoteGUI::setShowHeader ( bool $a_val )

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

                                              : void
    {
        $this->show_header = $a_val;
    }

◆ setUseObjectTitleHeader()

ilNoteGUI::setUseObjectTitleHeader ( bool $a_val )

Definition at line 199 of file class.ilNoteGUI.php.

                                                        : void
    {
        $this->use_obj_title_header = $a_val;
    }

◆ updateNote()

ilNoteGUI::updateNote ( )

Definition at line 1037 of file class.ilNoteGUI.php.

                                : void
    {
        $ilCtrl = $this->ctrl;
 
        $note = $this->manager->getById($this->requested_note_id);
        $text = $this->getNoteForm(
            "edit",
            $this->requested_note_type
        )->getData("note") ?? "";
 
        if ($this->notes_access->canEdit($note)) {
            $this->manager->updateNoteText(
                $this->requested_note_id,
                $text,
                $this->observer
            );
            $ilCtrl->setParameter($this, "note_mess", "mod");
        }
        $ilCtrl->redirect($this, "getListHTML", "", $this->ctrl->isAsynch());
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ updateWidget()

ilNoteGUI::updateWidget ( )

protected

Definition at line 1380 of file class.ilNoteGUI.php.

                                     : void
    {
        echo $this->getCommentsWidget();
        exit;
    }

References exit.

Field Documentation

◆ $access

ilAccessHandler ilNoteGUI::$access

protected

Definition at line 64 of file class.ilNoteGUI.php.

◆ $add_note_form

bool ilNoteGUI::$add_note_form

protected

Definition at line 50 of file class.ilNoteGUI.php.

◆ $ajax

bool ilNoteGUI::$ajax

protected

Definition at line 51 of file class.ilNoteGUI.php.

Referenced by __construct().

◆ $comments_settings

bool ilNoteGUI::$comments_settings = false

protected

Definition at line 46 of file class.ilNoteGUI.php.

◆ $ctrl

ilCtrl ilNoteGUI::$ctrl

protected

Definition at line 58 of file class.ilNoteGUI.php.

Referenced by activateComments(), deactivateComments(), getCommentsHTML(), getListHTML(), and getNotesHTML().

◆ $data

ILIAS Notes InternalDataService ilNoteGUI::$data

protected

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

◆ $default_command

string ilNoteGUI::$default_command = "getListHTML"

protected

Definition at line 68 of file class.ilNoteGUI.php.

Referenced by getDefaultCommand().

◆ $delete_note

bool ilNoteGUI::$delete_note = false

protected

Definition at line 84 of file class.ilNoteGUI.php.

◆ $edit_note_form

bool ilNoteGUI::$edit_note_form

protected

Definition at line 49 of file class.ilNoteGUI.php.

◆ $enable_sorting

bool ilNoteGUI::$enable_sorting = true

protected

Definition at line 76 of file class.ilNoteGUI.php.

◆ $export_html

bool ilNoteGUI::$export_html = false

protected

Definition at line 44 of file class.ilNoteGUI.php.

◆ $form_tpl

ilTemplate ilNoteGUI::$form_tpl

protected

Definition at line 79 of file class.ilNoteGUI.php.

◆ $gui

ILIAS Notes InternalGUIService ilNoteGUI::$gui

protected

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

◆ $hide_new_form

bool ilNoteGUI::$hide_new_form = false

protected

Definition at line 72 of file class.ilNoteGUI.php.

◆ $inc_sub

bool ilNoteGUI::$inc_sub

protected

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

Referenced by getNotes().

◆ $item_list_gui

array ilNoteGUI::$item_list_gui = []

protected

Definition at line 86 of file class.ilNoteGUI.php.

◆ $lng

ilLanguage ilNoteGUI::$lng

protected

Definition at line 59 of file class.ilNoteGUI.php.

Referenced by getListHTML().

◆ $log

ilLogger ilNoteGUI::$log

protected

Definition at line 78 of file class.ilNoteGUI.php.

◆ $manager

NotesManager ilNoteGUI::$manager

protected

Definition at line 42 of file class.ilNoteGUI.php.

◆ $news_id

int ilNoteGUI::$news_id = 0

protected

Definition at line 71 of file class.ilNoteGUI.php.

◆ $no_actions

bool ilNoteGUI::$no_actions = false

protected

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

◆ $note_mess

string ilNoteGUI::$note_mess = ""

protected

Definition at line 85 of file class.ilNoteGUI.php.

◆ $notes

array ilNoteGUI::$notes = null

protected

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

Referenced by getNotes().

◆ $notes_access

ILIAS Notes AccessManager ilNoteGUI::$notes_access

protected

Definition at line 36 of file class.ilNoteGUI.php.

◆ $obj_definition

ilObjectDefinition ilNoteGUI::$obj_definition

protected

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

◆ $obj_id

int ilNoteGUI::$obj_id

protected

Definition at line 53 of file class.ilNoteGUI.php.

◆ $obj_type

string ilNoteGUI::$obj_type

protected

Definition at line 47 of file class.ilNoteGUI.php.

◆ $observer

array ilNoteGUI::$observer = []

protected

Definition at line 69 of file class.ilNoteGUI.php.

◆ $old

bool ilNoteGUI::$old = false

Definition at line 67 of file class.ilNoteGUI.php.

◆ $only_latest

bool ilNoteGUI::$only_latest = false

protected

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

◆ $print

bool ilNoteGUI::$print = false

protected

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

◆ $private_enabled

bool ilNoteGUI::$private_enabled

protected

Definition at line 48 of file class.ilNoteGUI.php.

◆ $public_deletion_enabled

bool ilNoteGUI::$public_deletion_enabled = false

Definition at line 65 of file class.ilNoteGUI.php.

◆ $public_enabled

bool ilNoteGUI::$public_enabled

protected

Definition at line 40 of file class.ilNoteGUI.php.

◆ $rep_obj_id

ilNoteGUI::$rep_obj_id

protected

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

◆ $repository_mode

bool ilNoteGUI::$repository_mode = false

Definition at line 66 of file class.ilNoteGUI.php.

◆ $request

StandardGUIRequest ilNoteGUI::$request

protected

Definition at line 41 of file class.ilNoteGUI.php.

◆ $requested_news_id

int ilNoteGUI::$requested_news_id = 0

protected

Definition at line 83 of file class.ilNoteGUI.php.

◆ $requested_note_id

int ilNoteGUI::$requested_note_id = 0

protected

Definition at line 81 of file class.ilNoteGUI.php.

Referenced by getNotes().

◆ $requested_note_mess

string ilNoteGUI::$requested_note_mess = ""

protected

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

◆ $requested_note_type

int ilNoteGUI::$requested_note_type = 0

protected

Definition at line 80 of file class.ilNoteGUI.php.

◆ $search_text

string ilNoteGUI::$search_text

protected

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

Referenced by __construct(), and getNotes().

◆ $settings

ilSetting ilNoteGUI::$settings

protected

Definition at line 61 of file class.ilNoteGUI.php.

Referenced by getListHTML().

◆ $show_empty_list_message

bool ilNoteGUI::$show_empty_list_message = true

protected

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

Referenced by getShowEmptyListMessage().

◆ $show_header

bool ilNoteGUI::$show_header = true

protected

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

Referenced by getShowHeader().

◆ $targets_enabled

bool ilNoteGUI::$targets_enabled = false

protected

Definition at line 43 of file class.ilNoteGUI.php.

◆ $tree

ilTree ilNoteGUI::$tree

protected

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

◆ $ui

ILIAS DI UIServices ilNoteGUI::$ui

protected

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

◆ $use_obj_title_header

bool ilNoteGUI::$use_obj_title_header = true

protected

Definition at line 87 of file class.ilNoteGUI.php.

Referenced by getUseObjectTitleHeader().

◆ $user

ilObjUser ilNoteGUI::$user

protected

Definition at line 60 of file class.ilNoteGUI.php.

Referenced by getListHTML(), and getNotes().

◆ $user_img_export_html

bool ilNoteGUI::$user_img_export_html = false

protected

Definition at line 77 of file class.ilNoteGUI.php.

◆ $widget_header

string ilNoteGUI::$widget_header = ""

protected

Definition at line 74 of file class.ilNoteGUI.php.

◆ $wsp_access_handler

ilWorkspaceAccessHandler ilNoteGUI::$wsp_access_handler

protected

Definition at line 38 of file class.ilNoteGUI.php.

◆ $wsp_tree

ilWorkspaceTree ilNoteGUI::$wsp_tree

protected

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

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

Services/Notes/Note/class.ilNoteGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateComments()

◆ addNote()

◆ addNoteForm()

◆ addObserver()

◆ cancelAddNote()

◆ cancelDelete()

◆ cancelUpdateNote()

◆ confirmDelete()

◆ deactivateComments()

◆ deleteNote()

◆ editNoteForm()

◆ enableCommentsSettings()

◆ enablePrivateNotes()

◆ enablePublicNotes()

◆ enablePublicNotesDeletion()

◆ enableTargets()

◆ executeCommand()

◆ exportNotesHTML()

◆ getButton()

◆ getCommentsHTML()

◆ getCommentsWidget()

◆ getDefaultCommand()

◆ getHTML()

◆ getItemForNote()

◆ getItemGroupTitle()

◆ getListCommentsJSCall()

◆ getListHTML()

◆ getListNotesJSCall()

◆ getNoteForm()

◆ getNoteListHTML()

◆ getNotes()

◆ getNotesHTML()

◆ getNoteText()

◆ getNoteTextPlaceholder()

◆ getOriginHeader()

◆ getShowEmptyListMessage()

◆ getShowHeader()

◆ getShyButton()

◆ getSortationControl()

◆ getSubObjectTitle()

◆ getTarget()

◆ getUseObjectTitleHeader()

◆ listSortAsc()

◆ listSortDesc()

◆ renderComponents()

◆ renderContent()

◆ setDefaultCommand()

◆ setExportMode()

◆ setHideNewForm()

◆ setRepositoryMode()

◆ setShowEmptyListMessage()

◆ setShowHeader()

◆ setUseObjectTitleHeader()

◆ updateNote()

◆ updateWidget()

Field Documentation

◆ $access

◆ $add_note_form

◆ $ajax

◆ $comments_settings

◆ $ctrl

◆ $data

◆ $default_command

◆ $delete_note

◆ $edit_note_form

◆ $enable_sorting

◆ $export_html

◆ $form_tpl

◆ $gui

◆ $hide_new_form

◆ $inc_sub