ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
Public Member Functions | Data Fields | Protected Attributes
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$

@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 65 of file class.ilPDNotesGUI.php.

66 {
67 global $DIC;
68
69 $this->user = $DIC->user();
70 $this->tabs = $DIC->tabs();
71 $this->help = $DIC["ilHelp"];
72 $this->settings = $DIC->settings();
73 $this->access = $DIC->access();
74 $this->toolbar = $DIC->toolbar();
75 $tpl = $DIC["tpl"];
76 $lng = $DIC->language();
77 $ilCtrl = $DIC->ctrl();
78 $ilUser = $DIC->user();
79 $ilTabs = $DIC->tabs();
80 $ilHelp = $DIC["ilHelp"];
81
82 $ilHelp->setScreenIdComponent("note");
83
84 $lng->loadLanguageModule("notes");
85
86 // initiate variables
87 $this->tpl = $tpl;
88 $this->lng = $lng;
89 $this->ctrl = $ilCtrl;
90
91 // link from ilPDNotesBlockGUI
92 if ($_GET["rel_obj"]) {
93 $mode = ($_GET["note_type"] == IL_NOTE_PRIVATE) ? self::PRIVATE_NOTES : self::PUBLIC_COMMENTS;
94 $ilUser->writePref("pd_notes_mode", $mode);
95 $ilUser->writePref("pd_notes_rel_obj" . $mode, $_GET["rel_obj"]);
96 }
97 // edit link
98 elseif ($_REQUEST["note_id"]) {
99 $note = new ilNote($_REQUEST["note_id"]);
100 $mode = ($note->getType() == IL_NOTE_PRIVATE) ? self::PRIVATE_NOTES : self::PUBLIC_COMMENTS;
101 $obj = $note->getObject();
102 $ilUser->writePref("pd_notes_mode", $mode);
103 $ilUser->writePref("pd_notes_rel_obj" . $mode, $obj["rep_obj_id"]);
104 }
105 }
user
user()
Definition: user.php:4
$_GET
$_GET["client_id"]
Definition: cfg.phpunit.template.php:12
IL_NOTE_PRIVATE
const IL_NOTE_PRIVATE
Definition: class.ilNote.php:4
ilNote
Note class.
Definition: class.ilNote.php:25
$ilCtrl
global $ilCtrl
Definition: ilias.php:18
$DIC
global $DIC
Definition: saml.php:7
settings
settings()
Definition: settings.php:2
$ilUser
$ilUser
Definition: imgupload.php:18

References $_GET, $DIC, $ilCtrl, $ilUser, $lng, $tpl, IL_NOTE_PRIVATE, settings(), and user().

+ Here is the call graph for this function:

Member Function Documentation

◆ changeRelatedObject()

ilPDNotesGUI::changeRelatedObject ( )

change related object

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

281 {
282 $ilUser = $this->user;
283
284 $ilUser->writePref("pd_notes_rel_obj" . $this->getMode(), $_POST["rel_obj"]);
285 $this->ctrl->redirect($this);
286 }
$_POST
$_POST["username"]
Definition: cfg.phpunit.template.php:11
ilPDNotesGUI\getMode
getMode()
Get current mode.
Definition: class.ilPDNotesGUI.php:353

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

+ Here is the call graph for this function:

◆ displayHeader()

ilPDNotesGUI::displayHeader ( )

display header and locator

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

139 {
140 $ilSetting = $this->settings;
141
142 $t = $this->lng->txt("notes");
143 if (!$ilSetting->get("disable_notes") && !$ilSetting->get("disable_comments")) {
144 $t = $this->lng->txt("notes_and_comments");
145 }
146 if ($ilSetting->get("disable_notes")) {
147 $t = $this->lng->txt("notes_comments");
148 }
149
150 $this->tpl->setTitle($t);
151
152 // catch feedback message
153 // display infopanel if something happened
154 ilUtil::infoPanel();
155 }
ilUtil\infoPanel
static infoPanel($a_keep=true)
Definition: class.ilUtil.php:4570
$ilSetting
global $ilSetting
Definition: privfeed.php:17

References $ilSetting, $settings, $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 110 of file class.ilPDNotesGUI.php.

111 {
112 $next_class = $this->ctrl->getNextClass();
113 switch ($next_class) {
114 case "ilnotegui":
115 // scorm2004-start
116 $this->setTabs();
117 // scorm2004-end
118 $this->displayHeader();
119 $this->view(); // forwardCommand is invoked in view() method
120 break;
121
122 default:
123 // scorm2004-start
124 $this->setTabs();
125 // scorm2004-end
126 $cmd = $this->ctrl->getCmd("view");
127 $this->displayHeader();
128 $this->$cmd();
129 break;
130 }
131 $this->tpl->show(true);
132 return true;
133 }
ilPDNotesGUI\displayHeader
displayHeader()
display header and locator
Definition: class.ilPDNotesGUI.php:138
ilPDNotesGUI\setTabs
setTabs()
Show subtabs.
Definition: class.ilPDNotesGUI.php:292

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

