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 ()

	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 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 ()

	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 UI Renderer	$renderer

Factory	$factory

object	$gui_object

ILIAS Container Block StandardGUIRequest	$request

ILIAS Container 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

Private Attributes
int	$offset = 0

int	$limit

bool	$enableedit

string	$subtitle

int	$refid

string	$rowtemplatename

string	$rowtemplatedir

array	$modals = []

array	$sort_options = []

array	$presentations = []

string	$activePresentation = ''

string	$activeSortOption = ''

string	$sort_target = ''

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 39 of file class.ilBlockGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBlockGUI::__construct ( )

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

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

    {
        global $DIC;
        $this->factory = $DIC->ui()->factory();
        $this->renderer = $DIC->ui()->renderer();
 
        $this->http = $DIC->http();
        $block_service = new ILIAS\Container\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();
 
        $this->main_tpl->addJavaScript("./assets/js/ilblockcallback.js");
 
        $this->setLimit(25);
 
        $this->requested_ref_id = $this->request->getRefId();
    }

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), factory(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), PRES_SEC_LEG, renderer(), 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 = `""`,
		?RoundTrip	$modal = `null`
	)

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

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

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

Here is the caller graph for this function:

◆ addPresentation()

ilBlockGUI::addPresentation	(	string	$label,
		string	$target,
		bool	$active
	)

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

                                                                                : void
    {
        $this->presentations[$label] = $target;
        if ($active) {
            $this->activePresentation = $label;
        }
    }

Referenced by ilDashboardBlockGUI\addCommandActions().

Here is the caller graph for this function:

◆ addRepoCommands()

ilBlockGUI::addRepoCommands ( )

protected

Add repo commands.

Definition at line 638 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();
            }*/
 
            $parent_type = ilObject::_lookupType($this->requested_ref_id, true);
            $parent_gui = "ilObj" . $obj_def->getClassName($parent_type) . "GUI";
 
            if ($access->checkAccess("delete", "", $this->getRefId())) {
                $this->ctrl->setParameterByClass($parent_gui, 'ref_id', $this->requested_ref_id);
                $this->ctrl->setParameterByClass($parent_gui, 'item_ref_id', $this->getRefId());
 
                $this->addBlockCommand(
                    $this->ctrl->getLinkTargetByClass($parent_gui, 'delete'),
                    $lng->txt("delete")
                );
 
                $this->addBlockCommand(
                    $this->ctrl->getLinkTargetByClass($parent_gui, 'link'),
                    $lng->txt("link")
                );
 
                // see ilObjectListGUI::insertCutCommand();
                $this->addBlockCommand(
                    $this->ctrl->getLinkTargetByClass($parent_gui, 'cut'),
                    $lng->txt("move")
                );
 
                $this->ctrl->clearParameterByClass($parent_gui, 'ref_id');
                $this->ctrl->clearParameterByClass($parent_gui, 'item_ref_id');
            }
 
            // #14595 - see ilObjectListGUI::insertCopyCommand()
            if ($access->checkAccess("copy", "", $this->getRefId())) {
                $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(), ILIAS\Repository\ctrl(), ilObjectDefinition\getClassName(), ilCtrl\getLinkTargetByClass(), and ilCtrl\setParameterByClass().

Here is the call graph for this function:

◆ addSortOption()

ilBlockGUI::addSortOption	(	string	$option,
		string	$label,
		bool	$active
	)

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

                                                                              : void
    {
        if ($active) {
            $this->activeSortOption = $option;
        }
        $this->sort_options[$option] = $label;
    }

Referenced by ilDashboardBlockGUI\addCommandActions().

Here is the caller graph for this function:

◆ checkOffset()

ilBlockGUI::checkOffset ( int $offset )

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

                                            : bool
    {
        return $offset <= $this->max_count && $offset >= 0;
    }

References $offset.

Referenced by setOffset().

Here is the caller graph for this function:

◆ getActionsForPanel()

ilBlockGUI::getActionsForPanel ( )

protected

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

                                           : ?Dropdown
    {
        // actions
        $actions = [];
        $modals = [];
 
        foreach ($this->getBlockCommands() as $command) {
            $href = ($command['onclick'] !== '')
                ? ''
                : $command['href'];
            $button = $this->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"] . "');});";
                });
            }
 
            if (isset($command['modal']) && $command['modal'] instanceof Modal) {
                $button = $button->withOnClick($command['modal']->getShowSignal());
                $this->modals[] = $command['modal'];
            }
            $actions[] = $button;
        }
 
        if (count($actions) > 0) {
            $actions = $this->factory->dropdown()->standard($actions)
                               ->withAriaLabel(sprintf(
                                   $this->lng->txt('actions_for'),
                                   $this->specialCharsAsEntities($this->getTitle())
                               ));
            return $actions;
        }
        return null;
    }

