BlockGUI class for simle HTML content. More...

Inheritance diagram for ilHtmlBlockGUI:

Collaboration diagram for ilHtmlBlockGUI:

Public Member Functions
	ilHtmlBlockGUI ()
	Constructor.
	getBlockType ()
	Get block type.
	setBlock ($a_block)
&	executeCommand ()
	execute command
	getHTML ()
	Get block HTML code.
	fillDataSection ()
	Fill data section.
	create ()
	Create Form for Block.
	prepareSaveHtmlBlock (&$a_html_block)
	FORM HtmlBlock: Prepare Saving of HtmlBlock.
	saveHtmlBlock ()
	FORM HtmlBlock: Save HtmlBlock.
	cancelSaveHtmlBlock ()
	Cancel Saving.
Public Member Functions inherited from ilHtmlBlockGUIGen
	__construct ()
	Constructor.
	setFormEditMode ($a_form_edit_mode)
	Set FormEditMode.
	getFormEditMode ()
	Get FormEditMode.
	outputFormHtmlBlock ()
	FORM HtmlBlock: Output form.
	editHtmlBlock ()
	FORM HtmlBlock: Edit form.
	createHtmlBlock ()
	FORM HtmlBlock: Create HtmlBlock.
	updateHtmlBlock ()
	FORM HtmlBlock: Update HtmlBlock.
	getValuesHtmlBlock ()
	FORM HtmlBlock: Get current values for HtmlBlock form.
	checkInputHtmlBlock ()
	FORM HtmlBlock: Check input.
	prepareFormHtmlBlock (&$a_form_gui)
	FORM HtmlBlock: Prepare form.
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	getScreenMode ()
	Get Screen Mode for current command.

Static Public Attributes
static	$block_type = "html"

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

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

ilHtmlBlockGUI::cancelSaveHtmlBlock ( )

Cancel Saving.

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

References $ilCtrl.

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

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:

& ilHtmlBlockGUI::executeCommand ( )

execute command

Reimplemented from ilHtmlBlockGUIGen.

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();
                }
        }

ilHtmlBlockGUI::fillDataSection ( )

Fill data section.

Reimplemented from ilBlockGUI.

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:

ilHtmlBlockGUI::getBlockType ( )

Get block type.

Returns: string Block type.

Reimplemented from ilBlockGUI.

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

References $block_type.

Referenced by prepareSaveHtmlBlock().

        {
                return self::$block_type;
        }

Here is the caller graph for this function:

ilHtmlBlockGUI::getHTML ( )

Get block HTML code.

Reimplemented from ilBlockGUI.

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

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

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

Here is the call graph for this function:

static ilHtmlBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

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 ( )

Constructor.

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

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

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

Here is the call graph for this function:

ilHtmlBlockGUI::prepareSaveHtmlBlock ( & $a_html_block )

FORM HtmlBlock: Prepare Saving of HtmlBlock.

Parameters

object $a_html_block HtmlBlock object.

Reimplemented from ilHtmlBlockGUIGen.

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:

ilHtmlBlockGUI::saveHtmlBlock ( )

FORM HtmlBlock: Save HtmlBlock.

Reimplemented from ilHtmlBlockGUIGen.

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:

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

ilHtmlBlockGUI::$block_type = "html"

static

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

Referenced by getBlockType().

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

Field Documentation