ILIAS  release_7 Revision v7.30-3-g800a261c036
ilWikiImportantPagesBlockGUI Class Reference

Important pages wiki block. More...

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

Public Member Functions

 __construct ()
 Constructor. More...
 
 getBlockType ()
 
Returns
string
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
 getBlockType ()
 
 __construct ()
 Constructor. More...
 
 setData ($a_data)
 Set Data. More...
 
 getData ()
 Get Data. More...
 
 setPresentation (int $type)
 Set presentation. More...
 
 getPresentation ()
 Get presentation type. More...
 
 setBlockId ($a_block_id=0)
 Set Block Id. More...
 
 getBlockId ()
 Get Block Id. More...
 
 setGuiObject (&$a_gui_object)
 Set GuiObject. More...
 
 getGuiObject ()
 Get GuiObject. More...
 
 setTitle ($a_title)
 Set Title. More...
 
 getTitle ()
 Get Title. 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...
 
 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 (bool $a_admincommands)
 Set Administration Commmands. More...
 
 getAdminCommands ()
 Get Administration Commmands. 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 ()
 
 getConfigParameter ()
 
 getMoveParameter ()
 
 getRowTemplateName ()
 Get Row Template Name. More...
 
 getRowTemplateDir ()
 Get Row Template Directory. More...
 
 addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
 Add Block Command. More...
 
 getBlockCommands ()
 Get Block commands. More...
 
 getHTML ()
 Get HTML. 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...
 
 getAsynch ()
 Use this for final get before sending asynchronous output (ajax) per echo to output. More...
 
 getPaginationViewControl ()
 Fill previous/next row. More...
 
 getHTMLNew ()
 Get HTML. More...
 

Static Public Member Functions

static getScreenMode ()
 Get Screen Mode for current command. More...
 
static getScreenMode ()
 Get Screen Mode for current command. More...
 

Static Public Attributes

static $block_type = "wikiimppages"
 
static $st_data
 

Protected Member Functions

 isRepositoryObject ()
 Returns whether block has a corresponding repository object.
Returns
bool
More...
 
 getLegacyContent ()
 Get legacy content.
Returns
string
More...
 
- Protected Member Functions inherited from ilBlockGUI
 isRepositoryObject ()
 Returns whether block has a corresponding repository object. More...
 
 initCommands ()
 Init commands. More...
 
 fillRowColor ($a_placeholder="CSS_ROW")
 
 preloadData (array $data)
 Can be overwritten in subclasses. More...
 
 getLegacyContent ()
 Get legacy content. More...
 
 getViewControls ()
 Get view controls. More...
 
 getListItemForData (array $data)
 Get list item for data array. More...
 
 handleNavigation ()
 Handle navigation. More...
 
 loadData ()
 Load data for current page. More...
 
 getListItemGroups ()
 Get items. More...
 
 addRepoCommands ()
 Add repo commands. More...
 
 getNoItemFoundContent ()
 No item entry. More...
 

Protected Attributes

 $export = false
 
 $new_rendering = true
 
- Protected Attributes inherited from ilBlockGUI
 $ui
 
 $data = array()
 
 $enablenuminfo = true
 
 $footer_links = array()
 
 $block_id = 0
 
 $allow_moving = true
 
 $move = array("left" => false, "right" => false, "up" => false, "down" => false)
 
 $block_commands = array()
 
 $max_count = false
 
 $close_command = false
 
 $image = false
 
 $property = false
 
 $nav_value = ""
 
 $css_row = ""
 
 $title = ""
 
 $admincommands = false
 
 $dropdown
 
 $tpl
 
 $main_tpl
 
 $user
 
 $ctrl
 
 $access
 
 $lng
 
 $obj_def
 
 $presentation
 
 $new_rendering = false
 

Additional Inherited Members

- Data Fields inherited from ilBlockGUI
const PRES_MAIN_LEG = 0
 
const PRES_SEC_LEG = 1
 
const PRES_SEC_LIST = 2
 
const PRES_MAIN_LIST = 3
 

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.

Reimplemented from ilBlockGUI.

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

25 {
26 global $DIC;
27
28 $this->ctrl = $DIC->ctrl();
29 $this->lng = $DIC->language();
30 $this->access = $DIC->access();
31 $ilCtrl = $DIC->ctrl();
32 $lng = $DIC->language();
33
35
36 $lng->loadLanguageModule("wiki");
37 $this->setEnableNumInfo(false);
38
39 $this->setTitle($lng->txt("wiki_navigation"));
40 $this->allow_moving = false;
41 }
setTitle($a_title)
Set Title.
setEnableNumInfo($a_enablenuminfo)
Set Enable Item Number Info.
global $DIC
Definition: goto.php:24
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc

References $DIC, ilBlockGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ilBlockGUI\setEnableNumInfo(), and ilBlockGUI\setTitle().

+ Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilWikiImportantPagesBlockGUI::executeCommand ( )

execute command

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

