Column user interface class. More...

Collaboration diagram for ilColumnGUI:

Public Member Functions
	__construct (string $a_col_type="", string $a_side="", bool $use_std_context=false)

	setColType (string $a_coltype)

	getColType ()

	setSide (string $a_side)

	getSide ()

	setEnableEdit (bool $a_enableedit)

	getEnableEdit ()

	setRepositoryMode (bool $a_repositorymode)

	getRepositoryMode ()

	setAdminCommands (bool $a_admincommands)

	getAdminCommands ()

	setBlockProperty (string $a_block_type, string $a_property, string $a_value)
	This function is supposed to be used for block type specific properties, that should be passed to ilBlockGUI->setProperty. More...

	getBlockProperties (string $a_block_type)

	setAllBlockProperties (array $a_block_properties)

	setRepositoryItems (array $a_repositoryitems)

	getRepositoryItems ()

	setItemPresentationManager (ItemPresentationManager $item_presentation)

	getItemPresentationManager ()

	hasItemPresentationManager ()

	executeCommand ()

	getHTML ()

	showBlocks ()

	updateBlock ()
	Update Block (asynchronous) More...

	activateBlock ()
	Activate hidden block. More...

	determineBlocks ()
	Determine which blocks to show. More...

Static Public Member Functions
static	addCustomBlockLocation (string $className, string $path)
	Adds location information of the custom block gui. More...

static	addCustomBlockType (string $className, string $identifier)
	Adds the block type of the custom block gui. More...

static	getCmdSide ()
	Get Column Side of Current Command. More...

static	getScreenMode ()

Protected Member Functions
	isGloballyActivated (string $a_type)
	Check whether a block type is globally activated. More...

	exceededLimit (string $a_type)
	Check whether limit is not exceeded. More...

Protected Attributes
array	$repositoryitems

string	$coltype

ilDashboardSidePanelSettingsRepository	$dash_side_panel_settings

ItemPresentationManager	$item_presentation = null

ILIAS Container Block StandardGUIRequest	$request

ilCtrl	$ctrl

ilLanguage	$lng

ilObjUser	$user

ilTemplate	$tpl

AgentDetermination	$browser

ilSetting	$settings

string	$side = IL_COL_RIGHT

string	$type

bool	$enableedit = false

bool	$repositorymode = false

array	$blocks = []

array	$rep_block_types = array("feed","poll")

array	$block_property = array()

bool	$admincommands = false

array	$default_blocks

array	$custom_blocks

array	$check_global_activation

array	$check_nr_limit

Static Protected Attributes
static array	$locations

static array	$block_types

Detailed Description

Column user interface class.

This class is used on the personal desktop, the info screen class and witin container classes.

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

@ilCtrl_IsCalledBy ilColumnGUI: ilCalendarGUI @ilCtrl_Calls ilColumnGUI:

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

Constructor & Destructor Documentation

◆ __construct()

ilColumnGUI::__construct	(	string	$a_col_type = `""`,
		string	$a_side = `""`,
		bool	$use_std_context = `false`
	)

Definition at line 178 of file class.ilColumnGUI.php.

      {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->browser = $DIC->http()->agent();
        $this->settings = $DIC->settings();
        $this->setColType($a_col_type);
        $this->setSide($a_side);
 
        $block_service = new ILIAS\Container\Block\Service($DIC);
        $this->request = $block_service->internal()
           ->gui()
           ->standardRequest();
 
        $this->dash_side_panel_settings = new ilDashboardSidePanelSettingsRepository();
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), setColType(), setSide(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ activateBlock()

ilColumnGUI::activateBlock ( )

Activate hidden block.

Definition at line 533 of file class.ilColumnGUI.php.

                                   : void
    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
 
        if ($this->request->getBlock() != "") {
            $block = explode("_", $this->request->getBlock());
            ilBlockSetting::_writeDetailLevel($block[0], "2", $ilUser->getId(), (int) $block[1]);
        }
 
        $ilCtrl->returnToParent($this);
    }

References ilBlockSetting\_writeDetailLevel().

Here is the call graph for this function:

◆ addCustomBlockLocation()

static ilColumnGUI::addCustomBlockLocation	(	string	$className,
		string	$path
	)

static

