BlockGUI class for simle HTML content. More...

Inheritance diagram for ilHtmlBlockGUI:

Collaboration diagram for ilHtmlBlockGUI:

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

	getBlockType ()
	Get block type. More...

	setBlock ($a_block)

&	executeCommand ()
	execute command More...

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

	fillDataSection ()
	Fill data section. More...

	create ()
	Create Form for Block. More...

	prepareSaveHtmlBlock (&$a_html_block)
	FORM HtmlBlock: Prepare Saving of HtmlBlock. More...

	saveHtmlBlock ()
	FORM HtmlBlock: Save HtmlBlock. More...

	cancelSaveHtmlBlock ()
	Cancel Saving. More...

Public Member Functions inherited from ilHtmlBlockGUIGen
	__construct ()
	Constructor. More...

&	executeCommand ()
	Execute command. More...

	setFormEditMode ($a_form_edit_mode)
	Set FormEditMode. More...

	getFormEditMode ()
	Get FormEditMode. More...

	outputFormHtmlBlock ()
	FORM HtmlBlock: Output form. More...

	editHtmlBlock ()
	FORM HtmlBlock: Edit form. More...

	createHtmlBlock ()
	FORM HtmlBlock: Create HtmlBlock. More...

	saveHtmlBlock ()
	FORM HtmlBlock: Save HtmlBlock. More...

	updateHtmlBlock ()
	FORM HtmlBlock: Update HtmlBlock. More...

	getValuesHtmlBlock ()
	FORM HtmlBlock: Get current values for HtmlBlock form. More...

	checkInputHtmlBlock ()
	FORM HtmlBlock: Check input. More...

	prepareSaveHtmlBlock (&$a_html_block)
	FORM HtmlBlock: Prepare Saving of HtmlBlock. More...

	prepareFormHtmlBlock (&$a_form_gui)
	FORM HtmlBlock: Prepare form. More...

Public Member Functions inherited from ilBlockGUI
	ilBlockGUI ()
	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)
	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	getScreenMode ()
	Get Screen Mode for current command. More...

Static Public Member Functions inherited from ilBlockGUI
static	getBlockType ()

static	isRepositoryObject ()

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

Static Public Attributes
static	$block_type = "html"

Additional Inherited Members
Protected Member Functions inherited from ilBlockGUI
	fillRowColor ($a_placeholder="CSS_ROW")

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

Protected Attributes inherited from ilHtmlBlockGUIGen
	$form_edit_mode

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

Detailed Description

BlockGUI class for simle HTML content.

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

Version: $Id$

ilHtmlBlockGUI: ilColumnGUI

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

Member Function Documentation

◆ cancelSaveHtmlBlock()

ilHtmlBlockGUI::cancelSaveHtmlBlock ( )

Cancel Saving.

Definition at line 182 of file class.ilHtmlBlockGUI.php.

References $ilCtrl.

         {
                 global $ilCtrl;
 
                 $ilCtrl->returnToParent($this);
         }

◆ create()

ilHtmlBlockGUI::create ( )

Create Form for Block.

Definition at line 141 of file class.ilHtmlBlockGUI.php.

References ilHtmlBlockGUIGen\createHtmlBlock().

         {
                 return $this->createHtmlBlock();
         }

Here is the call graph for this function:

◆ executeCommand()

& ilHtmlBlockGUI::executeCommand ( )

execute command

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

References $cmd, and $ilCtrl.

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

◆ fillDataSection()

ilHtmlBlockGUI::fillDataSection ( )

Fill data section.

Definition at line 133 of file class.ilHtmlBlockGUI.php.

References ilBlockGUI\setDataSection().

         {
                 $this->setDataSection($this->html_block->getContent());
         }

Here is the call graph for this function:

◆ getBlockType()

ilHtmlBlockGUI::getBlockType ( )

Get block type.

Returns: string Block type.

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