71 {
72 $ilCtrl = $this->ctrl;
73
74 $next_class = $ilCtrl->getNextClass();
75 $cmd = $ilCtrl->getCmd("getHTML");
76
77 switch ($next_class) {
78 default:
79 return $this->$cmd();
80 }
81 }

References ilBlockGUI\$ctrl.

◆ fillDataSection()

ilWikiImportantPagesBlockGUI::fillDataSection ( )

Fill data section.

Reimplemented from ilBlockGUI.

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

108 {
109 $this->setDataSection($this->getLegacyContent());
110 }
setDataSection($a_content)
Call this from overwritten fillDataSection(), if standard row based data is not used.

References getLegacyContent(), and ilBlockGUI\setDataSection().

+ Here is the call graph for this function:

◆ getBlockType()

ilWikiImportantPagesBlockGUI::getBlockType ( )

Returns
string

Reimplemented from ilBlockGUI.

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

46 : string
47 {
48 return self::$block_type;
49 }

References $block_type.

◆ getHTML()

ilWikiImportantPagesBlockGUI::getHTML (   $a_export = false)

Get bloch HTML code.

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

87 {
88 $ilCtrl = $this->ctrl;
90
91 $this->export = $a_export;
92
93 include_once './Modules/Wiki/classes/class.ilWikiPerm.php';
94 if (!$this->export && ilWikiPerm::check("edit_wiki_navigation", $_GET["ref_id"])) {
95 $this->addBlockCommand(
96 $ilCtrl->getLinkTargetByClass("ilobjwikigui", "editImportantPages"),
97 $lng->txt("edit")
98 );
99 }
100
101 return parent::getHTML();
102 }
$_GET["client_id"]
addBlockCommand(string $a_href, string $a_text, string $a_onclick="")
Add Block Command.
static check($a_perm, $a_ref_id, $a_cmd="")
Check permission.

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

+ Here is the call graph for this function:

◆ getLegacyContent()

ilWikiImportantPagesBlockGUI::getLegacyContent ( )
protected

Get legacy content.

Returns
string

Reimplemented from ilBlockGUI.

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

122 : string
123 {
124 $ilCtrl = $this->ctrl;
126 $ilAccess = $this->access;
127
128 $tpl = new ilTemplate("tpl.wiki_imp_pages_block.html", true, true, "Modules/Wiki");
129
130 $cpar[0] = $cpar[1] = 0;
131 include_once("./Services/UIComponent/NestedList/classes/class.ilNestedList.php");
132
133 $list = new ilNestedList();
134 $list->setItemClass("ilWikiBlockItem");
135 $list->setListClass("ilWikiBlockList");
136 $list->setListClass("ilWikiBlockListNoIndent", 1);
137
138 $cnt = 1;
140 if (!$this->export) {
141 $list->addListNode("<p class='small'><a href='" .
142 $ilCtrl->getLinkTargetByClass("ilobjwikigui", "gotoStartPage")
143 . "'>" . $title . "</a></p>", 1, 0);
144 } else {
145 $list->addListNode("<p class='small'><a href='" .
146 "index.html" .
147 "'>" . $title . "</a></p>", 1, 0);
148 }
149 $cpar[0] = 1;
150
152 foreach ($ipages as $p) {
153 $cnt++;
154 $title = ilWikiPage::lookupTitle($p["page_id"]);
155 if (!$this->export) {
156 $list->addListNode("<p class='small'><a href='" .
158 . "'>" . $title . "</a></p>", $cnt, (int) $cpar[$p["indent"] - 1]);
159 } else {
160 $list->addListNode("<p class='small'><a href='" .
161 "wpg_" . $p["page_id"] . ".html" .
162 "'>" . $title . "</a></p>", $cnt, (int) $cpar[$p["indent"] - 1]);
163 }
164 $cpar[$p["indent"]] = $cnt;
165 }
166
167 return $list->getHTML();
168 }
static getGotoLink($a_ref_id, $a_page="")
Get goto link.
static _lookupImportantPagesList($a_wiki_id)
Get important pages list.
static _lookupStartPage($a_wiki_id)
Lookup start page.
static _lookupObjId($a_id)
special template class to simplify handling of ITX/PEAR
static lookupTitle($a_page_id)
Checks whether a page with given title exists.

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

Referenced by fillDataSection().

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

◆ getScreenMode()

static ilWikiImportantPagesBlockGUI::getScreenMode ( )
static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

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

63 {
64 return IL_SCREEN_SIDE;
65 }
const IL_SCREEN_SIDE

References IL_SCREEN_SIDE.

◆ isRepositoryObject()

ilWikiImportantPagesBlockGUI::isRepositoryObject ( )
protected

Returns whether block has a corresponding repository object.

Returns
bool

Reimplemented from ilBlockGUI.

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

54 : bool
55 {
56 return false;
57 }

Field Documentation

◆ $block_type

ilWikiImportantPagesBlockGUI::$block_type = "wikiimppages"
static

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

Referenced by getBlockType().

◆ $export

ilWikiImportantPagesBlockGUI::$export = false
protected

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

◆ $new_rendering

ilWikiImportantPagesBlockGUI::$new_rendering = true
protected

Definition at line 116 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: