ilPDTaggingBlockGUI Class Reference
ilPDTaggingBlockGUI displays personal tag cloud on personal desktop. More...
Inheritance diagram for ilPDTaggingBlockGUI:
Collaboration diagram for ilPDTaggingBlockGUI:
Public Member Functions | |
| __construct () | |
| Constructor. More... | |
| executeCommand () | |
| execute command More... | |
| getHTML () | |
| Handle config status. More... | |
| fillDataSection () | |
| Fill data section. More... | |
| getTagCloud () | |
| get tree bookmark list for personal desktop More... | |
| showResourcesForTag () | |
| List resources for tag. More... | |
| removeTagsWithoutAccess () | |
| Remove tasg without access. More... | |
| fillFooter () | |
| block footer More... | |
| setFooterLinks () | |
| Set footer links. More... | |
| getOverview () | |
| Get overview. More... | |
| Public Member Functions inherited from ilBlockGUI | |
| __construct () | |
| 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 () |
| Is block used in repository object? 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 = "pdtag" |
Additional Inherited Members | |
| Protected Member Functions inherited from ilBlockGUI | |
| fillRowColor ($a_placeholder="CSS_ROW") | |
| preloadData (array $data) | |
| Can be overwritten in subclasses. More... | |
| 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 | |
Detailed Description
ilPDTaggingBlockGUI displays personal tag cloud on personal desktop.
- Version
- $Id$
@ilCtrl_IsCalledBy ilPDTaggingBlockGUI: ilColumnGUI
Definition at line 34 of file class.ilPDTaggingBlockGUI.php.
Constructor & Destructor Documentation
◆ __construct()
| ilPDTaggingBlockGUI::__construct | ( | ) |
Constructor.
Reimplemented from ilBlockGUI.
Definition at line 41 of file class.ilPDTaggingBlockGUI.php.
42 {
44
45 parent::__construct();
46
48
51 $this->setLimit(99999);
52 $this->setAvailableDetailLevels(1,0);
53 }
setAvailableDetailLevels($a_max, $a_min=0)
Set Available Detail Levels.
Definition: class.ilBlockGUI.php:136
References $ilCtrl, $ilUser, $lng, ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setEnableNumInfo(), ilBlockGUI\setLimit(), and ilBlockGUI\setTitle().
Here is the call graph for this function:
Member Function Documentation
◆ executeCommand()
| ilPDTaggingBlockGUI::executeCommand | ( | ) |
◆ fillDataSection()
| ilPDTaggingBlockGUI::fillDataSection | ( | ) |
Fill data section.
Reimplemented from ilBlockGUI.
Definition at line 124 of file class.ilPDTaggingBlockGUI.php.
125 {
126 global $ilUser;
127
128 include_once("./Services/Tagging/classes/class.ilTagging.php");
130
132 {
134 }
135 else
136 {
137 if ($this->num_bookmarks == 0 && $this->num_folders == 0)
138 {
140 }
142 }
143 }
setDataSection($a_content)
Call this from overwritten fillDataSection(), if standard row based data is not used.
Definition: class.ilBlockGUI.php:1020
getTagCloud()
get tree bookmark list for personal desktop
Definition: class.ilPDTaggingBlockGUI.php:148
static getTagsForUser($a_user_id, $a_max=0, $a_only_online=true)
Get tags for a user.
Definition: class.ilTagging.php:148
References $ilUser, ilBlockGUI\getCurrentDetailLevel(), getOverview(), getTagCloud(), ilTagging\getTagsForUser(), ilBlockGUI\setDataSection(), and ilBlockGUI\setEnableDetailRow().
Here is the call graph for this function:
◆ fillFooter()
| ilPDTaggingBlockGUI::fillFooter | ( | ) |
block footer
Reimplemented from ilBlockGUI.
Definition at line 323 of file class.ilPDTaggingBlockGUI.php.
324 {
326
327 $this->setFooterLinks();
328 $this->fillFooterLinks();
330 if ($this->tpl->blockExists("block_footer"))
331 {
332 $this->tpl->setCurrentBlock("block_footer");
333 $this->tpl->parseCurrentBlock();
334 }
335 }
References $ilCtrl, $ilUser, $lng, ilBlockGUI\fillFooterLinks(), ilBlockGUI\getColSpan(), and setFooterLinks().
Here is the call graph for this function:
◆ getBlockType()
|
static |
Get block type.
- Returns
- string Block type.
Reimplemented from ilBlockGUI.
Definition at line 60 of file class.ilPDTaggingBlockGUI.php.
61 {
63 }
References $block_type.
◆ getHTML()
| ilPDTaggingBlockGUI::getHTML | ( | ) |
Handle config status.
Get HTML.
Reimplemented from ilBlockGUI.
Definition at line 106 of file class.ilPDTaggingBlockGUI.php.
107 {
108 // workaround to show details row
110
112 {
113 return "";
114 }
115 else
116 {
117 return parent::getHTML();
118 }
119 }
References ilBlockGUI\getCurrentDetailLevel(), and ilBlockGUI\setData().
Here is the call graph for this function:
◆ getOverview()
| ilPDTaggingBlockGUI::getOverview | ( | ) |
Get overview.
Definition at line 386 of file class.ilPDTaggingBlockGUI.php.
387 {
389
390 return '<div class="small">'.$lng->txt("tagging_tag_info")."</div>";
391 }
References $ilCtrl, $ilUser, and $lng.
Referenced by fillDataSection().
Here is the caller graph for this function:
◆ getScreenMode()
|
static |
Get Screen Mode for current command.
Reimplemented from ilBlockGUI.
Definition at line 79 of file class.ilPDTaggingBlockGUI.php.
80 {
82 {
83 case "showResourcesForTag":
85 break;
86
87 default:
89 break;
90 }
91 }
References $_GET, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.
◆ getTagCloud()
| ilPDTaggingBlockGUI::getTagCloud | ( | ) |
get tree bookmark list for personal desktop
Definition at line 148 of file class.ilPDTaggingBlockGUI.php.
149 {
151
152 $showdetails = ($this->getCurrentDetailLevel() > 2);
154 "Services/Tagging");
155 $max = 1;
156 foreach($this->tags as $tag)
157 {
158 $max = max($tag["cnt"], $max);
159 }
160 reset($this->tags);
161
162 foreach($this->tags as $tag)
163 {
171 $tpl->parseCurrentBlock();
172 }
174 }
static getRelevanceClass($cnt, $max)
Get style class for tag relevance.
Definition: class.ilTagging.php:233
special template class to simplify handling of ITX/PEAR
Definition: class.ilTemplate.php:14
References $ilCtrl, $ilUser, $tpl, ilBlockGUI\getCurrentDetailLevel(), and ilTagging\getRelevanceClass().
Referenced by fillDataSection().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ isRepositoryObject()
|
static |
Is block used in repository object?
- Returns
- string Block type.
Reimplemented from ilBlockGUI.
Definition at line 70 of file class.ilPDTaggingBlockGUI.php.
71 {
72 return false;
73 }
◆ removeTagsWithoutAccess()
| ilPDTaggingBlockGUI::removeTagsWithoutAccess | ( | ) |
Remove tasg without access.
Definition at line 274 of file class.ilPDTaggingBlockGUI.php.
275 {
277
278 // get resources
279 include_once("./Services/Tagging/classes/class.ilTagging.php");
281
282 foreach($objs as $key => $obj)
283 {
285 if (count($ref_ids) == 0)
286 {
287 $inaccessible = true;
288 }
289 else
290 {
291 $inaccessible = false;
292 }
294 {
295 $type = $obj["obj_type"];
296
297 if ($type == "") {
298 $inaccessible = true;
299 continue;
300 }
304 {
305 $inaccessible = true;
306 }
307 if ($inaccessible)
308 {
309 ilTagging::deleteTagOfObjectForUser($ilUser->getId(), $obj["obj_id"], $obj["obj_type"], $obj["sub_obj_id"], $obj["sub_obj_type"], $_GET["tag"]);
310 }
311 }
312 }
313
315
316 $ilCtrl->returnToParent($this);
317 }
static deleteTagOfObjectForUser($a_user_id, $a_obj_id, $a_obj_type, $a_sub_obj_id, $a_sub_obj_type, $a_tag)
Deletes tag of an object.
Definition: class.ilTagging.php:322
static getObjectsForTagAndUser($a_user_id, $a_tag)
Get objects for tag and user.
Definition: class.ilTagging.php:178
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.
Definition: class.ilUtil.php:4801
References $_GET, $ilCtrl, $ilUser, $lng, $ref_id, ilObject\_getAllReferences(), ilTagging\deleteTagOfObjectForUser(), ilTagging\getObjectsForTagAndUser(), and ilUtil\sendSuccess().
Here is the call graph for this function:
◆ setFooterLinks()
| ilPDTaggingBlockGUI::setFooterLinks | ( | ) |
Set footer links.
Definition at line 340 of file class.ilPDTaggingBlockGUI.php.
341 {
343return;
344/*
345 if ($this->num_bookmarks == 0 && $this->num_folders == 0)
346 {
347 return;
348 }
349
350 // flat
351 if ($ilUser->getPref("il_pd_bkm_mode") == 'tree')
352 {
353 $this->addFooterLink( $lng->txt("flatview"),
354 $ilCtrl->getLinkTarget($this, "setPdFlatMode"),
355 $ilCtrl->getLinkTarget($this, "setPdFlatMode",
356 "", true),
357 "block_".$this->getBlockType()."_".$this->block_id);
358 }
359 else
360 {
361 $this->addFooterLink($lng->txt("flatview"));
362 }
363
364 // as tree
365 if ($ilUser->getPref("il_pd_bkm_mode") == 'tree')
366 {
367 $this->addFooterLink($lng->txt("treeview"));
368 }
369 else
370 {
371 $this->addFooterLink($lng->txt("treeview"),
372 $ilCtrl->getLinkTarget($this,
373 "setPdTreeMode"),
374 $ilCtrl->getLinkTarget($this,
375 "setPdTreeMode", "", true),
376 "block_".$this->getBlockType()."_".$this->block_id
377 );
378 }
379*/
380 }
References $ilCtrl, $ilUser, and $lng.
Referenced by fillFooter().
Here is the caller graph for this function:
◆ showResourcesForTag()
| ilPDTaggingBlockGUI::showResourcesForTag | ( | ) |
List resources for tag.
Definition at line 179 of file class.ilPDTaggingBlockGUI.php.
180 {
182
184
186 include_once("./Services/PersonalDesktop/classes/class.ilPDContentBlockGUI.php");
188 $content_block->setColSpan(2);
190 "<i>".$_GET["tag"]."</i>"));
192 $content_block->addHeaderCommand($ilCtrl->getParentReturn($this),
194
195 // get resources
196 include_once("./Services/Tagging/classes/class.ilTagging.php");
198
199 $unaccessible = false;
200 foreach($objs as $key => $obj)
201 {
204 {
205 $type = $obj["obj_type"];
206
207 if ($type == "") {
208 $unaccessible = true;
209 continue;
210 }
211
212 // get list gui class for each object type
213 if (empty($this->item_list_gui[$type]))
214 {
215 $class = $objDefinition->getClassName($type);
216 $location = $objDefinition->getLocation($type);
217
218 $full_class = "ilObj".$class."ListGUI";
219
221 $this->item_list_gui[$type] = new $full_class();
222 $this->item_list_gui[$type]->enableDelete(false);
223 $this->item_list_gui[$type]->enablePath(true);
224 $this->item_list_gui[$type]->enableCut(false);
225 $this->item_list_gui[$type]->enableCopy(false);
226 $this->item_list_gui[$type]->enableSubscribe(false);
227 $this->item_list_gui[$type]->enableLink(false);
228 $this->item_list_gui[$type]->enableIcon(true);
229 }
230 $html = $this->item_list_gui[$type]->getListItemHTML(
231 $ref_id,
232 $obj["obj_id"],
235
237 {
238 $css = ($css != "tblrow1") ? "tblrow1" : "tblrow2";
239
246 $tpl->parseCurrentBlock();
247 }
248 else
249 {
250 $unaccessible = true;
251 }
252 }
253 }
254
255 if ($unaccessible)
256 {
260 $tpl->setVariable("HREF_REMOVE_TAGS", $ilCtrl->getLinkTarget($this, "removeTagsWithoutAccess"));
262 $tpl->parseCurrentBlock();
263 }
264
265 $content_block->setContent($tpl->get());
266 //$content_block->setContent("test");
267
268 return $content_block->getHTML();
269 }
BlockGUI class for (centered) Content on Personal Desktop.
Definition: class.ilPDContentBlockGUI.php:33
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
Definition: class.ilUtil.php:71
References $_GET, $html, $ilCtrl, $ilUser, $lng, $location, $ref_id, $tpl, ilObject\_getAllReferences(), ilObject\_lookupDescription(), ilObject\_lookupTitle(), ilUtil\getImagePath(), ilTagging\getObjectsForTagAndUser(), and sprintf.
Here is the call graph for this function:
Field Documentation
◆ $block_type
|
static |
Definition at line 36 of file class.ilPDTaggingBlockGUI.php.
Referenced by getBlockType().
The documentation for this class was generated from the following file:
- Services/Tagging/classes/class.ilPDTaggingBlockGUI.php