References $id, factory(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getAdminCommands()

ilBlockGUI::getAdminCommands ( )

Definition at line 282 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 488 of file class.ilBlockGUI.php.

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

References ILIAS\UI\examples\Symbol\Glyph\Header\header().

Here is the call graph for this function:

◆ getBlockCommands()

ilBlockGUI::getBlockCommands ( )

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

                                      : array
    {
        return $this->block_commands;
    }

◆ getBlockId()

ilBlockGUI::getBlockId ( )

Definition at line 173 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()

◆ getConfigParameter()

ilBlockGUI::getConfigParameter ( )

final

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

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

◆ getData()

ilBlockGUI::getData ( )

Reimplemented in ilCalendarBlockGUI, ilConsultationHoursCalendarBlockGUI, ilTutorialSupportBlockGUI, and ilDashboardBlockGUI.

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

                             : array
    {
        return $this->data;
    }

References $data.

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

Here is the caller graph for this function:

◆ getEnableEdit()

ilBlockGUI::getEnableEdit ( )

Definition at line 239 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 292 of file class.ilBlockGUI.php.

                                      : bool
    {
        return $this->enablenuminfo;
    }

References $enablenuminfo.

◆ getGuiObject()

ilBlockGUI::getGuiObject ( )

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

                                  : object
    {
        return $this->gui_object;
    }

References $gui_object.

◆ getHTML()

ilBlockGUI::getHTML ( )

Reimplemented in ilCalendarBlockGUI, ilCalendarSelectionBlockGUI, ilConsultationHoursCalendarBlockGUI, ilClassificationBlockGUI, ilDashboardBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, ilPDNewsBlockGUI, ilPollBlockGUI, ilPDStudyProgrammeSimpleListGUI, and ilPDTasksBlockGUI.

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

                             : string
    {
        $this->initCommands();
 
        $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 = $this->factory->panel()->secondary()->legacy(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->factory->legacy()->content($this->getLegacyContent())
                );
                break;
 
            case self::PRES_MAIN_LEG:
                $panel = $this->factory->panel()->standard(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->factory->legacy()->content($this->getLegacyContent())
                );
                break;
 
            case self::PRES_SEC_LIST:
                $this->handleNavigation();
                $panel = $this->factory->panel()->secondary()->listing(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->getListItemGroups()
                );
                break;
 
            case self::PRES_MAIN_TILE:
            case self::PRES_MAIN_LIST:
                $this->handleNavigation();
                $panel = $this->factory->panel()->listing()->standard(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->getListItemGroups()
                );
                break;
        }
 
        // check for empty list panel
        if (in_array($this->getPresentation(), [self::PRES_SEC_LIST, self::PRES_MAIN_LIST], true) &&
            ($panel->getItemGroups() === [] || (count($panel->getItemGroups()) === 1 && $panel->getItemGroups()[0]->getItems() === []))) {
            if ($this->getPresentation() === self::PRES_SEC_LIST) {
                $panel = $this->factory->panel()->secondary()->legacy(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->factory->legacy()->content($this->getNoItemFoundContent())
                );
            } else {
                $panel = $this->factory->panel()->standard(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->factory->legacy()->content($this->getNoItemFoundContent())
                );
            }
        }
 
        $actions = $this->getActionsForPanel();
        if ($actions !== null) {
            $panel = $panel->withActions($actions);
        }
        $viewControls = $this->getViewControlsForPanel();
        if ($viewControls !== [] &&
            (
                $panel instanceof StandardPanel ||
                $panel instanceof SecondaryListingPanel ||
                $panel instanceof SecondaryLegacyPanel ||
                $panel instanceof StandardListingPanel
            )
        ) {
            $panel = $panel->withViewControls($viewControls);
        }
 
        if ($ctrl->isAsynch()) {
            $html = $this->renderer->renderAsync([$panel, ...$this->modals]);
        } else {
            $html = $this->renderer->render([$panel, ...$this->modals]);
        }
 
 
        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 ilRBACAccessHandler\checkAccess(), factory(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), ilCtrl\isAsynch(), renderer(), and send().

Referenced by ilPDNewsBlockGUI\getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLegacyContent()

ilBlockGUI::getLegacyContent ( )

protected

Get legacy content.

Returns: string

Reimplemented in ilCalendarBlockGUI, ilCalendarSelectionBlockGUI, ilClassificationBlockGUI, ilDashboardBlockGUI, ilDashboardContentBlockGUI, ilObjectMetaDataBlockGUI, ilPollBlockGUI, ilRepositoryObjectSearchBlockGUI, ilLPProgressBlockGUI, ilWikiFunctionsBlockGUI, and ilWikiImportantPagesBlockGUI.

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

                                         : string
    {
        return "";
    }

◆ getLimit()

ilBlockGUI::getLimit ( )

Definition at line 229 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, ilTutorialSupportBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, and ilPDTasksBlockGUI.

Definition at line 511 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 ilDashboardBlockGUI.

Definition at line 563 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, and $DIC.

◆ getMoveParameter()

ilBlockGUI::getMoveParameter ( )

final

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

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

◆ getNavParameter()

ilBlockGUI::getNavParameter ( )

final

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

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

◆ getNoItemFoundContent()

ilBlockGUI::getNoItemFoundContent ( )

Reimplemented in ilCalendarBlockGUI, ilDashboardBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, and ilPDTasksBlockGUI.

Definition at line 810 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 214 of file class.ilBlockGUI.php.

                               : int
    {
        return $this->offset;
    }

References $offset.

◆ getPaginationViewControl()

ilBlockGUI::getPaginationViewControl ( )

Fill previous/next row.

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

                                              : ?\ILIAS\UI\Component\ViewControl\Pagination
    {
        global $DIC;
        $factory = $DIC->ui()->factory();
 
        $ilCtrl = $this->ctrl;
 
        if ($this->max_count <= $this->getLimit()) {
            return null;
        }
 
 
        //              $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(), "");
 
        return $factory->viewControl()->pagination()
            ->withTargetURL($href, $this->getNavParameter() . "page")
            ->withTotalEntries($this->max_count)
            ->withPageSize($this->getLimit())
            ->withMaxPaginationButtons(1)
            ->withCurrentPage($this->getOffset() / $this->getLimit());
    }

References $DIC, and ILIAS\UI\Component\ViewControl\Factory\pagination().

Here is the call graph for this function:

◆ getPresentation()

ilBlockGUI::getPresentation ( )

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

                                     : int
    {
        return $this->presentation;
    }

References $presentation.

Referenced by ilCalendarBlockGUI\getViewControlsForPanel().

Here is the caller graph for this function:

◆ getProperty()

ilBlockGUI::getProperty ( string $a_property )

Definition at line 306 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 272 of file class.ilBlockGUI.php.

                              : int
    {
        return $this->refid;
    }

References $refid.

Referenced by ilPollBlockGUI\fillRow(), ilPollBlockGUI\getHTML(), ilPollBlockGUI\getVoteURL(), and ilPollBlockGUI\initContentRenderer().

Here is the caller graph for this function:

◆ getRepositoryMode()

ilBlockGUI::getRepositoryMode ( )

Definition at line 249 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 347 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 342 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, ilObjectMetaDataBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, ilPDNewsBlockGUI, ilRepositoryObjectSearchBlockGUI, and ilPDTasksBlockGUI.

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

                                          : string
    {
        return IL_SCREEN_SIDE;
    }

References IL_SCREEN_SIDE.

◆ getSubtitle()

ilBlockGUI::getSubtitle ( )

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

                                 : string
    {
        return $this->subtitle;
    }

References $subtitle.

◆ getTitle()

ilBlockGUI::getTitle ( )

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

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by ilWikiFunctionsBlockGUI\getLegacyContent().

Here is the caller graph for this function:

◆ getViewControlsForPanel()

ilBlockGUI::getViewControlsForPanel ( )

Returns: ViewControl\Sortation[]|ViewControl\Pagination[]

Reimplemented in ilCalendarBlockGUI, and ilDashboardBlockGUI.

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

                                             : array
    {
        $viewControls = [];
        if (count($this->presentations) > 1) {
            $presentation = $this->factory->viewControl()->mode(
                $this->presentations,
                'label'
            )->withActive($this->activePresentation);
            $viewControls[] = $presentation;
        }
 
        if ($this->sort_options !== []) {
            if (! array_key_exists($this->activeSortOption, $this->sort_options)) {
                $this->activeSortOption = current(array_keys($this->sort_options));
            }
            $sortation = $this->factory->viewControl()->sortation(
                $this->sort_options,
                $this->activeSortOption
            )->withTargetURL(
                $this->sort_target,
                'sorting'
            );
            $viewControls[] = $sortation;
        }
 
        if ($this->getPresentation() === self::PRES_SEC_LIST) {
            $pg_view_control = $this->getPaginationViewControl();
            if ($pg_view_control !== null) {
                $viewControls[] = $pg_view_control;
            }
        }
        return $viewControls;
    }

References factory().

Here is the call graph for this function:

◆ handleNavigation()

ilBlockGUI::handleNavigation ( )

protected

Handle navigation.

Definition at line 520 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 372 of file class.ilBlockGUI.php.

                                     : void
    {
    }

◆ isRepositoryObject()

ilBlockGUI::isRepositoryObject ( )

abstractprotected

Returns whether block has a corresponding repository object.

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

◆ loadData()

ilBlockGUI::loadData ( )

protected

Load data for current page.

Returns: array

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

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

References $data.

Referenced by ilDashboardBlockGUI\getLegacyContent(), and ilDashboardBlockGUI\getListItemGroups().

Here is the caller graph for this function:

◆ 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 ilDashboardBlockGUI, and ilPDMailBlockGUI.

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

                                               : void
    {
    }

◆ send()

ilBlockGUI::send ( string $output )

protected

Send.

Exceptions

ResponseSendingException

Definition at line 801 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 277 of file class.ilBlockGUI.php.

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

◆ setBlockId()

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

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

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

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

Here is the caller graph for this function:

◆ setData()

ilBlockGUI::setData ( array $a_data )

Reimplemented in ilDashboardBlockGUI.

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

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

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

Here is the caller graph for this function:

◆ setEnableEdit()

ilBlockGUI::setEnableEdit ( bool $a_enableedit )

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

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

◆ setEnableNumInfo()

ilBlockGUI::setEnableNumInfo ( bool $a_enablenuminfo )

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

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

Referenced by ilCalendarBlockGUI\__construct(), ilConsultationHoursCalendarBlockGUI\__construct(), ilDashboardContentBlockGUI\__construct(), ilNewsForContextBlockGUI\__construct(), ilWikiFunctionsBlockGUI\__construct(), ilWikiImportantPagesBlockGUI\__construct(), ilObjectMetaDataBlockGUI\__construct(), ilRepositoryObjectSearchBlockGUI\__construct(), 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 183 of file class.ilBlockGUI.php.

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

◆ setLimit()

ilBlockGUI::setLimit ( int $a_limit )

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

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

Referenced by ilCalendarBlockGUI\__construct(), ilConsultationHoursCalendarBlockGUI\__construct(), __construct(), ilTutorialSupportBlockGUI\__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 203 of file class.ilBlockGUI.php.

                                            : void
    {
        // see https://github.com/ILIAS-eLearning/ILIAS/pull/6551/files
        $this->max_count = count($this->getData());
        if ($this->checkOffset($a_offset)) {
            $this->offset = $a_offset;
        } else {
            throw new ilException("ilBlockGUI::setOffset(): Offset out of range.");
        }
    }

References checkOffset(), and getData().

Here is the call graph for this function:

◆ setPresentation()

ilBlockGUI::setPresentation ( int $type )

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

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

Here is the caller graph for this function:

◆ 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 301 of file class.ilBlockGUI.php.

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

◆ setProperty()

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

Definition at line 311 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 267 of file class.ilBlockGUI.php.

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

◆ setRepositoryMode()

ilBlockGUI::setRepositoryMode ( bool $a_repositorymode )

Definition at line 244 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 319 of file class.ilBlockGUI.php.

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

Referenced by ilNewsForContextBlockGUI\__construct(), ilPDNewsBlockGUI\__construct(), and ilPollBlockGUI\__construct().

Here is the caller graph for this function:

◆ setSortTarget()

ilBlockGUI::setSortTarget ( string $target )

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

                                                 : void
    {
        $this->sort_target = $target;
    }

Referenced by ilDashboardBlockGUI\addCommandActions().

Here is the caller graph for this function:

◆ setSubtitle()

ilBlockGUI::setSubtitle ( string $a_subtitle )

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

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

◆ setTitle()

ilBlockGUI::setTitle ( string $a_title )

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

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

Here is the caller graph for this function:

◆ sortObject()

ilBlockGUI::sortObject ( )

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

                                : string
    {
        return $this->getHTML();
    }

◆ specialCharsAsEntities()

ilBlockGUI::specialCharsAsEntities ( string $string )

protected

Definition at line 138 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'
        );
    }

