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
	$ilias
	$tpl
	$lng
const	PUBLIC_COMMENTS = "publiccomments"
const	PRIVATE_NOTES = "privatenotes"

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$

@ilCtrl_Calls ilPDNotesGUI: ilNoteGUI

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

Constructor & Destructor Documentation

__construct()

ilPDNotesGUI::__construct

(

)

Constructor.

@access public

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

        {
                global $ilias, $tpl, $lng, $ilCtrl, $ilUser, $ilTabs, $ilHelp;
 
                $ilHelp->setScreenIdComponent("note");
 
                $lng->loadLanguageModule("notes");
                
                // initiate variables
                $this->ilias = $ilias;
                $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
                else if($_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"]);
                }
        }

References $_GET, $ilCtrl, $ilias, $ilUser, $lng, $tpl, and IL_NOTE_PRIVATE.

Member Function Documentation

changeRelatedObject()

ilPDNotesGUI::changeRelatedObject

(

)

change related object

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

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

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

Here is the call graph for this function:

displayHeader()

ilPDNotesGUI::displayHeader

(

)

display header and locator

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

        {
                global $ilSetting;
 
                $t = $this->lng->txt("notes");
                if (!$this->ilias->getSetting("disable_notes") && !$ilSetting->get("disable_comments"))
                {
                        $t = $this->lng->txt("notes_and_comments");
                }
                if ($this->ilias->getSetting("disable_notes"))
                {
                        $t = $this->lng->txt("notes_comments");
                }
 
                $this->tpl->setTitle($t);
 
                // catch feedback message
                // display infopanel if something happened
                ilUtil::infoPanel();
 
        }

References $ilSetting, $t, and ilUtil\infoPanel().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPDNotesGUI::executeCommand

(

)

execute command

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

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

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

Here is the call graph for this function:

getMode()

ilPDNotesGUI::getMode

(

)

Get current mode.

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

        {
                global $ilUser, $ilSetting;
                
                if ($ilUser->getPref("pd_notes_mode") == ilPDNotesGUI::PUBLIC_COMMENTS &&
                        !$ilSetting->get("disable_comments"))
                {
                        return ilPDNotesGUI::PUBLIC_COMMENTS;
                }
                else
                {
                        return ilPDNotesGUI::PRIVATE_NOTES;
                }
        }

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

Referenced by changeRelatedObject(), and view().

Here is the caller graph for this function:

setTabs()

ilPDNotesGUI::setTabs

(

)

Show subtabs.

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

        {
                global $ilTabs, $ilSetting, $ilCtrl;
 
                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));
                }
        }

References $ilCtrl, $ilSetting, PRIVATE_NOTES, and PUBLIC_COMMENTS.

Referenced by executeCommand().

Here is the caller graph for this function:

showPrivateNotes()

ilPDNotesGUI::showPrivateNotes

(

)

Show private notes.

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

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

References $ilCtrl, $ilUser, and PRIVATE_NOTES.

showPublicComments()

ilPDNotesGUI::showPublicComments

(

)

Show public comments.

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

        {
                global $ilUser, $ilCtrl, $ilSetting;
                
                if($ilSetting->get("disable_comments"))
                {
                        $ilCtrl->redirect($this, "showPrivateNotes");
                }
                
                $ilUser->writePref("pd_notes_mode", ilPDNotesGUI::PUBLIC_COMMENTS);
                $ilCtrl->redirect($this, "");
        }

References $ilCtrl, $ilSetting, $ilUser, and PUBLIC_COMMENTS.

view()

ilPDNotesGUI::view

(

)

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

        {
                global $ilUser, $lng, $ilSetting, $ilAccess, $ilToolbar;
 
                //$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;
                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 && 
                                sizeof($current_ref_ids) &&
                                $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("learning_resource")
                                                : $lng->txt("obj_".$type);
                                        $caption = $type_str.": ".ilObject::_lookupTitle($obj["rep_obj_id"]);
                                }
                                else
                                {
                                        $caption = $lng->txt("personal_desktop");
                                }
                                
                                $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->addInputItem($rel);
                        
                        $ilToolbar->addFormButton($lng->txt("change"), "changeRelatedObject");                  
                }
                
                $this->tpl->setContent($html);  
        }

References $html, $ilSetting, $ilUser, $lng, $options, $r, $ref_id, ilNote\_getRelatedObjectsOfUser(), ilObject\_lookupTitle(), ilObject\_lookupType(), getMode(), PRIVATE_NOTES, PUBLIC_COMMENTS, and ilUtil\sendInfo().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ilias

ilPDNotesGUI::$ilias

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

Referenced by __construct().

$lng

ilPDNotesGUI::$lng

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

Referenced by __construct(), and view().

$tpl

ilPDNotesGUI::$tpl

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

Referenced by __construct().

PRIVATE_NOTES

const ilPDNotesGUI::PRIVATE_NOTES = "privatenotes"

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

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

PUBLIC_COMMENTS

const ilPDNotesGUI::PUBLIC_COMMENTS = "publiccomments"

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

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

---

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

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