+ Here is the call graph for this function:

◆ getMode()

ilPDNotesGUI::getMode ( )

Get current mode.

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

354 {
355 $ilUser = $this->user;
356 $ilSetting = $this->settings;
357
358 if ($ilUser->getPref("pd_notes_mode") == ilPDNotesGUI::PUBLIC_COMMENTS &&
359 !$ilSetting->get("disable_comments")) {
360 return ilPDNotesGUI::PUBLIC_COMMENTS;
361 } else {
362 return ilPDNotesGUI::PRIVATE_NOTES;
363 }
364 }

References $ilSetting, $ilUser, $settings, $user, 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 292 of file class.ilPDNotesGUI.php.

293 {
294 $ilTabs = $this->tabs;
295 $ilSetting = $this->settings;
296 $ilCtrl = $this->ctrl;
297
298 if (!$ilSetting->get("disable_notes")) {
299 $ilTabs->addTarget(
300 "private_notes",
301 $ilCtrl->getLinkTarget($this, "showPrivateNotes"),
302 "",
303 "",
304 "",
305 ($this->getMode() == ilPDNotesGUI::PRIVATE_NOTES)
306 );
307 }
308
309 if (!$ilSetting->get("disable_comments")) {
310 $ilTabs->addTarget(
311 "notes_public_comments",
312 $ilCtrl->getLinkTarget($this, "showPublicComments"),
313 "",
314 "",
315 "",
316 ($this->getMode() == ilPDNotesGUI::PUBLIC_COMMENTS)
317 );
318 }
319 }

References $ctrl, $ilCtrl, $ilSetting, $settings, $tabs, 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 324 of file class.ilPDNotesGUI.php.

325 {
326 $ilUser = $this->user;
327 $ilCtrl = $this->ctrl;
328
329 $ilUser->writePref("pd_notes_mode", ilPDNotesGUI::PRIVATE_NOTES);
330 $ilCtrl->redirect($this, "");
331 }

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

◆ showPublicComments()

ilPDNotesGUI::showPublicComments ( )

Show public comments.

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

337 {
338 $ilUser = $this->user;
339 $ilCtrl = $this->ctrl;
340 $ilSetting = $this->settings;
341
342 if ($ilSetting->get("disable_comments")) {
343 $ilCtrl->redirect($this, "showPrivateNotes");
344 }
345
346 $ilUser->writePref("pd_notes_mode", ilPDNotesGUI::PUBLIC_COMMENTS);
347 $ilCtrl->redirect($this, "");
348 }

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

◆ view()

ilPDNotesGUI::view ( )

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

161 {
162 $ilUser = $this->user;
163 $lng = $this->lng;
164 $ilSetting = $this->settings;
165 $ilAccess = $this->access;
166 $ilToolbar = $this->toolbar;
167
168 //$this->tpl->addBlockFile("ADM_CONTENT", "objects", "tpl.table.html")
169 include_once("Services/Notes/classes/class.ilNoteGUI.php");
170
171 // output related item selection (if more than one)
172 include_once("Services/Notes/classes/class.ilNote.php");
173 $rel_objs = ilNote::_getRelatedObjectsOfUser($this->getMode());
174 //var_dump($rel_objs);
175 // prepend personal dektop, if first object
176 // if ($rel_objs[0]["rep_obj_id"] > 0 && $this->getMode() == ilPDNotesGUI::PRIVATE_NOTES)
177 if ($this->getMode() == ilPDNotesGUI::PRIVATE_NOTES) {
178 $rel_objs = array_merge(array(0), $rel_objs);
179 }
180
181 // #9410
182 if (!$rel_objs && $this->getMode() == ilPDNotesGUI::PUBLIC_COMMENTS) {
183 $lng->loadLanguageModule("notes");
184 ilUtil::sendInfo($lng->txt("msg_no_search_result"));
185 return;
186 }
187
188 $first = true;
189 foreach ($rel_objs as $r) {
190 if ($first) { // take first one as default
191 $this->current_rel_obj = $r["rep_obj_id"];
192 $current_ref_ids = $r["ref_ids"];
193 }
194 if ($r["rep_obj_id"] == $ilUser->getPref("pd_notes_rel_obj" . $this->getMode())) {
195 $this->current_rel_obj = $r["rep_obj_id"];
196 $current_ref_ids = $r["ref_ids"];
197 }
198 $first = false;
199 }
200 if ($this->current_rel_obj > 0) {
201 $notes_gui = new ilNoteGUI(
202 $this->current_rel_obj,
203 0,
204 ilObject::_lookupType($this->current_rel_obj),
205 true
206 );
207 } else {
208 $notes_gui = new ilNoteGUI(0, $ilUser->getId(), "pd");
209 }
210
211 if ($this->getMode() == ilPDNotesGUI::PRIVATE_NOTES) {
212 $notes_gui->enablePrivateNotes(true);
213 $notes_gui->enablePublicNotes(false);
214 } else {
215 $notes_gui->enablePrivateNotes(false);
216 $notes_gui->enablePublicNotes(true);
217
218 // #13707
219 if ($this->current_rel_obj > 0 &&
220 sizeof($current_ref_ids) &&
221 $ilSetting->get("comments_del_tutor", 1)) {
222 foreach ($current_ref_ids as $ref_id) {
223 if ($ilAccess->checkAccess("write", "", $ref_id)) {
224 $notes_gui->enablePublicNotesDeletion(true);
225 break;
226 }
227 }
228 }
229 }
230 $notes_gui->enableHiding(false);
231 $notes_gui->enableTargets(true);
232 $notes_gui->enableMultiSelection(true);
233 $notes_gui->enableAnchorJump(false);
234
235 $next_class = $this->ctrl->getNextClass($this);
236
237 if ($next_class == "ilnotegui") {
238 $html = $this->ctrl->forwardCommand($notes_gui);
239 } else {
240 if ($this->getMode() == ilPDNotesGUI::PRIVATE_NOTES) {
241 $html = $notes_gui->getOnlyNotesHTML();
242 } else {
243 $html = $notes_gui->getOnlyCommentsHTML();
244 }
245 }
246
247 if (count($rel_objs) > 1 ||
248 ($rel_objs[0]["rep_obj_id"] > 0)) {
249 $ilToolbar->setFormAction($this->ctrl->getFormAction($this));
250
251 foreach ($rel_objs as $obj) {
252 if ($obj["rep_obj_id"] > 0) {
253 $type = ilObject::_lookupType($obj["rep_obj_id"]);
254 $type_str = (in_array($type, array("lm", "htlm", "sahs")))
255 ? $lng->txt("learning_resource")
256 : $lng->txt("obj_" . $type);
257 $caption = $type_str . ": " . ilObject::_lookupTitle($obj["rep_obj_id"]);
258 } else {
259 $caption = $lng->txt("personal_desktop");
260 }
261
262 $options[$obj["rep_obj_id"]] = $caption;
263 }
264
265 include_once "Services/Form/classes/class.ilSelectInputGUI.php";
266 $rel = new ilSelectInputGUI($lng->txt("related_to"), "rel_obj");
267 $rel->setOptions($options);
268 $rel->setValue($this->current_rel_obj);
269 $ilToolbar->addInputItem($rel);
270
271 $ilToolbar->addFormButton($lng->txt("change"), "changeRelatedObject");
272 }
273
274 $this->tpl->setContent($html);
275 }
$options
if(!isset( $_REQUEST[ 'ReturnTo'])) if(!isset($_REQUEST['AuthId'])) $options
Definition: as_login.php:20
ilNoteGUI
Notes GUI class.
Definition: class.ilNoteGUI.php:19
ilNote\_getRelatedObjectsOfUser
static _getRelatedObjectsOfUser($a_mode)
get all related objects for user
Definition: class.ilNote.php:508
ilObject\_lookupTitle
static _lookupTitle($a_id)
lookup object title
Definition: class.ilObject.php:933
ilObject\_lookupType
static _lookupType($a_id, $a_reference=false)
lookup object type
Definition: class.ilObject.php:1204
ilSelectInputGUI
This class represents a selection list property in a property form.
Definition: class.ilSelectInputGUI.php:18
ilUtil\sendInfo
static sendInfo($a_info="", $a_keep=false)
Send Info Message to Screen.
Definition: class.ilUtil.php:4514
$html
$html
Definition: example_001.php:87
$r
$r
Definition: example_031.php:79
$type
$type
Definition: proxy_ylocal.php:10

References $access, $html, $ilSetting, $ilUser, $lng, $options, $r, $settings, $toolbar, $type, $user, 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

◆ $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(), setTabs(), showPrivateNotes(), and view().

◆ PUBLIC_COMMENTS

const ilPDNotesGUI::PUBLIC_COMMENTS = "publiccomments"

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

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

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