ilDummyBlockGUI Class Reference

BlockGUI class for dummy block. More...

Inheritance diagram for ilDummyBlockGUI:

Collaboration diagram for ilDummyBlockGUI:

Public Member Functions
	ilDummyBlockGUI ()
	Constructor.
	setBlock ($a_block)
	Do most of the initialisation.
&	executeCommand ()
	execute command
	fillDataSection ()
	Fill data section.
	getHTML ()
	Get block HTML code.
Public Member Functions inherited from ilBlockGUI
	ilBlockGUI ()
	Constructor.
	addHeaderLink ($a_href, $a_text, $status=true)
	getHeaderLinks ()
	setData ($a_data)
	Set Data.
	getData ()
	Get Data.
	setBigMode ($a_bigmode)
	Set Big Mode.
	getBigMode ()
	Get Big Mode.
	setBlockId ($a_block_id=0)
	Set Block Id.
	getBlockId ()
	Get Block Id.
	setAvailableDetailLevels ($a_max, $a_min=0)
	Set Available Detail Levels.
	setCurrentDetailLevel ($a_currentdetaillevel)
	Set Current Detail Level.
	setGuiObject (&$a_gui_object)
	Set GuiObject.
	getGuiObject ()
	Get GuiObject.
	getCurrentDetailLevel ()
	Get Current Detail Level.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setImage ($a_image)
	Set Image.
	getImage ()
	Get Image.
	setOffset ($a_offset)
	Set Offset.
	getOffset ()
	Get Offset.
	correctOffset ()
	setLimit ($a_limit)
	Set Limit.
	getLimit ()
	Get Limit.
	setEnableEdit ($a_enableedit)
	Set EnableEdit.
	getEnableEdit ()
	Get EnableEdit.
	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode.
	getRepositoryMode ()
	Get RepositoryMode.
	setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
	Set Footer Info.
	getFooterInfo ($a_hide_and_icon=false)
	Get Footer Info.
	setSubtitle ($a_subtitle)
	Set Subtitle.
	getSubtitle ()
	Get Subtitle.
	setRefId ($a_refid)
	Set Ref Id (only used if isRepositoryObject() is true).
	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true).
	setAdminCommands ($a_admincommands)
	Set Administration Commmands.
	getAdminCommands ()
	Get Administration Commmands.
	setColSpan ($a_colspan)
	Set Columns Span.
	getColSpan ()
	Get Columns Span.
	setEnableDetailRow ($a_enabledetailrow)
	Set EnableDetailRow.
	getEnableDetailRow ()
	Get EnableDetailRow.
	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info.
	getEnableNumInfo ()
	Get Enable Item Number Info.
	setProperties ($a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties.
	getProperty ($a_property)
	setProperty ($a_property, $a_value)
	setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
	Set Row Template Name.
	getNavParameter ()
	getDetailParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	Get Row Template Name.
	getRowTemplateDir ()
	Get Row Template Directory.
	addBlockCommand ($a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false)
	Add Block Command.
	getBlockCommands ()
	Get Block commands.
	addHeaderCommand ($a_href, $a_text, $a_as_close=false)
	Add Header Block Command.
	getHeaderCommands ()
	Get Header Block commands.
	addFooterLink ($a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false)
	Add a footer text/link.
	getFooterLinks ()
	Get footer links.
	clearFooterLinks ()
	Clear footer links.
	handleDetailLevel ()
	Handle read/write current detail level.
	setConfigMode ($a_configmode)
	Handle config status.
	getConfigMode ()
	Get Config Mode (move blocks).
	fillHeaderCommands ()
	Fill header commands block.
	fillHeaderTitleBlock ()
	Fill header title block (title and.
	setDataSection ($a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used.
	fillRow ($a_set)
	fillFooter ()
	fillPreviousNext ()
	Fill previous/next row.
	setPreviousNextLinks ()
	Get previous/next linkbar.
	fillFooterLinks ($a_top=false, $a_numinfo="")
	Fill footer links.
	fillDetailRow ()
	Fill Detail Setting Row.
	fillMoveRow ()
	Fill row for Moving.
	getAllowMove ($a_direction)
	setAllowMove ($a_direction, $a_allow=true)
	fillMoveLink ($a_value, $a_img, $a_txt)

Static Public Member Functions
static	getBlockType ()
	Get block type.
static	setBlockType ($a_type)
	Set block type.
static	isRepositoryObject ()
	Is this a repository object.
static	getScreenMode ()
	Get Screen Mode for current command.

Static Public Attributes
static	$block_type = ""

Additional Inherited Members
Protected Member Functions inherited from ilBlockGUI
	fillRowColor ($a_placeholder="CSS_ROW")
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()

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.

Member Function Documentation

& ilDummyBlockGUI::executeCommand

(

)

execute command

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

References $cmd, and $ilCtrl.

        {
                global $ilCtrl;

                $next_class = $ilCtrl->getNextClass();
                $cmd = $ilCtrl->getCmd("getHTML");

                switch ($next_class)
                {
                        default:
                                return $this->$cmd();
                }
        }

ilDummyBlockGUI::fillDataSection

(

)

Fill data section.

Reimplemented from ilBlockGUI.

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

References $lng, and ilBlockGUI\setDataSection().

        {
                global $lng;

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

Here is the call graph for this function:

static ilDummyBlockGUI::getBlockType ( )

static

Get block type.

Returns

string Block type.

Reimplemented from ilBlockGUI.

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

References $block_type.

        {
                return self::$block_type;
        }

ilDummyBlockGUI::getHTML

(

)

Get block HTML code.

Reimplemented from ilBlockGUI.

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

References $ilCtrl, $ilSetting, and $lng.

        {
                global $ilCtrl, $lng, $ilUser, $ilAccess, $ilSetting;
                
                return parent::getHTML();
        }

static ilDummyBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

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

References $ilCtrl, and IL_SCREEN_SIDE.

        {
                global $ilCtrl;
                
                return IL_SCREEN_SIDE;
        }

ilDummyBlockGUI::ilDummyBlockGUI

(

)

Constructor.

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

References $ilCtrl, $lng, and ilBlockGUI\setLimit().

        {
                global $ilCtrl, $lng;
                
                parent::__construct();
                
                $this->setLimit(5);
                $this->allow_moving = true;
        }

Here is the call graph for this function:

static ilDummyBlockGUI::isRepositoryObject ( )

static

Is this a repository object.

Returns

string Block type.

Reimplemented from ilBlockGUI.

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

        {
                return false;
        }

ilDummyBlockGUI::setBlock

(

$a_block

)

Do most of the initialisation.

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

        {
        }

static ilDummyBlockGUI::setBlockType (   $a_type )

static

Set block type.

Returns

string Block type.

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

        {
                self::$block_type = $a_type;
        }

Field Documentation

ilDummyBlockGUI::$block_type = ""

static

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

Referenced by getBlockType().

---

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

• Services/Block/classes/class.ilDummyBlockGUI.php