Adds location information of the custom block gui.

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

     : void {
        self::$locations[$className] = $path;
    }

◆ addCustomBlockType()

static ilColumnGUI::addCustomBlockType	(	string	$className,
		string	$identifier
	)

static

Adds the block type of the custom block gui.

Parameters

string	$className	The name of the custom block gui class
string	$identifier	The identifier (block type) of the custom block gui

Definition at line 216 of file class.ilColumnGUI.php.

     : void {
        self::$block_types[$className] = $identifier;
    }

◆ determineBlocks()

ilColumnGUI::determineBlocks ( )

Determine which blocks to show.

Definition at line 549 of file class.ilColumnGUI.php.

                                     : void
    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
 
        $this->blocks[IL_COL_LEFT] = array();
        $this->blocks[IL_COL_RIGHT] = array();
        $this->blocks[IL_COL_CENTER] = array();
 
        $user_id = 0;
        if ($this->getColType() === 'pd') {
            $user_id = $ilUser->getId();
            $positions = array_flip($this->dash_side_panel_settings->getPositions());
        }
 
        $def_nr = 1000;
        if (isset($this->default_blocks[$this->getColType()])) {
            foreach ($this->default_blocks[$this->getColType()] as $class => $def_side) {
                $type = self::$block_types[$class];
                if ($this->isGloballyActivated($type)) {
                    $nr = $def_nr++;
 
                    // extra handling for system messages, feedback block and news
                    if ($type == "news") {              // always show news first
                        $nr = -15;
                    }
                    if ($type == "cal") {
                        $nr = -8;
                    }
                    if ($type == "chcal") {         // consultation hours always directly below calendar
                        $nr = -7;
                    }
                    if ($type == "tusu") {          // tutorial support below calendar
                        $nr = -6;
                    }
                    if ($type == "pdfeedb") {           // always show feedback request second
                        $nr = -10;
                    }
                    if ($type == "clsfct") {            // mkunkel wants to have this on top
                        $nr = -16;
                    }
                    if ($type == "lpprogress") {                // learning progress above news
                        $nr = -17;
                    }
                    $side = ilBlockSetting::_lookupSide($type, $user_id);
                    if (is_null($side) || $side === "") {
                        $side = $def_side;
                    }
                    if ($side == IL_COL_LEFT) {
                        $side = IL_COL_RIGHT;
                    }
 
                    if ($this->getColType() === 'pd' && in_array(substr($type, 2), $this->dash_side_panel_settings->getValidModules(), true)) {
                        $nr = $positions[substr($type, 2)] ?? $nr;
                    }
 
                    $this->blocks[$side][] = array(
                        "nr" => $nr,
                        "class" => $class,
                        "type" => $type,
                        "id" => 0,
                        "custom" => false);
                }
            }
        }
 
        if (!$this->getRepositoryMode()) {
            $custom_block = new ilCustomBlock();
            $custom_block->setContextObjId($ilCtrl->getContextObjId());
            $custom_block->setContextObjType($ilCtrl->getContextObjType());
            $c_blocks = $custom_block->queryBlocksForContext();
 
            foreach ($c_blocks as $c_block) {
                $type = $c_block["type"];
 
                if ($this->isGloballyActivated($type)) {
                    $class = array_search($type, self::$block_types);
                    $nr = $def_nr++;
                    $side = ilBlockSetting::_lookupSide($type, $user_id, $c_block["id"]);
                    if (is_null($side)) {
                        $side = IL_COL_RIGHT;
                    }
 
                    $this->blocks[$side][] = array(
                        "nr" => $nr,
                        "class" => $class,
                        "type" => $type,
                        "id" => $c_block["id"],
                        "custom" => true);
                }
            }
        } else {        // get all subitems
            foreach ($this->rep_block_types as $block_type) {
                if ($this->isGloballyActivated($block_type) && $this->hasItemPresentationManager()) {
                    $item_ref_ids = $this->getItemPresentationManager()->getRefIdsOfType($block_type);
                    foreach ($item_ref_ids as $item_ref_id) {
                        $item = $this->getItemPresentationManager()->getRawDataByRefId($item_ref_id);
                        $costum_block = new ilCustomBlock();
                        $costum_block->setContextObjId((int) $item["obj_id"]);
                        $costum_block->setContextObjType($block_type);
                        $c_blocks = $costum_block->queryBlocksForContext();
                        $c_block = $c_blocks[0];
 
                        $type = $block_type;
                        $class = array_search($type, self::$block_types);
                        $nr = $def_nr++;
                        $side = ilBlockSetting::_lookupSide($type, $user_id, (int) $c_block["id"]);
                        if ($side == false) {
                            $side = IL_COL_RIGHT;
                        }
 
                        $this->blocks[$side][] = array(
                            "nr" => $nr,
                            "class" => $class,
                            "type" => $type,
                            "id" => $c_block["id"],
                            "custom" => true,
                            "ref_id" => $item["ref_id"]);
                    }
                }
            }
 
            // repository object custom blocks
            $custom_block = new ilCustomBlock();
            $custom_block->setContextObjId($ilCtrl->getContextObjId());
            $custom_block->setContextObjType($ilCtrl->getContextObjType());
            $c_blocks = $custom_block->queryBlocksForContext(false); // get all sub-object types
            foreach ($c_blocks as $c_block) {
                $type = $c_block["type"];
                $class = array_search($type, self::$block_types);
 
                if ($class) {
                    $nr = $def_nr++;
                    $side = IL_COL_RIGHT;
 
                    $this->blocks[$side][] = array(
                        "nr" => $nr,
                        "class" => $class,
                        "type" => $type,
                        "id" => $c_block["id"],
                        "custom" => true);
                }
            }
        }
 
        $this->blocks[IL_COL_LEFT] =
            ilArrayUtil::sortArray($this->blocks[IL_COL_LEFT], "nr", "asc", true);
        $this->blocks[IL_COL_RIGHT] =
            ilArrayUtil::sortArray($this->blocks[IL_COL_RIGHT], "nr", "asc", true);
        $this->blocks[IL_COL_CENTER] =
            ilArrayUtil::sortArray($this->blocks[IL_COL_CENTER], "nr", "asc", true);
    }

