ilPDNotesGUI Class Reference

Private Notes on PD. More...

Collaboration diagram for ilPDNotesGUI:

Public Member Functions
	__construct ()
	executeCommand ()
	displayHeader ()
	view ()
	changeRelatedObject ()
	showPrivateNotes ()
	showPublicComments ()
	printSelection ()

Data Fields
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng

Protected Member Functions
	readFilter ()
	getRelatedObjects ()
	getGui ()
	setSortation ()
	getFilter ()
	setToolbar ()

Protected Attributes
int	$note_type
string	$search_text = ""
FilterAdapterGUI	$filter = null
ILIAS Notes InternalGUIService	$gui
ILIAS DI UIServices	$ui
NotesManager	$notes_manager
int	$current_rel_obj = null
StandardGUIRequest	$request
ilCtrl	$ctrl
ilObjUser	$user
ilTabsGUI	$tabs
ilHelpGUI	$help
ilSetting	$settings
ilAccessHandler	$access
ilToolbarGUI	$toolbar
array	$related_objects = null

Detailed Description

Private Notes on PD.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilPDNotesGUI: ilNoteGUI, ilCommentGUI

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

Constructor & Destructor Documentation

__construct()

ilPDNotesGUI::__construct

(

)

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

References $context, $DIC, $lng, $tpl, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), readFilter(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

    {
        global $DIC;

        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->help = $DIC["ilHelp"];
        $this->settings = $DIC->settings();
        $this->access = $DIC->access();
        $this->toolbar = $DIC->toolbar();
        $tpl = $DIC["tpl"];
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
        $ilUser = $DIC->user();
        $ilHelp = $DIC["ilHelp"];
        $this->ui = $DIC->ui();

        $this->request = $DIC->notes()
            ->internal()
            ->gui()
            ->standardRequest();

        $ilHelp->setScreenIdComponent("note");

        $lng->loadLanguageModule("notes");

        // initiate variables
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->ctrl = $ilCtrl;

        $this->notes_manager = $DIC->notes()->internal()->domain()->notes();
        $this->gui = $DIC->notes()->internal()->gui();

        // link from ilPDNotesBlockGUI
        $rel_obj = $this->request->getRelatedObjId();
        $this->note_type = ($this->request->getNoteType() === Note::PRIVATE || $ilCtrl->getCmd() === "getNotesHTML")
            ? Note::PRIVATE
            : Note::PUBLIC;
        if ($ilCtrl->getCmd() === "getCommentsHTML") {
            $this->note_type = Note::PUBLIC;
        }
        $this->ctrl->setParameter($this, "note_type", $this->note_type);
        if ($rel_obj > 0) {
            $ilUser->writePref("pd_notes_rel_obj" . $this->note_type, (string) $rel_obj);
        }
        // edit link
        elseif ($this->request->getNoteId() > 0) {
            $note = $this->notes_manager->getById($this->request->getNoteId());
            $context = $note->getContext();
            $ilUser->writePref("pd_notes_rel_obj" . $this->note_type, $context->getObjId());
        }
        $this->readFilter();
        $ajax_url = $this->ctrl->getLinkTargetByClass(
            ["ildashboardgui", "ilpdnotesgui", "ilnotegui"],
            "",
            "",
            true,
            false
        );
        $this->gui->initJavascript($ajax_url);
    }

Here is the call graph for this function:

Member Function Documentation

changeRelatedObject()

ilPDNotesGUI::changeRelatedObject

(

)

Definition at line 285 of file class.ilPDNotesGUI.php.

References $user, ILIAS\Repository\ctrl(), and ilObjUser\writePref().

                                         : void
    {
        $ilUser = $this->user;

        $ilUser->writePref(
            "pd_notes_rel_obj" . $this->note_type,
            (string) $this->request->getRelatedObjId()
        );
        $this->ctrl->redirect($this);
    }

Here is the call graph for this function:

displayHeader()

ilPDNotesGUI::displayHeader

(

)

Definition at line 149 of file class.ilPDNotesGUI.php.

References $ilSetting, $settings, ilUtil\getImagePath(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                                   : void
    {
        $ilSetting = $this->settings;

        $t = $this->lng->txt("notes");
        if (!$ilSetting->get("disable_notes") && !$ilSetting->get("disable_comments")) {
            $t = $this->lng->txt("notes_and_comments");
        }
        if ($ilSetting->get("disable_notes")) {
            $t = $this->lng->txt("notes_comments");
        }

        if ($this->note_type === Note::PRIVATE) {
            $t = $this->lng->txt("private_notes");
            $this->tpl->setTitleIcon(ilUtil::getImagePath("standard/icon_nots.svg"));
        } else {
            $t = $this->lng->txt("notes_public_comments");
            $this->tpl->setTitleIcon(ilUtil::getImagePath("standard/icon_coms.svg"));
        }

        $this->tpl->setTitle($t);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPDNotesGUI::executeCommand

(

)

Definition at line 126 of file class.ilPDNotesGUI.php.

References ILIAS\Repository\ctrl(), displayHeader(), and view().

                                    : void
    {
        $next_class = $this->ctrl->getNextClass();
        switch ($next_class) {
            case "ilnotegui":
                $this->displayHeader();
                $this->view();          // forwardCommand is invoked in view() method
                break;

            case "ilcommentgui":
                $this->displayHeader();
                $this->view();          // forwardCommand is invoked in view() method
                break;

            default:
                $cmd = $this->ctrl->getCmd("view");
                $this->displayHeader();
                $this->$cmd();
                break;
        }
        $this->tpl->printToStdout(true);
    }

Here is the call graph for this function:

getFilter()

ilPDNotesGUI::getFilter ( )

protected

Definition at line 323 of file class.ilPDNotesGUI.php.

References $filter, $gui, $lng, ilObject\_lookupTitle(), ILIAS\Repository\filter(), getRelatedObjects(), ILIAS\Repository\lng(), and ilLanguage\txt().

Referenced by readFilter(), and view().

                                  : FilterAdapterGUI
    {
        $gui = $this->gui;
        $lng = $this->lng;
        if (is_null($this->filter)) {
            $options = [];

            if ($this->note_type === Note::PRIVATE) {
                $options[-1] = $this->lng->txt("note_without_object");
            }

            foreach ($this->getRelatedObjects() as $k) {
                $options[$k] = ilObject::_lookupTitle($k);
            }
            $this->filter = $gui->filter(
                "notes_filter_" . $this->note_type,
                self::class,
                "view",
                false,
                false
            )
                ->text("text", $lng->txt("notes_text"))
                ->select("object", $lng->txt("notes_origin"), $options);
        }
        return $this->filter;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGui()

ilPDNotesGUI::getGui ( )

protected

Definition at line 242 of file class.ilPDNotesGUI.php.

References $current_rel_obj, $gui, ilObject\_lookupType(), getRelatedObjects(), and ILIAS\Repository\user().

Referenced by view().

                               : ilNoteGUI
    {
        $rel_objs = $this->getRelatedObjects();
        if ($this->current_rel_obj === null) {
            $rep_objs = $rel_objs;
            $type = "";
            $include_subs = true;
            $obj_id = 0;
        } elseif ($this->current_rel_obj > 0) {
            $rep_objs = $this->current_rel_obj;
            $type = \ilObject::_lookupType($this->current_rel_obj);
            $include_subs = true;
            $obj_id = 0;
        } else {
            $rep_objs = 0;
            $type = "pd";
            $include_subs = false;
            $obj_id = $this->user->getId();
        }
        if ($this->note_type === Note::PRIVATE) {
            $gui = new ilNoteGUI(
                $rep_objs,
                $obj_id,
                $type,
                $include_subs,
                0,
                false,
                $this->search_text
            );
        } else {
            $gui = $this->gui->getCommentsGUI(
                $rep_objs,
                $obj_id,
                $type,
                0,
                $include_subs,
                false,
                $this->search_text
            );
        }
        return $gui;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRelatedObjects()

ilPDNotesGUI::getRelatedObjects ( )

protected

Definition at line 172 of file class.ilPDNotesGUI.php.

References $related_objects.

Referenced by getFilter(), getGui(), and view().

                                          : array
    {
        if (is_null($this->related_objects)) {
            $this->related_objects = $this->notes_manager->getRelatedObjectsOfUser(
                $this->note_type
            );
        }
        return $this->related_objects;
    }

Here is the caller graph for this function:

printSelection()

ilPDNotesGUI::printSelection

(

)

Exceptions

Definition at line 387 of file class.ilPDNotesGUI.php.

                                    : void
    {
        $pv = $this->gui->print();
        $pv->sendForm();
    }

readFilter()

ilPDNotesGUI::readFilter ( )

protected

Definition at line 115 of file class.ilPDNotesGUI.php.

References $data, getFilter(), and ILIAS\Repository\int().

Referenced by __construct().

                                   : void
    {
        $data = $this->getFilter()->getData();
        if (!isset($data["object"]) || $data["object"] === "") {
            $this->current_rel_obj = null;
        } else {
            $this->current_rel_obj = (int) $data["object"];
        }
        $this->search_text = $data["text"] ?? "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSortation()

ilPDNotesGUI::setSortation ( )

protected

Definition at line 317 of file class.ilPDNotesGUI.php.

References view().

                                     : void
    {
        $this->notes_manager->setSortAscending($this->gui->standardRequest()->getSortation() === "asc");
        $this->view();
    }

Here is the call graph for this function:

setToolbar()

ilPDNotesGUI::setToolbar ( )

protected

Definition at line 350 of file class.ilPDNotesGUI.php.

References Vendor\Package\$b, Vendor\Package\$c, $ctrl, ilCtrl\getLinkTarget(), ilCtrl\getLinkTargetByClass(), ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), and ILIAS\Repository\ui().

Referenced by view().

                                   : void
    {
        $ctrl = $this->ctrl;

        // sortation
        $c = $this->lng->txt("create_date") . ", ";
        $options = [
            'desc' => $c . $this->lng->txt("sorting_desc"),
            'asc' => $c . $this->lng->txt("sorting_asc")
        ];
        $select_option = ($this->notes_manager->getSortAscending())
            ? 'asc'
            : 'desc';
        $s = $this->ui->factory()->viewControl()->sortation($options)
               ->withTargetURL($ctrl->getLinkTarget($this, "setSortation"), 'sortation')
               ->withLabel($options[$select_option]);
        $this->toolbar->addComponent($s);

        // print selection
        $pv = $this->gui->print();
        $modal_elements = $pv->getModalElements(
            $ctrl->getLinkTarget($this, "printSelection")
        );
        $this->toolbar->addComponent($modal_elements->button);
        $this->toolbar->addComponent($modal_elements->modal);

        // export html
        $b = $this->ui->factory()->button()->standard(
            $this->lng->txt("notes_html_export"),
            $ctrl->getLinkTargetByClass("ilNoteGUI", "exportNotesHTML")
        );
        $this->toolbar->addComponent($b);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showPrivateNotes()

ilPDNotesGUI::showPrivateNotes

(

)

Definition at line 296 of file class.ilPDNotesGUI.php.

References $ctrl, $user, and ilCtrl\redirectByClass().

                                      : void
    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;

        $ilCtrl->redirectByClass(ilNoteGUI::class, "getNotesHTML");
    }

Here is the call graph for this function:

showPublicComments()

ilPDNotesGUI::showPublicComments

(

)

Definition at line 304 of file class.ilPDNotesGUI.php.

References $ctrl, $ilSetting, $settings, and $user.

                                        : void
    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;

        if ($ilSetting->get("disable_comments")) {
            $ilCtrl->redirect($this, "showPrivateNotes");
        }

        $ilCtrl->redirectByClass(ilCommentGUI::class, "getListHTML");
    }

view()

ilPDNotesGUI::view

(

)

Definition at line 182 of file class.ilPDNotesGUI.php.

References $access, $ilSetting, $lng, $ref_id, $settings, $toolbar, $user, ilObject\_getAllReferences(), ILIAS\Repository\ctrl(), getFilter(), getGui(), getRelatedObjects(), ilLanguage\loadLanguageModule(), setToolbar(), and ilLanguage\txt().

Referenced by executeCommand(), and setSortation().

                          : void
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilSetting = $this->settings;
        $ilAccess = $this->access;
        $ilToolbar = $this->toolbar;

        $rel_objs = $this->getRelatedObjects();
        $this->setToolbar();

        if ($this->note_type === Note::PRIVATE) {
            $rel_objs = array_merge(
                [0],
                $rel_objs
            );
        }

        // #9410
        if (count($rel_objs) === 0 && $this->note_type === Note::PUBLIC) {
            $lng->loadLanguageModule("notes");
            $this->tpl->setOnScreenMessage('info', $lng->txt("msg_no_search_result"));
            return;
        }
        $notes_gui = $this->getGui();

        if ($this->note_type === Note::PRIVATE) {
            $notes_gui->enablePrivateNotes(true);
            $notes_gui->enablePublicNotes(false);
        } else {
            $notes_gui->enablePrivateNotes(false);
            $notes_gui->enablePublicNotes(true);
            // #13707
            if ($this->current_rel_obj > 0 &&
                $ilSetting->get("comments_del_tutor", '1')) {
                foreach (\ilObject::_getAllReferences($this->current_rel_obj) as $ref_id) {
                    if ($ilAccess->checkAccess("write", "", $ref_id)) {
                        $notes_gui->enablePublicNotesDeletion(true);
                        break;
                    }
                }
            }
        }
        $notes_gui->enableTargets(true);

        $next_class = $this->ctrl->getNextClass($this);

        if (in_array($next_class, ["ilnotegui", "ilcommentgui"])) {
            $html = $this->ctrl->forwardCommand($notes_gui);
        } elseif ($this->note_type === Note::PRIVATE) {
            $html = $notes_gui->getNotesHTML();
        } else {
            $html = $notes_gui->getListHTML();
        }

        $filter_html = $this->getFilter()->render();

        $this->tpl->setContent($filter_html . $html);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilPDNotesGUI::$access

protected

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

Referenced by view().

$ctrl

ilCtrl ilPDNotesGUI::$ctrl

protected

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

Referenced by setToolbar(), showPrivateNotes(), and showPublicComments().

$current_rel_obj

int ilPDNotesGUI::$current_rel_obj = null

protected

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

Referenced by getGui().

$filter

FilterAdapterGUI ilPDNotesGUI::$filter = null

protected

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

Referenced by getFilter().

$gui

ILIAS Notes InternalGUIService ilPDNotesGUI::$gui

protected

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

Referenced by getFilter(), and getGui().

$help

ilHelpGUI ilPDNotesGUI::$help

protected

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

$lng

ilLanguage ilPDNotesGUI::$lng

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

Referenced by __construct(), getFilter(), and view().

$note_type

int ilPDNotesGUI::$note_type

protected

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

$notes_manager

NotesManager ilPDNotesGUI::$notes_manager

protected

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

$related_objects

array ilPDNotesGUI::$related_objects = null

protected

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

Referenced by getRelatedObjects().

$request

StandardGUIRequest ilPDNotesGUI::$request

protected

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

$search_text

string ilPDNotesGUI::$search_text = ""

protected

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

$settings

ilSetting ilPDNotesGUI::$settings

protected

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

Referenced by displayHeader(), showPublicComments(), and view().

$tabs

ilTabsGUI ilPDNotesGUI::$tabs

protected

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

$toolbar

ilToolbarGUI ilPDNotesGUI::$toolbar

protected

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

Referenced by view().

$tpl

ilGlobalTemplateInterface ilPDNotesGUI::$tpl

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

Referenced by __construct().

$ui

ILIAS DI UIServices ilPDNotesGUI::$ui

protected

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

$user

ilObjUser ilPDNotesGUI::$user

protected

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

Referenced by changeRelatedObject(), showPrivateNotes(), showPublicComments(), and view().

---

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

• Services/Notes/Note/class.ilPDNotesGUI.php