Field Documentation

◆ $access

ilAccessHandler ilBlockGUI::$access

protected

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

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

◆ $activePresentation

string ilBlockGUI::$activePresentation = ''

private

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

◆ $activeSortOption

string ilBlockGUI::$activeSortOption = ''

private

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

◆ $admincommands

bool ilBlockGUI::$admincommands = false

protected

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

Referenced by getAdminCommands().

◆ $allow_moving

bool ilBlockGUI::$allow_moving = true

protected

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

◆ $block_commands

array ilBlockGUI::$block_commands = array()

protected

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

◆ $block_id

string ilBlockGUI::$block_id = "0"

protected

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

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

◆ $block_manager

ILIAS Container Block BlockManager ilBlockGUI::$block_manager

protected

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

◆ $close_command

bool ilBlockGUI::$close_command = false

protected

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

◆ $css_row

string ilBlockGUI::$css_row = ""

protected

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

◆ $ctrl

ilCtrl ilBlockGUI::$ctrl

protected

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

◆ $data

array ilBlockGUI::$data = array()

protected

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

Referenced by ilNewsForContextBlockGUI\__construct(), ilPDNewsBlockGUI\__construct(), ilCalendarSelectionBlockGUI\buildPath(), ilCalendarBlockGUI\getData(), 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 86 of file class.ilBlockGUI.php.

