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

BlockGUI class for wiki functions block. More...

+ Inheritance diagram for ilWikiFunctionsBlockGUI:
+ Collaboration diagram for ilWikiFunctionsBlockGUI:

Public Member Functions

 __construct ()
 Constructor. More...
 
executeCommand ()
 execute command More...
 
 setPageObject ($a_pageob)
 Set Page Object. More...
 
 getPageObject ()
 Get Page Object. More...
 
 getHTML ()
 Get bloch HTML code. More...
 
 fillDataSection ()
 Fill data section. 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 ()
 Is this a 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 = "wikiside"
 
static $st_data
 

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

BlockGUI class for wiki functions block.

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

Definition at line 14 of file class.ilWikiFunctionsBlockGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilWikiFunctionsBlockGUI::__construct ( )

Constructor.

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

23 {
24 global $ilCtrl, $lng;
25
26 parent::ilBlockGUI();
27
28 $lng->loadLanguageModule("wiki");
29 $this->setEnableNumInfo(false);
30
31 $this->setTitle($lng->txt("wiki_functions"));
32 $this->allow_moving = false;
33 }
setTitle($a_title)
Set Title.
setEnableNumInfo($a_enablenuminfo)
Set Enable Item Number Info.
global $ilCtrl
Definition: ilias.php:18
global $lng
Definition: privfeed.php:40

References $ilCtrl, $lng, ilBlockGUI\setEnableNumInfo(), and ilBlockGUI\setTitle().

+ Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

& ilWikiFunctionsBlockGUI::executeCommand ( )

execute command

Definition at line 66 of file class.ilWikiFunctionsBlockGUI.php.

67 {
68 global $ilCtrl;
69
70 $next_class = $ilCtrl->getNextClass();
71 $cmd = $ilCtrl->getCmd("getHTML");
72
73 switch ($next_class)
74 {
75 default:
76 return $this->$cmd();
77 }
78 }
$cmd
Definition: sahs_server.php:35

References $cmd, and $ilCtrl.

◆ fillDataSection()

ilWikiFunctionsBlockGUI::fillDataSection ( )

Fill data section.

Reimplemented from ilBlockGUI.

Definition at line 113 of file class.ilWikiFunctionsBlockGUI.php.

