class.ilPDNotesGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2012 ILIAS open source, Extended GPL, see docs/LICENSE */


include_once("Services/Notes/classes/class.ilNote.php");

class ilPDNotesGUI
{
    protected $ctrl;

    protected $user;

    protected $tabs;

    protected $help;

    protected $settings;

    protected $access;

    protected $toolbar;

    public $tpl;
    public $lng;
    
    const PUBLIC_COMMENTS = "publiccomments";
    const PRIVATE_NOTES = "privatenotes";

    public function __construct()
    {
        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();
        $ilTabs = $DIC->tabs();
        $ilHelp = $DIC["ilHelp"];

        $ilHelp->setScreenIdComponent("note");

        $lng->loadLanguageModule("notes");
        
        // initiate variables
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->ctrl = $ilCtrl;
        
        // link from ilPDNotesBlockGUI
        if ($_GET["rel_obj"]) {
            $mode = ($_GET["note_type"] == IL_NOTE_PRIVATE) ? self::PRIVATE_NOTES : self::PUBLIC_COMMENTS;
            $ilUser->writePref("pd_notes_mode", $mode);
            $ilUser->writePref("pd_notes_rel_obj" . $mode, $_GET["rel_obj"]);
        }
        // edit link
        elseif ($_REQUEST["note_id"]) {
            $note = new ilNote($_REQUEST["note_id"]);
            $mode = ($note->getType() == IL_NOTE_PRIVATE) ? self::PRIVATE_NOTES : self::PUBLIC_COMMENTS;
            $obj = $note->getObject();
            $ilUser->writePref("pd_notes_mode", $mode);
            $ilUser->writePref("pd_notes_rel_obj" . $mode, $obj["rep_obj_id"]);
        }
    }

    public function executeCommand()
    {
        $next_class = $this->ctrl->getNextClass();
        switch ($next_class) {
            case "ilnotegui":
                // scorm2004-start
                $this->setTabs();
                // scorm2004-end
                $this->displayHeader();
                $this->view();          // forwardCommand is invoked in view() method
                break;
                
            default:
                // scorm2004-start
                $this->setTabs();
                // scorm2004-end
                $cmd = $this->ctrl->getCmd("view");
                $this->displayHeader();
                $this->$cmd();
                break;
        }
        $this->tpl->printToStdout(true);
        return true;
    }

    public function displayHeader()
    {
        $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->getMode() == self::PRIVATE_NOTES) {
            $t = $this->lng->txt("private_notes");
            $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_nots.svg"));
        } else {
            $t = $this->lng->txt("notes_public_comments");
            $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_coms.svg"));
        }

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