◆ $enableedit

bool ilBlockGUI::$enableedit

private

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

Referenced by getEnableEdit().

◆ $enablenuminfo

bool ilBlockGUI::$enablenuminfo = true

protected

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

Referenced by getEnableNumInfo().

◆ $factory

Factory ilBlockGUI::$factory

protected

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

Referenced by ilCalendarBlockGUI\getListItemForData(), ilCalendarSelectionBlockGUI\getListItemForData(), ilNewsForContextBlockGUI\getListItemForData(), and ilPDTasksBlockGUI\getListItemForData().

◆ $footer_links

array ilBlockGUI::$footer_links = array()

protected

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

◆ $gui_object

object ilBlockGUI::$gui_object

protected

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

Referenced by getGuiObject().

◆ $http

ILIAS HTTP GlobalHttpState ilBlockGUI::$http

private

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

◆ $image

bool ilBlockGUI::$image = false

protected

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

◆ $limit

int ilBlockGUI::$limit

private

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

Referenced by getLimit().

◆ $lng

ilLanguage ilBlockGUI::$lng

protected

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

◆ $main_tpl

ilGlobalTemplateInterface ilBlockGUI::$main_tpl

protected

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

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

◆ $max_count

int ilBlockGUI::$max_count = 0

protected

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

◆ $modals