References $user_id, ilBlockSetting\_lookupSide(), IL_COL_CENTER, IL_COL_LEFT, IL_COL_RIGHT, and ilArrayUtil\sortArray().

Here is the call graph for this function:

◆ exceededLimit()

ilColumnGUI::exceededLimit ( string $a_type )

protected

Check whether limit is not exceeded.

Definition at line 775 of file class.ilColumnGUI.php.

     : bool {
        $ilSetting = $this->settings;
        $ilCtrl = $this->ctrl;
 
        if ($this->check_nr_limit[$a_type]) {
            if (!$this->getRepositoryMode()) {
                $costum_block = new ilCustomBlock();
                $costum_block->setContextObjId($ilCtrl->getContextObjId());
                $costum_block->setContextObjType($ilCtrl->getContextObjType());
                $costum_block->setType($a_type);
                $res = $costum_block->queryCntBlockForContext();
                $cnt = (int) $res[0]["cnt"];
            } else {
                return false;           // not implemented for repository yet
            }
 
 
            if ($ilSetting->get("block_limit_" . $a_type) > $cnt) {
                return false;
            } else {
                return true;
            }
        }
        return false;
    }

References $ilSetting, $res, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ executeCommand()

ilColumnGUI::executeCommand ( )

Definition at line 372 of file class.ilColumnGUI.php.

                                    : string
    {
        $ilCtrl = $this->ctrl;
 
        $ilCtrl->setParameter($this, "col_side", $this->getSide());
 
        $next_class = $ilCtrl->getNextClass();
        $cmd = $ilCtrl->getCmd("getHTML");
 
        $cur_block_type = $this->request->getBlockType();
 
        if ($next_class != "") {
            // forward to block
            if ($gui_class = array_search($cur_block_type, self::$block_types)) {
                $ilCtrl->setParameter($this, "block_type", $cur_block_type);
                $block_gui = new $gui_class();
                $block_gui->setProperties($this->block_property[$cur_block_type] ?? []);
                $block_gui->setRepositoryMode($this->getRepositoryMode());
                $block_gui->setEnableEdit($this->getEnableEdit());
                $block_gui->setAdminCommands($this->getAdminCommands());
 
                if (in_array($gui_class, $this->custom_blocks[$this->getColType()]) ||
                    in_array($cur_block_type, $this->rep_block_types)) {
                    $block_class = substr($gui_class, 0, strlen($gui_class) - 3);
                    $app_block = new $block_class($this->request->getBlockId());
                    $block_gui->setBlock($app_block);
                }
                $html = $ilCtrl->forwardCommand($block_gui);
                $ilCtrl->setParameter($this, "block_type", "");
 
                return $html;
            }
        } else {
            return (string) $this->$cmd();
        }
        return "";
    }

