ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilWikiImportantPagesBlockGUI Class Reference

Important pages wiki block. More...

+ Inheritance diagram for ilWikiImportantPagesBlockGUI:
+ Collaboration diagram for ilWikiImportantPagesBlockGUI:

Public Member Functions

 __construct ()
 Constructor. More...
 
 executeCommand ()
 execute command More...
 
 getHTML ($a_export=false)
 Get bloch HTML code. More...
 
 fillDataSection ()
 Fill data section. 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 this a repository object. More...
 
static getScreenMode ()
 Get Screen Mode for current command. More...
 
- Static Public Member Functions inherited from ilBlockGUI
static getBlockType ()
 
static isRepositoryObject ()
 
static getScreenMode ()
 Get Screen Mode for current command. More...
 

Static Public Attributes

static $block_type = "wikiimppages"
 
static $st_data
 

Protected Attributes

 $export = false
 
- 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

Important pages wiki block.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilWikiImportantPagesBlockGUI::__construct ( )

Constructor.

Definition at line 24 of file class.ilWikiImportantPagesBlockGUI.php.

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

25  {
26  global $ilCtrl, $lng;
27 
28  parent::__construct();
29 
30  $lng->loadLanguageModule("wiki");
31  $this->setEnableNumInfo(false);
32 
33  $this->setTitle($lng->txt("wiki_navigation"));
34  $this->allow_moving = false;
35  }
setEnableNumInfo($a_enablenuminfo)
Set Enable Item Number Info.
global $ilCtrl
Definition: ilias.php:18
setTitle($a_title)
Set Title.
global $lng
Definition: privfeed.php:17
+ Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilWikiImportantPagesBlockGUI::executeCommand ( )

execute command

Definition at line 68 of file class.ilWikiImportantPagesBlockGUI.php.

References $cmd, and $ilCtrl.

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

◆ fillDataSection()

ilWikiImportantPagesBlockGUI::fillDataSection ( )

Fill data section.

Definition at line 105 of file class.ilWikiImportantPagesBlockGUI.php.

References $_GET, $ilCtrl, $lng, $title, $tpl, ilObjWiki\_lookupImportantPagesList(), ilObject\_lookupObjId(), ilObjWiki\_lookupStartPage(), export, ilObjWikiGUI\getGotoLink(), ilWikiPage\lookupTitle(), and ilBlockGUI\setDataSection().

106  {
107  global $ilCtrl, $lng, $ilAccess;
108 
109  $tpl = new ilTemplate("tpl.wiki_imp_pages_block.html", true, true, "Modules/Wiki");
110 
111  $cpar[0] = $cpar[1] = 0;
112  include_once("./Services/UIComponent/NestedList/classes/class.ilNestedList.php");
113 
114  $list = new ilNestedList();
115  $list->setItemClass("ilWikiBlockItem");
116  $list->setListClass("ilWikiBlockList");
117  $list->setListClass("ilWikiBlockListNoIndent", 1);
118 
119  $cnt = 1;
121  if (!$this->export)
122  {
123  $list->addListNode("<p class='small'><a href='".
124  $ilCtrl->getLinkTargetByClass("ilobjwikigui", "gotoStartPage")
125  ."'>".$title."</a></p>", 1, 0);
126  }
127  else
128  {
129  $list->addListNode("<p class='small'><a href='".
130  "index.html".
131  "'>".$title."</a></p>", 1, 0);
132  }
133  $cpar[0] = 1;
134 
136  foreach ($ipages as $p)
137  {
138  $cnt++;
139  $title = ilWikiPage::lookupTitle($p["page_id"]);
140  if (!$this->export)
141  {
142  $list->addListNode("<p class='small'><a href='".
144  ."'>".$title."</a></p>", $cnt, (int) $cpar[$p["indent"] - 1]);
145  }
146  else
147  {
148  $list->addListNode("<p class='small'><a href='".
149  "wpg_".$p["page_id"].".html".
150  "'>".$title."</a></p>", $cnt, (int) $cpar[$p["indent"] - 1]);
151  }
152  $cpar[$p["indent"]] = $cnt;
153  }
154 
155  $this->setDataSection($list->getHTML());
156  }
static getGotoLink($a_ref_id, $a_page="")
Get goto link.
static lookupTitle($a_page_id)
Checks whether a page with given title exists.
static _lookupImportantPagesList($a_wiki_id)
Get important pages list.
setDataSection($a_content)
Call this from overwritten fillDataSection(), if standard row based data is not used.
$_GET["client_id"]
Nested List.
static _lookupStartPage($a_wiki_id)
Lookup start page.
global $tpl
Definition: ilias.php:8
global $ilCtrl
Definition: ilias.php:18
Removing first two heading rows for CSV export
Definition: 26utf8.php:79
static _lookupObjId($a_id)
special template class to simplify handling of ITX/PEAR
global $lng
Definition: privfeed.php:17
+ Here is the call graph for this function:

◆ getBlockType()

static ilWikiImportantPagesBlockGUI::getBlockType ( )
static

Get block type.

Returns
string Block type.

Definition at line 42 of file class.ilWikiImportantPagesBlockGUI.php.

43  {
44  return self::$block_type;
45  }

◆ getHTML()

ilWikiImportantPagesBlockGUI::getHTML (   $a_export = false)

Get bloch HTML code.

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

References $_GET, $ilCtrl, $lng, ilBlockGUI\addBlockCommand(), ilWikiPerm\check(), and export.

86  {
87  global $ilCtrl, $lng;
88 
89  $this->export = $a_export;
90 
91  include_once './Modules/Wiki/classes/class.ilWikiPerm.php';
92  if (!$this->export && ilWikiPerm::check("edit_wiki_navigation", $_GET["ref_id"]))
93  {
94  $this->addBlockCommand(
95  $ilCtrl->getLinkTargetByClass("ilobjwikigui", "editImportantPages"),
96  $lng->txt("edit"), "_top");
97  }
98 
99  return parent::getHTML();
100  }
static check($a_perm, $a_ref_id, $a_cmd="")
Check permission.
$_GET["client_id"]
addBlockCommand($a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false, $a_html="")
Add Block Command.
global $ilCtrl
Definition: ilias.php:18
Removing first two heading rows for CSV export
Definition: 26utf8.php:79
global $lng
Definition: privfeed.php:17
+ Here is the call graph for this function:

◆ getScreenMode()

static ilWikiImportantPagesBlockGUI::getScreenMode ( )
static

Get Screen Mode for current command.

Definition at line 60 of file class.ilWikiImportantPagesBlockGUI.php.

References IL_SCREEN_SIDE.

61  {
62  return IL_SCREEN_SIDE;
63  }
const IL_SCREEN_SIDE

◆ isRepositoryObject()

static ilWikiImportantPagesBlockGUI::isRepositoryObject ( )
static

Is this a repository object.

Returns
string Block type.

Definition at line 52 of file class.ilWikiImportantPagesBlockGUI.php.

53  {
54  return false;
55  }

Field Documentation

◆ $block_type

ilWikiImportantPagesBlockGUI::$block_type = "wikiimppages"
static

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

◆ $export

ilWikiImportantPagesBlockGUI::$export = false
protected

Definition at line 19 of file class.ilWikiImportantPagesBlockGUI.php.

◆ $st_data

ilWikiImportantPagesBlockGUI::$st_data
static

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


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