Column user interface class. More...

Collaboration diagram for ilColumnGUI:

Public Member Functions
	__construct ($a_col_type="", $a_side="", $use_std_context=false)
	Constructor. More...

	setColType ($a_coltype)
	Set Column Type. More...

	getColType ()
	Get Column Type. More...

	setSide ($a_side)
	Set Side IL_COL_LEFT \| IL_COL_RIGHT. More...

	getSide ()
	Get Side IL_COL_LEFT \| IL_COL_RIGHT. More...

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

	getEnableEdit ()
	Get EnableEdit. More...

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

	getRepositoryMode ()
	Get RepositoryMode. More...

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

	getAdminCommands ()
	Get Administration Commmands. More...

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

	getBlockProperties ($a_block_type)

	setAllBlockProperties ($a_block_properties)

	setRepositoryItems ($a_repositoryitems)
	Set Repository Items. More...

	getRepositoryItems ()
	Get Repository Items. More...

	executeCommand ()
	execute command More...

	getHTML ()
	Get HTML for column. More...

	showBlocks ()
	Show blocks. More...

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

	activateBlock ()
	Activate hidden block. More...

	addBlock ()
	Add a block. More...

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

	setActionMenu ($action_menu)

	getActionMenu ()

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

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

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

static	getScreenMode ()
	Get Screen Mode for current command. More...

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

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

Protected Attributes
	$ctrl

	$lng

	$user

	$tpl

	$browser

	$settings

	$side = IL_COL_RIGHT

	$type

	$enableedit = false

	$repositorymode = false

	$repositoryitems = array()

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

	$block_property = array()

	$admincommands = false

	$action_menu

	$default_blocks

	$custom_blocks

	$check_global_activation

	$check_nr_limit

Static Protected Attributes
static	$locations

static	$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: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

ilColumnGUI: ilCalendarGUI ilColumnGUI:

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

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

References $DIC, setColType(), setSide(), settings(), and user().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->tpl = $DIC["tpl"];
         $this->browser = $DIC["ilBrowser"];
         $this->settings = $DIC->settings();
         $this->setColType($a_col_type);
         $this->setSide($a_side);
 
         $this->dash_side_panel_settings = new ilDashboardSidePanelSettingsRepository();
     }

Here is the call graph for this function:

Member Function Documentation

◆ activateBlock()

ilColumnGUI::activateBlock ( )

Activate hidden block.

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

References $_GET, $ctrl, $ilCtrl, $ilUser, $user, and ilBlockSetting\_writeDetailLevel().

     {
         $ilUser = $this->user;
         $ilCtrl = $this->ctrl;
 
         if ($_GET["block"] != "") {
             $block = explode("_", $_GET["block"]);
             include_once("Services/Block/classes/class.ilBlockSetting.php");
             ilBlockSetting::_writeDetailLevel($block[0], 2, $ilUser->getId(), $block[1]);
         }
 
         $ilCtrl->returnToParent($this);
     }

Here is the call graph for this function:

◆ addBlock()

ilColumnGUI::addBlock ( )

Add a block.

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

References $_GET, $ctrl, $ilCtrl, getAdminCommands(), getEnableEdit(), and getRepositoryMode().

     {
         $ilCtrl = $this->ctrl;
         
         $class = array_search($_GET["block_type"], self::$block_types);
 
         $ilCtrl->setCmdClass($class);
         $ilCtrl->setCmd("create");
         include_once("./" . self::$locations[$class] . "classes/class." . $class . ".php");
         $block_gui = new $class();
         $block_gui->setProperties($this->block_property[$_GET["block_type"]]);
         $block_gui->setRepositoryMode($this->getRepositoryMode());
         $block_gui->setEnableEdit($this->getEnableEdit());
         $block_gui->setAdminCommands($this->getAdminCommands());
         
         $ilCtrl->setParameter($this, "block_type", $_GET["block_type"]);
         $html = $ilCtrl->forwardCommand($block_gui);
         $ilCtrl->setParameter($this, "block_type", "");
         return $html;
     }

Here is the call graph for this function:

◆ addCustomBlockLocation()

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

static

Adds location information of the custom block gui.

public

Parameters

string	The name of the custom block gui class
string	The path of the custom block gui class

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

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