◆ getAdminCommands()

ilColumnGUI::getAdminCommands ( )

Definition at line 289 of file class.ilColumnGUI.php.

                                      : bool
    {
        return $this->admincommands;
    }

◆ getBlockProperties()

ilColumnGUI::getBlockProperties ( string $a_block_type )

Definition at line 333 of file class.ilColumnGUI.php.

     : array {
        return $this->block_property[$a_block_type];
    }

◆ getCmdSide()

static ilColumnGUI::getCmdSide ( )

static

Get Column Side of Current Command.

Definition at line 226 of file class.ilColumnGUI.php.

                                       : ?string
    {
        global $DIC;
 
        $block_service = new ILIAS\Container\Block\Service($DIC);
        $request = $block_service->internal()
            ->gui()
            ->standardRequest();
        return $request->getColSide();
    }

References $DIC.

Referenced by ilContainerContentGUI\forwardToColumnGUI(), and ilObjectGUI\getCenterColumnHTML().

Here is the caller graph for this function:

◆ getColType()

ilColumnGUI::getColType ( )

Definition at line 245 of file class.ilColumnGUI.php.

                                : string
    {
        return $this->coltype;
    }

◆ getEnableEdit()

ilColumnGUI::getEnableEdit ( )

Definition at line 268 of file class.ilColumnGUI.php.

                                   : bool
    {
        return $this->enableedit;
    }

◆ getHTML()

ilColumnGUI::getHTML ( )

Definition at line 410 of file class.ilColumnGUI.php.

                             : string
    {
        $ilCtrl = $this->ctrl;
 
        $ilCtrl->setParameter($this, "col_side", $this->getSide());
 
        $this->tpl = new ilTemplate("tpl.column.html", true, true, "components/ILIAS/Container");
        $this->determineBlocks();
        $this->showBlocks();
        return $this->tpl->get();
    }

◆ getItemPresentationManager()

ilColumnGUI::getItemPresentationManager ( )

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

                                                : ItemPresentationManager
    {
        return $this->item_presentation;
    }

◆ getRepositoryItems()

ilColumnGUI::getRepositoryItems ( )

Definition at line 351 of file class.ilColumnGUI.php.

                                        : array
    {
        return $this->repositoryitems;
    }

◆ getRepositoryMode()

ilColumnGUI::getRepositoryMode ( )

Definition at line 279 of file class.ilColumnGUI.php.

                                       : bool
    {
        return $this->repositorymode;
    }

◆ getScreenMode()

static ilColumnGUI::getScreenMode ( )

static

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

                                          : string
    {
        global $DIC;
 
        $ilCtrl = $DIC->ctrl();
 
        $block_service = new ILIAS\Container\Block\Service($DIC);
        $request = $block_service->internal()
                                 ->gui()
                                 ->standardRequest();
 
        if ($ilCtrl->getCmdClass() == "ilcolumngui") {
            switch ($ilCtrl->getCmd()) {
                case "addBlock":
                    return IL_SCREEN_CENTER;
            }
        }
 
        $cur_block_type = $request->getBlockType();
 
        if ($class = array_search($cur_block_type, self::$block_types)) {
            return call_user_func(array($class, 'getScreenMode'));
        }
 
        return IL_SCREEN_SIDE;
    }

References $DIC, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

Referenced by ilContainerContentGUI\forwardToColumnGUI(), and ilObjectGUI\getCenterColumnHTML().

Here is the caller graph for this function:

◆ getSide()

ilColumnGUI::getSide ( )

Definition at line 258 of file class.ilColumnGUI.php.

                             : string
    {
        return $this->side;
    }

◆ hasItemPresentationManager()

ilColumnGUI::hasItemPresentationManager ( )

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

                                                : bool
    {
        return isset($this->item_presentation);
    }

◆ isGloballyActivated()