array ilBlockGUI::$modals = []

private

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

◆ $move

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

protected

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

◆ $nav_value

string ilBlockGUI::$nav_value = ""

protected

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

◆ $obj_def

ilObjectDefinition ilBlockGUI::$obj_def

protected

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

Referenced by ilNewsForContextBlockGUI\getHTML().

◆ $offset

int ilBlockGUI::$offset = 0

private

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

Referenced by checkOffset(), and getOffset().

◆ $presentation

int ilBlockGUI::$presentation

protected

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

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

◆ $presentations

array ilBlockGUI::$presentations = []

private

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

Referenced by ilDashboardBlockGUI\addCommandActions().

◆ $property

array ilBlockGUI::$property = []

protected

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

◆ $refid

int ilBlockGUI::$refid

private

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

Referenced by getRefId().

◆ $renderer

ILIAS UI Renderer ilBlockGUI::$renderer

protected

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

Referenced by ilNewsForContextBlockGUI\showNews().

◆ $repositorymode

bool ilBlockGUI::$repositorymode = false

protected

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

Referenced by getRepositoryMode().

◆ $request

ILIAS Container Block StandardGUIRequest ilBlockGUI::$request

protected

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

Referenced by ilDashboardRecommendedContentGUI\__construct(), and ilWikiFunctionsBlockGUI\__construct().