        // catch feedback message
        // display infopanel if something happened
        ilUtil::infoPanel();
    }

    /*
    * display notes
    */
    public function view()
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilSetting = $this->settings;
        $ilAccess = $this->access;
        $ilToolbar = $this->toolbar;

        //$this->tpl->addBlockFile("ADM_CONTENT", "objects", "tpl.table.html")
        include_once("Services/Notes/classes/class.ilNoteGUI.php");
                
        // output related item selection (if more than one)
        include_once("Services/Notes/classes/class.ilNote.php");
        $rel_objs = ilNote::_getRelatedObjectsOfUser($this->getMode());
        //var_dump($rel_objs);
        // prepend personal dektop, if first object
        //              if ($rel_objs[0]["rep_obj_id"] > 0 && $this->getMode() == ilPDNotesGUI::PRIVATE_NOTES)
        if ($this->getMode() == ilPDNotesGUI::PRIVATE_NOTES) {
            $rel_objs = array_merge(array(0), $rel_objs);
        }

        // #9410
        if (!$rel_objs && $this->getMode() == ilPDNotesGUI::PUBLIC_COMMENTS) {
            $lng->loadLanguageModule("notes");
            ilUtil::sendInfo($lng->txt("msg_no_search_result"));
            return;
        }

        $first = true;
        $current_ref_ids = [];
        foreach ($rel_objs as $r) {
            if ($first) {       // take first one as default
                $this->current_rel_obj = $r["rep_obj_id"];
                $current_ref_ids = $r["ref_ids"];
            }
            if ($r["rep_obj_id"] == $ilUser->getPref("pd_notes_rel_obj" . $this->getMode())) {
                $this->current_rel_obj = $r["rep_obj_id"];
                $current_ref_ids = $r["ref_ids"];
            }
            $first = false;
        }
        if ($this->current_rel_obj > 0) {
            $notes_gui = new ilNoteGUI(
                $this->current_rel_obj,
                0,
                ilObject::_lookupType($this->current_rel_obj),
                true
            );
        } else {
            $notes_gui = new ilNoteGUI(0, $ilUser->getId(), "pd");
        }
        
        if ($this->getMode() == ilPDNotesGUI::PRIVATE_NOTES) {
            $notes_gui->enablePrivateNotes(true);
            $notes_gui->enablePublicNotes(false);
        } else {
            $notes_gui->enablePrivateNotes(false);
            $notes_gui->enablePublicNotes(true);
            // #13707
            if ($this->current_rel_obj > 0 &&
                count($current_ref_ids) > 0 &&
                $ilSetting->get("comments_del_tutor", 1)) {
                foreach ($current_ref_ids as $ref_id) {
                    if ($ilAccess->checkAccess("write", "", $ref_id)) {
                        $notes_gui->enablePublicNotesDeletion(true);
                        break;
                    }
                }
            }
        }
        $notes_gui->enableHiding(false);
        $notes_gui->enableTargets(true);
        $notes_gui->enableMultiSelection(true);
        $notes_gui->enableAnchorJump(false);

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

        if ($next_class == "ilnotegui") {
            $html = $this->ctrl->forwardCommand($notes_gui);
        } else {
            if ($this->getMode() == ilPDNotesGUI::PRIVATE_NOTES) {
                $html = $notes_gui->getOnlyNotesHTML();
            } else {
                $html = $notes_gui->getOnlyCommentsHTML();
            }
        }
        
        if (count($rel_objs) > 1 ||
            ($rel_objs[0]["rep_obj_id"] > 0)) {
            $ilToolbar->setFormAction($this->ctrl->getFormAction($this));
            
            foreach ($rel_objs as $obj) {
                if ($obj["rep_obj_id"] > 0) {
                    $type = ilObject::_lookupType($obj["rep_obj_id"]);
                    $type_str = (in_array($type, array("lm", "htlm", "sahs")))
                        ? $lng->txt("obj_lm")
                        : $lng->txt("obj_" . $type);
                    $caption = $type_str . ": " . ilObject::_lookupTitle($obj["rep_obj_id"]);
                } else {
                    $caption = $lng->txt("note_without_object");
                }
                
                $options[$obj["rep_obj_id"]] = $caption;
            }
            
            include_once "Services/Form/classes/class.ilSelectInputGUI.php";
            $rel = new ilSelectInputGUI($lng->txt("related_to"), "rel_obj");
            $rel->setOptions($options);
            $rel->setValue($this->current_rel_obj);
            $ilToolbar->addStickyItem($rel);

            $btn = ilSubmitButton::getInstance();
            $btn->setCaption('change');
            $btn->setCommand('changeRelatedObject');
            $ilToolbar->addStickyItem($btn);
        }
        
        $this->tpl->setContent($html);
    }
    
    public function changeRelatedObject()
    {
        $ilUser = $this->user;
        
        $ilUser->writePref("pd_notes_rel_obj" . $this->getMode(), $_POST["rel_obj"]);
        $this->ctrl->redirect($this);
    }

    // scorm2004-start
    public function setTabs()
    {
        $ilTabs = $this->tabs;
        $ilSetting = $this->settings;
        $ilCtrl = $this->ctrl;

        /*
        if(!$ilSetting->get("disable_notes"))
        {
            $ilTabs->addTarget("private_notes",
                $ilCtrl->getLinkTarget($this, "showPrivateNotes"), "", "", "",
                ($this->getMode() == ilPDNotesGUI::PRIVATE_NOTES));
        }

        if(!$ilSetting->get("disable_comments"))
        {
            $ilTabs->addTarget("notes_public_comments",
                $ilCtrl->getLinkTarget($this, "showPublicComments"), "", "", "",
                ($this->getMode() == ilPDNotesGUI::PUBLIC_COMMENTS));
        }*/
    }
    
    public function showPrivateNotes()
    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        
        $ilUser->writePref("pd_notes_mode", ilPDNotesGUI::PRIVATE_NOTES);
        $ilCtrl->redirect($this, "");
    }
    
    public function showPublicComments()
    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;
        
        if ($ilSetting->get("disable_comments")) {
            $ilCtrl->redirect($this, "showPrivateNotes");
        }
        
        $ilUser->writePref("pd_notes_mode", ilPDNotesGUI::PUBLIC_COMMENTS);
        $ilCtrl->redirect($this, "");
    }

    public function getMode()
    {
        $ilUser = $this->user;
        $ilSetting = $this->settings;
        
        if ($ilUser->getPref("pd_notes_mode") == ilPDNotesGUI::PUBLIC_COMMENTS &&
            !$ilSetting->get("disable_comments")) {
            return ilPDNotesGUI::PUBLIC_COMMENTS;
        } else {
            return ilPDNotesGUI::PRIVATE_NOTES;
        }
    }
}