114 {
115 global $ilCtrl, $lng, $ilAccess;
116
117 $tpl = new ilTemplate("tpl.wiki_side_block_content.html", true, true, "Modules/Wiki");
118
119 $wp = $this->getPageObject();
120
121 // info
122 $actions[] = array(
123 "txt" => $lng->txt("info_short"),
124 "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "infoScreen")
125 );
126
127 // recent changes
128 $actions[] = array(
129 "txt" => $lng->txt("wiki_recent_changes"),
130 "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "recentChanges")
131 );
132
133 foreach ($actions as $a)
134 {
135 $tpl->setCurrentBlock("action");
136 $tpl->setVariable("HREF", $a["href"]);
137 $tpl->setVariable("TXT", $a["txt"]);
138 $tpl->parseCurrentBlock();
139
140 $tpl->touchBlock("item");
141 }
142
143
144 $actions = array();
145
146 // all pages
147 $actions[] = array(
148 "txt" => $lng->txt("wiki_all_pages"),
149 "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "allPages")
150 );
151
152 // new pages
153 $actions[] = array(
154 "txt" => $lng->txt("wiki_new_pages"),
155 "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "newPages")
156 );
157
158 // popular pages
159 $actions[] = array(
160 "txt" => $lng->txt("wiki_popular_pages"),
161 "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "popularPages")
162 );
163
164 // orphaned pages
165 $actions[] = array(
166 "txt" => $lng->txt("wiki_orphaned_pages"),
167 "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "orphanedPages")
168 );
169
170
171 // page lists
172 include_once("./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
173 $list = new ilAdvancedSelectionListGUI();
174 $list->setListTitle($lng->txt("wiki_page_lists"));
176 $list->setId("wiki_pglists");
177
178 foreach ($actions as $a)
179 {
180 $list->addItem($a["txt"], "",
181 $a["href"]);
182 }
183 $tpl->setCurrentBlock("plain");
184 $tpl->setVariable("PLAIN", $list->getHTML());
185 $tpl->parseCurrentBlock();
186 $tpl->touchBlock("item");
187
188
189 // page actions
190 $list = new ilAdvancedSelectionListGUI();
192 $list->setListTitle($lng->txt("wiki_page_actions"));
193 $list->setId("wiki_pgactions");
194
195 if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
196 {
197 // rating
198 if(ilObjWiki::_lookupRating($this->getPageObject()->getWikiId()))
199 {
200 if(!$this->getPageObject()->getRating())
201 {
202 $list->addItem($lng->txt("wiki_activate_page_rating"), "",
203 $ilCtrl->getLinkTargetByClass("ilwikipagegui", "activateWikiPageRating"));
204 }
205 else
206 {
207 $list->addItem($lng->txt("wiki_deactivate_page_rating"), "",
208 $ilCtrl->getLinkTargetByClass("ilwikipagegui", "deactivateWikiPageRating"));
209 }
210 }
211
212 // unhide advmd?
213 include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php';
214 if((bool)sizeof(ilAdvancedMDRecord::_getSelectedRecordsByObject("wiki", $this->getPageObject()->getWikiId(), "wpg")) &&
216 {
217 $list->addItem($lng->txt("wiki_unhide_meta_adv_records"), "",
218 $ilCtrl->getLinkTargetByClass("ilwikipagegui", "unhideAdvancedMetaData"));
219 }
220 }
221
222 if (($ilAccess->checkAccess("edit_content", "", $_GET["ref_id"]) && !$this->getPageObject()->getBlocked())
223 || $ilAccess->checkAccess("write", "", $_GET["ref_id"]))
224 {
225 // rename
226 $list->addItem($lng->txt("wiki_rename_page"), "",
227 $ilCtrl->getLinkTargetByClass("ilwikipagegui", "renameWikiPage"));
228 }
229
230 include_once("./Modules/Wiki/classes/class.ilWikiPerm.php");
231 if (ilWikiPerm::check("activate_wiki_protection", $_GET["ref_id"]))
232 {
233 // block/unblock
234 if ($this->getPageObject()->getBlocked())
235 {
236 $list->addItem($lng->txt("wiki_unblock_page"), "",
237 $ilCtrl->getLinkTargetByClass("ilwikipagegui", "unblockWikiPage"));
238 }
239 else
240 {
241 $list->addItem($lng->txt("wiki_block_page"), "",
242 $ilCtrl->getLinkTargetByClass("ilwikipagegui", "blockWikiPage"));
243 }
244 }
245
246 include_once("./Modules/Wiki/classes/class.ilWikiPerm.php");
247 if (ilWikiPerm::check("delete_wiki_pages", $_GET["ref_id"]))
248 {
249 // delete page
250 $st_page = ilObjWiki::_lookupStartPage($this->getPageObject()->getParentId());
251 if ($st_page != $this->getPageObject()->getTitle())
252 {
253 $list->addItem($lng->txt("wiki_delete_page"), "",
254 $ilCtrl->getLinkTargetByClass("ilwikipagegui", "deleteWikiPageConfirmationScreen"));
255 }
256 }
257
258 if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
259 {
260
261 include_once "Modules/Wiki/classes/class.ilWikiPageTemplate.php";
262 $wpt = new ilWikiPageTemplate($this->getPageObject()->getParentId());
263 if(!$wpt->isPageTemplate($this->getPageObject()->getId()))
264 {
265 $list->addItem($lng->txt("wiki_add_template"), "",
266 $ilCtrl->getLinkTargetByClass("ilwikipagetemplategui", "addPageTemplateFromPageAction"));
267 }
268 else
269 {
270 $list->addItem($lng->txt("wiki_remove_template_status"), "",
271 $ilCtrl->getLinkTargetByClass("ilwikipagetemplategui", "removePageTemplateFromPageAction"));
272 }
273 }
274
275 if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]) ||
276 $ilAccess->checkAccess("read", "", $_GET["ref_id"]))
277 {
278 $tpl->setCurrentBlock("plain");
279 $tpl->setVariable("PLAIN", $list->getHTML());
280 $tpl->parseCurrentBlock();
281 $tpl->touchBlock("item");
282 }
283
284 // permissions
285// if ($ilAccess->checkAccess('edit_permission', "", $_GET["ref_id"]))
286// {
287// $actions[] = array(
288// "txt" => $lng->txt("perm_settings"),
289// "href" => $ilCtrl->getLinkTargetByClass(array("ilobjwikigui", "ilpermissiongui"), "perm")
290// );
291// }
292
293 $actions = array();
294
295 // settings
296 if ($ilAccess->checkAccess('write', "", $_GET["ref_id"]))
297 {
298 $actions[] = array(
299 "txt" => $lng->txt("wiki_contributors"),
300 "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "listContributors")
301 );
302 }
303
304 // manage
305 if (ilWikiPerm::check("wiki_html_export", $_GET["ref_id"]))
306 {
307 $actions[] = array(
308 "txt" => $lng->txt("wiki_html_export"),
309 "id" => "il_wiki_user_export",
310 "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "initUserHTMLExport")
311 );
312 }
313
314 // manage
315 if ($ilAccess->checkAccess('write', "", $_GET["ref_id"]))
316 {
317 $actions[] = array(
318 "txt" => $lng->txt("settings"),
319 "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "editSettings")
320 );
321 }
322 else if ($ilAccess->checkAccess('statistics_read', "", $_GET["ref_id"]))
323 {
324 $actions[] = array(
325 "txt" => $lng->txt("statistics"),
326 "href" => $ilCtrl->getLinkTargetByClass(array("ilobjwikigui", "ilwikistatgui"), "initial")
327 );
328 }
329
330 foreach ($actions as $a)
331 {
332 $tpl->setCurrentBlock("action");
333 $tpl->setVariable("HREF", $a["href"]);
334 $tpl->setVariable("TXT", $a["txt"]);
335 if ($a["id"] != "")
336 {
337 $tpl->setVariable("ACT_ID", "id='".$a["id"]."'");
338 }
339 $tpl->parseCurrentBlock();
340
341 $tpl->touchBlock("item");
342 }
343
344
345 $this->setDataSection($tpl->get());
346 }
global $tpl
Definition: ilias.php:8
$_GET["client_id"]
static _getSelectedRecordsByObject($a_obj_type, $a_obj_id, $a_sub_type="")
Get selected records by object.
User interface class for advanced drop-down selection lists.
setDataSection($a_content)
Call this from overwritten fillDataSection(), if standard row based data is not used.
getTitle()
Get Title.
static _lookupStartPage($a_wiki_id)
Lookup start page.
static _lookupRating($a_wiki_id)
Lookup whether rating is activated.
special template class to simplify handling of ITX/PEAR
static lookupAdvancedMetadataHidden($a_page_id)
static check($a_perm, $a_ref_id, $a_cmd="")
Check permission.

