ilWikiFunctionsBlockGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilWikiFunctionsBlockGUI:

Collaboration diagram for ilWikiFunctionsBlockGUI:

Public Member Functions
	__construct ()
	getBlockType ()
	executeCommand ()
	execute command More...
	setPageObject (ilWikiPage $a_pageob)
	getPageObject ()
	fillDataSection ()
	Standard implementation for row based data. More...
Public Member Functions inherited from ilBlockGUI
	__construct ()
	getBlockType ()
	setData (array $a_data)
	getData ()
	setPresentation (int $type)
	getPresentation ()
	setBlockId (string $a_block_id="0")
	getBlockId ()
	setGuiObject (object $a_gui_object)
	Set GuiObject. More...
	getGuiObject ()
	setTitle (string $a_title)
	getTitle ()
	setOffset (int $a_offset)
	getOffset ()
	correctOffset ()
	setLimit (int $a_limit)
	getLimit ()
	setEnableEdit (bool $a_enableedit)
	getEnableEdit ()
	setRepositoryMode (bool $a_repositorymode)
	getRepositoryMode ()
	setSubtitle (string $a_subtitle)
	getSubtitle ()
	setRefId (int $a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...
	getRefId ()
	setAdminCommands (bool $a_admincommands)
	getAdminCommands ()
	setEnableNumInfo (bool $a_enablenuminfo)
	getEnableNumInfo ()
	setProperties (array $a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...
	getProperty (string $a_property)
	setProperty (string $a_property, string $a_value)
	setRowTemplate (string $a_rowtemplatename, string $a_rowtemplatedir="")
	Set Row Template Name. More...
	getNavParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	getRowTemplateDir ()
	addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
	getBlockCommands ()
	getHTML ()
	fillHeaderCommands ()
	fillHeaderTitleBlock ()
	setDataSection (string $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 (array $a_set)
	fillFooter ()
	fillPreviousNext ()
	setPreviousNextLinks ()
	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...
	getPaginationViewControl ()
	Fill previous/next row. More...
	getHTMLNew ()
	getNoItemFoundContent ()

Static Public Attributes
static	$block_type = "wikiside"
static	$st_data

Protected Member Functions
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	getLegacyContent ()
	Get legacy content. More...
Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	specialCharsAsEntities (string $string)
	initCommands ()
	fillRowColor (string $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...
	send (string $output)
	Send. More...

Protected Attributes
int	$ref_id
ilWikiPage	$pageob
ilObjWiki	$wiki
bool	$new_rendering = true
Protected Attributes inherited from ilBlockGUI
object	$gui_object
ILIAS Block StandardGUIRequest	$request
ILIAS Block BlockManager	$block_manager
bool	$repositorymode = false
ILIAS DI UIServices	$ui
array	$data = array()
bool	$enablenuminfo = true
array	$footer_links = array()
string	$block_id = "0"
bool	$allow_moving = true
array	$move = array("left" => false, "right" => false, "up" => false, "down" => false)
array	$block_commands = array()
int	$max_count = 0
bool	$close_command = false
bool	$image = false
array	$property = []
string	$nav_value = ""
string	$css_row = ""
string	$title = ""
bool	$admincommands = false
array	$dropdown
ilTemplate	$tpl
ilGlobalTemplateInterface	$main_tpl
ilObjUser	$user
ilCtrl	$ctrl
ilAccessHandler	$access
ilLanguage	$lng
ilObjectDefinition	$obj_def
int	$presentation
int	$requested_ref_id
bool	$new_rendering = false

Additional Inherited Members
Static Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()
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
const	PRES_MAIN_TILE = 4

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning BlockGUI class for wiki functions block

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilWikiFunctionsBlockGUI::__construct

(

)

Reimplemented from ilBlockGUI.

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

    {
        global $DIC;
 
        $request = $DIC
            ->wiki()
            ->internal()
            ->gui()
            ->editing()
            ->request();
 
        $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 = $request->getRefId();
 
        $this->wiki = new ilObjWiki($this->ref_id);
 
        $this->setPresentation(self::PRES_SEC_LEG);
    }

References $DIC, ilBlockGUI\$lng, ilBlockGUI\$request, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ilBlockGUI\setEnableNumInfo(), ilBlockGUI\setPresentation(), ilBlockGUI\setTitle(), ilLanguage\txt(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilWikiFunctionsBlockGUI::executeCommand

(

)

execute command

Definition at line 77 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\getNextClass().

Here is the call graph for this function:

fillDataSection()

ilWikiFunctionsBlockGUI::fillDataSection

(

)

Standard implementation for row based data.

Overwrite this and call setContent for other data.

Reimplemented from ilBlockGUI.

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

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

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

Here is the call graph for this function:

getBlockType()

ilWikiFunctionsBlockGUI::getBlockType

(

)

Reimplemented from ilBlockGUI.

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

                                  : string
    {
        return self::$block_type;
    }

References $block_type.

getLegacyContent()

ilWikiFunctionsBlockGUI::getLegacyContent ( )

protected

Get legacy content.

Returns

string

Reimplemented from ilBlockGUI.

Definition at line 112 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
        $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?
            if (count(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")
            );
        }
 
        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")
                );
            }
        }
 
        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)) {
            $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)) {
            if (!$this->wiki->isCommentsExportPossible()) {
                $actions[] = array(
                    "txt" => $lng->txt("wiki_html_export"),
                    "id" => "il_wiki_user_export",
                    "href" => $ilCtrl->getLinkTargetByClass("ilobjwikigui", "initUserHTMLExport")
                );
            } else {
                $this->lng->loadLanguageModule("note");
                $comments_helper = new \ILIAS\Notes\Export\ExportHelperGUI();
                $comments_modal = $comments_helper->getCommentIncludeModalDialog(
                    $this->lng->txt("wiki_html_export"),
                    $this->lng->txt("note_html_export_include_comments"),
                    "il.Wiki.Pres.performHTMLExport();",
                    "il.Wiki.Pres.performHTMLExportWithComments();",
                    true
                );
                $actions[] = array(
                    "txt" => $lng->txt("wiki_html_export"),
                    "modal" => $comments_modal
                );
            }
        }
 
        // 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")
                );
        }
 
        $modal_html = "";
        foreach ($actions as $a) {
            $tpl->setCurrentBlock("action");
            if (($a["modal"] ?? "") != "") {
                $signal = $a["modal"]->getShowSignal();
                $onclick = "$(document).trigger('" . $signal . "', {'id': '" . $signal . "','triggerer':$(this), 'options': JSON.parse('[]')}); return false;";
                $tpl->setVariable("ONCLICK", ' onclick="' . $onclick . '" ');
                $tpl->setVariable("HREF", "#");
                $modal_html .= $this->ui->renderer()->render($a["modal"]);
            } else {
                $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() . $modal_html;
    }

References Vendor\Package\$a, ilBlockGUI\$access, ilBlockGUI\$ctrl, ilBlockGUI\$lng, ilBlockGUI\$tpl, ilAdvancedMDRecord\_getSelectedRecordsByObject(), ilObjWiki\_lookupRating(), ilObjWiki\_lookupStartPage(), ilWikiPerm\check(), ilTemplate\get(), ILIAS\Survey\Mode\getId(), getPageObject(), ilBlockGUI\getTitle(), ILIAS\Repository\lng(), ilWikiPage\lookupAdvancedMetadataHidden(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), ilAdvancedSelectionListGUI\STYLE_LINK, ilTemplate\touchBlock(), ilLanguage\txt(), and ILIAS\Repository\ui().

Referenced by fillDataSection().

Here is the call graph for this function:

Here is the caller graph for this function:

getPageObject()

ilWikiFunctionsBlockGUI::getPageObject

(

)

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

                                   : ilWikiPage
    {
        return $this->pageob;
    }

References $pageob.

Referenced by getLegacyContent().

Here is the caller graph for this function:

isRepositoryObject()

ilWikiFunctionsBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Reimplemented from ilBlockGUI.

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

                                           : bool
    {
        return false;
    }

setPageObject()

ilWikiFunctionsBlockGUI::setPageObject

(

ilWikiPage

$a_pageob

)

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

                                                       : void
    {
        $this->pageob = $a_pageob;
    }

Field Documentation

$block_type

ilWikiFunctionsBlockGUI::$block_type = "wikiside"

static

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

Referenced by getBlockType().

$new_rendering

bool ilWikiFunctionsBlockGUI::$new_rendering = true

protected

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

$pageob

ilWikiPage ilWikiFunctionsBlockGUI::$pageob

protected

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

Referenced by getPageObject().

$ref_id

int ilWikiFunctionsBlockGUI::$ref_id

protected

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

$st_data

ilWikiFunctionsBlockGUI::$st_data

static

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

$wiki

ilObjWiki ilWikiFunctionsBlockGUI::$wiki

protected

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

---

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

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