class.ilCommentGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Notes\Note;

class ilCommentGUI extends ilNoteGUI
{
    protected int $note_type = Note::PUBLIC;

    public function __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 = ""
    ) {
        parent::__construct(
            $rep_obj_id,
            $obj_id,
            $obj_type,
            $include_subobjects,
            $news_id,
            $ajax,
            $search_text
        );
        $this->enablePrivateNotes(false);
        $this->enablePublicNotes(true);
    }

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

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

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

    protected function getItemGroupTitle(int $obj_id = 0): string
    {
        if (!$this->show_header) {
            return "";
        }
        return $this->lng->txt("notes_comments");
    }

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

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

    protected function getFormLabelKey(): string
    {
        return "comment";
    }

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

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

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


    /*
    public function getHTML(): string
    {
        $this->gui->initJavascript();
        return $this->getCommentsWidget();
    }*/

    public function getListHTML(bool $a_init_form = true): 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);
    }



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

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

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

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

}