◆ $requested_ref_id

int ilBlockGUI::$requested_ref_id

protected

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

Referenced by ilClassificationBlockGUI\__construct().

◆ $rowtemplatedir

string ilBlockGUI::$rowtemplatedir

private

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

◆ $rowtemplatename

string ilBlockGUI::$rowtemplatename

private

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

◆ $sort_options

array ilBlockGUI::$sort_options = []

private

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

◆ $sort_target

string ilBlockGUI::$sort_target = ''

private

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

◆ $subtitle

string ilBlockGUI::$subtitle

private

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

Referenced by getSubtitle().

◆ $title

string ilBlockGUI::$title = ""

protected

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

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

◆ $tpl

ilTemplate ilBlockGUI::$tpl

protected

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

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

◆ $ui

ILIAS DI UIServices ilBlockGUI::$ui

protected

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

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

◆ $user

ilObjUser ilBlockGUI::$user

protected

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

◆ PRES_MAIN_LEG

const ilBlockGUI::PRES_MAIN_LEG = 0

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

◆ PRES_MAIN_LIST

const ilBlockGUI::PRES_MAIN_LIST = 3

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

◆ PRES_MAIN_TILE

const ilBlockGUI::PRES_MAIN_TILE = 4

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

◆ PRES_SEC_LEG

const ilBlockGUI::PRES_SEC_LEG = 1

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

Referenced by __construct().

◆ PRES_SEC_LIST

const ilBlockGUI::PRES_SEC_LIST = 2

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

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

components/ILIAS/Container/Block/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()

◆ addPresentation()

◆ addRepoCommands()

◆ addSortOption()

◆ checkOffset()

◆ getActionsForPanel()

◆ getAdminCommands()

◆ getAsynch()

◆ getBlockCommands()

◆ getBlockId()

◆ getBlockType()

◆ getConfigParameter()

◆ getData()

◆ getEnableEdit()

◆ getEnableNumInfo()

◆ getGuiObject()

◆ getHTML()

◆ getLegacyContent()

◆ getLimit()

◆ getListItemForData()

◆ getListItemGroups()

◆ getMoveParameter()

◆ getNavParameter()

◆ getNoItemFoundContent()

◆ getOffset()

◆ getPaginationViewControl()

◆ getPresentation()

◆ getProperty()

◆ getRefId()

◆ getRepositoryMode()

◆ getRowTemplateDir()

◆ getRowTemplateName()

◆ getScreenMode()

◆ getSubtitle()

◆ getTitle()

◆ getViewControlsForPanel()

◆ handleNavigation()

◆ initCommands()

◆ isRepositoryObject()

◆ loadData()

◆ preloadData()

◆ send()

◆ setAdminCommands()

◆ setBlockId()

◆ setData()

◆ setEnableEdit()

◆ setEnableNumInfo()

◆ setGuiObject()

◆ setLimit()

◆ setOffset()

◆ setPresentation()

◆ setProperties()

◆ setProperty()

◆ setRefId()

◆ setRepositoryMode()

◆ setRowTemplate()

◆ setSortTarget()

◆ setSubtitle()

◆ setTitle()

◆ sortObject()

◆ specialCharsAsEntities()

Field Documentation

◆ $access

◆ $activePresentation

◆ $activeSortOption

◆ $admincommands

◆ $allow_moving

◆ $block_commands

◆ $block_id

◆ $block_manager