Referenced by prepareSaveHtmlBlock().

         {
                 return self::$block_type;
         }

Here is the caller graph for this function:

◆ getHTML()

ilHtmlBlockGUI::getHTML ( )

Get block HTML code.

Definition at line 118 of file class.ilHtmlBlockGUI.php.

References $ilCtrl, $ilUser, $lng, and ilBlockGUI\getCurrentDetailLevel().

         {
                 global $ilCtrl, $lng, $ilUser;
 
                 if ($this->getCurrentDetailLevel() == 0)
                 {
                         return "";
                 }
 
                 return parent::getHTML();
         }

Here is the call graph for this function:

◆ getScreenMode()

static ilHtmlBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

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

References $ilCtrl, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

         {
                 global $ilCtrl;
                 
                 switch($ilCtrl->getCmd())
                 {
                         case "create":
                         case "edit":
                         case "saveHtmlBlock":
                         case "updateHtmlBlock":
                         case "editHtmlBlock":
                                 return IL_SCREEN_CENTER;
                                 break;
 
                         default:
                                 return IL_SCREEN_SIDE;
                                 break;
                 }
         }

◆ ilHtmlBlockGUI()

ilHtmlBlockGUI::ilHtmlBlockGUI ( )

Constructor.

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

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

         {
                 global $ilCtrl, $lng;
                 
                 parent::__construct();
                 parent::ilBlockGUI();
                 
                 //$this->setImage(ilUtil::getImagePath("icon_feed_s.png"));
 
                 $lng->loadLanguageModule("block_html");
 
                 $this->setLimit(99999);
                 $this->setAvailableDetailLevels(1, 0);
                 $this->setEnableNumInfo(false);
         }

Here is the call graph for this function:

◆ prepareSaveHtmlBlock()

ilHtmlBlockGUI::prepareSaveHtmlBlock ( & $a_html_block )

FORM HtmlBlock: Prepare Saving of HtmlBlock.

Parameters

object $a_html_block HtmlBlock object.

Definition at line 151 of file class.ilHtmlBlockGUI.php.

References $ilCtrl, and getBlockType().

         {
                 global $ilCtrl;
                 
                 $a_html_block->setType($this->getBlockType());
                 $a_html_block->setContextObjId($ilCtrl->getContextObjId());
                 $a_html_block->setContextObjType($ilCtrl->getContextObjType());
         }

Here is the call graph for this function:

◆ saveHtmlBlock()

ilHtmlBlockGUI::saveHtmlBlock ( )

FORM HtmlBlock: Save HtmlBlock.

Definition at line 164 of file class.ilHtmlBlockGUI.php.

References $ilCtrl, and ilHtmlBlockGUIGen\checkInputHtmlBlock().

         {
                 global $ilCtrl;
 
                 if ($this->checkInputHtmlBlock())
                 {
                         parent::saveHtmlBlock();
                         $ilCtrl->returnToParent($this);
                 }
                 else
                 {
                         return parent::saveHtmlBlock();
                 }
         }

Here is the call graph for this function:

◆ setBlock()

ilHtmlBlockGUI::setBlock ( $a_block )

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

References ilBlockGUI\setBlockId(), and ilBlockGUI\setTitle().

         {
                 $this->html_block = $a_block;
                 $this->setTitle($this->html_block->getTitle());
                 $this->setBlockId($this->html_block->getId());
         }

Here is the call graph for this function:

Field Documentation

◆ $block_type

ilHtmlBlockGUI::$block_type = "html"

static

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

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

Services/Block/classes/class.ilHtmlBlockGUI.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ cancelSaveHtmlBlock()

◆ create()

◆ executeCommand()

◆ fillDataSection()

◆ getBlockType()

◆ getHTML()

◆ getScreenMode()

◆ ilHtmlBlockGUI()

◆ prepareSaveHtmlBlock()

◆ saveHtmlBlock()

◆ setBlock()

Field Documentation

◆ $block_type