ilColumnGUI::isGloballyActivated ( string $a_type )

protected

Check whether a block type is globally activated.

Definition at line 705 of file class.ilColumnGUI.php.

     : bool {
        $ilSetting = $this->settings;
        $ilCtrl = $this->ctrl;
 
        if ($a_type == 'pdfeed') {
            return false;
        }
 
        if (isset($this->check_global_activation[$a_type]) && $this->check_global_activation[$a_type]) {
            if ($a_type === 'pd' . ilDashboardSidePanelSettingsRepository::NEWS) {
                return ($this->dash_side_panel_settings->isEnabled($this->dash_side_panel_settings::NEWS) &&
                    $ilSetting->get('block_activated_news'));
            } elseif ($a_type === 'pd' . ilDashboardSidePanelSettingsRepository::MAIL) {
                return $this->dash_side_panel_settings->isEnabled($this->dash_side_panel_settings::MAIL);
            } elseif ($a_type === 'pd' . ilDashboardSidePanelSettingsRepository::TASKS) {
                return $this->dash_side_panel_settings->isEnabled($this->dash_side_panel_settings::TASKS);
            } elseif ($a_type == 'news') {
                return
                    $ilSetting->get('block_activated_news') &&
 
                    (!in_array($ilCtrl->getContextObjType(), ["grp", "crs"]) ||
                        ilContainer::_lookupContainerSetting(
                            $GLOBALS['ilCtrl']->getContextObjId(),
                            ilObjectServiceSettingsGUI::USE_NEWS,
                            "1"
                        )) &&
                    ilContainer::_lookupContainerSetting(
                        $GLOBALS['ilCtrl']->getContextObjId(),
                        'cont_show_news',
                        "1"
                    );
            } elseif ($ilSetting->get("block_activated_" . $a_type)) {
                return true;
            } elseif ($a_type == 'cal' || $a_type == 'chcal') {
                return ilCalendarSettings::lookupCalendarContentPresentationEnabled($ilCtrl->getContextObjId());
            } elseif ($a_type === 'pd' . ilDashboardSidePanelSettingsRepository::CALENDAR) {
                if (!$this->dash_side_panel_settings->isEnabled($this->dash_side_panel_settings::CALENDAR)) {
                    return false;
                }
                return ilCalendarSettings::_getInstance()->isEnabled();
            } elseif ($a_type == "tagcld") {
                $tags_active = new ilSetting("tags");
                return (bool) $tags_active->get("enable", "0");
            } elseif ($a_type == "clsfct") {
                if ($ilCtrl->getContextObjType() == "cat") {    // taxonomy presentation in classification block
                    return true;
                }
                $tags_active = new ilSetting("tags");           // tags presentation in classification block
                return (bool) $tags_active->get("enable", "0");
            } elseif (
                $a_type === "tusu" &&
                ilObjCourse::lookupTutorialBlockSettingEabled($ilCtrl->getContextObjId())
            ) {
                return true;
            } elseif ($a_type === "lpprogress") {
                $obj_lp = ilObjectLP::getInstance($ilCtrl->getContextObjId());
                $progress_block_settings = (new TrackingView())->progressBlock()->settings()->repository();
                return $obj_lp->getCurrentMode() === ilLPObjSettings::LP_MODE_COLLECTION &&
                    $progress_block_settings->isBlockShownForObject($ilCtrl->getContextObjId());
            }
            return false;
        }
        return true;
    }

◆ setAdminCommands()

ilColumnGUI::setAdminCommands ( bool $a_admincommands )

Definition at line 284 of file class.ilColumnGUI.php.

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

Referenced by ilContainerGUI\setColumnSettings().

Here is the caller graph for this function:

◆ setAllBlockProperties()

ilColumnGUI::setAllBlockProperties ( array $a_block_properties )

Definition at line 339 of file class.ilColumnGUI.php.

     : void {
        $this->block_property = $a_block_properties;
    }

Referenced by ilInfoScreenGUI\setColumnSettings().

Here is the caller graph for this function:

◆ setBlockProperty()

ilColumnGUI::setBlockProperty	(	string	$a_block_type,
		string	$a_property,
		string	$a_value
	)

This function is supposed to be used for block type specific properties, that should be passed to ilBlockGUI->setProperty.

