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

Collaboration diagram for ilWikiImportantPagesBlockGUI:

Public Member Functions
	__construct ()
	getBlockType ()
	executeCommand ()
	getHTML (bool $a_export=false)
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 ()
	checkOffset (int $offset)
	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="", ?RoundTrip $modal=null)
	getBlockCommands ()
	getHTML ()
	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...
	getPaginationViewControl ()
	Fill previous/next row. More...
	getViewControlsForPanel ()
	sortObject ()
	addSortOption (string $option, string $label, bool $active)
	setSortTarget (string $target)
	addPresentation (string $label, string $target, bool $active)
	getNoItemFoundContent ()

Static Public Attributes
static string	$block_type = "wikiimppages"

Protected Member Functions
	isRepositoryObject ()
	getLegacyContent ()
Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	specialCharsAsEntities (string $string)
	initCommands ()
	preloadData (array $data)
	Can be overwritten in subclasses. More...
	getLegacyContent ()
	Get legacy content. 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...
	getActionsForPanel ()
	send (string $output)
	Send. More...

Protected Attributes
ILIAS Wiki Navigation ImportantPageManager	$imp_pages
ILIAS Wiki WikiGUIRequest	$wiki_request
ILIAS Wiki InternalGUIService	$gui
ILIAS Wiki Wiki DomainService	$wiki_manager
string	$lang
ILIAS Wiki Page PageManager	$pm
ILIAS Wiki InternalDomainService	$domain
ILIAS Wiki InternalService	$service
bool	$export = false
Protected Attributes inherited from ilBlockGUI
ILIAS UI Renderer	$renderer
Factory	$factory
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

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 Important pages wiki block

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilWikiImportantPagesBlockGUI::__construct

(

)

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

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

    {
        global $DIC;

        $this->service = $DIC->wiki()->internal();

        $this->domain = $this->service->domain();
        $this->gui = $this->service->gui();
        $this->wiki_request = $this->gui->request();

        $ref_id = $this->wiki_request->getRefId();
        $this->pm = $this->domain->page()->page($ref_id);
        $this->wiki_manager = $this->domain->wiki();
        $this->imp_pages = $this->domain->importantPage($ref_id);
        $this->lang = $this->wiki_request->getTranslation();

        $this->ctrl = $this->gui->ctrl();
        $this->lng = $this->domain->lng();
        $this->access = $this->domain->access();

        parent::__construct();

        $this->lng->loadLanguageModule("wiki");
        $this->setEnableNumInfo(false);

        $this->setTitle($this->lng->txt("wiki_navigation"));
        $this->allow_moving = false;
        $this->gui = $DIC->wiki()->internal()->gui();
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilWikiImportantPagesBlockGUI::executeCommand

(

)

Returns

mixed

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

References ilBlockGUI\$ctrl, and ilCtrl\getNextClass().

    {
        $ilCtrl = $this->ctrl;

        $next_class = $ilCtrl->getNextClass();
        $cmd = $ilCtrl->getCmd("getHTML");

        switch ($next_class) {
            default:
                return $this->$cmd();
        }
    }

Here is the call graph for this function:

getBlockType()

ilWikiImportantPagesBlockGUI::getBlockType

(

)

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

                                  : string
    {
        return self::$block_type;
    }

getHTML()

ilWikiImportantPagesBlockGUI::getHTML

(

bool

$a_export = false

)

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

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

                                                   : string
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->export = $a_export;

        if (!$this->export && ilWikiPerm::check("edit_wiki_navigation", $this->requested_ref_id)) {
            $this->addBlockCommand(
                $ilCtrl->getLinkTargetByClass("ilobjwikigui", "editImportantPages"),
                $lng->txt("edit")
            );
        }

        return parent::getHTML();
    }

Here is the call graph for this function:

getLegacyContent()

ilWikiImportantPagesBlockGUI::getLegacyContent ( )

protected

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

References ilBlockGUI\$ctrl, $lang, ilBlockGUI\$title, and ILIAS\Repository\ui().

                                         : string
    {
        $ilCtrl = $this->ctrl;
        $cpar[1] = 0;

        $listing = $this->gui->listing();

        $cnt = 1;
        $start_page_id = $this->wiki_manager->getStartingPageId($this->requested_ref_id);

        if ($this->pm->exists($start_page_id, $this->lang)) {
            $title = $this->pm->getTitle($start_page_id, $this->lang);
            if (!$this->export) {
                $listing->node($this->ui->factory()->link()->standard(
                    $title,
                    $this->pm->getPermaLink($start_page_id, $this->lang)
                ), "1", "0");
            } else {
                $listing->node($this->ui->factory()->link()->standard(
                    $title,
                    "index.html"
                ), "1", "0");
            }
        }

        $cpar[0] = 1;

        foreach ($this->imp_pages->getList() as $p) {
            if ($this->pm->exists($p->getId(), $this->lang)) {
                $cnt++;
                $title = $this->pm->getTitle($p->getId(), $this->lang);
                if (!$this->export) {
                    $listing->node($this->ui->factory()->link()->standard(
                        $title,
                        $this->pm->getPermaLink($p->getId(), $this->lang)
                    ), (string) $cnt, (string) ($cpar[$p->getIndent() - 1] ?? 0));
                } else {
                    $listing->node($this->ui->factory()->link()->standard(
                        $title,
                        "wpg_" . $p->getId() . ".html"
                    ), (string) $cnt, (string) ($cpar[$p->getIndent() - 1] ?? 0));
                }
                $cpar[$p->getIndent()] = $cnt;
            }
        }

        return $listing->render();
    }

Here is the call graph for this function:

isRepositoryObject()

ilWikiImportantPagesBlockGUI::isRepositoryObject ( )

protected

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

                                           : bool
    {
        return false;
    }

Field Documentation

$block_type

string ilWikiImportantPagesBlockGUI::$block_type = "wikiimppages"

static

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

$domain

ILIAS Wiki InternalDomainService ilWikiImportantPagesBlockGUI::$domain

protected

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

$export

bool ilWikiImportantPagesBlockGUI::$export = false

protected

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

$gui

ILIAS Wiki InternalGUIService ilWikiImportantPagesBlockGUI::$gui

protected

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

$imp_pages

ILIAS Wiki Navigation ImportantPageManager ilWikiImportantPagesBlockGUI::$imp_pages

protected

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

$lang

string ilWikiImportantPagesBlockGUI::$lang

protected

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

Referenced by getLegacyContent().

$pm

ILIAS Wiki Page PageManager ilWikiImportantPagesBlockGUI::$pm

protected

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

$service

ILIAS Wiki InternalService ilWikiImportantPagesBlockGUI::$service

protected

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

$wiki_manager

ILIAS Wiki Wiki DomainService ilWikiImportantPagesBlockGUI::$wiki_manager

protected

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

$wiki_request

ILIAS Wiki WikiGUIRequest ilWikiImportantPagesBlockGUI::$wiki_request

protected

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

---

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

• components/ILIAS/Wiki/classes/class.ilWikiImportantPagesBlockGUI.php