ilWikiFunctionsBlockGUI Class Reference

BlockGUI class for wiki functions block. More...

Inheritance diagram for ilWikiFunctionsBlockGUI:

Collaboration diagram for ilWikiFunctionsBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	getBlockType ()
	Returns string 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
	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 = "wikiside"
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
	$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

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.

Reimplemented from ilBlockGUI.

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

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->access = $DIC->access();
        $lng = $DIC->language();
        
        parent::__construct();
        
        $lng->loadLanguageModule("wiki");
        $this->setEnableNumInfo(false);
        
        $this->setTitle($lng->txt("wiki_functions"));
        $this->allow_moving = false;
 
        $this->ref_id = (int) $_GET["ref_id"];
 
        $this->setPresentation(self::PRES_SEC_LEG);
    }

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

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilWikiFunctionsBlockGUI::executeCommand

(

)

execute command

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

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

References ilBlockGUI\$ctrl, and $ilCtrl.

fillDataSection()

ilWikiFunctionsBlockGUI::fillDataSection

(

)

Fill data section.

Reimplemented from ilBlockGUI.

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

    {
        $this->setDataSection($this->getLegacyContent());
    }

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

Here is the call graph for this function:

getBlockType()

ilWikiFunctionsBlockGUI::getBlockType

(

)

Returns

string

Reimplemented from ilBlockGUI.

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

                                   : string
    {
        return self::$block_type;
    }

References $block_type.

getHTML()

ilWikiFunctionsBlockGUI::getHTML

(

)

Get bloch HTML code.

Reimplemented from ilBlockGUI.

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

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
        
        return parent::getHTML();
    }

References ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$lng, and ilBlockGUI\$user.

getLegacyContent()

ilWikiFunctionsBlockGUI::getLegacyContent ( )

protected

Get legacy content.

Returns

string