Definition at line 325 of file class.ilColumnGUI.php.

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

Referenced by ilContainerGUI\setColumnSettings(), and ilObjForumGUI\setColumnSettings().

Here is the caller graph for this function:

◆ setColType()

ilColumnGUI::setColType ( string $a_coltype )

Parameters

string $a_coltype Column Type

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

                                                 : void
    {
        $this->coltype = $a_coltype;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setEnableEdit()

ilColumnGUI::setEnableEdit ( bool $a_enableedit )

Definition at line 263 of file class.ilColumnGUI.php.

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

Referenced by ilObjectGUI\setColumnSettings(), and ilInfoScreenGUI\setColumnSettings().

Here is the caller graph for this function:

◆ setItemPresentationManager()

ilColumnGUI::setItemPresentationManager ( ItemPresentationManager $item_presentation )

Definition at line 356 of file class.ilColumnGUI.php.

     : void {
        $this->item_presentation = $item_presentation;
    }

Referenced by ilContainerGUI\setColumnSettings().

Here is the caller graph for this function:

◆ setRepositoryItems()

ilColumnGUI::setRepositoryItems ( array $a_repositoryitems )

Definition at line 345 of file class.ilColumnGUI.php.

     : void {
        $this->repositoryitems = $a_repositoryitems;
    }

◆ setRepositoryMode()

ilColumnGUI::setRepositoryMode ( bool $a_repositorymode )

Definition at line 273 of file class.ilColumnGUI.php.

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

Referenced by ilObjForumGUI\setColumnSettings(), ilObjectGUI\setColumnSettings(), and ilInfoScreenGUI\setColumnSettings().

Here is the caller graph for this function:

◆ setSide()

ilColumnGUI::setSide ( string $a_side )

Parameters

string $a_side Side IL_COL_LEFT | IL_COL_RIGHT

Definition at line 253 of file class.ilColumnGUI.php.

                                           : void
    {
        $this->side = $a_side;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ showBlocks()

ilColumnGUI::showBlocks ( )

Definition at line 422 of file class.ilColumnGUI.php.

                                : void
    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        $i = 1;
        $sum_moveable = count($this->blocks[$this->getSide()]);
 
        foreach ($this->blocks[$this->getSide()] as $block) {
            $gui_class = $block["class"] ?? null;
            if (!is_string($gui_class)) {
                continue;
            }
            $block_class = substr($gui_class, 0, strlen($gui_class) - 3);
 
            // get block gui class
            $block_gui = new $gui_class();
            if (isset($this->block_property[$block["type"]])) {
                $block_gui->setProperties($this->block_property[$block["type"]]);
            }
            $block_gui->setRepositoryMode($this->getRepositoryMode());
            $block_gui->setEnableEdit($this->getEnableEdit());
            $block_gui->setAdminCommands($this->getAdminCommands());
 
            // get block for custom blocks
            if ($block["custom"]) {
                $path = "./../" . self::$locations[$gui_class] . "classes/" .
                    "class." . $block_class . ".php";
                if (file_exists($path)) {
                    $app_block = new $block_class((int) $block["id"]);
                } else {
                    // we only need generic block
                    $app_block = new ilCustomBlock((int) $block["id"]);
                }
                $block_gui->setBlock($app_block);
                if (isset($block["ref_id"])) {
                    $block_gui->setRefId((int) $block["ref_id"]);
                }
            }
 
            $ilCtrl->setParameter($this, "block_type", $block_gui->getBlockType());
            $this->tpl->setCurrentBlock("col_block");
 
            $html = $ilCtrl->getHTML($block_gui);
 
            // don't render a block if it's empty
            if ($html != "") {
                $this->tpl->setVariable("BLOCK", $html);
                $this->tpl->parseCurrentBlock();
                $ilCtrl->setParameter($this, "block_type", "");
            }
        }
    }

References $path.

◆ updateBlock()

ilColumnGUI::updateBlock ( )

Update Block (asynchronous)

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

                                 : void
    {
        $ilCtrl = $this->ctrl;
 
        $this->determineBlocks();
        $i = 1;
        $sum_moveable = count($this->blocks[$this->getSide()]);
 
        foreach ($this->blocks[$this->getSide()] as $block) {
            // set block id to context obj id,
            // if block is not a custom block and context is not personal desktop
            if (!$block["custom"] && $ilCtrl->getContextObjType() != "" && $ilCtrl->getContextObjType() != "user") {
                $block["id"] = $ilCtrl->getContextObjId();
            }
 
            if ($this->request->getBlockId() == "block_" . $block["type"] . "_" . $block["id"]) {
                $gui_class = $block["class"];
                $block_class = substr($block["class"], 0, strlen($block["class"]) - 3);
 
                $block_gui = new $gui_class();
                $block_gui->setProperties($this->block_property[$block["type"]]);
                $block_gui->setRepositoryMode($this->getRepositoryMode());
                $block_gui->setEnableEdit($this->getEnableEdit());
                $block_gui->setAdminCommands($this->getAdminCommands());
 
                // get block for custom blocks
                if ($block["custom"]) {
                    $app_block = new $block_class($block["id"]);
                    $block_gui->setBlock($app_block);
                    $block_gui->setRefId($block["ref_id"]);
                }
 
                $ilCtrl->setParameter($this, "block_type", $block["type"]);
                echo $ilCtrl->getHTML($block_gui);
                exit;
            }
 
            // count (moveable) blocks
            if ($block["type"] != "pdfeedb"
                && $block["type"] != "news") {
                $i++;
            } else {
                $sum_moveable--;
            }
        }
        echo "Error: ilColumnGUI::updateBlock: Block '" .
            $this->request->getBlockId() . "' unknown.";
        exit;
    }

References exit.

Field Documentation

◆ $admincommands

bool ilColumnGUI::$admincommands = false

protected

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

◆ $block_property

array ilColumnGUI::$block_property = array()

protected

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

◆ $block_types

array ilColumnGUI::$block_types

staticprotected

Initial value:

= array(
        "ilPDMailBlockGUI" => 'pd' . ilDashboardSidePanelSettingsRepository::MAIL,
        "ilPDTasksBlockGUI" => 'pd' . ilDashboardSidePanelSettingsRepository::TASKS,
        "ilPDNewsBlockGUI" => 'pd' . ilDashboardSidePanelSettingsRepository::NEWS,
        "ilNewsForContextBlockGUI" => "news",
        "ilCalendarBlockGUI" => "cal",
        "ilTutorialSupportBlockGUI" => "tusu",
        "ilPDCalendarBlockGUI" => 'pd' . ilDashboardSidePanelSettingsRepository::CALENDAR,
        "ilConsultationHoursCalendarBlockGUI" => "chcal",
        "ilSelectedItemsBlockGUI" => "pditems",
        'ilPollBlockGUI' => 'poll',
        'ilClassificationBlockGUI' => 'clsfct',
        "ilPDStudyProgrammeSimpleListGUI" => "prgsimplelist",
        "ilPDStudyProgrammeExpandableListGUI" => "prgexpandablelist",
        "ilLPProgressBlockGUI" => "lpprogress"
    )

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

◆ $blocks

array ilColumnGUI::$blocks = []

protected

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

◆ $browser

AgentDetermination ilColumnGUI::$browser

protected

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

◆ $check_global_activation

array ilColumnGUI::$check_global_activation

protected

Initial value:

=
        array("news" => true,
            "cal" => true,
            "chcal" => true,
            "tusu" => true,
            "pd" . ilDashboardSidePanelSettingsRepository::CALENDAR => true,
            "pd" . ilDashboardSidePanelSettingsRepository::NEWS => true,
            "pdtag" => true,
            "pd" . ilDashboardSidePanelSettingsRepository::MAIL => true,
            "pd" . ilDashboardSidePanelSettingsRepository::TASKS => true,
            "tagcld" => true,
            "clsfct" => true,
            "lpprogress" => true)

Definition at line 161 of file class.ilColumnGUI.php.

◆ $check_nr_limit

array ilColumnGUI::$check_nr_limit

protected

Initial value:

=

array("pdfeed" => true)

Definition at line 175 of file class.ilColumnGUI.php.

◆ $coltype

string ilColumnGUI::$coltype

protected

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

◆ $ctrl

ilCtrl ilColumnGUI::$ctrl

protected

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

◆ $custom_blocks

array ilColumnGUI::$custom_blocks

protected

Initial value:

= array(
        "cat" => array(),
        "crs" => array(),
        "grp" => array(),
        "frm" => array(),
        "root" => array(),
        "info" => array(),
        "fold" => array(),
        "pd" => array()
    )

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

◆ $dash_side_panel_settings

ilDashboardSidePanelSettingsRepository ilColumnGUI::$dash_side_panel_settings

protected

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

◆ $default_blocks

array ilColumnGUI::$default_blocks

protected

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

◆ $enableedit

bool ilColumnGUI::$enableedit = false

protected

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

◆ $item_presentation

ItemPresentationManager ilColumnGUI::$item_presentation = null

protected

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

◆ $lng

ilLanguage ilColumnGUI::$lng

protected

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

◆ $locations

array ilColumnGUI::$locations

staticprotected

Initial value:

= array(
        "ilNewsForContextBlockGUI" => "components/ILIAS/News/",
        "ilCalendarBlockGUI" => "components/ILIAS/Calendar/",
        "ilTutorialSupportBlockGUI" => "components/ILIAS/Course/",
        "ilPDCalendarBlockGUI" => "components/ILIAS/Calendar/",
        "ilConsultationHoursCalendarBlockGUI" => "components/ILIAS/Calendar/",
        "ilPDTasksBlockGUI" => "components/ILIAS/Tasks/",
        "ilPDMailBlockGUI" => "components/ILIAS/Mail/",
        "ilSelectedItemsBlockGUI" => "components/ILIAS/Dashboard/Block/",
        "ilPDNewsBlockGUI" => "components/ILIAS/News/",
        'ilPollBlockGUI' => 'components/ILIAS/Poll/',
        'ilClassificationBlockGUI' => 'components/ILIAS/Classification/',
        "ilPDStudyProgrammeSimpleListGUI" => "components/ILIAS/StudyProgramme/",
        "ilPDStudyProgrammeExpandableListGUI" => "components/ILIAS/StudyProgramme/",
        "ilLPProgressBlockGUI" => "components/ILIAS/Tracking/"
    )

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

◆ $rep_block_types

array ilColumnGUI::$rep_block_types = array("feed","poll")

protected

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

◆ $repositoryitems

array ilColumnGUI::$repositoryitems

protected

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

◆ $repositorymode

bool ilColumnGUI::$repositorymode = false

protected

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

◆ $request

ILIAS Container Block StandardGUIRequest ilColumnGUI::$request

protected

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

◆ $settings

ilSetting ilColumnGUI::$settings

protected

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

◆ $side

string ilColumnGUI::$side = IL_COL_RIGHT

protected

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

◆ $tpl

ilTemplate ilColumnGUI::$tpl

protected

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

◆ $type

string ilColumnGUI::$type

protected

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

◆ $user

ilObjUser ilColumnGUI::$user

protected

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

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

components/ILIAS/Container/Block/class.ilColumnGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateBlock()

◆ addCustomBlockLocation()

◆ addCustomBlockType()

◆ determineBlocks()

◆ exceededLimit()

◆ executeCommand()

◆ getAdminCommands()

◆ getBlockProperties()

◆ getCmdSide()

◆ getColType()

◆ getEnableEdit()

◆ getHTML()

◆ getItemPresentationManager()

◆ getRepositoryItems()

◆ getRepositoryMode()

◆ getScreenMode()

◆ getSide()

◆ hasItemPresentationManager()

◆ isGloballyActivated()

◆ setAdminCommands()

◆ setAllBlockProperties()

◆ setBlockProperty()

◆ setColType()

◆ setEnableEdit()

◆ setItemPresentationManager()

◆ setRepositoryItems()

◆ setRepositoryMode()

◆ setSide()

◆ showBlocks()

◆ updateBlock()

Field Documentation

◆ $admincommands

◆ $block_property

◆ $block_types

◆ $blocks

◆ $browser

◆ $check_global_activation

◆ $check_nr_limit

◆ $coltype

◆ $ctrl

◆ $custom_blocks

◆ $dash_side_panel_settings

◆ $default_blocks

◆ $enableedit

◆ $item_presentation

◆ $lng

◆ $locations

◆ $rep_block_types

◆ $repositoryitems

◆ $repositorymode

◆ $request

◆ $settings

◆ $side

◆ $tpl

◆ $type

◆ $user