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

Inheritance diagram for ilBlockGUI:

Collaboration diagram for ilBlockGUI:

Public Member Functions
	getBlockType ()

	__construct ()
	Constructor. More...

	setData ($a_data)
	Set Data. More...

	getData ()
	Get Data. More...

	setPresentation (int $type)
	Set presentation. More...

	getPresentation ()
	Get presentation type. More...

	setBlockId ($a_block_id=0)
	Set Block Id. More...

	getBlockId ()
	Get Block Id. More...

	setGuiObject (&$a_gui_object)
	Set GuiObject. More...

	getGuiObject ()
	Get GuiObject. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setOffset ($a_offset)
	Set Offset. More...

	getOffset ()
	Get Offset. More...

	correctOffset ()

	setLimit ($a_limit)
	Set Limit. More...

	getLimit ()
	Get Limit. More...

	setEnableEdit ($a_enableedit)
	Set EnableEdit. More...

	getEnableEdit ()
	Get EnableEdit. More...

	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode. More...

	getRepositoryMode ()
	Get RepositoryMode. More...

	setSubtitle ($a_subtitle)
	Set Subtitle. More...

	getSubtitle ()
	Get Subtitle. More...

	setRefId ($a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...

	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true). More...

	setAdminCommands (bool $a_admincommands)
	Set Administration Commmands. More...

	getAdminCommands ()
	Get Administration Commmands. More...

	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info. More...

	getEnableNumInfo ()
	Get Enable Item Number Info. More...

	setProperties ($a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...

	getProperty ($a_property)

	setProperty ($a_property, $a_value)

	setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
	Set Row Template Name. More...

	getNavParameter ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()
	Get Row Template Name. More...

	getRowTemplateDir ()
	Get Row Template Directory. More...

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
	Add Block Command. More...

	getBlockCommands ()
	Get Block commands. More...

	getHTML ()
	Get HTML. More...

	fillHeaderCommands ()
	Fill header commands block. More...

	fillHeaderTitleBlock ()
	Fill header title block (title and. More...

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

	fillDataSection ()
	Standard implementation for row based data. More...

	fillRow ($a_set)

	fillFooter ()

	fillPreviousNext ()
	Fill previous/next row. More...

	setPreviousNextLinks ()
	Get previous/next linkbar. More...

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

	getPaginationViewControl ()
	Fill previous/next row. More...

	getHTMLNew ()
	Get HTML. More...

Static Public Member Functions
static	getScreenMode ()
	Get Screen Mode for current command. More...

Data Fields
const	PRES_MAIN_LEG = 0

const	PRES_SEC_LEG = 1

const	PRES_SEC_LIST = 2

const	PRES_MAIN_LIST = 3

Protected Member Functions
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...

	initCommands ()
	Init commands. More...

	fillRowColor ($a_placeholder="CSS_ROW")

	preloadData (array $data)
	Can be overwritten in subclasses. More...

	getLegacyContent ()
	Get legacy content. More...

	getViewControls ()
	Get view controls. More...

	getListItemForData (array $data)
	Get list item for data array. More...

	handleNavigation ()
	Handle navigation. More...

	loadData ()
	Load data for current page. More...

	getListItemGroups ()
	Get items. More...

	addRepoCommands ()
	Add repo commands. More...

	getNoItemFoundContent ()
	No item entry. More...

Protected Attributes
	$ui

	$data = array()

	$enablenuminfo = true

	$footer_links = array()

	$block_id = 0

	$allow_moving = true

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

	$block_commands = array()

	$max_count = false

	$close_command = false

	$image = false

	$property = false

	$nav_value = ""

	$css_row = ""

	$title = ""

	$admincommands = false

	$dropdown

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

	$presentation

	$new_rendering = false

Detailed Description

This class represents a block method of a block.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilBlockGUI::__construct ( )

Constructor.

Parameters

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

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

    {
        global $DIC;
 
        // 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();
 
        include_once("./Services/YUI/classes/class.ilYuiUtil.php");
        ilYuiUtil::initConnection();
        $this->main_tpl->addJavaScript("./Services/Block/js/ilblockcallback.js");
 
        $this->setLimit($this->user->getPref("hits_per_page"));
    }

References $DIC, ilYuiUtil\initConnection(), PRES_SEC_LEG, setLimit(), ui(), and 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 = `""`
	)

Add Block Command.

Parameters

string	$a_href
string	$a_text
string	$a_onclick

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

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

Referenced by ilCalendarSelectionBlockGUI\__construct(), addRepoCommands(), ilWikiImportantPagesBlockGUI\getHTML(), ilExternalFeedBlockGUI\getHTML(), ilPollBlockGUI\getHTML(), getHTML(), ilCalendarBlockGUI\getHTML(), ilNewsForContextBlockGUI\getHTML(), ilPDNewsBlockGUI\getHTML(), ilPDSelectedItemsBlockGUI\getLegacyContent(), ilPDSelectedItemsBlockGUI\getListItemGroups(), ilCalendarBlockGUI\initCommands(), ilPDSelectedItemsBlockGUI\renderManageList(), and ilPDSelectedItemsBlockGUI\setFooterLinks().

Here is the caller graph for this function:

◆ addRepoCommands()

ilBlockGUI::addRepoCommands ( )

protected

Add repo commands.

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

    {
        $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=" . $_GET["ref_id"] . "&cmd=delete" .
                    "&item_ref_id=" . $this->getRefId(),
                    $lng->txt("delete")
                );
 
                // see ilObjectListGUI::insertCutCommand();
                $this->addBlockCommand(
                    "ilias.php?baseClass=ilRepositoryGUI&ref_id=" . $_GET["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($_GET["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 $_GET, $access, $ctrl, $lng, $obj_def, ilObject\_lookupType(), addBlockCommand(), getRefId(), getRepositoryMode(), and isRepositoryObject().

Referenced by getHTMLNew().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correctOffset()

ilBlockGUI::correctOffset ( )

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

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

References setOffset().

Referenced by fillDataSection(), and loadData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillDataSection()

ilBlockGUI::fillDataSection ( )

Standard implementation for row based data.

Overwrite this and call setContent for other data.

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

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

    {
        $this->nav_value = (isset($_POST[$this->getNavParameter()]) && $_POST[$this->getNavParameter()] != "")
            ? $_POST[$this->getNavParameter()]
            : (isset($_GET[$this->getNavParameter()]) ? $_GET[$this->getNavParameter()] : $this->nav_value);
        $this->nav_value = ($this->nav_value == "" && isset($_SESSION[$this->getNavParameter()]))
            ? $_SESSION[$this->getNavParameter()]
            : $this->nav_value;
 
        $_SESSION[$this->getNavParameter()] = $this->nav_value;
 
        $nav = explode(":", $this->nav_value);
        if (isset($nav[2])) {
            $this->setOffset($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 $_GET, $_POST, $_SESSION, $data, $nav_value, correctOffset(), fillRow(), fillRowColor(), getData(), getLimit(), getNavParameter(), getOffset(), getRowTemplateDir(), getRowTemplateName(), preloadData(), and setOffset().

Referenced by ilCalendarBlockGUI\fillDataSection(), and getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillFooter()

ilBlockGUI::fillFooter ( )

Reimplemented in ilCalendarBlockGUI, ilDashboardContentBlockGUI, and ilPDSelectedItemsBlockGUI.

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

768 {

769 }

Referenced by getHTML().

Here is the caller graph for this function:

◆ fillHeaderCommands()

ilBlockGUI::fillHeaderCommands ( )

Fill header commands block.

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

    {
        // adv selection gui
        include_once "Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php";
        $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 ($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 $dropdown, getBlockType(), ilUtil\getImagePath(), ilAdvancedSelectionListGUI\ICON_CONFIG, and ilAdvancedSelectionListGUI\STYLE_LINK_BUTTON.

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillHeaderTitleBlock()

ilBlockGUI::fillHeaderTitleBlock ( )

Fill header title block (title and.

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

    {
        $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, getBlockType(), and getTitle().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillPreviousNext()

ilBlockGUI::fillPreviousNext ( )

Fill previous/next row.

Reimplemented in ilDashboardContentBlockGUI.

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

    {
        $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, $max_count, getEnableNumInfo(), getLimit(), getOffset(), and setPreviousNextLinks().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillRow()

ilBlockGUI::fillRow ( $a_set )

Reimplemented in ilPollBlockGUI, ilPDTasksBlockGUI, ilNewsForContextBlockGUI, ilExternalFeedBlockGUI, and ilPDMailBlockGUI.

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

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

Referenced by fillDataSection().

Here is the caller graph for this function:

◆ fillRowColor()

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

finalprotected

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

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

Referenced by fillDataSection().

Here is the caller graph for this function:

◆ getAdminCommands()

ilBlockGUI::getAdminCommands ( )

Get Administration Commmands.

Returns: boolean Administration Commmands

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

                                       : bool
    {
        return $this->admincommands;
    }

References $admincommands.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getAsynch()

ilBlockGUI::getAsynch ( )

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

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

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

◆ getBlockCommands()

ilBlockGUI::getBlockCommands ( )

Get Block commands.

Returns: array

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

                                       : array
    {
        return $this->block_commands;
    }

References $block_commands.

Referenced by getHTML(), and getHTMLNew().

Here is the caller graph for this function:

◆ getBlockId()

ilBlockGUI::getBlockId ( )

Get Block Id.

Returns: int Block Id

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

    {
        return $this->block_id;
    }

References $block_id.

Referenced by ilCalendarBlockGUI\__construct(), getConfigParameter(), ilExternalFeedBlockGUI\getDynamicReload(), ilNewsForContextBlockGUI\getDynamicReload(), ilExternalFeedBlockGUI\getHTML(), ilExternalFeedBlockGUI\getJSEnabler(), ilNewsForContextBlockGUI\getJSEnabler(), getMoveParameter(), getNavParameter(), and ilCalendarBlockGUI\setSeed().

Here is the caller graph for this function:

◆ getBlockType()

ilBlockGUI::getBlockType ( )

abstract

Returns: string

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

Referenced by fillHeaderCommands(), fillHeaderTitleBlock(), getConfigParameter(), getHTML(), getHTMLNew(), getMoveParameter(), getNavParameter(), getPaginationViewControl(), and setPreviousNextLinks().

Here is the caller graph for this function:

◆ getConfigParameter()

ilBlockGUI::getConfigParameter ( )

final

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

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

References getBlockId(), and getBlockType().

Here is the call graph for this function:

◆ getData()

ilBlockGUI::getData ( )

Get Data.

Returns: array Data

Reimplemented in ilCalendarBlockGUI, and ilConsultationHoursCalendarBlockGUI.

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

    {
        return $this->data;
    }

References $data.

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

Here is the caller graph for this function:

◆ getEnableEdit()

ilBlockGUI::getEnableEdit ( )

Get EnableEdit.

Returns: boolean EnableEdit

Reimplemented in ilCalendarBlockGUI, and ilNewsForContextBlockGUI.

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

    {
        return $this->enableedit;
    }

◆ getEnableNumInfo()

ilBlockGUI::getEnableNumInfo ( )

Get Enable Item Number Info.

Returns: boolean Enable Item Number Info

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

    {
        return $this->enablenuminfo;
    }

References $enablenuminfo.

Referenced by ilDashboardContentBlockGUI\fillFooter(), and fillPreviousNext().

Here is the caller graph for this function:

◆ getGuiObject()

ilBlockGUI::getGuiObject ( )

Get GuiObject.

Returns: object GUI object

Reimplemented in ilExternalFeedBlockGUI.

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

    {
        return $this->gui_object;
    }

◆ getHTML()

ilBlockGUI::getHTML ( )

Get HTML.

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

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

    {
        $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=" . $_GET["ref_id"] . "&cmd=delete" .
                    "&item_ref_id=" . $this->getRefId(),
                    $lng->txt("delete")
                );
 
                // see ilObjectListGUI::insertCutCommand();
                $this->addBlockCommand(
                    "ilias.php?baseClass=ilRepositoryGUI&ref_id=" . $_GET["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($_GET["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();
 
 
        // for screen readers we first output the title and the commands
        // (e.g. close icon afterwards), otherwise we first output the
        // header commands, since we want to have the close icon top right
        // and not floated after the title
        if (is_object($ilUser) && $ilUser->getPref("screen_reader_optimization")) {
            $this->fillHeaderTitleBlock();
            $this->fillHeaderCommands();
        } else {
            $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>';
        }
    }

References $_GET, $access, $ctrl, $ilUser, $lng, $obj_def, $user, ilObject\_lookupType(), addBlockCommand(), fillDataSection(), fillFooter(), fillHeaderCommands(), fillHeaderTitleBlock(), fillPreviousNext(), getAdminCommands(), getBlockCommands(), getBlockType(), getHTMLNew(), getPresentation(), getRefId(), getRepositoryMode(), initCommands(), and isRepositoryObject().

Referenced by ilPDNewsBlockGUI\getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTMLNew()

ilBlockGUI::getHTMLNew ( )

Get HTML.

Reimplemented in ilConsultationHoursCalendarBlockGUI, and ilPDTasksBlockGUI.

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

    {
        global $DIC;
        $factory = $DIC->ui()->factory();
        $renderer = $DIC->ui()->renderer();
        $access = $this->access;
 
        $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->getTitle(),
                    $factory->legacy($this->getLegacyContent())
                );
                break;
 
            case self::PRES_MAIN_LEG:
                $panel = $factory->panel()->standard(
                    $this->getTitle(),
                    $factory->legacy($this->getLegacyContent())
                );
                break;
 
            case self::PRES_SEC_LIST:
                $this->handleNavigation();
                $panel = $factory->panel()->secondary()->listing(
                    $this->getTitle(),
                    $this->getListItemGroups()
                );
                break;
 
            case self::PRES_MAIN_LIST:
                $this->handleNavigation();
                $panel = $factory->panel()->listing()->standard(
                    $this->getTitle(),
                    $this->getListItemGroups()
                );
                break;
 
            case self::PRES_MAIN_TILE:
                $this->handleNavigation();
                $panel = $factory->panel()->listing()->standard(
                    $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->getTitle(),
                    $factory->legacy($this->getNoItemFoundContent())
                );
            } else {
                $panel = $factory->panel()->standard(
                    $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()) {
            echo $html;
            exit;
        } else {
            // return incl. wrapping div with id
            $html = '<div id="' . "block_" . $this->getBlockType() . "_" . $this->block_id . '">' .
                $html . '</div>';
        }
 
        //$this->new_rendering = false;
        //$html.= $this->getHTML();
 
        return $html;
    }

References $access, $ctrl, $DIC, $factory, $panel, addRepoCommands(), exit, getBlockCommands(), getBlockType(), getListItemGroups(), getNoItemFoundContent(), getPresentation(), getTitle(), getViewControls(), handleNavigation(), isRepositoryObject(), PRES_MAIN_LEG, PRES_MAIN_LIST, PRES_SEC_LEG, and PRES_SEC_LIST.

Referenced by 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 ilPollBlockGUI, ilWikiFunctionsBlockGUI, ilWikiImportantPagesBlockGUI, ilCalendarBlockGUI, ilCalendarSelectionBlockGUI, ilClassificationBlockGUI, ilPDSelectedItemsBlockGUI, ilObjectMetaDataBlockGUI, and ilRepositoryObjectSearchBlockGUI.

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

                                          : string
    {
        return "";
    }

◆ getLimit()

ilBlockGUI::getLimit ( )

Get Limit.

Returns: int Limit

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

    {
        return $this->limit;
    }

Referenced by fillDataSection(), fillPreviousNext(), getPaginationViewControl(), handleNavigation(), loadData(), and setPreviousNextLinks().

Here is the caller graph for this function:

◆ getListItemForData()

ilBlockGUI::getListItemForData ( array $data )

protected

Get list item for data array.

Parameters

array $data

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

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

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

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

Referenced by getListItemGroups().

Here is the caller graph for this function:

◆ getListItemGroups()

ilBlockGUI::getListItemGroups ( )

protected

Get items.

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

Reimplemented in ilPDSelectedItemsBlockGUI.

Definition at line 1023 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, $factory, getListItemForData(), and loadData().

Referenced by getHTMLNew().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMoveParameter()

ilBlockGUI::getMoveParameter ( )

final

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

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

References getBlockId(), and getBlockType().

Here is the call graph for this function:

◆ getNavParameter()

ilBlockGUI::getNavParameter ( )

final

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

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

References getBlockId(), and getBlockType().

Referenced by fillDataSection(), getPaginationViewControl(), handleNavigation(), and setPreviousNextLinks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNoItemFoundContent()

ilBlockGUI::getNoItemFoundContent ( )

protected

No item entry.

Returns: string

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

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

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

Referenced by getHTMLNew().

Here is the caller graph for this function:

◆ getOffset()

ilBlockGUI::getOffset ( )

Get Offset.

Returns: int Offset

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

    {
        return $this->offset;
    }

Referenced by fillDataSection(), fillPreviousNext(), getPaginationViewControl(), loadData(), and setPreviousNextLinks().

Here is the caller graph for this function:

◆ getPaginationViewControl()

ilBlockGUI::getPaginationViewControl ( )

Fill previous/next row.

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

    {
        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((int) $this->getOffset() / $this->getLimit());
    }

References $block_id, $ctrl, $DIC, $factory, getBlockType(), getLimit(), getNavParameter(), and getOffset().

Referenced by getViewControls().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPresentation()

ilBlockGUI::getPresentation ( )

Get presentation type.

Returns: int

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

                                      : int
    {
        return $this->presentation;
    }

References $presentation.

Referenced by getHTML(), getHTMLNew(), getViewControls(), and ilCalendarBlockGUI\getViewControls().

Here is the caller graph for this function:

◆ getProperty()

ilBlockGUI::getProperty ( $a_property )

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

    {
        return $this->property[$a_property];
    }

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

Here is the caller graph for this function:

◆ getRefId()

ilBlockGUI::getRefId ( )

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

Returns: int Ref Id

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

    {
        return $this->refid;
    }

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

Here is the caller graph for this function:

◆ getRepositoryMode()

ilBlockGUI::getRepositoryMode ( )

Get RepositoryMode.

Returns: boolean RepositoryMode

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

    {
        return $this->repositorymode;
    }

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

Here is the caller graph for this function:

◆ getRowTemplateDir()

ilBlockGUI::getRowTemplateDir ( )

Get Row Template Directory.

Returns: string Row Template Directory

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

    {
        return $this->rowtemplatedir;
    }

Referenced by fillDataSection(), and ilPollBlockGUI\getLegacyContent().

Here is the caller graph for this function:

◆ getRowTemplateName()

ilBlockGUI::getRowTemplateName ( )

Get Row Template Name.

Returns: string Row Template Name

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

    {
        return $this->rowtemplatename;
    }

Referenced by fillDataSection(), and ilPollBlockGUI\getLegacyContent().

Here is the caller graph for this function:

◆ getScreenMode()

static ilBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Reimplemented in ilExternalFeedBlockGUI, ilPollBlockGUI, ilWikiFunctionsBlockGUI, ilWikiImportantPagesBlockGUI, ilCalendarBlockGUI, ilCalendarSelectionBlockGUI, ilClassificationBlockGUI, ilPDSelectedItemsBlockGUI, ilPDMailBlockGUI, ilNewsForContextBlockGUI, ilPDNewsBlockGUI, ilObjectMetaDataBlockGUI, ilRepositoryObjectSearchBlockGUI, and ilPDTasksBlockGUI.

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

    {
        return IL_SCREEN_SIDE;
    }

References IL_SCREEN_SIDE.

◆ getSubtitle()

ilBlockGUI::getSubtitle ( )

Get Subtitle.

Returns: string Subtitle

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

    {
        return $this->subtitle;
    }

◆ getTitle()

ilBlockGUI::getTitle ( )

Get Title.

Returns: string Title

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

    {
        return (string) $this->title;
    }

References $title.

Referenced by fillHeaderTitleBlock(), getHTMLNew(), ilWikiFunctionsBlockGUI\getLegacyContent(), and ilExternalFeedBlockGUI\showFeedItem().

Here is the caller graph for this function:

◆ getViewControls()

ilBlockGUI::getViewControls ( )

protected

Get view controls.

Returns: array

Reimplemented in ilCalendarBlockGUI.

Definition at line 955 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 [];
    }

References getPaginationViewControl(), and getPresentation().

Referenced by getHTMLNew().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleNavigation()

ilBlockGUI::handleNavigation ( )

protected

Handle navigation.

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

    {
        $reg_page = $_REQUEST[$this->getNavParameter() . "page"];
        if ($reg_page !== "") {
            $this->nav_value = "::" . ($reg_page * $this->getLimit());
        }
 
        if ($this->nav_value == "" && isset($_SESSION[$this->getNavParameter()])) {
            $this->nav_value = $_SESSION[$this->getNavParameter()];
        }
 
        $_SESSION[$this->getNavParameter()] = $this->nav_value;
 
        $nav = explode(":", $this->nav_value);
        if (isset($nav[2])) {
            $this->setOffset($nav[2]);
        } else {
            $this->setOffset(0);
        }
    }

References $_SESSION, $nav_value, getLimit(), getNavParameter(), and setOffset().

Referenced by getHTMLNew().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCommands()

ilBlockGUI::initCommands ( )

protected

Init commands.

Reimplemented in ilCalendarBlockGUI.

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

510 {

511 }

Referenced by getHTML().

Here is the caller graph for this function:

◆ isRepositoryObject()

ilBlockGUI::isRepositoryObject ( )

abstractprotected

Returns whether block has a corresponding repository object.

Returns: bool

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

Referenced by addRepoCommands(), getHTML(), and getHTMLNew().

Here is the caller graph for this function:

◆ loadData()

ilBlockGUI::loadData ( )

protected

Load data for current page.

Returns: array

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

    {
        $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, correctOffset(), getData(), getLimit(), getOffset(), and preloadData().

Referenced by getListItemGroups().

Here is the call graph for this function:

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 ilPDMailBlockGUI.

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

919 {

920 }

Referenced by fillDataSection(), and loadData().

Here is the caller graph for this function:

◆ setAdminCommands()

ilBlockGUI::setAdminCommands ( bool $a_admincommands )

Set Administration Commmands.

Parameters

boolean $a_admincommands Administration Commmands

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

    {
        $this->admincommands = $a_admincommands;
    }

◆ setBlockId()

ilBlockGUI::setBlockId ( $a_block_id = 0 )

Set Block Id.

Parameters

int $a_block_id Block ID

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

    {
        $this->block_id = $a_block_id;
    }

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

Here is the caller graph for this function:

◆ setData()

ilBlockGUI::setData ( $a_data )

Set Data.

Parameters

array $a_data Data

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

    {
        $this->data = $a_data;
    }

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

Here is the caller graph for this function:

◆ setDataSection()

ilBlockGUI::setDataSection ( $a_content )

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

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

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

Here is the caller graph for this function:

◆ setEnableEdit()

ilBlockGUI::setEnableEdit ( $a_enableedit )

Set EnableEdit.

Parameters

boolean $a_enableedit EnableEdit

Reimplemented in ilCalendarBlockGUI, and ilNewsForContextBlockGUI.

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

    {
        $this->enableedit = $a_enableedit;
    }

◆ setEnableNumInfo()

ilBlockGUI::setEnableNumInfo ( $a_enablenuminfo )

Set Enable Item Number Info.

Parameters

boolean $a_enablenuminfo Enable Item Number Info

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

    {
        $this->enablenuminfo = $a_enablenuminfo;
    }

Here is the caller graph for this function:

◆ setGuiObject()

ilBlockGUI::setGuiObject ( & $a_gui_object )

Set GuiObject.

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

Parameters

object $a_gui_object GUI object

Reimplemented in ilExternalFeedBlockGUI.

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

    {
        $this->gui_object = $a_gui_object;
    }

◆ setLimit()

ilBlockGUI::setLimit ( $a_limit )

Set Limit.

Parameters

int $a_limit Limit

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

    {
        $this->limit = $a_limit;
    }

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

Here is the caller graph for this function:

◆ setOffset()

ilBlockGUI::setOffset ( $a_offset )

Set Offset.

Parameters

int $a_offset Offset

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

    {
        $this->offset = $a_offset;
    }

Referenced by correctOffset(), fillDataSection(), and handleNavigation().

Here is the caller graph for this function:

◆ setPresentation()

ilBlockGUI::setPresentation ( int $type )

Set presentation.

Parameters

int $type

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

    {
        $this->presentation = $type;
    }

References $type.

Here is the caller graph for this function:

◆ setPreviousNextLinks()

ilBlockGUI::setPreviousNextLinks ( )

Get previous/next linkbar.

Author: Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Returns: array linkbar or false on error

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

    {
        // @todo: fix this
        return false;
 
 
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        // if more entries then entries per page -> show link bar
        if ($this->max_count > $this->getLimit() && ($this->getLimit() != 0)) {
            // previous link
            if ($this->getOffset() >= 1) {
                $prevoffset = $this->getOffset() - $this->getLimit();
 
                $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", "");
                $text = $lng->txt("previous");
 
                //                              $this->addFooterLink($text, $href, $onclick, $block_id, true);
            }
 
            // calculate number of pages
            $pages = intval($this->max_count / $this->getLimit());
 
            // add a page if a rest remains
            if (($this->max_count % $this->getLimit())) {
                $pages++;
            }
 
            // show next link (if not last page)
            if (!(($this->getOffset() / $this->getLimit()) == ($pages - 1)) && ($pages != 1)) {
                $newoffset = $this->getOffset() + $this->getLimit();
 
                $ilCtrl->setParameterByClass(
                    "ilcolumngui",
                    $this->getNavParameter(),
                    "::" . $newoffset
                );
 
                // ajax link
                $ilCtrl->setParameterByClass(
                    "ilcolumngui",
                    "block_id",
                    "block_" . $this->getBlockType() . "_" . $this->block_id
                );
                //$this->tpl->setCurrentBlock("pnonclick");
                $block_id = "block_" . $this->getBlockType() . "_" . $this->block_id;
                $onclick = $ilCtrl->getLinkTargetByClass(
                    "ilcolumngui",
                    "updateBlock",
                    "",
                    true
                );
                //echo "-".$onclick."-";
                //$this->tpl->parseCurrentBlock();
                $ilCtrl->setParameterByClass(
                    "ilcolumngui",
                    "block_id",
                    ""
                );
 
                // normal link
                $href = $ilCtrl->getLinkTargetByClass("ilcolumngui", "");
                $text = $lng->txt("next");
 
                //                              $this->addFooterLink($text, $href, $onclick, $block_id, true);
            }
            $ilCtrl->setParameterByClass(
                "ilcolumngui",
                $this->getNavParameter(),
                ""
            );
            return true;
        } else {
            return false;
        }
    }

References $block_id, $ctrl, $lng, getBlockType(), getLimit(), getNavParameter(), and getOffset().

Referenced by fillPreviousNext().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setProperties()

ilBlockGUI::setProperties ( $a_properties )

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

Parameters

string $a_properties properties array (key => value)

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

    {
        $this->property = $a_properties;
    }

◆ setProperty()

ilBlockGUI::setProperty	(	$a_property,
		$a_value
	)

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

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

◆ setRefId()

ilBlockGUI::setRefId ( $a_refid )

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

Parameters

int $a_refid Ref Id

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

    {
        $this->refid = $a_refid;
    }

◆ setRepositoryMode()

ilBlockGUI::setRepositoryMode ( $a_repositorymode )

Set RepositoryMode.

Parameters

boolean $a_repositorymode RepositoryMode

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

    {
        $this->repositorymode = $a_repositorymode;
    }

◆ setRowTemplate()

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

Set Row Template Name.

Parameters

string $a_rowtemplatename Row Template Name

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

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

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

Here is the caller graph for this function:

◆ setSubtitle()

ilBlockGUI::setSubtitle ( $a_subtitle )

Set Subtitle.

Parameters

string $a_subtitle Subtitle

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

    {
        $this->subtitle = $a_subtitle;
    }

◆ setTitle()

ilBlockGUI::setTitle ( $a_title )

Set Title.

Parameters

string $a_title Title

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

    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

Field Documentation

◆ $access

ilBlockGUI::$access

protected

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

Referenced by addRepoCommands(), ilExternalFeedBlockGUI\fillRow(), ilClassificationBlockGUI\filterContainer(), ilCalendarSelectionBlockGUI\getCalendars(), ilExternalFeedBlockGUI\getHTML(), ilPollBlockGUI\getHTML(), getHTML(), getHTMLNew(), ilWikiFunctionsBlockGUI\getLegacyContent(), ilWikiImportantPagesBlockGUI\getLegacyContent(), and ilNewsForContextBlockGUI\showNews().

◆ $admincommands

ilBlockGUI::$admincommands = false

protected

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

Referenced by getAdminCommands().

◆ $allow_moving

ilBlockGUI::$allow_moving = true

protected

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

◆ $block_commands

ilBlockGUI::$block_commands = array()

protected

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

Referenced by getBlockCommands().

◆ $block_id

ilBlockGUI::$block_id = 0

protected

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

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

◆ $close_command

ilBlockGUI::$close_command = false

protected

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

◆ $css_row

ilBlockGUI::$css_row = ""

protected

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

◆ $ctrl

ilBlockGUI::$ctrl

protected

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

◆ $data

ilBlockGUI::$data = array()

protected

◆ $dropdown

ilBlockGUI::$dropdown

protected

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

Referenced by fillHeaderCommands().

◆ $enablenuminfo

ilBlockGUI::$enablenuminfo = true

protected

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

Referenced by getEnableNumInfo().

◆ $footer_links

ilBlockGUI::$footer_links = array()

protected

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

◆ $image

ilBlockGUI::$image = false

protected

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

◆ $lng

ilBlockGUI::$lng

protected

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

◆ $main_tpl

ilBlockGUI::$main_tpl

protected

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

Referenced by ilCalendarBlockGUI\__construct(), ilClassificationBlockGUI\fillDataSection(), ilPollBlockGUI\fillRow(), ilClassificationBlockGUI\filterContainer(), ilClassificationBlockGUI\getAjax(), ilClassificationBlockGUI\getHTML(), and ilExternalFeedBlockGUI\importFile().

◆ $max_count

ilBlockGUI::$max_count = false

protected

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

Referenced by fillPreviousNext().

◆ $move

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

protected

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

◆ $nav_value

ilBlockGUI::$nav_value = ""

protected

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

Referenced by fillDataSection(), and handleNavigation().

◆ $new_rendering

ilBlockGUI::$new_rendering = false

protected

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

◆ $obj_def

ilBlockGUI::$obj_def

protected

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

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

◆ $presentation

ilBlockGUI::$presentation

protected

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

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

◆ $property

ilBlockGUI::$property = false

protected

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

◆ $title

ilBlockGUI::$title = ""

protected

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

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

◆ $tpl

ilBlockGUI::$tpl

protected

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

Referenced by ilCalendarBlockGUI\__construct(), ilCalendarBlockGUI\fillDataSection(), ilCalendarSelectionBlockGUI\fillDataSection(), ilClassificationBlockGUI\fillDataSection(), ilPollBlockGUI\fillRow(), ilClassificationBlockGUI\filterContainer(), ilClassificationBlockGUI\getAjax(), ilClassificationBlockGUI\getHTML(), ilWikiFunctionsBlockGUI\getLegacyContent(), ilWikiImportantPagesBlockGUI\getLegacyContent(), ilCalendarBlockGUI\getLegacyContent(), ilRepositoryObjectSearchBlockGUI\getLegacyContent(), ilExternalFeedBlockGUI\importFile(), ilExternalFeedBlockGUI\showFeedItem(), ilNewsForContextBlockGUI\showFeedUrl(), ilPDNewsBlockGUI\showFeedUrl(), and ilNewsForContextBlockGUI\showNews().

◆ $ui

ilBlockGUI::$ui

protected

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

◆ $user

ilBlockGUI::$user

protected

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

◆ PRES_MAIN_LEG

const ilBlockGUI::PRES_MAIN_LEG = 0

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

Referenced by getHTMLNew().

◆ PRES_MAIN_LIST

const ilBlockGUI::PRES_MAIN_LIST = 3

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

Referenced by getHTMLNew().

◆ PRES_SEC_LEG

const ilBlockGUI::PRES_SEC_LEG = 1

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

Referenced by __construct(), and getHTMLNew().

◆ PRES_SEC_LIST

const ilBlockGUI::PRES_SEC_LIST = 2

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

Referenced by getHTMLNew().

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

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

◆ setAdminCommands()

◆ setBlockId()

◆ setData()

◆ setDataSection()

◆ setEnableEdit()

◆ setEnableNumInfo()

◆ setGuiObject()

◆ setLimit()

◆ setOffset()

◆ setPresentation()

◆ setPreviousNextLinks()

◆ setProperties()

◆ setProperty()

◆ setRefId()

◆ setRepositoryMode()

◆ setRowTemplate()

◆ setSubtitle()

◆ setTitle()

Field Documentation

◆ $access

◆ $admincommands

◆ $allow_moving

◆ $block_commands

◆ $block_id

◆ $close_command