Comment GUI. More...

Inheritance diagram for ilCommentGUI:

Collaboration diagram for ilCommentGUI:

Public Member Functions
	__construct ( $rep_obj_id=0, int $obj_id=0, string $obj_type="", bool $include_subobjects=false, int $news_id=0, bool $ajax=true, string $search_text="")

	getNotesHTML ()

	getCommentsHTML ()

	getListHTML (bool $a_init_form=true)

Public Member Functions inherited from 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="")

	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 ()

	getListHTML (bool $a_init_form=true)

	activateComments ()

	deactivateComments ()

	getNoteListHTML (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...

	setExportMode ()

	getGlyph ()

	getNumber ()

	getTriggerShyButton ()

	getWidget ()

Protected Member Functions
	getNoEntriesText (bool $search)

	getItemGroupTitle (int $obj_id=0)

	getItemTitle (Note $note)

	addItemProperties (Note $note, array &$properties)

	getFormLabelKey ()

	getDeleteText ()

	getLatestItemText ()

	getAddEditItemText ()

	getListTitle ()

	getAddText ()

	getDeletedMultipleText ()

	getDeletedSingleText ()

Protected Member Functions inherited from ilNoteGUI
	renderComponents (array $components)

	getCommentsHTML ()

	getNotes ()

	getListTitle ()

	getAddText ()

	getDeletedMultipleText ()

	getDeletedSingleText ()

	getLatestItemText ()

	getAddEditItemText ()

	getNoEntriesText (bool $search)

	getSortationControl ()

	getItemGroupTitle (int $obj_id=0)

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

	getItemTitle (Note $note)

	addItemProperties (Note $note, array &$properties)

	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)

	getFormLabelKey ()

	deleteNote ()

	getDeleteText ()

	listSortAsc ()

	listSortDesc ()

	getOriginHeader ()

	updateWidget ()

	updateGlyph ()

	updateNumber ()

Protected Attributes
int	$note_type = Note::PUBLIC

Protected Attributes inherited from ilNoteGUI
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	$note_type = Note::PRIVATE

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

int	$recipient = 0

Additional Inherited Members
Static Public Member Functions inherited from ilNoteGUI
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 inherited from ilNoteGUI
bool	$public_deletion_enabled = false

bool	$repository_mode = false

bool	$old = false

Detailed Description

Comment GUI.

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

Constructor & Destructor Documentation

◆ __construct()

ilCommentGUI::__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

Reimplemented from ilNoteGUI.

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

      {
        parent::__construct(
            $rep_obj_id,
            $obj_id,
            $obj_type,
            $include_subobjects,
            $news_id,
            $ajax,
            $search_text
        );
        $this->enablePrivateNotes(false);
        $this->enablePublicNotes(true);
    }

References ilNoteGUI\$ajax, ilNoteGUI\$news_id, ilNoteGUI\$obj_id, ilNoteGUI\$obj_type, ilNoteGUI\$rep_obj_id, ilNoteGUI\$search_text, ILIAS\GlobalScreen\Provider\__construct(), ilNoteGUI\enablePrivateNotes(), and ilNoteGUI\enablePublicNotes().

Here is the call graph for this function:

Member Function Documentation

◆ addItemProperties()

ilCommentGUI::addItemProperties	(	Note	$note,
		array &	$properties
	)

protected

Reimplemented from ilNoteGUI.

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

                                                                        : void
    {
        $creation_date = ilDatePresentation::formatDate(new ilDate($note->getCreationDate(), IL_CAL_DATETIME));
        $properties[$this->lng->txt("create_date")] = $creation_date;
    }

References ilDatePresentation\formatDate(), ILIAS\Notes\Note\getCreationDate(), IL_CAL_DATETIME, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getAddEditItemText()

ilCommentGUI::getAddEditItemText ( )

protected

