ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes
ilWikiSideBlockGUI Class Reference
Modules/Wiki

BlockGUI class for wiki sideblock. More...

+ Inheritance diagram for ilWikiSideBlockGUI:
+ Collaboration diagram for ilWikiSideBlockGUI:

Public Member Functions

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

Static Public Member Functions

static getBlockType ()
 Get block type.
static isRepositoryObject ()
 Is this a repository object.
static getScreenMode ()
 Get Screen Mode for current command.

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.
- 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 sideblock.

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

+++CalledBy ilWikiSideBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

ilWikiSideBlockGUI::__construct ( )

Constructor.

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

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

{
global $ilCtrl, $lng;
parent::ilBlockGUI();
$lng->loadLanguageModule("wiki");
$this->setEnableNumInfo(false);
$this->setTitle($lng->txt("wiki_quick_navigation"));
$this->allow_moving = false;
}

+ Here is the call graph for this function:

Member Function Documentation

& ilWikiSideBlockGUI::executeCommand ( )

execute command

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

References $cmd, and $ilCtrl.

{
global $ilCtrl;
$next_class = $ilCtrl->getNextClass();
$cmd = $ilCtrl->getCmd("getHTML");
switch ($next_class)
{
default:
return $this->$cmd();
}
}
ilWikiSideBlockGUI::fillDataSection ( )

Fill data section.

Reimplemented from ilBlockGUI.

Definition at line 115 of file class.ilWikiSideBlockGUI.php.

References $ilCtrl, $lng, $tpl, getPageObject(), and ilBlockGUI\setDataSection().

{
global $ilCtrl, $lng, $ilAccess;
$tpl = new ilTemplate("tpl.wiki_side_block_content.html", true, true, "Modules/Wiki");
$wp = $this->getPageObject();
// start page
$actions[] = array(
"txt" => $lng->txt("wiki_start_page"),
"href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "gotoStartPage")
);
// all pages
$actions[] = array(
"txt" => $lng->txt("wiki_all_pages"),
"href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "allPages")
);
// new pages
$actions[] = array(
"txt" => $lng->txt("wiki_new_pages"),
"href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "newPages")
);
// popular pages
$actions[] = array(
"txt" => $lng->txt("wiki_popular_pages"),
"href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "popularPages")
);
// orphaned pages
$actions[] = array(
"txt" => $lng->txt("wiki_orphaned_pages"),
"href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "orphanedPages")
);
// recent changes
$actions[] = array(
"txt" => $lng->txt("wiki_recent_changes"),
"href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "recentChanges")
);
foreach ($actions as $a)
{
$tpl->setCurrentBlock("action");
$tpl->setVariable("HREF", $a["href"]);
$tpl->setVariable("TXT", $a["txt"]);
$tpl->parseCurrentBlock();
$tpl->touchBlock("item");
}
$this->setDataSection($tpl->get());
}

+ Here is the call graph for this function:

static ilWikiSideBlockGUI::getBlockType ( )
static

Get block type.

Returns
string Block type.

Reimplemented from ilBlockGUI.

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

References $block_type.

{
return self::$block_type;
}
ilWikiSideBlockGUI::getHTML ( )

Get bloch HTML code.

Reimplemented from ilBlockGUI.

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

References $ilCtrl, $ilUser, and $lng.

{
global $ilCtrl, $lng, $ilUser;
return parent::getHTML();
}
ilWikiSideBlockGUI::getPageObject ( )

Get Page Object.

Returns
int Page Object

Definition at line 97 of file class.ilWikiSideBlockGUI.php.

Referenced by fillDataSection().

{
return $this->pageob;
}

+ Here is the caller graph for this function:

static ilWikiSideBlockGUI::getScreenMode ( )
static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

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

References IL_SCREEN_SIDE.

{
return IL_SCREEN_SIDE;
}
static ilWikiSideBlockGUI::isRepositoryObject ( )
static

Is this a repository object.

Returns
string Block type.

Reimplemented from ilBlockGUI.

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

{
return false;
}
ilWikiSideBlockGUI::setPageObject (   $a_pageob)

Set Page Object.

Parameters
int$a_pageobPage Object

Definition at line 87 of file class.ilWikiSideBlockGUI.php.

{
$this->pageob = $a_pageob;
}

Field Documentation

ilWikiSideBlockGUI::$block_type = "wikiside"
static

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

Referenced by getBlockType().

ilWikiSideBlockGUI::$st_data
static

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

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