ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilPDNotesBlockGUI Class Reference

BlockGUI class for Personal Desktop Notes block. More...

+ Inheritance diagram for ilPDNotesBlockGUI:
+ Collaboration diagram for ilPDNotesBlockGUI:

Public Member Functions

 ilPDNotesBlockGUI ()
 Constructor. More...
 
executeCommand ()
 execute command More...
 
 getHTML ()
 Handle config status. More...
 
 fillDataSection ()
 Fill data section. More...
 
 getListRowData ()
 Get list data. More...
 
 fillRow ($a_set)
 get flat bookmark list for personal desktop More...
 
 getOverview ()
 Get overview. More...
 
 showNote ()
 show single note More...
 
- Public Member Functions inherited from ilBlockGUI
 ilBlockGUI ()
 Constructor. More...
 
 addHeaderLink ($a_href, $a_text, $status=true)
 
 getHeaderLinks ()
 
 setData ($a_data)
 Set Data. More...
 
 getData ()
 Get Data. More...
 
 setBigMode ($a_bigmode)
 Set Big Mode. More...
 
 getBigMode ()
 Get Big Mode. More...
 
 setBlockId ($a_block_id=0)
 Set Block Id. More...
 
 getBlockId ()
 Get Block Id. More...
 
 setAvailableDetailLevels ($a_max, $a_min=0)
 Set Available Detail Levels. More...
 
 setCurrentDetailLevel ($a_currentdetaillevel)
 Set Current Detail Level. More...
 
 setGuiObject (&$a_gui_object)
 Set GuiObject. More...
 
 getGuiObject ()
 Get GuiObject. More...
 
 getCurrentDetailLevel ()
 Get Current Detail Level. More...
 
 setTitle ($a_title)
 Set Title. More...
 
 getTitle ()
 Get Title. More...
 
 setImage ($a_image)
 Set Image. More...
 
 getImage ()
 Get Image. More...
 
 setOffset ($a_offset)
 Set Offset. More...
 
 getOffset ()
 Get Offset. More...
 
 correctOffset ()
 
 setLimit ($a_limit)
 Set Limit. More...
 
 getLimit ()
 Get Limit. More...
 
 setEnableEdit ($a_enableedit)
 Set EnableEdit. More...
 
 getEnableEdit ()
 Get EnableEdit. More...
 
 setRepositoryMode ($a_repositorymode)
 Set RepositoryMode. More...
 
 getRepositoryMode ()
 Get RepositoryMode. More...
 
 setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
 Set Footer Info. More...
 
 getFooterInfo ($a_hide_and_icon=false)
 Get Footer Info. More...
 
 setSubtitle ($a_subtitle)
 Set Subtitle. More...
 
 getSubtitle ()
 Get Subtitle. More...
 
 setRefId ($a_refid)
 Set Ref Id (only used if isRepositoryObject() is true). More...
 
 getRefId ()
 Get Ref Id (only used if isRepositoryObject() is true). More...
 
 setAdminCommands ($a_admincommands)
 Set Administration Commmands. More...
 
 getAdminCommands ()
 Get Administration Commmands. More...
 
 setColSpan ($a_colspan)
 Set Columns Span. More...
 
 getColSpan ()
 Get Columns Span. More...
 
 setEnableDetailRow ($a_enabledetailrow)
 Set EnableDetailRow. More...
 
 getEnableDetailRow ()
 Get EnableDetailRow. More...
 
 setEnableNumInfo ($a_enablenuminfo)
 Set Enable Item Number Info. More...
 
 getEnableNumInfo ()
 Get Enable Item Number Info. More...
 
 setProperties ($a_properties)
 This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...
 
 getProperty ($a_property)
 
 setProperty ($a_property, $a_value)
 
 setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
 Set Row Template Name. More...
 
 getNavParameter ()
 
 getDetailParameter ()
 
 getConfigParameter ()
 
 getMoveParameter ()
 
 getRowTemplateName ()
 Get Row Template Name. More...
 
 getRowTemplateDir ()
 Get Row Template Directory. More...
 
 addBlockCommand ($a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false, $a_html="")
 Add Block Command. More...
 
 getBlockCommands ()
 Get Block commands. More...
 
 addHeaderCommand ($a_href, $a_text, $a_as_close=false)
 Add Header Block Command. More...
 
 getHeaderCommands ()
 Get Header Block commands. More...
 
 addFooterLink ($a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false, $a_checked=false)
 Add a footer text/link. More...
 
 getFooterLinks ()
 Get footer links. More...
 
 clearFooterLinks ()
 Clear footer links. More...
 
 handleDetailLevel ()
 Handle read/write current detail level. More...
 
 getHTML ()
 Handle config status. More...
 
 fillHeaderCommands ()
 Fill header commands block. More...
 
 fillHeaderTitleBlock ()
 Fill header title block (title and. More...
 
 setDataSection ($a_content)
 Call this from overwritten fillDataSection(), if standard row based data is not used. More...
 
 fillDataSection ()
 Standard implementation for row based data. More...
 
 fillRow ($a_set)
 
 fillFooter ()
 
 fillPreviousNext ()
 Fill previous/next row. More...
 
 setPreviousNextLinks ()
 Get previous/next linkbar. More...
 
 fillFooterLinks ($a_top=false, $a_numinfo="")
 Fill footer links. More...
 
 fillDetailRow ()
 Fill Detail Setting Row. More...
 

Static Public Member Functions

static getBlockType ()
 Get block type. More...
 
static isRepositoryObject ()
 Get block type. More...
 
static getScreenMode ()
 Get Screen Mode for current command. More...
 
static getBlockType ()
 
static isRepositoryObject ()
 
static getScreenMode ()
 Get Screen Mode for current command. More...
 

Static Public Attributes

static $block_type = "pdnotes"
 

Protected Attributes

 $note_gui = null
 
- Protected Attributes inherited from ilBlockGUI
 $data = array()
 
 $colspan = 1
 
 $enablenuminfo = true
 
 $detail_min = 0
 
 $detail_max = 0
 
 $bigmode = false
 
 $footer_links = array()
 
 $block_id = 0
 
 $header_commands = array()
 
 $allow_moving = true
 
 $move = array("left" => false, "right" => false, "up" => false, "down" => false)
 
 $enabledetailrow = true
 
 $header_links = array()
 
 $footerinfo = false
 
 $footerinfo_icon = false
 
 $block_commands = array()
 
 $max_count = false
 
 $close_command = false
 
 $image = false
 
 $property = false
 
 $nav_value = ""
 
 $css_row = ""
 
 $dropdown
 

Additional Inherited Members

- Protected Member Functions inherited from ilBlockGUI
 fillRowColor ($a_placeholder="CSS_ROW")
 
 preloadData (array $data)
 Can be overwritten in subclasses. More...
 

Detailed Description

BlockGUI class for Personal Desktop Notes block.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

@ilCtrl_IsCalledBy ilPDNotesBlockGUI: ilColumnGUI

Definition at line 15 of file class.ilPDNotesBlockGUI.php.

Member Function Documentation

◆ executeCommand()

& ilPDNotesBlockGUI::executeCommand ( )

execute command

Definition at line 74 of file class.ilPDNotesBlockGUI.php.

75 {
76 global $ilCtrl;
77
78 $next_class = $ilCtrl->getNextClass();
79 $cmd = $ilCtrl->getCmd("getHTML");
80
81 return $this->$cmd();
82 }
global $ilCtrl
Definition: ilias.php:18
$cmd
Definition: sahs_server.php:35

References $cmd, and $ilCtrl.

◆ fillDataSection()

ilPDNotesBlockGUI::fillDataSection ( )

Fill data section.

Reimplemented from ilBlockGUI.

Definition at line 99 of file class.ilPDNotesBlockGUI.php.

100 {
101 global $ilUser;
102
103 include_once("Services/Notes/classes/class.ilNote.php");
104 $this->notes = ilNote::_getLastNotesOfUser();
105
106 if ($this->getCurrentDetailLevel() > 1 && count($this->notes) > 0)
107 {
108 $this->setRowTemplate("tpl.pd_notes_overview.html", "Services/Notes");
109 $this->getListRowData();
110 //$this->setColSpan(2);
111 parent::fillDataSection();
112 }
113 else
114 {
115 $this->setEnableNumInfo(false);
116 if (count($this->notes) == 0)
117 {
118 $this->setEnableDetailRow(false);
119 }
120 $this->setDataSection($this->getOverview());
121 }
122 }
setRowTemplate($a_rowtemplatename, $a_rowtemplatedir="")
Set Row Template Name.
getCurrentDetailLevel()
Get Current Detail Level.
setEnableDetailRow($a_enabledetailrow)
Set EnableDetailRow.
setDataSection($a_content)
Call this from overwritten fillDataSection(), if standard row based data is not used.
setEnableNumInfo($a_enablenuminfo)
Set Enable Item Number Info.
_getLastNotesOfUser()
get last notes of current user
getListRowData()
Get list data.
global $ilUser
Definition: imgupload.php:15

References $ilUser, ilNote\_getLastNotesOfUser(), ilBlockGUI\getCurrentDetailLevel(), getListRowData(), getOverview(), ilBlockGUI\setDataSection(), ilBlockGUI\setEnableDetailRow(), ilBlockGUI\setEnableNumInfo(), and ilBlockGUI\setRowTemplate().

+ Here is the call graph for this function:

◆ fillRow()

ilPDNotesBlockGUI::fillRow (   $a_set)

get flat bookmark list for personal desktop

Reimplemented from ilBlockGUI.

Definition at line 192 of file class.ilPDNotesBlockGUI.php.

193 {
194 global $ilUser, $ilCtrl, $lng;
195
196 include_once("Services/Notes/classes/class.ilNoteGUI.php");
197 if (!is_object($this->note_gui))
198 {
199 $this->note_gui = new ilNoteGUI(0,0,"");
200 $this->note_gui->enableTargets();
201 }
202
203 //if ($this->getCurrentDetailLevel() > 2)
204 //{
205 // $this->tpl->setVariable("VAL_SUBJECT", "<b>".$a_set["subject"]."</b>");
206 //}
207 //else
208 //{
209 $this->tpl->setVariable("VAL_SUBJECT", $a_set["subject"]);
210 //}
211
212 // link subject to show note function
213 $ilCtrl->setParameter($this, "rel_obj", $a_set["rep_obj_id"]);
214 $ilCtrl->setParameter($this, "note_id", $a_set["id"]);
215 $ilCtrl->setParameter($this, "note_type", IL_NOTE_PRIVATE);
216 $this->tpl->setVariable("HREF_SHOW_NOTE",
217 $ilCtrl->getLinkTarget($this, "showNote"));
218 $this->tpl->setVariable("IMG_NOTE", $a_set["img"]);
219 $this->tpl->setVariable("ALT_NOTE", $a_set["alt"]);
220 $ilCtrl->clearParameters($this);
221
222 // details
223 if ($this->getCurrentDetailLevel() > 2)
224 {
225 $this->tpl->setCurrentBlock("details");
226 if (substr($a_set["text"], 0, 40) != substr($a_set["text"], 0, 40))
227 {
228 $this->tpl->setVariable("NOTE_TEXT", $a_set["text"]);
229 }
230 $this->tpl->setVariable("VAL_DATE",
232 $this->tpl->parseCurrentBlock();
233
234 // target objects
235 $this->note_gui->showTargets($this->tpl, $a_set["rep_obj_id"], $a_set["id"],
236 $a_set["obj_type"], $a_set["obj_id"]);
237
238 // edit button
239 $this->tpl->setCurrentBlock("edit_note");
240 $this->tpl->setVariable("TXT_EDIT_NOTE", $lng->txt("edit"));
241 $ilCtrl->setParameterByClass("ilnotegui", "rel_obj", $a_set["rep_obj_id"]);
242 $ilCtrl->setParameterByClass("ilnotegui", "note_id", $a_set["id"]);
243 $ilCtrl->setParameterByClass("ilnotegui", "note_type", IL_NOTE_PRIVATE);
244 $this->tpl->setVariable("LINK_EDIT_NOTE",
245 $ilCtrl->getLinkTargetByClass(array("ilpersonaldesktopgui", "ilpdnotesgui", "ilnotegui"), "editNoteForm")
246 ."#note_edit");
247 $this->tpl->parseCurrentBlock();
248 }
249 $ilCtrl->clearParametersByClass("ilnotegui");
250 }
const IL_CAL_DATETIME
const IL_NOTE_PRIVATE
Definition: class.ilNote.php:4
static formatDate(ilDateTime $date)
Format a date @access public.
@classDescription Date and time handling
Notes GUI class.
global $lng
Definition: privfeed.php:40

References $ilCtrl, $ilUser, $lng, ilDatePresentation\formatDate(), ilBlockGUI\getCurrentDetailLevel(), IL_CAL_DATETIME, and IL_NOTE_PRIVATE.

+ Here is the call graph for this function:

◆ getBlockType()

static ilPDNotesBlockGUI::getBlockType ( )
static

Get block type.

Returns
string Block type.

Reimplemented from ilBlockGUI.

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

40 {
41 return self::$block_type;
42 }

References $block_type.

◆ getHTML()

ilPDNotesBlockGUI::getHTML ( )

Handle config status.

Get HTML.

Reimplemented from ilBlockGUI.

Definition at line 84 of file class.ilPDNotesBlockGUI.php.

85 {
86 if ($this->getCurrentDetailLevel() == 0)
87 {
88 return "";
89 }
90 else
91 {
92 return parent::getHTML();
93 }
94 }

References ilBlockGUI\getCurrentDetailLevel().

+ Here is the call graph for this function:

◆ getListRowData()

ilPDNotesBlockGUI::getListRowData ( )

Get list data.

Definition at line 128 of file class.ilPDNotesBlockGUI.php.

129 {
130 global $ilUser, $lng, $ilCtrl;
131
132 $data = array();
133
134 foreach($this->notes as $note)
135 {
136 switch ($note->getLabel())
137 {
139 $img = ilUtil::getImagePath("note_unlabeled.svg");
140 $alt = $lng->txt("note");
141 break;
142
144 $img = ilUtil::getImagePath("note_unlabeled.svg");
145 $alt = $lng->txt("note").", ".$lng->txt("important");
146 break;
147
148 case IL_NOTE_QUESTION:
149 $img = ilUtil::getImagePath("note_unlabeled.svg");
150 $alt = $lng->txt("note").", ".$lng->txt("question");
151 break;
152
153 case IL_NOTE_PRO:
154 $img = ilUtil::getImagePath("note_unlabeled.svg");
155 $alt = $lng->txt("note").", ".$lng->txt("pro");
156 break;
157
158 case IL_NOTE_CONTRA:
159 $img = ilUtil::getImagePath("note_unlabeled.svg");
160 $alt = $lng->txt("note").", ".$lng->txt("contra");
161 break;
162 }
163
164 // details
165 $target = $note->getObject();
166
167 // new notes do not have subject anymore
168 $title = $note->getSubject();
169 if(!$title)
170 {
171 $title = ilUtil::shortenText($note->getText(), 75, true, true);
172 }
173
174 $data[] = array(
175 "subject" => $title,
176 "img" => $img,
177 "alt" => $alt,
178 "text" => ilUtil::shortenText($note->getText(), 150, true, true),
179 "date" => $note->getCreationDate(),
180 "id" => $note->getId(),
181 "obj_type" => $target["obj_type"],
182 "obj_id" => $target["obj_id"],
183 "rep_obj_id" => $target["rep_obj_id"]);
184 }
185
186 $this->setData($data);
187 }
const IL_NOTE_PRO
const IL_NOTE_UNLABELED
Definition: class.ilNote.php:7
const IL_NOTE_CONTRA
const IL_NOTE_QUESTION
Definition: class.ilNote.php:9
const IL_NOTE_IMPORTANT
Definition: class.ilNote.php:8
setData($a_data)
Set Data.
static shortenText($a_str, $a_len, $a_dots=false, $a_next_blank=false, $a_keep_extension=false)
shorten a string to given length.
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)

References ilBlockGUI\$data, $ilCtrl, $ilUser, $img, $lng, ilUtil\getImagePath(), IL_NOTE_CONTRA, IL_NOTE_IMPORTANT, IL_NOTE_PRO, IL_NOTE_QUESTION, IL_NOTE_UNLABELED, ilBlockGUI\setData(), and ilUtil\shortenText().

Referenced by fillDataSection().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getOverview()

ilPDNotesBlockGUI::getOverview ( )

Get overview.

Definition at line 255 of file class.ilPDNotesBlockGUI.php.

256 {
257 global $ilUser, $lng, $ilCtrl;
258
259 return '<div class="small">'.((int) count($this->notes))." ".$lng->txt("notes")."</div>";
260 }

References $ilCtrl, $ilUser, and $lng.

Referenced by fillDataSection().

+ Here is the caller graph for this function:

◆ getScreenMode()

static ilPDNotesBlockGUI::getScreenMode ( )
static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

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

58 {
59 switch($_GET["cmd"])
60 {
61 case "showNote":
62 return IL_SCREEN_CENTER;
63 break;
64
65 default:
66 return IL_SCREEN_SIDE;
67 break;
68 }
69 }
$_GET["client_id"]
const IL_SCREEN_SIDE
const IL_SCREEN_CENTER

References $_GET, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

◆ ilPDNotesBlockGUI()

ilPDNotesBlockGUI::ilPDNotesBlockGUI ( )

Constructor.

Definition at line 23 of file class.ilPDNotesBlockGUI.php.

24 {
25 global $ilCtrl, $lng, $ilUser;
26
27 parent::ilBlockGUI();
28
29 $this->setLimit(5);
30 $this->setTitle($lng->txt("notes"));
32 }
setLimit($a_limit)
Set Limit.
setAvailableDetailLevels($a_max, $a_min=0)
Set Available Detail Levels.
setTitle($a_title)
Set Title.

References $ilCtrl, $ilUser, $lng, ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setLimit(), and ilBlockGUI\setTitle().

+ Here is the call graph for this function:

◆ isRepositoryObject()

static ilPDNotesBlockGUI::isRepositoryObject ( )
static

Get block type.

Returns
string Block type.

Reimplemented from ilBlockGUI.

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

50 {
51 return false;
52 }

◆ showNote()

ilPDNotesBlockGUI::showNote ( )

show single note

Definition at line 265 of file class.ilPDNotesBlockGUI.php.

266 {
267 global $lng, $ilCtrl;
268
269 include_once("./Services/Notes/classes/class.ilNoteGUI.php");
270 $note_gui = new ilNoteGUI();
271 $note_gui->enableTargets();
272 include_once("./Services/PersonalDesktop/classes/class.ilPDContentBlockGUI.php");
273 $content_block = new ilPDContentBlockGUI();
274 $content_block->setContent($note_gui->getPDNoteHTML($_GET["note_id"]));
275 $content_block->setTitle($lng->txt("note"));
276 $content_block->setColSpan(2);
277 $content_block->addHeaderCommand($ilCtrl->getLinkTargetByClass("ilpersonaldesktopgui", "show"),
278 $lng->txt("selected_items_back"));
279
280 return $content_block->getHTML();
281 }
BlockGUI class for (centered) Content on Personal Desktop.

References $_GET, $ilCtrl, $lng, and $note_gui.

Field Documentation

◆ $block_type

ilPDNotesBlockGUI::$block_type = "pdnotes"
static

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

Referenced by getBlockType().

◆ $note_gui

ilPDNotesBlockGUI::$note_gui = null
protected

Definition at line 18 of file class.ilPDNotesBlockGUI.php.

Referenced by showNote().


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