Reimplemented from ilNoteGUI.

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

                                           : string
    {
        return $this->lng->txt("notes_add_edit_comment");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getAddText()

ilCommentGUI::getAddText ( )

protected

Reimplemented from ilNoteGUI.

Definition at line 189 of file class.ilCommentGUI.php.

                                   : string
    {
        return $this->lng->txt("note_add_comment");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getCommentsHTML()

ilCommentGUI::getCommentsHTML ( )

Reimplemented from ilNoteGUI.

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

                                     : string
    {
        throw new ilException("Call to getCommentsHTML is deprecated");
    }

◆ getDeletedMultipleText()

ilCommentGUI::getDeletedMultipleText ( )

protected

Reimplemented from ilNoteGUI.

Definition at line 194 of file class.ilCommentGUI.php.

                                               : string
    {
        return $this->lng->txt("notes_comments_deleted");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getDeletedSingleText()

ilCommentGUI::getDeletedSingleText ( )

protected

Reimplemented from ilNoteGUI.

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

                                             : string
    {
        return $this->lng->txt("notes_comment_deleted");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getDeleteText()

ilCommentGUI::getDeleteText ( )

protected

Reimplemented from ilNoteGUI.

Definition at line 96 of file class.ilCommentGUI.php.

                                      : string
    {
        return $this->lng->txt("notes_delete_comment");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getFormLabelKey()

ilCommentGUI::getFormLabelKey ( )

protected

Reimplemented from ilNoteGUI.

Definition at line 91 of file class.ilCommentGUI.php.

                                        : string
    {
        return "comment";
    }

◆ getItemGroupTitle()

ilCommentGUI::getItemGroupTitle ( int $obj_id = 0 )

protected

Reimplemented from ilNoteGUI.

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

                                                         : string
    {
        if (!$this->show_header) {
            return "";
        }
        return $this->lng->txt("notes_comments");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getItemTitle()

ilCommentGUI::getItemTitle ( Note $note )

protected

Reimplemented from ilNoteGUI.

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

                                               : string
    {
        return $this->gui->profile()->getNamePresentation($note->getAuthor());
    }

References ILIAS\Notes\Note\getAuthor().

Here is the call graph for this function:

◆ getLatestItemText()

ilCommentGUI::getLatestItemText ( )

protected

Reimplemented from ilNoteGUI.

Definition at line 101 of file class.ilCommentGUI.php.

                                          : string
    {
        return $this->lng->txt("notes_latest_comment");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getListHTML()

ilCommentGUI::getListHTML ( bool $a_init_form = true )

Reimplemented from ilNoteGUI.

Definition at line 119 of file class.ilCommentGUI.php.

                                                         : string
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;
 
        if ($this->ajax) {
            $this->gui->initJavascript();
        }
        $ilCtrl = $this->ctrl;
        $ilCtrl->setParameter($this, "notes_type", $this->note_type);
 
        $content = "";
        // #15948 - public enabled vs. comments_settings
        $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($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 ilNoteGUI\$ctrl, $ilSetting, ilNoteGUI\$lng, ilNoteGUI\$settings, ilNoteGUI\$user, ANONYMOUS_USER_ID, ilNoteGUI\getNoteListHTML(), ilNoteGUI\getShyButton(), ilNoteGUI\renderComponents(), ilNoteGUI\renderContent(), ilCtrl\setParameter(), and ilLanguage\txt().

Here is the call graph for this function:

◆ getListTitle()

ilCommentGUI::getListTitle ( )

protected

Reimplemented from ilNoteGUI.

Definition at line 184 of file class.ilCommentGUI.php.

                                     : string
    {
        return $this->lng->txt("notes_public_comments");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getNoEntriesText()

ilCommentGUI::getNoEntriesText ( bool $search )

protected

Reimplemented from ilNoteGUI.

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

                                                     : string
    {
        if (!$search) {
            $mess_txt = $this->lng->txt("notes_no_comments");
        } else {
            $mess_txt = $this->lng->txt("notes_no_comments_found");
        }
        return $mess_txt;
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getNotesHTML()

ilCommentGUI::getNotesHTML ( )

Reimplemented from ilNoteGUI.

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

                                  : string
    {
        throw new ilException("Call to getNotesHTML is deprecated");
    }

Field Documentation

◆ $note_type

int ilCommentGUI::$note_type = Note::PUBLIC

protected

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

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

components/ILIAS/Notes/Comment/class.ilCommentGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addItemProperties()

◆ getAddEditItemText()

◆ getAddText()

◆ getCommentsHTML()

◆ getDeletedMultipleText()

◆ getDeletedSingleText()

◆ getDeleteText()

◆ getFormLabelKey()

◆ getItemGroupTitle()

◆ getItemTitle()

◆ getLatestItemText()

◆ getListHTML()

◆ getListTitle()

◆ getNoEntriesText()

◆ getNotesHTML()

Field Documentation

◆ $note_type