References $_GET, $ilCtrl, $lng, $tpl, ilAdvancedMDRecord\_getSelectedRecordsByObject(), ilObjWiki\_lookupRating(), ilObjWiki\_lookupStartPage(), ilWikiPerm\check(), getPageObject(), ilBlockGUI\getTitle(), ilWikiPage\lookupAdvancedMetadataHidden(), ilBlockGUI\setDataSection(), and ilAdvancedSelectionListGUI\STYLE_LINK.

+ Here is the call graph for this function:

◆ getBlockType()

static ilWikiFunctionsBlockGUI::getBlockType ( )
static

Get block type.

Returns
string Block type.

Reimplemented from ilBlockGUI.

Definition at line 40 of file class.ilWikiFunctionsBlockGUI.php.

References $block_type.

◆ getHTML()

ilWikiFunctionsBlockGUI::getHTML ( )

Get bloch HTML code.

Reimplemented from ilBlockGUI.

Definition at line 103 of file class.ilWikiFunctionsBlockGUI.php.

104 {
105 global $ilCtrl, $lng, $ilUser;
106
107 return parent::getHTML();
108 }
global $ilUser
Definition: imgupload.php:15

References $ilCtrl, $ilUser, and $lng.

◆ getPageObject()

ilWikiFunctionsBlockGUI::getPageObject ( )

Get Page Object.

Returns
int Page Object

Definition at line 95 of file class.ilWikiFunctionsBlockGUI.php.

96 {
97 return $this->pageob;
98 }

Referenced by fillDataSection().

+ Here is the caller graph for this function:

◆ getScreenMode()

static ilWikiFunctionsBlockGUI::getScreenMode ( )
static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

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

59 {
60 return IL_SCREEN_SIDE;
61 }
const IL_SCREEN_SIDE

References IL_SCREEN_SIDE.

◆ isRepositoryObject()

static ilWikiFunctionsBlockGUI::isRepositoryObject ( )
static

Is this a repository object.

Returns
string Block type.

Reimplemented from ilBlockGUI.

Definition at line 50 of file class.ilWikiFunctionsBlockGUI.php.

51 {
52 return false;
53 }

◆ setPageObject()

ilWikiFunctionsBlockGUI::setPageObject (   $a_pageob)

Set Page Object.

Parameters
int$a_pageobPage Object

Definition at line 85 of file class.ilWikiFunctionsBlockGUI.php.

86 {
87 $this->pageob = $a_pageob;
88 }

Field Documentation

◆ $block_type

ilWikiFunctionsBlockGUI::$block_type = "wikiside"
static

Definition at line 16 of file class.ilWikiFunctionsBlockGUI.php.

Referenced by getBlockType().

◆ $st_data

ilWikiFunctionsBlockGUI::$st_data
static

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


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