BlockGUI class for dummy block. More...

Inheritance diagram for ilDummyBlockGUI:

Collaboration diagram for ilDummyBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	getBlockType ()

	setBlock ($a_block)
	Do most of the initialisation. More...

	executeCommand ()
	execute command More...

	fillDataSection ()
	Fill data section. More...

	getHTML ()
	Get block HTML code. More...

Public Member Functions inherited from ilBlockGUI
	getBlockType ()

	__construct ()
	Constructor. More...

	addHeaderLink ($a_href, $a_text, $status=true)

	getHeaderLinks ()

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

	getData ()
	Get Data. More...

	setBigMode ($a_bigmode)
	Set Big Mode. More...

	getBigMode ()
	Get Big Mode. More...

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

	getBlockId ()
	Get Block Id. More...

	setAvailableDetailLevels ($a_max, $a_min=0)
	Set Available Detail Levels. More...

	setCurrentDetailLevel ($a_currentdetaillevel)
	Set Current Detail Level. More...

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

	getGuiObject ()
	Get GuiObject. More...

	getCurrentDetailLevel ()
	Get Current Detail Level. More...

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

	getTitle ()
	Get Title. More...

	setImage ($a_image)
	Set Image. More...

	getImage ()
	Get Image. 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...

	setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
	Set Footer Info. More...

	getFooterInfo ($a_hide_and_icon=false)
	Get Footer Info. 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 ($a_admincommands)
	Set Administration Commmands. More...

	getAdminCommands ()
	Get Administration Commmands. More...

	setColSpan ($a_colspan)
	Set Columns Span. More...

	getColSpan ()
	Get Columns Span. More...

	setEnableDetailRow ($a_enabledetailrow)
	Set EnableDetailRow. More...

	getEnableDetailRow ()
	Get EnableDetailRow. 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 ()

	getDetailParameter ()

	getConfigParameter ()

	getMoveParameter ()

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

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

	addBlockCommand ( $a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false, $a_html="")
	Add Block Command. More...

	getBlockCommands ()
	Get Block commands. More...

	addHeaderCommand ($a_href, $a_text, $a_as_close=false)
	Add Header Block Command. More...

	getHeaderCommands ()
	Get Header Block commands. More...

	addFooterLink ( $a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false, $a_checked=false)
	Add a footer text/link. More...

	getFooterLinks ()
	Get footer links. More...

	clearFooterLinks ()
	Clear footer links. More...

	handleDetailLevel ()
	Handle read/write current detail level. More...

	getHTML ()
	Handle config status. 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...

	fillFooterLinks ($a_top=false, $a_numinfo="")
	Fill footer links. More...

	fillDetailRow ()
	Fill Detail Setting Row. More...

Static Public Member Functions
static	setBlockType ($a_type)
	Set block type. More...

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

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

Static Public Attributes
static	$block_type = ""

Protected Member Functions
	isRepositoryObject ()

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

	fillRowColor ($a_placeholder="CSS_ROW")

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

Protected Attributes
	$settings

Protected Attributes inherited from ilBlockGUI
	$data = array()

	$colspan = 1

	$enablenuminfo = true

	$detail_min = 0

	$detail_max = 0

	$bigmode = false

	$footer_links = array()

	$block_id = 0

	$header_commands = array()

	$allow_moving = true

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

	$enabledetailrow = true

	$header_links = array()

	$footerinfo = false

	$footerinfo_icon = false

	$block_commands = array()

	$max_count = false

	$close_command = false

	$image = false

	$property = false

	$nav_value = ""

	$css_row = ""

	$dropdown

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

Detailed Description

BlockGUI class for dummy block.

Only used for moving, if block is not visible

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

Version: $Id$

ilDummyBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilDummyBlockGUI::__construct ( )

Constructor.

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

References $DIC, ilBlockGUI\setLimit(), settings(), and user().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->access = $DIC->access();
         $this->settings = $DIC->settings();
 
         parent::__construct();
         
         $this->setLimit(5);
         $this->allow_moving = true;
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilDummyBlockGUI::executeCommand ( )

execute command

Definition at line 112 of file class.ilDummyBlockGUI.php.

References ilBlockGUI\$ctrl, and $ilCtrl.

     {
         $ilCtrl = $this->ctrl;
 
         $next_class = $ilCtrl->getNextClass();
         $cmd = $ilCtrl->getCmd("getHTML");
 
         switch ($next_class) {
             default:
                 return $this->$cmd();
         }
     }

◆ fillDataSection()

ilDummyBlockGUI::fillDataSection ( )

Fill data section.

Definition at line 128 of file class.ilDummyBlockGUI.php.

References ilBlockGUI\$lng, and ilBlockGUI\setDataSection().

     {
         $lng = $this->lng;
 
         $this->setDataSection($lng->txt("invisible_block_mess"));
     }

Here is the call graph for this function:

◆ getBlockType()

ilDummyBlockGUI::getBlockType ( )

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

                                    : string
     {
         return self::$block_type;
     }

◆ getHTML()

ilDummyBlockGUI::getHTML ( )

Get block HTML code.

Definition at line 138 of file class.ilDummyBlockGUI.php.

References ilBlockGUI\$access, ilBlockGUI\$ctrl, $ilCtrl, $ilSetting, $ilUser, ilBlockGUI\$lng, $settings, and ilBlockGUI\$user.

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $ilUser = $this->user;
         $ilAccess = $this->access;
         $ilSetting = $this->settings;
         
         return parent::getHTML();
     }

◆ getScreenMode()

static ilDummyBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

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

References $DIC, $ilCtrl, and IL_SCREEN_SIDE.

     {
         global $DIC;
 
         $ilCtrl = $DIC->ctrl();
         
         return IL_SCREEN_SIDE;
     }

◆ isRepositoryObject()

ilDummyBlockGUI::isRepositoryObject ( )

protected

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

                                             : bool
     {
         return false;
     }

◆ setBlock()

ilDummyBlockGUI::setBlock ( $a_block )

Do most of the initialisation.

Definition at line 105 of file class.ilDummyBlockGUI.php.

106 {

107 }

◆ setBlockType()

static ilDummyBlockGUI::setBlockType ( $a_type )

static

Set block type.

Returns: string Block type.

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

References $a_type.

     {
         self::$block_type = $a_type;
     }

Field Documentation

◆ $block_type

ilDummyBlockGUI::$block_type = ""

static

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

◆ $settings

ilDummyBlockGUI::$settings

protected

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

Referenced by getHTML().

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

Services/Block/classes/class.ilDummyBlockGUI.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ fillDataSection()

◆ getBlockType()

◆ getHTML()

◆ getScreenMode()

◆ isRepositoryObject()

◆ setBlock()

◆ setBlockType()

Field Documentation

◆ $block_type

◆ $settings