Reimplemented from ilBlockGUI.

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

                                          : string
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilAccess = $this->access;
        
        $tpl = new ilTemplate("tpl.wiki_side_block_content.html", true, true, "Modules/Wiki");
        
        $wp = $this->getPageObject();
 
        // info
        $actions[] = array(
            "txt" => $lng->txt("info_short"),
            "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "infoScreen")
            );
 
        // 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");
        }
 
 
        $actions = array();
        
        // 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")
            );
 
 
        // page lists
        include_once("./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
        $list = new ilAdvancedSelectionListGUI();
        $list->setListTitle($lng->txt("wiki_page_lists"));
        $list->setStyle(ilAdvancedSelectionListGUI::STYLE_LINK);
        $list->setId("wiki_pglists");
 
        foreach ($actions as $a) {
            $list->addItem(
                $a["txt"],
                "",
                $a["href"]
            );
        }
        $tpl->setCurrentBlock("plain");
        $tpl->setVariable("PLAIN", $list->getHTML());
        $tpl->parseCurrentBlock();
        $tpl->touchBlock("item");
 
        
        // page actions
        $list = new ilAdvancedSelectionListGUI();
        $list->setStyle(ilAdvancedSelectionListGUI::STYLE_LINK);
        $list->setListTitle($lng->txt("wiki_page_actions"));
        $list->setId("wiki_pgactions");
 
        if ($ilAccess->checkAccess("write", "", $this->ref_id)) {
            // rating
            if (ilObjWiki::_lookupRating($this->getPageObject()->getWikiId())) {
                if (!$this->getPageObject()->getRating()) {
                    $list->addItem(
                        $lng->txt("wiki_activate_page_rating"),
                        "",
                        $ilCtrl->getLinkTargetByClass("ilwikipagegui", "activateWikiPageRating")
                    );
                } else {
                    $list->addItem(
                        $lng->txt("wiki_deactivate_page_rating"),
                        "",
                        $ilCtrl->getLinkTargetByClass("ilwikipagegui", "deactivateWikiPageRating")
                    );
                }
            }
        }
 
        if ($ilAccess->checkAccess("write", "", $this->ref_id) ||
            $ilAccess->checkAccess("edit_page_meta", "", $this->ref_id)) {
            // unhide advmd?
            include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php';
            if ((bool) sizeof(ilAdvancedMDRecord::_getSelectedRecordsByObject("wiki", $this->ref_id, "wpg")) &&
                ilWikiPage::lookupAdvancedMetadataHidden($this->getPageObject()->getId())) {
                $list->addItem(
                    $lng->txt("wiki_unhide_meta_adv_records"),
                    "",
                    $ilCtrl->getLinkTargetByClass("ilwikipagegui", "unhideAdvancedMetaData")
                );
            }
        }
 
        if (($ilAccess->checkAccess("edit_content", "", $this->ref_id) && !$this->getPageObject()->getBlocked())
            || $ilAccess->checkAccess("write", "", $this->ref_id)) {
            // rename
            $list->addItem(
                $lng->txt("wiki_rename_page"),
                "",
                $ilCtrl->getLinkTargetByClass("ilwikipagegui", "renameWikiPage")
            );
        }
 
        include_once("./Modules/Wiki/classes/class.ilWikiPerm.php");
        if (ilWikiPerm::check("activate_wiki_protection", $this->ref_id)) {
            // block/unblock
            if ($this->getPageObject()->getBlocked()) {
                $list->addItem(
                    $lng->txt("wiki_unblock_page"),
                    "",
                    $ilCtrl->getLinkTargetByClass("ilwikipagegui", "unblockWikiPage")
                );
            } else {
                $list->addItem(
                    $lng->txt("wiki_block_page"),
                    "",
                    $ilCtrl->getLinkTargetByClass("ilwikipagegui", "blockWikiPage")
                );
            }
        }
 
        include_once("./Modules/Wiki/classes/class.ilWikiPerm.php");
        if (ilWikiPerm::check("delete_wiki_pages", $this->ref_id)) {
            // delete page
            $st_page = ilObjWiki::_lookupStartPage($this->getPageObject()->getParentId());
            if ($st_page != $this->getPageObject()->getTitle()) {
                $list->addItem(
                    $lng->txt("wiki_delete_page"),
                    "",
                    $ilCtrl->getLinkTargetByClass("ilwikipagegui", "deleteWikiPageConfirmationScreen")
                );
            }
        }
        
        if ($ilAccess->checkAccess("write", "", $this->ref_id)) {
            include_once "Modules/Wiki/classes/class.ilWikiPageTemplate.php";
            $wpt = new ilWikiPageTemplate($this->getPageObject()->getParentId());
            if (!$wpt->isPageTemplate($this->getPageObject()->getId())) {
                $list->addItem(
                    $lng->txt("wiki_add_template"),
                    "",
                    $ilCtrl->getLinkTargetByClass("ilwikipagetemplategui", "addPageTemplateFromPageAction")
                );
            } else {
                $list->addItem(
                    $lng->txt("wiki_remove_template_status"),
                    "",
                    $ilCtrl->getLinkTargetByClass("ilwikipagetemplategui", "removePageTemplateFromPageAction")
                );
            }
        }
 
        if ($ilAccess->checkAccess("write", "", $this->ref_id) ||
            $ilAccess->checkAccess("read", "", $this->ref_id)) {
            $tpl->setCurrentBlock("plain");
            $tpl->setVariable("PLAIN", $list->getHTML());
            $tpl->parseCurrentBlock();
            $tpl->touchBlock("item");
        }
 
        // permissions
        //              if ($ilAccess->checkAccess('edit_permission', "", $this->ref_id))
        //              {
        //                      $actions[] = array(
        //                              "txt" => $lng->txt("perm_settings"),
        //                              "href" => $ilCtrl->getLinkTargetByClass(array("ilobjwikigui", "ilpermissiongui"), "perm")
        //                              );
        //              }
 
        $actions = array();
        
        // settings
        if ($ilAccess->checkAccess('write', "", $this->ref_id)) {
            $actions[] = array(
                "txt" => $lng->txt("wiki_contributors"),
                "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "listContributors")
                );
        }
 
        // manage
        if (ilWikiPerm::check("wiki_html_export", $this->ref_id)) {
            $actions[] = array(
                "txt" => $lng->txt("wiki_html_export"),
                "id" => "il_wiki_user_export",
                "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "initUserHTMLExport")
            );
        }
 
        // manage
        if ($ilAccess->checkAccess('write', "", $this->ref_id)) {
            $actions[] = array(
                "txt" => $lng->txt("settings"),
                "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "editSettings")
                );
        } elseif ($ilAccess->checkAccess('statistics_read', "", $this->ref_id)) {
            $actions[] = array(
                "txt" => $lng->txt("statistics"),
                "href" => $ilCtrl->getLinkTargetByClass(array("ilobjwikigui", "ilwikistatgui"), "initial")
                );
        }
 
        foreach ($actions as $a) {
            $tpl->setCurrentBlock("action");
            $tpl->setVariable("HREF", $a["href"]);
            $tpl->setVariable("TXT", $a["txt"]);
            if ($a["id"] != "") {
                $tpl->setVariable("ACT_ID", "id='" . $a["id"] . "'");
            }
            $tpl->parseCurrentBlock();
 
            $tpl->touchBlock("item");
        }
 
        return $tpl->get();
    }

References Vendor\Package\$a, ilBlockGUI\$access, ilBlockGUI\$ctrl, $ilCtrl, ilBlockGUI\$lng, ilBlockGUI\$tpl, ilAdvancedMDRecord\_getSelectedRecordsByObject(), ilObjWiki\_lookupRating(), ilObjWiki\_lookupStartPage(), ilWikiPerm\check(), getPageObject(), ilBlockGUI\getTitle(), ilWikiPage\lookupAdvancedMetadataHidden(), and ilAdvancedSelectionListGUI\STYLE_LINK.

Referenced by fillDataSection().

Here is the call graph for this function:

Here is the caller graph for this function:

getPageObject()

ilWikiFunctionsBlockGUI::getPageObject

(

)

Get Page Object.

Returns

int Page Object

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

    {
        return $this->pageob;
    }

Referenced by getLegacyContent().

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 64 of file class.ilWikiFunctionsBlockGUI.php.

    {
        return IL_SCREEN_SIDE;
    }

References IL_SCREEN_SIDE.

isRepositoryObject()

ilWikiFunctionsBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Returns

bool

Reimplemented from ilBlockGUI.

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

                                            : bool
    {
        return false;
    }

setPageObject()

ilWikiFunctionsBlockGUI::setPageObject

(

$a_pageob

)

Set Page Object.

Parameters

int

$a_pageob

Page Object

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

    {
        $this->pageob = $a_pageob;
    }

Field Documentation

$block_type

ilWikiFunctionsBlockGUI::$block_type = "wikiside"

static

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

Referenced by getBlockType().

$new_rendering

ilWikiFunctionsBlockGUI::$new_rendering = true

protected

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

$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:

• Modules/Wiki/classes/class.ilWikiFunctionsBlockGUI.php