This class represents a block method of a block. More...

Inheritance diagram for ilBlockGUI:

Collaboration diagram for ilBlockGUI:

Public Member Functions
	__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 Member Functions
static	getScreenMode ()

Data Fields
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

Protected Member Functions
	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
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

Private Attributes
int	$offset

int	$limit

bool	$enableedit

string	$subtitle

int	$refid

string	$rowtemplatename

string	$rowtemplatedir

ILIAS HTTP GlobalHttpState	$http

Detailed Description

This class represents a block method of a block.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilBlockGUI::__construct ( )

Reimplemented in ilPollBlockGUI, ilPDStudyProgrammeSimpleListGUI, ilWikiFunctionsBlockGUI, ilWikiImportantPagesBlockGUI, ilCalendarBlockGUI, ilConsultationHoursCalendarBlockGUI, ilPDCalendarBlockGUI, ilClassificationBlockGUI, ilDashboardContentBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, ilPDNewsBlockGUI, and ilPDTasksBlockGUI.

Definition at line 76 of file class.ilBlockGUI.php.

    {
        global $DIC;
 
 
        $this->http = $DIC->http();
        $block_service = new ILIAS\Block\Service($DIC);
        $this->block_manager = $block_service->internal()
            ->domain()
            ->block();
        $this->request = $block_service->internal()
            ->gui()
            ->standardRequest();
 
 
        // default presentation
        $this->presentation = self::PRES_SEC_LEG;
 
        $this->user = $DIC->user();
        $this->ctrl = $DIC->ctrl();
        $this->access = $DIC->access();
        $this->lng = $DIC->language();
        $this->main_tpl = $DIC["tpl"];
        $this->obj_def = $DIC["objDefinition"];
        $this->ui = $DIC->ui();
 
        ilYuiUtil::initConnection();
        $this->main_tpl->addJavaScript("./Services/Block/js/ilblockcallback.js");
 
        $this->setLimit((int) $this->user->getPref("hits_per_page"));
 
        $this->requested_ref_id = $this->request->getRefId();
    }

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ilYuiUtil\initConnection(), ILIAS\Repository\lng(), PRES_SEC_LEG, setLimit(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Referenced by ilPDNewsBlockGUI\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ addBlockCommand()

ilBlockGUI::addBlockCommand	(	string	$a_href,
		string	$a_text,
		string	$a_onclick = `""`
	)

Definition at line 327 of file class.ilBlockGUI.php.

                                                                                           : void
    {
        $this->block_commands[] = [
            "href" => $a_href,
            "text" => $a_text,
            "onclick" => $a_onclick
        ];
    }

Referenced by ilCalendarSelectionBlockGUI\__construct(), ilPollBlockGUI\getHTML(), ilCalendarBlockGUI\getHTML(), ilNewsForContextBlockGUI\getHTML(), ilPDNewsBlockGUI\getHTML(), ilWikiImportantPagesBlockGUI\getHTML(), and ilCalendarBlockGUI\initCommands().

Here is the caller graph for this function:

◆ addRepoCommands()

ilBlockGUI::addRepoCommands ( )

protected

Add repo commands.

Definition at line 810 of file class.ilBlockGUI.php.

                                        : void
    {
        $access = $this->access;
        $lng = $this->lng;
        $ctrl = $this->ctrl;
        $obj_def = $this->obj_def;
 
        if ($this->getRepositoryMode() && $this->isRepositoryObject()) {
            // #10993
            // @todo: fix this in new presentation somehow
            /*
            if ($this->getAdminCommands()) {
                $this->tpl->setCurrentBlock("block_check");
                $this->tpl->setVariable("BL_REF_ID", $this->getRefId());
                $this->tpl->parseCurrentBlock();
            }*/
 
            if ($access->checkAccess("delete", "", $this->getRefId())) {
                $this->addBlockCommand(
                    "ilias.php?baseClass=ilRepositoryGUI&ref_id=" . $this->requested_ref_id . "&cmd=delete" .
                    "&item_ref_id=" . $this->getRefId(),
                    $lng->txt("delete")
                );
 
                $this->addBlockCommand(
                    "ilias.php?baseClass=ilRepositoryGUI&ref_id=" . $this->requested_ref_id . "&cmd=link" .
                    "&item_ref_id=" . $this->getRefId(),
                    $lng->txt("link")
                );
 
                // see ilObjectListGUI::insertCutCommand();
                $this->addBlockCommand(
                    "ilias.php?baseClass=ilRepositoryGUI&ref_id=" . $this->requested_ref_id . "&cmd=cut" .
                    "&item_ref_id=" . $this->getRefId(),
                    $lng->txt("move")
                );
            }
 
            // #14595 - see ilObjectListGUI::insertCopyCommand()
            if ($access->checkAccess("copy", "", $this->getRefId())) {
                $parent_type = ilObject::_lookupType($this->requested_ref_id, true);
                $parent_gui = "ilObj" . $obj_def->getClassName($parent_type) . "GUI";
 
                $ctrl->setParameterByClass("ilobjectcopygui", "source_id", $this->getRefId());
                $copy_cmd = $ctrl->getLinkTargetByClass(
                    array("ilrepositorygui", $parent_gui, "ilobjectcopygui"),
                    "initTargetSelection"
                );
 
                // see ilObjectListGUI::insertCopyCommand();
                $this->addBlockCommand(
                    $copy_cmd,
                    $lng->txt("copy")
                );
            }
        }
    }

References $lng, ilObject\_lookupType(), ilRBACAccessHandler\checkAccess(), ilObjectDefinition\getClassName(), ilCtrl\getLinkTargetByClass(), and ilCtrl\setParameterByClass().

Here is the call graph for this function:

◆ correctOffset()

ilBlockGUI::correctOffset ( )

Definition at line 192 of file class.ilBlockGUI.php.

                                   : void
    {
        if (!($this->offset < $this->max_count)) {
            $this->setOffset(0);
        }
    }

References setOffset().

Here is the call graph for this function:

◆ fillDataSection()

ilBlockGUI::fillDataSection ( )

Standard implementation for row based data.

Overwrite this and call setContent for other data.

Reimplemented in ilPollBlockGUI, ilPDStudyProgrammeSimpleListGUI, ilWikiFunctionsBlockGUI, ilWikiImportantPagesBlockGUI, ilCalendarBlockGUI, ilDashboardContentBlockGUI, ilPDSelectedItemsBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, ilPDNewsBlockGUI, ilObjectMetaDataBlockGUI, ilRepositoryObjectSearchBlockGUI, and ilPDTasksBlockGUI.

Definition at line 534 of file class.ilBlockGUI.php.

                                     : void
    {
        $req_nav_par = $this->request->getNavPar($this->getNavParameter());
        if ($req_nav_par != "") {
            $this->nav_value = $req_nav_par;
        }
        $this->nav_value = ($this->nav_value != "")
            ? $this->nav_value
            : $this->block_manager->getNavPar($this->getNavParameter());
 
        $this->block_manager->setNavPar(
            $this->getNavParameter(),
            $this->nav_value
        );
 
        $nav = explode(":", $this->nav_value);
        if (isset($nav[2])) {
            $this->setOffset((int) $nav[2]);
        } else {
            $this->setOffset(0);
        }
 
        // data
        $this->tpl->addBlockFile(
            "BLOCK_ROW",
            "block_row",
            $this->getRowTemplateName(),
            $this->getRowTemplateDir()
        );
 
        $data = $this->getData();
        $this->max_count = count($data);
        $this->correctOffset();
        $data = array_slice($data, $this->getOffset(), $this->getLimit());
 
        $this->preloadData($data);
 
        foreach ($data as $record) {
            $this->tpl->setCurrentBlock("block_row");
            $this->fillRowColor();
            $this->fillRow($record);
            $this->tpl->setCurrentBlock("block_row");
            $this->tpl->parseCurrentBlock();
        }
    }

References $data.

Referenced by ilCalendarBlockGUI\fillDataSection().

Here is the caller graph for this function:

◆ fillFooter()

ilBlockGUI::fillFooter ( )

Reimplemented in ilDashboardContentBlockGUI.

Definition at line 587 of file class.ilBlockGUI.php.

                                : void
    {
    }

◆ fillHeaderCommands()

ilBlockGUI::fillHeaderCommands ( )

Definition at line 459 of file class.ilBlockGUI.php.

                                        : void
    {
        // adv selection gui
        $dropdown = new ilAdvancedSelectionListGUI();
        $dropdown->setUseImages(true);
        $dropdown->setStyle(ilAdvancedSelectionListGUI::STYLE_LINK_BUTTON);
        $dropdown->setHeaderIcon(ilAdvancedSelectionListGUI::ICON_CONFIG);
        $dropdown->setId("block_dd_" . $this->getBlockType() . "_" . $this->block_id);
        foreach ($this->dropdown as $item) {
            if ($item["href"] || $item["onclick"]) {
                if (isset($item["checked"]) && $item["checked"]) {
                    $item["image"] = ilUtil::getImagePath("icon_checked.svg");
                }
                $dropdown->addItem(
                    $item["text"],
                    "",
                    $item["href"],
                    $item["image"] ?? "",
                    $item["text"],
                    "",
                    "",
                    false,
                    $item["onclick"]
                );
            }
        }
        $dropdown = $dropdown->getHTML();
        $this->tpl->setCurrentBlock("header_dropdown");
        $this->tpl->setVariable("ADV_DROPDOWN", $dropdown);
        $this->tpl->parseCurrentBlock();
 
        $this->tpl->setCurrentBlock("hitem");
        $this->tpl->parseCurrentBlock();
    }

References ilUtil\getImagePath(), ilAdvancedSelectionListGUI\ICON_CONFIG, and ilAdvancedSelectionListGUI\STYLE_LINK_BUTTON.

Here is the call graph for this function:

◆ fillHeaderTitleBlock()

ilBlockGUI::fillHeaderTitleBlock ( )

Definition at line 494 of file class.ilBlockGUI.php.

                                          : void
    {
        $lng = $this->lng;
 
 
        // header title
        $this->tpl->setCurrentBlock("header_title");
        $this->tpl->setVariable(
            "BTID",
            "block_" . $this->getBlockType() . "_" . $this->block_id
        );
        $this->tpl->setVariable(
            "BLOCK_TITLE",
            $this->getTitle()
        );
        $this->tpl->setVariable(
            "TXT_BLOCK",
            $lng->txt("block")
        );
        $this->tpl->parseCurrentBlock();
 
        $this->tpl->setCurrentBlock("hitem");
        $this->tpl->parseCurrentBlock();
    }

References $lng.

◆ fillPreviousNext()

ilBlockGUI::fillPreviousNext ( )

Reimplemented in ilDashboardContentBlockGUI.

Definition at line 599 of file class.ilBlockGUI.php.

                                      : void
    {
        $lng = $this->lng;
 
        // table pn numinfo
        $numinfo = "";
        if ($this->getEnableNumInfo() && $this->max_count > 0) {
            $start = $this->getOffset() + 1;                // compute num info
            $end = $this->getOffset() + $this->getLimit();
 
            if ($end > $this->max_count or $this->getLimit() == 0) {
                $end = $this->max_count;
            }
 
            $numinfo = "(" . $start . "-" . $end . " " . strtolower($lng->txt("of")) . " " . $this->max_count . ")";
        }
 
        $this->setPreviousNextLinks();
        $this->tpl->setVariable("NUMINFO", $numinfo);
    }

References $lng.

◆ fillRow()

ilBlockGUI::fillRow ( array $a_set )

Reimplemented in ilPollBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, and ilPDTasksBlockGUI.

Definition at line 580 of file class.ilBlockGUI.php.

                                         : void
    {
        foreach ($a_set as $key => $value) {
            $this->tpl->setVariable("VAL_" . strtoupper($key), $value);
        }
    }

References ILIAS\LTI\ToolProvider\$key.

◆ fillRowColor()

ilBlockGUI::fillRowColor ( string $a_placeholder = "CSS_ROW" )

finalprotected

Definition at line 591 of file class.ilBlockGUI.php.

                                                                            : void
    {
        $this->css_row = ($this->css_row != "ilBlockRow1")
            ? "ilBlockRow1"
            : "ilBlockRow2";
        $this->tpl->setVariable($a_placeholder, $this->css_row);
    }

◆ getAdminCommands()

ilBlockGUI::getAdminCommands ( )

Definition at line 257 of file class.ilBlockGUI.php.

                                      : bool
    {
        return $this->admincommands;
    }

References $admincommands.

◆ getAsynch()

ilBlockGUI::getAsynch ( )

Use this for final get before sending asynchronous output (ajax) per echo to output.

Definition at line 636 of file class.ilBlockGUI.php.

                               : string
    {
        header("Content-type: text/html; charset=UTF-8");
        return $this->tpl->get();
    }

◆ getBlockCommands()

ilBlockGUI::getBlockCommands ( )

Definition at line 336 of file class.ilBlockGUI.php.

                                      : array
    {
        return $this->block_commands;
    }

◆ getBlockId()

ilBlockGUI::getBlockId ( )

Definition at line 152 of file class.ilBlockGUI.php.

                                : string
    {
        return $this->block_id;
    }

References $block_id.

Referenced by ilCalendarBlockGUI\__construct(), ilNewsForContextBlockGUI\getDynamicReload(), ilNewsForContextBlockGUI\getJSEnabler(), and ilCalendarBlockGUI\setSeed().

Here is the caller graph for this function:

◆ getBlockType()

ilBlockGUI::getBlockType ( )

abstract

Reimplemented in ilPollBlockGUI, ilPDStudyProgrammeSimpleListGUI, ilWikiFunctionsBlockGUI, ilWikiImportantPagesBlockGUI, ilCalendarBlockGUI, ilCalendarSelectionBlockGUI, ilConsultationHoursCalendarBlockGUI, ilPDCalendarBlockGUI, ilClassificationBlockGUI, ilDashboardContentBlockGUI, ilPDSelectedItemsBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, ilPDNewsBlockGUI, ilObjectMetaDataBlockGUI, ilRepositoryObjectSearchBlockGUI, and ilPDTasksBlockGUI.

◆ getConfigParameter()

ilBlockGUI::getConfigParameter ( )

final

Definition at line 307 of file class.ilBlockGUI.php.

                                              : string
    {
        return $this->getBlockType() . "_" . $this->getBlockId() . "_blconf";
    }

◆ getData()

ilBlockGUI::getData ( )

Reimplemented in ilCalendarBlockGUI, and ilConsultationHoursCalendarBlockGUI.

Definition at line 132 of file class.ilBlockGUI.php.

                             : array
    {
        return $this->data;
    }

References $data.

Referenced by ilNewsForContextBlockGUI\fillDataSection(), ilPDNewsBlockGUI\fillDataSection(), ilNewsForContextBlockGUI\getHTML(), ilPollBlockGUI\getLegacyContent(), ilNewsForContextBlockGUI\getOverview(), and ilNewsForContextBlockGUI\showNews().

Here is the caller graph for this function:

◆ getEnableEdit()

ilBlockGUI::getEnableEdit ( )

Definition at line 214 of file class.ilBlockGUI.php.

                                   : bool
    {
        return $this->enableedit;
    }

References $enableedit.

Referenced by ilNewsForContextBlockGUI\executeCommand(), and ilNewsForContextBlockGUI\getHTML().

Here is the caller graph for this function:

◆ getEnableNumInfo()

ilBlockGUI::getEnableNumInfo ( )

Definition at line 267 of file class.ilBlockGUI.php.

                                      : bool
    {
        return $this->enablenuminfo;
    }

References $enablenuminfo.

Referenced by ilDashboardContentBlockGUI\fillFooter().

Here is the caller graph for this function:

◆ getGuiObject()

ilBlockGUI::getGuiObject ( )

Definition at line 167 of file class.ilBlockGUI.php.

                                  : object
    {
        return $this->gui_object;
    }

References $gui_object.

◆ getHTML()

ilBlockGUI::getHTML ( )

Reimplemented in ilPollBlockGUI, ilPDStudyProgrammeSimpleListGUI, ilCalendarBlockGUI, ilCalendarSelectionBlockGUI, ilClassificationBlockGUI, ilDashboardContentBlockGUI, ilPDSelectedItemsBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, ilPDNewsBlockGUI, and ilRepositoryObjectSearchBlockGUI.

Definition at line 350 of file class.ilBlockGUI.php.

                             : string
    {
        $this->initCommands();
 
        if ($this->new_rendering) {
            return $this->getHTMLNew();
        }
 
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilAccess = $this->access;
        $ilUser = $this->user;
        $objDefinition = $this->obj_def;
 
        if ($this->isRepositoryObject()) {
            if (!$ilAccess->checkAccess("read", "", $this->getRefId())) {
                return "";
            }
        }
 
        $this->tpl = new ilTemplate("tpl.block.html", true, true, "Services/Block");
 
        //              $this->handleConfigStatus();
 
        $this->fillDataSection();
        if ($this->getRepositoryMode() && $this->isRepositoryObject()) {
            // #10993
            // @todo: fix this in new presentation somehow
            if ($this->getAdminCommands()) {
                $this->tpl->setCurrentBlock("block_check");
                $this->tpl->setVariable("BL_REF_ID", $this->getRefId());
                $this->tpl->parseCurrentBlock();
            }
 
            if ($ilAccess->checkAccess("delete", "", $this->getRefId())) {
                $this->addBlockCommand(
                    "ilias.php?baseClass=ilRepositoryGUI&ref_id=" . $this->requested_ref_id . "&cmd=delete" .
                    "&item_ref_id=" . $this->getRefId(),
                    $lng->txt("delete")
                );
 
                // see ilObjectListGUI::insertCutCommand();
                $this->addBlockCommand(
                    "ilias.php?baseClass=ilRepositoryGUI&ref_id=" . $this->requested_ref_id . "&cmd=cut" .
                    "&item_ref_id=" . $this->getRefId(),
                    $lng->txt("move")
                );
            }
 
            // #14595 - see ilObjectListGUI::insertCopyCommand()
            if ($ilAccess->checkAccess("copy", "", $this->getRefId())) {
                $parent_type = ilObject::_lookupType($this->requested_ref_id, true);
                $parent_gui = "ilObj" . $objDefinition->getClassName($parent_type) . "GUI";
 
                $ilCtrl->setParameterByClass("ilobjectcopygui", "source_id", $this->getRefId());
                $copy_cmd = $ilCtrl->getLinkTargetByClass(
                    array("ilrepositorygui", $parent_gui, "ilobjectcopygui"),
                    "initTargetSelection"
                );
 
                // see ilObjectListGUI::insertCopyCommand();
                $this->addBlockCommand(
                    $copy_cmd,
                    $lng->txt("copy")
                );
            }
        }
 
        $this->dropdown = array();
 
        // commands
        if (count($this->getBlockCommands()) > 0) {
            foreach ($this->getBlockCommands() as $command) {
                if ($command["onclick"]) {
                    $command["onclick"] = "ilBlockJSHandler('" . "block_" . $this->getBlockType() . "_" . $this->block_id .
                        "','" . $command["onclick"] . "')";
                }
                $this->dropdown[] = $command;
            }
        }
 
        // fill previous next
        $this->fillPreviousNext();
 
        // fill footer
        $this->fillFooter();
 
 
        $this->fillHeaderCommands();
        $this->fillHeaderTitleBlock();
 
        if ($this->getPresentation() === self::PRES_MAIN_LEG) {
            $this->tpl->touchBlock("hclassb");
        } else {
            $this->tpl->touchBlock("hclass");
        }
 
        if ($ilCtrl->isAsynch()) {
            // return without div wrapper
            echo $this->tpl->get();
        //echo $this->tpl->getAsynch();
        } else {
            // return incl. wrapping div with id
            return '<div id="' . "block_" . $this->getBlockType() . "_" . $this->block_id . '">' .
                $this->tpl->get() . '</div>';
        }
        return "";
    }

References $ilUser, $lng, and ilObject\_lookupType().

Referenced by ilPDNewsBlockGUI\getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTMLNew()

ilBlockGUI::getHTMLNew ( )

Reimplemented in ilConsultationHoursCalendarBlockGUI, and ilPDTasksBlockGUI.

Definition at line 868 of file class.ilBlockGUI.php.

                                : string
    {
        global $DIC;
        $factory = $DIC->ui()->factory();
        $renderer = $DIC->ui()->renderer();
        $access = $this->access;
        $panel = null;
 
        $ctrl = $this->ctrl;
 
        if ($this->isRepositoryObject()) {
            if (!$access->checkAccess("read", "", $this->getRefId())) {
                return "";
            }
        }
 
        $this->addRepoCommands();
 
        switch ($this->getPresentation()) {
            case self::PRES_SEC_LEG:
                $panel = $factory->panel()->secondary()->legacy(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $factory->legacy($this->getLegacyContent())
                );
                break;
 
            case self::PRES_MAIN_LEG:
                $panel = $factory->panel()->standard(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $factory->legacy($this->getLegacyContent())
                );
                break;
 
            case self::PRES_SEC_LIST:
                $this->handleNavigation();
                $panel = $factory->panel()->secondary()->listing(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->getListItemGroups()
                );
                break;
 
            case self::PRES_MAIN_TILE:
            case self::PRES_MAIN_LIST:
                $this->handleNavigation();
                $panel = $factory->panel()->listing()->standard(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->getListItemGroups()
                );
                break;
 
        }
 
        // actions
        $actions = [];
 
        foreach ($this->getBlockCommands() as $command) {
            $href = ($command["onclick"] != "")
                ? ""
                : $command["href"];
            $button = $factory->button()->shy($command["text"], $href);
            if ($command["onclick"]) {
                $button = $button->withOnLoadCode(function ($id) use ($command) {
                    return
                        "$(\"#$id\").click(function() { ilBlockJSHandler('" . "block_" . $this->getBlockType() . "_" . $this->block_id .
                        "','" . $command["onclick"] . "');});";
                });
            }
            $actions[] = $button;
        }
 
        // check for empty list panel
        if (in_array($this->getPresentation(), [self::PRES_SEC_LIST, self::PRES_MAIN_LIST]) &&
            (count($panel->getItemGroups()) == 0 || (count($panel->getItemGroups()) == 1 && count($panel->getItemGroups()[0]->getItems()) == 0))) {
            if ($this->getPresentation() == self::PRES_SEC_LIST) {
                $panel = $factory->panel()->secondary()->legacy(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $factory->legacy($this->getNoItemFoundContent())
                );
            } else {
                $panel = $factory->panel()->standard(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $factory->legacy($this->getNoItemFoundContent())
                );
            }
        }
 
 
        if (count($actions) > 0) {
            $actions = $factory->dropdown()->standard($actions)
                ->withAriaLabel(sprintf(
                    $this->lng->txt('actions_for'),
                    htmlspecialchars($this->getTitle())
                ));
            $panel = $panel->withActions($actions);
        }
 
        // view controls
        if (count($this->getViewControls()) > 0) {
            $panel = $panel->withViewControls($this->getViewControls());
        }
 
        if ($ctrl->isAsynch()) {
            $html = $renderer->renderAsync($panel);
        } else {
            $html = $renderer->render($panel);
        }
 
 
        if ($ctrl->isAsynch()) {
            $this->send($html);
        } else {
            // return incl. wrapping div with id
            $html = '<div id="' . "block_" . $this->getBlockType() . "_" . $this->block_id . '">' .
                $html . '</div>';
        }
 
        return $html;
    }

References $DIC, $factory, $id, $panel, ilRBACAccessHandler\checkAccess(), ILIAS\UI\Implementation\Component\ViewControl\getViewControls(), ilCtrl\isAsynch(), ILIAS\Repository\lng(), and send().

Here is the call graph for this function:

◆ getLegacyContent()

ilBlockGUI::getLegacyContent ( )

protected

Get legacy content.

Returns: string

Reimplemented in ilPollBlockGUI, ilWikiFunctionsBlockGUI, ilWikiImportantPagesBlockGUI, ilCalendarBlockGUI, ilCalendarSelectionBlockGUI, ilClassificationBlockGUI, ilPDSelectedItemsBlockGUI, ilObjectMetaDataBlockGUI, and ilRepositoryObjectSearchBlockGUI.

Definition at line 655 of file class.ilBlockGUI.php.

                                         : string
    {
        return "";
    }

◆ getLimit()

ilBlockGUI::getLimit ( )

Definition at line 204 of file class.ilBlockGUI.php.

                              : int
    {
        return $this->limit;
    }

References $limit.

◆ getListItemForData()

ilBlockGUI::getListItemForData ( array $data )

protected

Get list item for data array.

Parameters

array $data

Returns: null|\ILIAS\UI\Component\Item\Item

Reimplemented in ilCalendarBlockGUI, ilCalendarSelectionBlockGUI, ilConsultationHoursCalendarBlockGUI, ilPDSelectedItemsBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, and ilPDTasksBlockGUI.

Definition at line 682 of file class.ilBlockGUI.php.

                                                      : ?\ILIAS\UI\Component\Item\Item
    {
        return null;
    }

◆ getListItemGroups()

ilBlockGUI::getListItemGroups ( )

protected

Get items.

Returns: \ILIAS\UI\Component\Item\Group[]

Reimplemented in ilPDSelectedItemsBlockGUI.

Definition at line 735 of file class.ilBlockGUI.php.

                                          : array
    {
        global $DIC;
        $factory = $DIC->ui()->factory();
 
        $data = $this->loadData();
 
        $items = [];
 
        foreach ($data as $record) {
            $item = $this->getListItemForData($record);
            if ($item !== null) {
                $items[] = $item;
            }
        }
 
        $item_group = $factory->item()->group("", $items);
 
        return [$item_group];
    }

References $data, $DIC, and $factory.

◆ getMoveParameter()

ilBlockGUI::getMoveParameter ( )

final

Definition at line 312 of file class.ilBlockGUI.php.

                                            : string
    {
        return $this->getBlockType() . "_" . $this->getBlockId() . "_blmove";
    }

◆ getNavParameter()

ilBlockGUI::getNavParameter ( )

final

Definition at line 302 of file class.ilBlockGUI.php.

                                           : string
    {
        return $this->getBlockType() . "_" . $this->getBlockId() . "_blnav";
    }

◆ getNoItemFoundContent()

ilBlockGUI::getNoItemFoundContent ( )

Reimplemented in ilCalendarBlockGUI, ilPDMembershipBlockGUI, ilPDSelectedItemsBlockGUI, ilNewsForContextBlockGUI, and ilPDTasksBlockGUI.

Definition at line 1000 of file class.ilBlockGUI.php.

                                           : string
    {
        return $this->lng->txt("no_items");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getOffset()

ilBlockGUI::getOffset ( )

Definition at line 187 of file class.ilBlockGUI.php.

                               : int
    {
        return $this->offset;
    }

References $offset.

◆ getPaginationViewControl()

ilBlockGUI::getPaginationViewControl ( )

Fill previous/next row.

Definition at line 759 of file class.ilBlockGUI.php.

                                              : ?\ILIAS\UI\Component\ViewControl\Pagination
    {
        global $DIC;
        $factory = $DIC->ui()->factory();
 
        $ilCtrl = $this->ctrl;
 
 
        //              $ilCtrl->setParameterByClass("ilcolumngui",
        //                      $this->getNavParameter(), "::" . $prevoffset);
 
        // ajax link
        $ilCtrl->setParameterByClass(
            "ilcolumngui",
            "block_id",
            "block_" . $this->getBlockType() . "_" . $this->block_id
        );
        $block_id = "block_" . $this->getBlockType() . "_" . $this->block_id;
        $onclick = $ilCtrl->getLinkTargetByClass(
            "ilcolumngui",
            "updateBlock",
            "",
            true
        );
        $ilCtrl->setParameterByClass(
            "ilcolumngui",
            "block_id",
            ""
        );
 
        // normal link
        $href = $ilCtrl->getLinkTargetByClass("ilcolumngui", "", "", false, false);
 
        //$ilCtrl->setParameterByClass("ilcolumngui",
        //      $this->getNavParameter(), "");
 
        if ($this->max_count <= $this->getLimit()) {
            return null;
        }
 
        return $factory->viewControl()->pagination()
            ->withTargetURL($href, $this->getNavParameter() . "page")
            ->withTotalEntries($this->max_count)
            ->withPageSize($this->getLimit())
            ->withMaxPaginationButtons(5)
            ->withCurrentPage($this->getOffset() / $this->getLimit());
    }

References $DIC, and $factory.

◆ getPresentation()

ilBlockGUI::getPresentation ( )

Definition at line 142 of file class.ilBlockGUI.php.

                                     : int
    {
        return $this->presentation;
    }

References $presentation.

Referenced by ilCalendarBlockGUI\getViewControls().

Here is the caller graph for this function:

◆ getProperty()

ilBlockGUI::getProperty ( string $a_property )

Definition at line 281 of file class.ilBlockGUI.php.

                                                   : ?string
    {
        return $this->property[$a_property] ?? null;
    }

Referenced by ilCalendarBlockGUI\getHTML(), ilNewsForContextBlockGUI\getHTML(), ilNewsForContextBlockGUI\initSettingsForm(), ilNewsForContextBlockGUI\saveSettings(), and ilNewsForContextBlockGUI\showNews().

Here is the caller graph for this function:

◆ getRefId()

ilBlockGUI::getRefId ( )

Definition at line 247 of file class.ilBlockGUI.php.

                              : int
    {
        return $this->refid;
    }

References $refid.

Referenced by ilPollBlockGUI\commentJSCall(), ilPollBlockGUI\fillRow(), and ilPollBlockGUI\getHTML().

Here is the caller graph for this function:

◆ getRepositoryMode()

ilBlockGUI::getRepositoryMode ( )

Definition at line 224 of file class.ilBlockGUI.php.

                                       : bool
    {
        return $this->repositorymode;
    }

References $repositorymode.

Referenced by ilNewsForContextBlockGUI\getHTML(), ilCalendarBlockGUI\getTargetGUIClassPath(), ilConsultationHoursCalendarBlockGUI\getTargetGUIClassPath(), and ilCalendarBlockGUI\initCommands().

Here is the caller graph for this function:

◆ getRowTemplateDir()

ilBlockGUI::getRowTemplateDir ( )

Definition at line 322 of file class.ilBlockGUI.php.

                                       : string
    {
        return $this->rowtemplatedir;
    }

Referenced by ilPollBlockGUI\getLegacyContent().

Here is the caller graph for this function:

◆ getRowTemplateName()

ilBlockGUI::getRowTemplateName ( )

Definition at line 317 of file class.ilBlockGUI.php.

                                        : string
    {
        return $this->rowtemplatename;
    }

Referenced by ilPollBlockGUI\getLegacyContent().

Here is the caller graph for this function:

◆ getScreenMode()

static ilBlockGUI::getScreenMode ( )

static

Reimplemented in ilCalendarBlockGUI, ilCalendarSelectionBlockGUI, ilClassificationBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, ilPDNewsBlockGUI, ilObjectMetaDataBlockGUI, ilRepositoryObjectSearchBlockGUI, and ilPDTasksBlockGUI.

Definition at line 341 of file class.ilBlockGUI.php.

                                          : string
    {
        return IL_SCREEN_SIDE;
    }

References IL_SCREEN_SIDE.

◆ getSubtitle()

ilBlockGUI::getSubtitle ( )

Definition at line 234 of file class.ilBlockGUI.php.

                                 : string
    {
        return $this->subtitle;
    }

References $subtitle.

◆ getTitle()

ilBlockGUI::getTitle ( )

Definition at line 177 of file class.ilBlockGUI.php.

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by ilWikiFunctionsBlockGUI\getLegacyContent().

Here is the caller graph for this function:

◆ getViewControls()

ilBlockGUI::getViewControls ( )

protected

Get view controls.

Returns: array

Reimplemented in ilCalendarBlockGUI.

Definition at line 665 of file class.ilBlockGUI.php.

                                        : array
    {
        if ($this->getPresentation() == self::PRES_SEC_LIST) {
            $pg_view_control = $this->getPaginationViewControl();
            if (!is_null($pg_view_control)) {
                return [$pg_view_control];
            }
        }
        return [];
    }

◆ handleNavigation()

ilBlockGUI::handleNavigation ( )

protected

Handle navigation.

Definition at line 691 of file class.ilBlockGUI.php.

                                         : void
    {
        $reg_page = $this->request->getNavPage($this->getNavParameter());
        if ($reg_page !== "") {
            $this->nav_value = "::" . ($reg_page * $this->getLimit());
        }
 
        if ($this->nav_value == "") {
            $this->nav_value = $this->block_manager->getNavPar($this->getNavParameter());
        }
 
        $this->block_manager->setNavPar(
            $this->getNavParameter(),
            $this->nav_value
        );
 
        $nav = explode(":", $this->nav_value);
        if (isset($nav[2])) {
            $this->setOffset((int) $nav[2]);
        } else {
            $this->setOffset(0);
        }
    }

◆ initCommands()

ilBlockGUI::initCommands ( )

protected

Reimplemented in ilCalendarBlockGUI.

Definition at line 346 of file class.ilBlockGUI.php.

                                     : void
    {
    }

◆ isRepositoryObject()

ilBlockGUI::isRepositoryObject ( )

abstractprotected

Returns whether block has a corresponding repository object.

Reimplemented in ilPollBlockGUI, ilPDStudyProgrammeSimpleListGUI, ilWikiFunctionsBlockGUI, ilWikiImportantPagesBlockGUI, ilCalendarBlockGUI, ilCalendarSelectionBlockGUI, ilConsultationHoursCalendarBlockGUI, ilClassificationBlockGUI, ilDashboardContentBlockGUI, ilPDSelectedItemsBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, ilObjectMetaDataBlockGUI, ilRepositoryObjectSearchBlockGUI, and ilPDTasksBlockGUI.

◆ loadData()

ilBlockGUI::loadData ( )

protected

Load data for current page.

Returns: array

Definition at line 719 of file class.ilBlockGUI.php.

                                 : array
    {
        $data = $this->getData();
        $this->max_count = count($data);
        $this->correctOffset();
        $data = array_slice($data, $this->getOffset(), $this->getLimit());
        $this->preloadData($data);
        return $data;
    }

References $data.

◆ preloadData()

ilBlockGUI::preloadData ( array $data )

protected

Can be overwritten in subclasses.

Only the visible part of the complete data was passed so a preload of the visible data is possible.

Parameters

array $data

Reimplemented in ilPDMailBlockGUI.

Definition at line 628 of file class.ilBlockGUI.php.

                                               : void
    {
    }

◆ send()

ilBlockGUI::send ( string $output )

protected

Send.

Exceptions

ResponseSendingException

Definition at line 991 of file class.ilBlockGUI.php.

                                           : void
    {
        $this->http->saveResponse($this->http->response()->withBody(
            Streams::ofString($output)
        ));
        $this->http->sendResponse();
        $this->http->close();
    }

References ILIAS\FileDelivery\http().

Referenced by ilNewsForContextBlockGUI\enableJS(), ilNewsForContextBlockGUI\hideNotifications(), and ilNewsForContextBlockGUI\showNotifications().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAdminCommands()

ilBlockGUI::setAdminCommands ( bool $a_admincommands )

Definition at line 252 of file class.ilBlockGUI.php.

                                                           : void
    {
        $this->admincommands = $a_admincommands;
    }

◆ setBlockId()

ilBlockGUI::setBlockId ( string $a_block_id = "0" )

Definition at line 147 of file class.ilBlockGUI.php.

                                                        : void
    {
        $this->block_id = $a_block_id;
    }

Referenced by ilCalendarBlockGUI\__construct(), ilConsultationHoursCalendarBlockGUI\__construct(), ilPDCalendarBlockGUI\__construct(), ilNewsForContextBlockGUI\__construct(), ilObjectMetaDataBlockGUI\__construct(), and ilPollBlockGUI\setBlock().

Here is the caller graph for this function:

◆ setData()

ilBlockGUI::setData ( array $a_data )

Definition at line 127 of file class.ilBlockGUI.php.

                                          : void
    {
        $this->data = $a_data;
    }

Referenced by ilNewsForContextBlockGUI\__construct(), ilPDNewsBlockGUI\__construct(), ilPDMailBlockGUI\fillDataSection(), ilPollBlockGUI\getHTML(), ilPDSelectedItemsBlockGUI\getHTML(), ilPDMailBlockGUI\getHTML(), ilNewsForContextBlockGUI\hideNotifications(), ilNewsForContextBlockGUI\showNews(), and ilNewsForContextBlockGUI\showNotifications().

Here is the caller graph for this function:

◆ setDataSection()

ilBlockGUI::setDataSection ( string $a_content )

Call this from overwritten fillDataSection(), if standard row based data is not used.

Definition at line 522 of file class.ilBlockGUI.php.

                                                     : void
    {
        $this->tpl->setCurrentBlock("data_section");
        $this->tpl->setVariable("DATA", $a_content);
        $this->tpl->parseCurrentBlock();
        $this->tpl->setVariable("BLOCK_ROW", "");
    }

Referenced by ilPollBlockGUI\fillDataSection(), ilWikiFunctionsBlockGUI\fillDataSection(), ilWikiImportantPagesBlockGUI\fillDataSection(), ilCalendarBlockGUI\fillDataSection(), ilPDSelectedItemsBlockGUI\fillDataSection(), ilPDMailBlockGUI\fillDataSection(), ilNewsForContextBlockGUI\fillDataSection(), ilPDNewsBlockGUI\fillDataSection(), ilObjectMetaDataBlockGUI\fillDataSection(), ilRepositoryObjectSearchBlockGUI\fillDataSection(), and ilPDTasksBlockGUI\fillDataSection().

Here is the caller graph for this function:

◆ setEnableEdit()

ilBlockGUI::setEnableEdit ( bool $a_enableedit )

Definition at line 209 of file class.ilBlockGUI.php.

                                                     : void
    {
        $this->enableedit = $a_enableedit;
    }

◆ setEnableNumInfo()

ilBlockGUI::setEnableNumInfo ( bool $a_enablenuminfo )

Definition at line 262 of file class.ilBlockGUI.php.

                                                           : void
    {
        $this->enablenuminfo = $a_enablenuminfo;
    }

Referenced by ilWikiFunctionsBlockGUI\__construct(), ilWikiImportantPagesBlockGUI\__construct(), ilCalendarBlockGUI\__construct(), ilConsultationHoursCalendarBlockGUI\__construct(), ilDashboardContentBlockGUI\__construct(), ilNewsForContextBlockGUI\__construct(), ilObjectMetaDataBlockGUI\__construct(), ilRepositoryObjectSearchBlockGUI\__construct(), ilPDMailBlockGUI\fillDataSection(), ilPDNewsBlockGUI\fillDataSection(), ilPDTasksBlockGUI\fillDataSection(), and ilCalendarBlockGUI\getData().

Here is the caller graph for this function:

◆ setGuiObject()

ilBlockGUI::setGuiObject ( object $a_gui_object )

Set GuiObject.

Only used for repository blocks, that are represented as real repository objects (have a ref id and permissions)

Definition at line 162 of file class.ilBlockGUI.php.

                                                      : void
    {
        $this->gui_object = $a_gui_object;
    }

◆ setLimit()

ilBlockGUI::setLimit ( int $a_limit )

Definition at line 199 of file class.ilBlockGUI.php.

                                          : void
    {
        $this->limit = $a_limit;
    }

Referenced by __construct(), ilCalendarBlockGUI\__construct(), ilConsultationHoursCalendarBlockGUI\__construct(), ilDashboardContentBlockGUI\__construct(), ilPDMailBlockGUI\__construct(), ilNewsForContextBlockGUI\__construct(), ilPDNewsBlockGUI\__construct(), ilPDTasksBlockGUI\__construct(), and ilCalendarSelectionBlockGUI\__construct().

Here is the caller graph for this function:

◆ setOffset()

ilBlockGUI::setOffset ( int $a_offset )

Definition at line 182 of file class.ilBlockGUI.php.

                                            : void
    {
        $this->offset = $a_offset;
    }

Referenced by correctOffset().

Here is the caller graph for this function:

◆ setPresentation()

ilBlockGUI::setPresentation ( int $type )

Definition at line 137 of file class.ilBlockGUI.php.

                                              : void
    {
        $this->presentation = $type;
    }

References $type.

Referenced by ilWikiFunctionsBlockGUI\__construct(), ilCalendarBlockGUI\__construct(), ilConsultationHoursCalendarBlockGUI\__construct(), ilDashboardContentBlockGUI\__construct(), ilPDMailBlockGUI\__construct(), ilNewsForContextBlockGUI\__construct(), ilPDNewsBlockGUI\__construct(), ilPDTasksBlockGUI\__construct(), ilCalendarSelectionBlockGUI\__construct(), ilCalendarBlockGUI\setForceMonthView(), ilCalendarBlockGUI\setPdModeEvents(), and ilCalendarBlockGUI\setPdModeMonth().

Here is the caller graph for this function:

◆ setPreviousNextLinks()

ilBlockGUI::setPreviousNextLinks ( )

Definition at line 620 of file class.ilBlockGUI.php.

                                          : void
    {
    }

◆ setProperties()

ilBlockGUI::setProperties ( array $a_properties )

This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties.

Definition at line 276 of file class.ilBlockGUI.php.

                                                      : void
    {
        $this->property = $a_properties;
    }

◆ setProperty()

ilBlockGUI::setProperty	(	string	$a_property,
		string	$a_value
	)

Definition at line 286 of file class.ilBlockGUI.php.

                                                                    : void
    {
        $this->property[$a_property] = $a_value;
    }

◆ setRefId()

ilBlockGUI::setRefId ( int $a_refid )

Set Ref Id (only used if isRepositoryObject() is true).

Definition at line 242 of file class.ilBlockGUI.php.

                                          : void
    {
        $this->refid = $a_refid;
    }

◆ setRepositoryMode()

ilBlockGUI::setRepositoryMode ( bool $a_repositorymode )

Definition at line 219 of file class.ilBlockGUI.php.

                                                             : void
    {
        $this->repositorymode = $a_repositorymode;
    }

◆ setRowTemplate()

ilBlockGUI::setRowTemplate	(	string	$a_rowtemplatename,
		string	$a_rowtemplatedir = `""`
	)

Set Row Template Name.

Definition at line 294 of file class.ilBlockGUI.php.

     : void {
        $this->rowtemplatename = $a_rowtemplatename;
        $this->rowtemplatedir = $a_rowtemplatedir;
    }

Referenced by ilPollBlockGUI\__construct(), ilNewsForContextBlockGUI\__construct(), ilPDNewsBlockGUI\__construct(), ilCalendarBlockGUI\fillDataSection(), ilPDMailBlockGUI\fillDataSection(), and ilPDTasksBlockGUI\fillDataSection().

Here is the caller graph for this function:

◆ setSubtitle()

ilBlockGUI::setSubtitle ( string $a_subtitle )

Definition at line 229 of file class.ilBlockGUI.php.

                                                   : void
    {
        $this->subtitle = $a_subtitle;
    }

◆ setTitle()

ilBlockGUI::setTitle ( string $a_title )

Definition at line 172 of file class.ilBlockGUI.php.

                                             : void
    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

◆ specialCharsAsEntities()

ilBlockGUI::specialCharsAsEntities ( string $string )

protected

Definition at line 117 of file class.ilBlockGUI.php.

                                                             : string
    {
        // Should be replaced by a proper refinery transformation once https://github.com/ILIAS-eLearning/ILIAS/pull/6314 is merged
        return  htmlspecialchars(
            $string,
            ENT_QUOTES | ENT_SUBSTITUTE,
            'utf-8'
        );
    }

Referenced by ilPollBlockGUI\fillRow().

Here is the caller graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilBlockGUI::$access

protected

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

Referenced by ilClassificationBlockGUI\filterContainer(), ilWikiFunctionsBlockGUI\getLegacyContent(), and ilNewsForContextBlockGUI\showNews().

◆ $admincommands

bool ilBlockGUI::$admincommands = false

protected

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

Referenced by getAdminCommands().

◆ $allow_moving

bool ilBlockGUI::$allow_moving = true

protected

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

◆ $block_commands

array ilBlockGUI::$block_commands = array()

protected

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

◆ $block_id

string ilBlockGUI::$block_id = "0"

protected

Definition at line 53 of file class.ilBlockGUI.php.

Referenced by ilNewsForContextBlockGUI\addToSettingsForm(), getBlockId(), and ilNewsForContextBlockGUI\writeSettings().

◆ $block_manager

ILIAS Block BlockManager ilBlockGUI::$block_manager

protected

Definition at line 45 of file class.ilBlockGUI.php.

◆ $close_command

bool ilBlockGUI::$close_command = false

protected

Definition at line 58 of file class.ilBlockGUI.php.

◆ $css_row

string ilBlockGUI::$css_row = ""

protected

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

◆ $ctrl

ilCtrl ilBlockGUI::$ctrl

protected

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

◆ $data

array ilBlockGUI::$data = array()

protected

Definition at line 50 of file class.ilBlockGUI.php.

Referenced by ilNewsForContextBlockGUI\__construct(), ilPDNewsBlockGUI\__construct(), ilCalendarSelectionBlockGUI\buildPath(), getData(), ilCalendarBlockGUI\getData(), ilCalendarBlockGUI\getListItemForData(), ilCalendarSelectionBlockGUI\getListItemForData(), ilConsultationHoursCalendarBlockGUI\getListItemForData(), ilPDMailBlockGUI\getListItemForData(), ilNewsForContextBlockGUI\getListItemForData(), ilPDTasksBlockGUI\getListItemForData(), ilPDNewsBlockGUI\getNewsData(), ilNewsForContextBlockGUI\hideNotifications(), ilPDMailBlockGUI\preloadData(), and ilNewsForContextBlockGUI\showNotifications().

◆ $dropdown

array ilBlockGUI::$dropdown

protected

Definition at line 65 of file class.ilBlockGUI.php.

◆ $enableedit

bool ilBlockGUI::$enableedit

private

Definition at line 38 of file class.ilBlockGUI.php.

Referenced by getEnableEdit().

◆ $enablenuminfo

bool ilBlockGUI::$enablenuminfo = true

protected

Definition at line 51 of file class.ilBlockGUI.php.

Referenced by getEnableNumInfo().

◆ $footer_links

array ilBlockGUI::$footer_links = array()

protected

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

◆ $gui_object

object ilBlockGUI::$gui_object

protected

Definition at line 43 of file class.ilBlockGUI.php.

Referenced by getGuiObject().

◆ $http

ILIAS HTTP GlobalHttpState ilBlockGUI::$http

private

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

◆ $image

bool ilBlockGUI::$image = false

protected

Definition at line 59 of file class.ilBlockGUI.php.

◆ $limit

int ilBlockGUI::$limit

private

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

Referenced by getLimit().

◆ $lng

ilLanguage ilBlockGUI::$lng

protected

Definition at line 71 of file class.ilBlockGUI.php.

◆ $main_tpl

ilGlobalTemplateInterface ilBlockGUI::$main_tpl

protected

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

Referenced by ilClassificationBlockGUI\filterContainer(), ilClassificationBlockGUI\getAjax(), ilClassificationBlockGUI\getHTML(), and ilClassificationBlockGUI\getLegacyContent().

◆ $max_count

int ilBlockGUI::$max_count = 0

protected

Definition at line 57 of file class.ilBlockGUI.php.

◆ $move

array ilBlockGUI::$move = array("left" => false, "right" => false, "up" => false, "down" => false)

protected

Definition at line 55 of file class.ilBlockGUI.php.

◆ $nav_value

string ilBlockGUI::$nav_value = ""

protected

Definition at line 61 of file class.ilBlockGUI.php.

◆ $new_rendering

bool ilBlockGUI::$new_rendering = false

protected

Definition at line 647 of file class.ilBlockGUI.php.

◆ $obj_def

ilObjectDefinition ilBlockGUI::$obj_def

protected

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

Referenced by ilNewsForContextBlockGUI\getHTML().

◆ $offset

int ilBlockGUI::$offset

private

Definition at line 36 of file class.ilBlockGUI.php.

Referenced by getOffset().

◆ $presentation

int ilBlockGUI::$presentation

protected

Definition at line 73 of file class.ilBlockGUI.php.

Referenced by ilCalendarBlockGUI\addSubscriptionButton(), ilCalendarBlockGUI\executeCommand(), and getPresentation().

◆ $property

array ilBlockGUI::$property = []

protected

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

◆ $refid

int ilBlockGUI::$refid

private

Definition at line 40 of file class.ilBlockGUI.php.

Referenced by getRefId().

◆ $repositorymode

bool ilBlockGUI::$repositorymode = false

protected

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

Referenced by getRepositoryMode().

◆ $request

ILIAS Block StandardGUIRequest ilBlockGUI::$request

protected

Definition at line 44 of file class.ilBlockGUI.php.

Referenced by ilWikiFunctionsBlockGUI\__construct().

◆ $requested_ref_id

int ilBlockGUI::$requested_ref_id

protected

Definition at line 74 of file class.ilBlockGUI.php.

Referenced by ilClassificationBlockGUI\__construct().

◆ $rowtemplatedir

string ilBlockGUI::$rowtemplatedir

private

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

◆ $rowtemplatename

string ilBlockGUI::$rowtemplatename

private

Definition at line 41 of file class.ilBlockGUI.php.

◆ $subtitle

string ilBlockGUI::$subtitle

private

Definition at line 39 of file class.ilBlockGUI.php.

Referenced by getSubtitle().

◆ $title

string ilBlockGUI::$title = ""

protected

Definition at line 63 of file class.ilBlockGUI.php.

Referenced by ilCalendarBlockGUI\__construct(), ilWikiImportantPagesBlockGUI\getLegacyContent(), ilPDTasksBlockGUI\getListItemForData(), getTitle(), ilNewsForContextBlockGUI\showFeedUrl(), and ilNewsForContextBlockGUI\showNews().

◆ $tpl

ilTemplate ilBlockGUI::$tpl

protected

Definition at line 66 of file class.ilBlockGUI.php.

Referenced by ilCalendarBlockGUI\fillDataSection(), ilClassificationBlockGUI\filterContainer(), ilClassificationBlockGUI\getAjax(), ilClassificationBlockGUI\getHTML(), ilWikiFunctionsBlockGUI\getLegacyContent(), ilCalendarBlockGUI\getLegacyContent(), ilCalendarSelectionBlockGUI\getLegacyContent(), ilClassificationBlockGUI\getLegacyContent(), ilRepositoryObjectSearchBlockGUI\getLegacyContent(), ilNewsForContextBlockGUI\showFeedUrl(), ilPDNewsBlockGUI\showFeedUrl(), and ilNewsForContextBlockGUI\showNews().

◆ $ui

ILIAS DI UIServices ilBlockGUI::$ui

protected

Definition at line 49 of file class.ilBlockGUI.php.

Referenced by ilCalendarBlockGUI\addMiniMonth(), ilCalendarBlockGUI\getData(), ilCalendarBlockGUI\getModalForApp(), and ilCalendarBlockGUI\getViewControl().

◆ $user

ilObjUser ilBlockGUI::$user

protected

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

◆ PRES_MAIN_LEG

const ilBlockGUI::PRES_MAIN_LEG = 0

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

◆ PRES_MAIN_LIST

const ilBlockGUI::PRES_MAIN_LIST = 3

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

◆ PRES_MAIN_TILE

const ilBlockGUI::PRES_MAIN_TILE = 4

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

◆ PRES_SEC_LEG

const ilBlockGUI::PRES_SEC_LEG = 1

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

Referenced by __construct().

◆ PRES_SEC_LIST

const ilBlockGUI::PRES_SEC_LIST = 2

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

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

Services/Block/classes/class.ilBlockGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addBlockCommand()

◆ addRepoCommands()

◆ correctOffset()

◆ fillDataSection()

◆ fillFooter()

◆ fillHeaderCommands()

◆ fillHeaderTitleBlock()

◆ fillPreviousNext()

◆ fillRow()

◆ fillRowColor()

◆ getAdminCommands()

◆ getAsynch()

◆ getBlockCommands()

◆ getBlockId()

◆ getBlockType()

◆ getConfigParameter()

◆ getData()

◆ getEnableEdit()

◆ getEnableNumInfo()

◆ getGuiObject()

◆ getHTML()

◆ getHTMLNew()

◆ getLegacyContent()

◆ getLimit()

◆ getListItemForData()

◆ getListItemGroups()

◆ getMoveParameter()

◆ getNavParameter()

◆ getNoItemFoundContent()

◆ getOffset()

◆ getPaginationViewControl()

◆ getPresentation()

◆ getProperty()

◆ getRefId()

◆ getRepositoryMode()

◆ getRowTemplateDir()

◆ getRowTemplateName()

◆ getScreenMode()

◆ getSubtitle()

◆ getTitle()

◆ getViewControls()

◆ handleNavigation()

◆ initCommands()

◆ isRepositoryObject()

◆ loadData()

◆ preloadData()

◆ send()

◆ setAdminCommands()

◆ setBlockId()

◆ setData()

◆ setDataSection()

◆ setEnableEdit()

◆ setEnableNumInfo()

◆ setGuiObject()

◆ setLimit()

◆ setOffset()

◆ setPresentation()

◆ setPreviousNextLinks()

◆ setProperties()

◆ setProperty()

◆ setRefId()

◆ setRepositoryMode()

◆ setRowTemplate()

◆ setSubtitle()

◆ setTitle()

◆ specialCharsAsEntities()

Field Documentation

◆ $access

◆ $admincommands

◆ $allow_moving