◆ addCustomBlockType()

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

static

Adds the block type of the custom block gui.

public

Parameters

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

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

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

◆ determineBlocks()

ilColumnGUI::determineBlocks ( )

Determine which blocks to show.

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

References $ctrl, $ilCtrl, $ilSetting, $ilUser, $settings, $side, $type, $user, ilBlockSetting\_lookupSide(), getColType(), getRepositoryItems(), getRepositoryMode(), IL_COL_CENTER, IL_COL_LEFT, IL_COL_RIGHT, isGloballyActivated(), and ilUtil\sortArray().

Referenced by getHTML(), and updateBlock().

     {
         $ilUser = $this->user;
         $ilCtrl = $this->ctrl;
         $ilSetting = $this->settings;
 
         include_once("./Services/Block/classes/class.ilBlockSetting.php");
         $this->blocks[IL_COL_LEFT] = array();
         $this->blocks[IL_COL_RIGHT] = array();
         $this->blocks[IL_COL_CENTER] = array();
         
         $user_id = ($this->getColType() == "pd")
             ? $ilUser->getId()
             : 0;
 
         $def_nr = 1000;
         if (is_array($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 == "pdfeedb") {           // always show feedback request second
                         $nr = -10;
                     }
                     if ($type == "clsfct") {            // mkunkel wants to have this on top
                         $nr = -16;
                     }
                     $side = ilBlockSetting::_lookupSide($type, $user_id);
                     if ($side === false) {
                         $side = $def_side;
                     }
                     if ($side == IL_COL_LEFT) {
                         $side = IL_COL_RIGHT;
                     }
                     
                     $this->blocks[$side][] = array(
                         "nr" => $nr,
                         "class" => $class,
                         "type" => $type,
                         "id" => 0,
                         "custom" => false);
                 }
             }
         }
         
         if (!$this->getRepositoryMode()) {
             include_once("./Services/Block/classes/class.ilCustomBlock.php");
             $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 ($side === false) {
                         $side = IL_COL_RIGHT;
                     }
     
                     $this->blocks[$side][] = array(
                         "nr" => $nr,
                         "class" => $class,
                         "type" => $type,
                         "id" => $c_block["id"],
                         "custom" => true);
                 }
             }
         } else {        // get all subitems
             include_once("./Services/Block/classes/class.ilCustomBlock.php");
             $rep_items = $this->getRepositoryItems();
 
             foreach ($this->rep_block_types as $block_type) {
                 if ($this->isGloballyActivated($block_type)) {
                     if (!is_array($rep_items[$block_type])) {
                         continue;
                     }
                     foreach ($rep_items[$block_type] as $item) {
                         $costum_block = new ilCustomBlock();
                         $costum_block->setContextObjId($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, $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
             include_once("./Services/Block/classes/class.ilCustomBlock.php");
             $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] =
             ilUtil::sortArray($this->blocks[IL_COL_LEFT], "nr", "asc", true);
         $this->blocks[IL_COL_RIGHT] =
             ilUtil::sortArray($this->blocks[IL_COL_RIGHT], "nr", "asc", true);
         $this->blocks[IL_COL_CENTER] =
             ilUtil::sortArray($this->blocks[IL_COL_CENTER], "nr", "asc", true);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exceededLimit()

ilColumnGUI::exceededLimit ( $a_type )

protected

Check whether limit is not exceeded.

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

References $_POST, $a_type, $ctrl, $i, $ilCtrl, $ilSetting, $ilUser, $res, $response, $settings, $side, $user, ilBlockSetting\_writeNumber(), ilBlockSetting\_writeSide(), exit, getColType(), getRepositoryMode(), IL_COL_LEFT, and IL_COL_RIGHT.

Referenced by showBlocks().

     {
         $ilSetting = $this->settings;
         $ilCtrl = $this->ctrl;
 
         if ($this->check_nr_limit[$a_type]) {
             if (!$this->getRepositoryMode()) {
                 include_once("./Services/Block/classes/class.ilCustomBlock.php");
                 $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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilColumnGUI::executeCommand ( )

execute command

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

References $_GET, $_POST, $ctrl, $ilCtrl, getAdminCommands(), getColType(), getEnableEdit(), getRepositoryMode(), and getSide().

     {
         $ilCtrl = $this->ctrl;
         
         $ilCtrl->setParameter($this, "col_side", $this->getSide());
         //$ilCtrl->saveParameter($this, "col_side");
 
         $next_class = $ilCtrl->getNextClass();
         $cmd = $ilCtrl->getCmd("getHTML");
 
         $cur_block_type = ($_GET["block_type"])
             ? $_GET["block_type"]
             : $_POST["block_type"];
 
         if ($next_class != "") {
             // forward to block
             if ($gui_class = array_search($cur_block_type, self::$block_types)) {
                 include_once("./" . self::$locations[$gui_class] . "classes/" .
                     "class." . $gui_class . ".php");
                 $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);
                     include_once("./" . self::$locations[$gui_class] . "classes/" .
                         "class." . $block_class . ".php");
                     $app_block = new $block_class($_GET["block_id"]);
                     $block_gui->setBlock($app_block);
                 }
                 $html = $ilCtrl->forwardCommand($block_gui);
                 $ilCtrl->setParameter($this, "block_type", "");
                 
                 return $html;
             }
         } else {
             return $this->$cmd();
         }
     }

Here is the call graph for this function:

◆ getActionMenu()

ilColumnGUI::getActionMenu ( )

Returns

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

References $action_menu.

     {
         return $this->action_menu;
     }

◆ getAdminCommands()

ilColumnGUI::getAdminCommands ( )

Get Administration Commmands.

Returns: boolean Administration Commmands

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

References $admincommands.

Referenced by addBlock(), executeCommand(), showBlocks(), and updateBlock().

     {
         return $this->admincommands;
     }

Here is the caller graph for this function:

◆ getBlockProperties()

ilColumnGUI::getBlockProperties ( $a_block_type )

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

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

◆ getCmdSide()

static ilColumnGUI::getCmdSide ( )

static

Get Column Side of Current Command.

Returns: string Column Side

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

References $_GET.

Referenced by ilContainerContentGUI\__forwardToColumnGUI(), ilCourseContentGUI\__forwardToColumnGUI(), and ilObjectGUI\getCenterColumnHTML().

     {
         return $_GET["col_side"];
     }

Here is the caller graph for this function:

◆ getColType()

ilColumnGUI::getColType ( )

Get Column Type.

Returns: string Column Type

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

Referenced by determineBlocks(), exceededLimit(), executeCommand(), and showBlocks().

     {
         return $this->coltype;
     }

Here is the caller graph for this function:

◆ getEnableEdit()

ilColumnGUI::getEnableEdit ( )

Get EnableEdit.

Returns: boolean EnableEdit

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

References $enableedit.

Referenced by addBlock(), executeCommand(), getHTML(), showBlocks(), and updateBlock().

     {
         return $this->enableedit;
     }

Here is the caller graph for this function:

◆ getHTML()

ilColumnGUI::getHTML ( )

Get HTML for column.

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

References $ctrl, $ilCtrl, determineBlocks(), getEnableEdit(), getRepositoryMode(), getSide(), and showBlocks().

     {
         $ilCtrl = $this->ctrl;
         
         $ilCtrl->setParameter($this, "col_side", $this->getSide());
         
         $this->tpl = new ilTemplate("tpl.column.html", true, true, "Services/Block");
         $this->determineBlocks();
         $this->showBlocks();
 
         if ($this->getEnableEdit() || !$this->getRepositoryMode()) {
             $this->addHiddenBlockSelector();
         }
 
         return $this->tpl->get();
     }

Here is the call graph for this function:

◆ getRepositoryItems()

ilColumnGUI::getRepositoryItems ( )

Get Repository Items.

Returns: array Repository Items

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

References $repositoryitems.

Referenced by determineBlocks().

     {
         return $this->repositoryitems;
     }

Here is the caller graph for this function:

◆ getRepositoryMode()

ilColumnGUI::getRepositoryMode ( )

Get RepositoryMode.

Returns: boolean RepositoryMode

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

References $repositorymode.

Referenced by addBlock(), determineBlocks(), exceededLimit(), executeCommand(), getHTML(), showBlocks(), and updateBlock().

     {
         return $this->repositorymode;
     }

Here is the caller graph for this function:

◆ getScreenMode()

static ilColumnGUI::getScreenMode ( )

static

Get Screen Mode for current command.

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

References $_GET, $_POST, $DIC, $ilCtrl, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

Referenced by ilContainerContentGUI\__forwardToColumnGUI(), ilCourseContentGUI\__forwardToColumnGUI(), and ilObjectGUI\getCenterColumnHTML().

     {
         global $DIC;
 
         $ilCtrl = $DIC->ctrl();
 
         if ($ilCtrl->getCmdClass() == "ilcolumngui") {
             switch ($ilCtrl->getCmd()) {
                 case "addBlock":
                     return IL_SCREEN_CENTER;
             }
         }
 
         $cur_block_type = "";
         if (isset($_GET["block_type"]) && $_GET["block_type"]) {
             $cur_block_type = $_GET["block_type"];
         } elseif (isset($_POST["block_type"])) {
             $cur_block_type = $_POST["block_type"];
         }
 
         if ($class = array_search($cur_block_type, self::$block_types)) {
             include_once("./" . self::$locations[$class] . "classes/" .
                 "class." . $class . ".php");
             return call_user_func(array($class, 'getScreenMode'));
         }
 
         return IL_SCREEN_SIDE;
     }

Here is the caller graph for this function:

◆ getSide()

ilColumnGUI::getSide ( )

Get Side IL_COL_LEFT | IL_COL_RIGHT.

Returns: string Side IL_COL_LEFT | IL_COL_RIGHT

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

References $side.

Referenced by executeCommand(), getHTML(), showBlocks(), and updateBlock().

     {
         return $this->side;
     }

Here is the caller graph for this function:

◆ isGloballyActivated()

ilColumnGUI::isGloballyActivated ( $a_type )

protected

Check whether a block type is globally activated.

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

References $a_type, $ctrl, $GLOBALS, $ilCtrl, $ilSetting, $settings, ilCalendarSettings\_getInstance(), ilContainer\_lookupContainerSetting(), ilCalendarSettings\lookupCalendarActivated(), and ilObjectServiceSettingsGUI\USE_NEWS.

Referenced by determineBlocks(), and showBlocks().

     {
         $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 == 'pdnews') {
                 return ($this->dash_side_panel_settings->isEnabled($this->dash_side_panel_settings::NEWS) &&
                     $ilSetting->get('block_activated_news'));
             } elseif ($a_type == 'pdmail') {
                 return $this->dash_side_panel_settings->isEnabled($this->dash_side_panel_settings::MAIL);
             } elseif ($a_type == 'pdtasks') {
                 return $this->dash_side_panel_settings->isEnabled($this->dash_side_panel_settings::TASKS);
             } elseif ($a_type == 'news') {
                 include_once 'Services/Container/classes/class.ilContainer.php';
                 return
                     $ilSetting->get('block_activated_news') &&
 
                     (!in_array($ilCtrl->getContextObjType(), ["grp", "crs"]) ||
                         ilContainer::_lookupContainerSetting(
                             $GLOBALS['ilCtrl']->getContextObjId(),
                             ilObjectServiceSettingsGUI::USE_NEWS,
                             true
                     )) &&
                     ilContainer::_lookupContainerSetting(
                         $GLOBALS['ilCtrl']->getContextObjId(),
                         'cont_show_news',
                         true
                     );
             } elseif ($ilSetting->get("block_activated_" . $a_type)) {
                 return true;
             } elseif ($a_type == 'cal') {
                 include_once('./Services/Calendar/classes/class.ilCalendarSettings.php');
                 return ilCalendarSettings::lookupCalendarActivated($GLOBALS['ilCtrl']->getContextObjId());
             } elseif ($a_type == 'pdcal') {
                 if (!$this->dash_side_panel_settings->isEnabled($this->dash_side_panel_settings::CALENDAR)) {
                     return false;
                 }
                 include_once('./Services/Calendar/classes/class.ilCalendarSettings.php');
                 return ilCalendarSettings::_getInstance()->isEnabled();
             } elseif ($a_type == "tagcld") {
                 $tags_active = new ilSetting("tags");
                 return (bool) $tags_active->get("enable", false);
             } 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", false);
             }
             return false;
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActionMenu()

ilColumnGUI::setActionMenu ( $action_menu )

Parameters

\ilAdvancedSelectionListGUI $action_menu

Returns: ilColumnGUI

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

References $action_menu.

     {
         $this->action_menu = $action_menu;
         return $this;
     }

◆ setAdminCommands()

ilColumnGUI::setAdminCommands ( $a_admincommands )

Set Administration Commmands.

Parameters

boolean $a_admincommands Administration Commmands

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

Referenced by ilContainerGUI\setColumnSettings().

     {
         $this->admincommands = $a_admincommands;
     }

Here is the caller graph for this function:

◆ setAllBlockProperties()

ilColumnGUI::setAllBlockProperties ( $a_block_properties )

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

     {
         $this->block_property = $a_block_properties;
     }

◆ setBlockProperty()

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

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

Parameters

string	$a_property	property name
string	$a_value	property value

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

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

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

Here is the caller graph for this function:

◆ setColType()

ilColumnGUI::setColType ( $a_coltype )

Set Column Type.

Parameters

string $a_coltype Column Type

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

Referenced by __construct().

     {
         $this->coltype = $a_coltype;
     }

Here is the caller graph for this function:

◆ setEnableEdit()

ilColumnGUI::setEnableEdit ( $a_enableedit )

Set EnableEdit.

Parameters

boolean $a_enableedit EnableEdit

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

Referenced by ilObjectGUI\setColumnSettings().

     {
         $this->enableedit = $a_enableedit;
     }

Here is the caller graph for this function:

◆ setRepositoryItems()

ilColumnGUI::setRepositoryItems ( $a_repositoryitems )

Set Repository Items.

Parameters

array $a_repositoryitems Repository Items

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

Referenced by ilContainerGUI\setColumnSettings().

     {
         $this->repositoryitems = $a_repositoryitems;
     }

Here is the caller graph for this function:

◆ setRepositoryMode()

ilColumnGUI::setRepositoryMode ( $a_repositorymode )

Set RepositoryMode.

Parameters

boolean $a_repositorymode RepositoryMode

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

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

     {
         $this->repositorymode = $a_repositorymode;
     }

Here is the caller graph for this function:

◆ setSide()

ilColumnGUI::setSide ( $a_side )

Set Side IL_COL_LEFT | IL_COL_RIGHT.

Parameters

string $a_side Side IL_COL_LEFT | IL_COL_RIGHT

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

Referenced by __construct().

     {
         $this->side = $a_side;
     }

Here is the caller graph for this function:

◆ showBlocks()

ilColumnGUI::showBlocks ( )

Show blocks.

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

References $ctrl, $i, $ilCtrl, $ilUser, $lng, $user, ilBlockSetting\_lookupDetailLevel(), exceededLimit(), getAdminCommands(), getColType(), getEnableEdit(), getRepositoryMode(), getSide(), IL_COL_RIGHT, and isGloballyActivated().

Referenced by getHTML().

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $ilUser = $this->user;
 
         $i = 1;
         $sum_moveable = count($this->blocks[$this->getSide()]);
 
         foreach ($this->blocks[$this->getSide()] as $block) {
             if ($ilCtrl->getContextObjType() != "user" ||
                 ilBlockSetting::_lookupDetailLevel(
                     $block["type"],
                     $ilUser->getId(),
                     $block["id"]
                 ) > 0) {
                 $gui_class = $block["class"];
                 $block_class = substr($block["class"], 0, strlen($block["class"]) - 3);
                 
                 // get block gui class
                 include_once("./" . self::$locations[$gui_class] . "classes/" .
                     "class." . $gui_class . ".php");
                 $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)) {
                         include_once($path);
                         $app_block = new $block_class($block["id"]);
                     } else {
                         // we only need generic block
                         $app_block = new ilCustomBlock($block["id"]);
                     }
                     $block_gui->setBlock($app_block);
                     if (isset($block["ref_id"])) {
                         $block_gui->setRefId($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", "");
                 }
                 
                 // count (moveable) blocks
                 if ($block["type"] != "pdfeedb" &&
                     $block["type"] != "news") {
                     $i++;
                 } else {
                     $sum_moveable--;
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateBlock()

ilColumnGUI::updateBlock ( )

Update Block (asynchronous)

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

References $_GET, $ctrl, $i, $ilCtrl, determineBlocks(), exit, getAdminCommands(), getEnableEdit(), getRepositoryMode(), and getSide().

     {
         $ilCtrl = $this->ctrl;
         
         $this->determineBlocks();
         $i = 1;
         $sum_moveable = count($this->blocks[$this->getSide()]);
 
         foreach ($this->blocks[$this->getSide()] as $block) {
             include_once("./" . self::$locations[$block["class"]] . "classes/" .
                 "class." . $block["class"] . ".php");
                 
             // 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 (is_int(strpos($_GET["block_id"], "block_".$block["type"]."_".$block["id"])))
 
             if ($_GET["block_id"] == "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"]) {
                     include_once("./" . self::$locations[$gui_class] . "classes/" .
                         "class." . $block_class . ".php");
                     $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 '" .
             $_GET["block_id"] . "' unknown.";
         exit;
     }

Here is the call graph for this function:

Field Documentation

◆ $action_menu

ilColumnGUI::$action_menu

protected

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

Referenced by getActionMenu(), and setActionMenu().

◆ $admincommands

ilColumnGUI::$admincommands = false

protected

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

Referenced by getAdminCommands().

◆ $block_property

ilColumnGUI::$block_property = array()

protected

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

◆ $block_types

ilColumnGUI::$block_types

staticprotected

Initial value:

= array(
        "ilPDMailBlockGUI" => "pdmail",
        "ilPDTasksBlockGUI" => "pdtasks",
        "ilPDNewsBlockGUI" => "pdnews",
        "ilNewsForContextBlockGUI" => "news",
        "ilCalendarBlockGUI" => "cal",
        "ilPDCalendarBlockGUI" => "pdcal",
        "ilExternalFeedBlockGUI" => "feed",
        "ilPDExternalFeedBlockGUI" => "pdfeed",
        "ilPDSelectedItemsBlockGUI" => "pditems",
        'ilPollBlockGUI' => 'poll',
        'ilClassificationBlockGUI' => 'clsfct',
        "ilPDStudyProgrammeSimpleListGUI" => "prgsimplelist",
        "ilPDStudyProgrammeExpandableListGUI" => "prgexpandablelist",
    )

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

◆ $browser

ilColumnGUI::$browser

protected

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

◆ $check_global_activation

ilColumnGUI::$check_global_activation

protected

Initial value:

=
        array("news" => true,
            "cal" => true,
            "pdcal" => true,
            "pdnews" => true,
            "pdtag" => true,
            "pdmail" => true,
            "pdtasks" => true,
            "tagcld" => true,
            "clsfct" => true)

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

◆ $check_nr_limit

ilColumnGUI::$check_nr_limit

protected

Initial value:

=

array("pdfeed" => true)

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

◆ $ctrl

ilColumnGUI::$ctrl

protected

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

Referenced by activateBlock(), addBlock(), determineBlocks(), exceededLimit(), executeCommand(), getHTML(), isGloballyActivated(), showBlocks(), and updateBlock().

◆ $custom_blocks

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 140 of file class.ilColumnGUI.php.

◆ $default_blocks

ilColumnGUI::$default_blocks

protected

Initial value:

= array(
        "cat" => array(
            "ilNewsForContextBlockGUI" => IL_COL_RIGHT,
            "ilClassificationBlockGUI" => IL_COL_RIGHT
            ),
        "crs" => array(
            "ilNewsForContextBlockGUI" => IL_COL_RIGHT,
            "ilCalendarBlockGUI" => IL_COL_RIGHT,
            "ilClassificationBlockGUI" => IL_COL_RIGHT
            ),
        "grp" => array(
            "ilNewsForContextBlockGUI" => IL_COL_RIGHT,
            "ilCalendarBlockGUI" => IL_COL_RIGHT,
            "ilClassificationBlockGUI" => IL_COL_RIGHT
            ),
        "frm" => array("ilNewsForContextBlockGUI" => IL_COL_RIGHT),
        "root" => array(),
        "info" => array(
            "ilNewsForContextBlockGUI" => IL_COL_RIGHT),
        "pd" => array(
            "ilPDTasksBlockGUI" => IL_COL_RIGHT,
            "ilPDCalendarBlockGUI" => IL_COL_RIGHT,
            "ilPDNewsBlockGUI" => IL_COL_RIGHT,
            "ilPDStudyProgrammeSimpleListGUI" => IL_COL_CENTER,
            "ilPDStudyProgrammeExpandableListGUI" => IL_COL_CENTER,
            "ilPDSelectedItemsBlockGUI" => IL_COL_CENTER,
            "ilPDMailBlockGUI" => IL_COL_RIGHT
            )
        )

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

◆ $enableedit

ilColumnGUI::$enableedit = false

protected

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

Referenced by getEnableEdit().

◆ $lng

ilColumnGUI::$lng

protected

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

Referenced by showBlocks().

◆ $locations

ilColumnGUI::$locations

staticprotected

Initial value:

= array(
        "ilNewsForContextBlockGUI" => "Services/News/",
        "ilCalendarBlockGUI" => "Services/Calendar/",
        "ilPDCalendarBlockGUI" => "Services/Calendar/",
        "ilPDTasksBlockGUI" => "Services/Tasks/",
        "ilPDMailBlockGUI" => "Services/Mail/",
        "ilPDSelectedItemsBlockGUI" => "Services/Dashboard/ItemsBlock/",
        "ilPDNewsBlockGUI" => "Services/News/",
        "ilExternalFeedBlockGUI" => "Modules/ExternalFeed/",
        "ilPDExternalFeedBlockGUI" => "Services/Feeds/",
        'ilPollBlockGUI' => 'Modules/Poll/',
        'ilClassificationBlockGUI' => 'Services/Classification/',
        "ilPDStudyProgrammeSimpleListGUI" => "Modules/StudyProgramme/",
        "ilPDStudyProgrammeExpandableListGUI" => "Modules/StudyProgramme/",
    )

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

◆ $rep_block_types

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

protected

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

◆ $repositoryitems

ilColumnGUI::$repositoryitems = array()

protected

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

Referenced by getRepositoryItems().

◆ $repositorymode

ilColumnGUI::$repositorymode = false

protected

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

Referenced by getRepositoryMode().

◆ $settings

ilColumnGUI::$settings

protected

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

Referenced by determineBlocks(), exceededLimit(), and isGloballyActivated().

◆ $side

ilColumnGUI::$side = IL_COL_RIGHT

protected

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

Referenced by determineBlocks(), exceededLimit(), and getSide().

◆ $tpl

ilColumnGUI::$tpl

protected

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

◆ $type

ilColumnGUI::$type

protected

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

Referenced by determineBlocks().

◆ $user

ilColumnGUI::$user

protected

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

Referenced by activateBlock(), determineBlocks(), exceededLimit(), and showBlocks().

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

Services/Block/classes/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()

◆ addBlock()

◆ addCustomBlockLocation()

◆ addCustomBlockType()

◆ determineBlocks()

◆ exceededLimit()

◆ executeCommand()

◆ getActionMenu()

◆ getAdminCommands()

◆ getBlockProperties()

◆ getCmdSide()

◆ getColType()

◆ getEnableEdit()

◆ getHTML()

◆ getRepositoryItems()

◆ getRepositoryMode()

◆ getScreenMode()

◆ getSide()

◆ isGloballyActivated()

◆ setActionMenu()

◆ setAdminCommands()

◆ setAllBlockProperties()

◆ setBlockProperty()

◆ setColType()

◆ setEnableEdit()

◆ setRepositoryItems()

◆ setRepositoryMode()

◆ setSide()

◆ showBlocks()

◆ updateBlock()

Field Documentation

◆ $action_menu

◆ $admincommands

◆ $block_property

◆ $block_types

◆ $browser

◆ $check_global_activation

◆ $check_nr_limit

◆ $ctrl

◆ $custom_blocks

◆ $default_blocks

◆ $enableedit

◆ $lng

◆ $locations

◆ $rep_block_types

◆ $repositoryitems

◆ $repositorymode

◆ $settings

◆ $side

◆ $tpl

◆ $type

◆ $user