ilPDNotesGUI Class Reference

Private Notes on PD. More...

Collaboration diagram for ilPDNotesGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	execute command More...
	displayHeader ()
	display header and locator More...
	view ()
	changeRelatedObject ()
	change related object More...
	setTabs ()
	Show subtabs. More...
	showPrivateNotes ()
	Show private notes. More...
	showPublicComments ()
	Show public comments. More...
	getMode ()
	Get current mode. More...

Data Fields
	$tpl
	$lng
const	PUBLIC_COMMENTS = "publiccomments"
const	PRIVATE_NOTES = "privatenotes"

Protected Attributes
	$ctrl
	$user
	$tabs
	$help
	$settings
	$access
	$toolbar

Detailed Description

Private Notes on PD.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilPDNotesGUI: ilNoteGUI

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

Constructor & Destructor Documentation

__construct()

ilPDNotesGUI::__construct

(

)

Constructor.

public

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

References $_GET, $DIC, $ilUser, $lng, $tpl, help(), IL_NOTE_PRIVATE, settings(), and 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();
        $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"]);
        }
    }

Here is the call graph for this function:

Member Function Documentation

changeRelatedObject()

ilPDNotesGUI::changeRelatedObject

(

)

change related object

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

References $_POST, $ilUser, $user, and getMode().

    {
        $ilUser = $this->user;
        
        $ilUser->writePref("pd_notes_rel_obj" . $this->getMode(), $_POST["rel_obj"]);
        $this->ctrl->redirect($this);
    }

Here is the call graph for this function:

displayHeader()

ilPDNotesGUI::displayHeader

(

)

display header and locator

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

References $ilSetting, $settings, ilUtil\getImagePath(), getMode(), and ilUtil\infoPanel().

Referenced by executeCommand().

    {
        $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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPDNotesGUI::executeCommand

(

)

execute command

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

References displayHeader(), setTabs(), and view().

    {
        $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;
    }

Here is the call graph for this function:

getMode()

ilPDNotesGUI::getMode

(

)

Get current mode.

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

References $ilSetting, $ilUser, $settings, $user, PRIVATE_NOTES, and PUBLIC_COMMENTS.

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

    {
        $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;
        }
    }

Here is the caller graph for this function:

setTabs()

ilPDNotesGUI::setTabs

(

)

Show subtabs.

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

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

Referenced by executeCommand().

    {
        $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));
        }*/
    }

Here is the caller graph for this function:

showPrivateNotes()

ilPDNotesGUI::showPrivateNotes

(

)

Show private notes.

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

References $ctrl, $ilUser, $user, and PRIVATE_NOTES.

    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        
        $ilUser->writePref("pd_notes_mode", ilPDNotesGUI::PRIVATE_NOTES);
        $ilCtrl->redirect($this, "");
    }

showPublicComments()

ilPDNotesGUI::showPublicComments

(

)

Show public comments.

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

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

    {
        $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, "");
    }

view()

ilPDNotesGUI::view

(

)

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

References $access, $ilSetting, $ilUser, $lng, $settings, $toolbar, $type, $user, ilNote\_getRelatedObjectsOfUser(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilNoteGUI\enablePrivateNotes(), ilSubmitButton\getInstance(), getMode(), PRIVATE_NOTES, PUBLIC_COMMENTS, and ilUtil\sendInfo().

Referenced by executeCommand().

    {
        $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,
                0,
                false
            );
        } else {
            $notes_gui = new ilNoteGUI(0, $ilUser->getId(), "pd", false, 0, false);
        }
        
        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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilPDNotesGUI::$access

protected

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

Referenced by view().

$ctrl

ilPDNotesGUI::$ctrl

protected

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

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

$help

ilPDNotesGUI::$help

protected

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

$lng

ilPDNotesGUI::$lng

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

Referenced by __construct(), and view().

$settings

ilPDNotesGUI::$settings

protected

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

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

$tabs

ilPDNotesGUI::$tabs

protected

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

Referenced by setTabs().

$toolbar

ilPDNotesGUI::$toolbar

protected

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

Referenced by view().

$tpl

ilPDNotesGUI::$tpl

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

Referenced by __construct().

$user

ilPDNotesGUI::$user

protected

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

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

PRIVATE_NOTES

const ilPDNotesGUI::PRIVATE_NOTES = "privatenotes"

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

Referenced by ilNote\_getRelatedObjectsOfUser(), getMode(), showPrivateNotes(), and view().

PUBLIC_COMMENTS

const ilPDNotesGUI::PUBLIC_COMMENTS = "publiccomments"

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

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

---

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

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