ilHtmlBlockGUIGen Class Reference

GUI class for HTML Block. More...

Inheritance diagram for ilHtmlBlockGUIGen:

Collaboration diagram for ilHtmlBlockGUIGen:

Public Member Functions
	__construct ()
	Constructor.
&	executeCommand ()
	Execute command.
	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.
	saveHtmlBlock ()
	FORM HtmlBlock: Save HtmlBlock.
	updateHtmlBlock ()
	FORM HtmlBlock: Update HtmlBlock.
	getValuesHtmlBlock ()
	FORM HtmlBlock: Get current values for HtmlBlock form.
	checkInputHtmlBlock ()
	FORM HtmlBlock: Check input.
	prepareSaveHtmlBlock (&$a_html_block)
	FORM HtmlBlock: Prepare Saving of HtmlBlock.
	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).
	getHTML ()
	Get HTML.
	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.
	fillDataSection ()
	Standard implementation for row based data.
	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)

Protected Attributes
	$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()

Additional Inherited Members
Static Public Member Functions inherited from ilBlockGUI
static	getBlockType ()
static	isRepositoryObject ()
static	getScreenMode ()
	Get Screen Mode for current command.
Protected Member Functions inherited from ilBlockGUI
	fillRowColor ($a_placeholder="CSS_ROW")

Detailed Description

GUI class for HTML Block.

Author

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

Version

$Id$

Definition at line 36 of file class.ilHtmlBlockGUIGen.php.

Constructor & Destructor Documentation

ilHtmlBlockGUIGen::__construct

(

)

Constructor.

Definition at line 45 of file class.ilHtmlBlockGUIGen.php.

References $_GET, and $ilCtrl.

Referenced by ilHtmlBlockGUI\ilHtmlBlockGUI().

        {
                global $ilCtrl;
                
                $this->ctrl = $ilCtrl;
                
                
                include_once("Services/Block/classes/class.ilHtmlBlock.php");
                if ($_GET["html_block_id"] > 0)
                {
                        $this->html_block = new ilHtmlBlock($_GET["html_block_id"]);
                }
                
                $this->ctrl->saveParameter($this, array("html_block_id"));
                

        }

Here is the caller graph for this function:

Member Function Documentation

ilHtmlBlockGUIGen::checkInputHtmlBlock

(

)

FORM HtmlBlock: Check input.

Definition at line 269 of file class.ilHtmlBlockGUIGen.php.

References $_POST, and ilTypeCheck\check().

Referenced by ilHtmlBlockGUI\saveHtmlBlock(), saveHtmlBlock(), and updateHtmlBlock().

        {
                
                include_once("./Services/Utilities/classes/class.ilTypeCheck.php");
                $ilTypeCheck = new ilTypeCheck();
                
                $this->form_check["HtmlBlock"] = array();
                $this->form_check["HtmlBlock"]["Title"] =
                        ilTypeCheck::check("varchar", $_POST["block_title"], true);
                $this->form_check["HtmlBlock"]["Content"] =
                        ilTypeCheck::check("text", $_POST["block_content"], false);
                
                foreach($this->form_check["HtmlBlock"] as $prop_check)
                {
                        if (!$prop_check["ok"])
                        {
                                return false;
                        }
                }
                return true;

        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilHtmlBlockGUIGen::createHtmlBlock

(

)

FORM HtmlBlock: Create HtmlBlock.

Definition at line 179 of file class.ilHtmlBlockGUIGen.php.

References IL_FORM_CREATE, outputFormHtmlBlock(), and setFormEditMode().

Referenced by ilHtmlBlockGUI\create().

        {
                $this->setFormEditMode(IL_FORM_CREATE);
                return $this->outputFormHtmlBlock();

        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilHtmlBlockGUIGen::editHtmlBlock

(

)

FORM HtmlBlock: Edit form.

Definition at line 168 of file class.ilHtmlBlockGUIGen.php.

References IL_FORM_EDIT, outputFormHtmlBlock(), and setFormEditMode().

        {
                $this->setFormEditMode(IL_FORM_EDIT);
                return $this->outputFormHtmlBlock();

        }

Here is the call graph for this function:

& ilHtmlBlockGUIGen::executeCommand

(

)

Execute command.

Reimplemented in ilHtmlBlockGUI.

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

References $cmd, and $ilCtrl.

        {
                global $ilCtrl;
                
                // get next class and command
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();
                
                switch ($next_class)
                {
                        default:
                                $html = $this->$cmd();
                                break;
                }
                
                return $html;

        }

ilHtmlBlockGUIGen::getFormEditMode

(

)

Get FormEditMode.

Returns

int Form Edit Mode (IL_FORM_EDIT | IL_FORM_CREATE | IL_FORM_RE_EDIT | IL_FORM_RE_CREATE)

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

References $form_edit_mode.

Referenced by getValuesHtmlBlock(), and outputFormHtmlBlock().

        {
                return $this->form_edit_mode;
        }

Here is the caller graph for this function:

ilHtmlBlockGUIGen::getValuesHtmlBlock

(

)

FORM HtmlBlock: Get current values for HtmlBlock form.

Definition at line 237 of file class.ilHtmlBlockGUIGen.php.

References $_POST, ilObjAdvancedEditing\_getUsedHTMLTagsAsString(), getFormEditMode(), IL_FORM_CREATE, IL_FORM_EDIT, IL_FORM_RE_CREATE, IL_FORM_RE_EDIT, and ilUtil\stripSlashes().

Referenced by outputFormHtmlBlock().

        {
                $values = array();
                
                switch ($this->getFormEditMode())
                {
                        case IL_FORM_CREATE:
                                $values["Title"] = "";
                                $values["Content"] = "";
                                break;
                                
                        case IL_FORM_EDIT:
                                $values["Title"] = $this->html_block->getTitle();
                                $values["Content"] = $this->html_block->getContent();
                                break;
                                
                        case IL_FORM_RE_EDIT:
                        case IL_FORM_RE_CREATE:
                                $values["Title"] = ilUtil::stripSlashes($_POST["block_title"]);
                                $values["Content"] = ilUtil::stripSlashes($_POST["block_content"]
                                ,true, ilObjAdvancedEditing::_getUsedHTMLTagsAsString());
                                break;
                }
                
                return $values;

        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilHtmlBlockGUIGen::outputFormHtmlBlock

(

)

FORM HtmlBlock: Output form.

Definition at line 110 of file class.ilHtmlBlockGUIGen.php.

References $lng, getFormEditMode(), getValuesHtmlBlock(), IL_FORM_CREATE, IL_FORM_RE_CREATE, and prepareFormHtmlBlock().

Referenced by createHtmlBlock(), editHtmlBlock(), saveHtmlBlock(), and updateHtmlBlock().

        {
                global $lng;
                
                $lng->loadLanguageModule("block");
                
                include("Services/Form/classes/class.ilPropertyFormGUI.php");
                
                $form_gui = new ilPropertyFormGUI();
                
                $values = $this->getValuesHtmlBlock();
                
                // Property Title
                $alert = ($this->form_check["HtmlBlock"]["Title"]["error"] != "")
                        ? $this->form_check["HtmlBlock"]["Title"]["error"]
                        : "";
                $form_gui->addTextProperty($lng->txt("block_html_block_title"),
                        "block_title",
                        $values["Title"],
                        "", $alert, true
                        , "200");
                
                // Property Content
                $alert = ($this->form_check["HtmlBlock"]["Content"]["error"] != "")
                        ? $this->form_check["HtmlBlock"]["Content"]["error"]
                        : "";
                $form_gui->addTextAreaProperty($lng->txt("block_html_block_content"),
                        "block_content",
                        $values["Content"],
                        "", $alert, false
                        , "40", "8", true);
                
                // save and cancel commands
                if (in_array($this->getFormEditMode(), array(IL_FORM_CREATE,IL_FORM_RE_CREATE)))
                {
                        $form_gui->addCommandButton("saveHtmlBlock", $lng->txt("save"));
                        $form_gui->addCommandButton("cancelSaveHtmlBlock", $lng->txt("cancel"));
                }
                else
                {
                        $form_gui->addCommandButton("updateHtmlBlock", $lng->txt("save"));
                        $form_gui->addCommandButton("cancelUpdateHtmlBlock", $lng->txt("cancel"));
                }
                
                $form_gui->setTitle($lng->txt("block_html_block_head"));
                $form_gui->setFormAction($this->ctrl->getFormAction($this));
                
                // individual preparation of form
                $this->prepareFormHtmlBlock($form_gui);
                
                return $form_gui->getHTML();

        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilHtmlBlockGUIGen::prepareFormHtmlBlock

(

&

$a_form_gui

)

FORM HtmlBlock: Prepare form.

(Can be overwritten in derived classes)

Parameters

object

$a_form_gui

ilPropertyFormGUI instance.

Definition at line 307 of file class.ilHtmlBlockGUIGen.php.

Referenced by outputFormHtmlBlock().

        {

        }

Here is the caller graph for this function:

ilHtmlBlockGUIGen::prepareSaveHtmlBlock

(

&

$a_html_block

)

FORM HtmlBlock: Prepare Saving of HtmlBlock.

Parameters

object

$a_html_block

HtmlBlock object.

Reimplemented in ilHtmlBlockGUI.

Definition at line 297 of file class.ilHtmlBlockGUIGen.php.

Referenced by saveHtmlBlock().

        {

        }

Here is the caller graph for this function:

ilHtmlBlockGUIGen::saveHtmlBlock

(

)

FORM HtmlBlock: Save HtmlBlock.

Reimplemented in ilHtmlBlockGUI.

Definition at line 190 of file class.ilHtmlBlockGUIGen.php.

References $_POST, ilObjAdvancedEditing\_getUsedHTMLTagsAsString(), checkInputHtmlBlock(), IL_FORM_RE_CREATE, outputFormHtmlBlock(), prepareSaveHtmlBlock(), setFormEditMode(), and ilUtil\stripSlashes().

        {
                include_once("./Services/AdvancedEditing/classes/class.ilObjAdvancedEditing.php");
                if ($this->checkInputHtmlBlock())
                {
                        $this->html_block = new ilHtmlBlock();
                        $this->html_block->setTitle(ilUtil::stripSlashes($_POST["block_title"]));
                        $this->html_block->setContent(ilUtil::stripSlashes($_POST["block_content"]
                                ,true, ilObjAdvancedEditing::_getUsedHTMLTagsAsString()));
                        $this->prepareSaveHtmlBlock($this->html_block);
                        $this->html_block->create();
                }
                else
                {
                        $this->setFormEditMode(IL_FORM_RE_CREATE);
                        return $this->outputFormHtmlBlock();
                }

        }

Here is the call graph for this function:

ilHtmlBlockGUIGen::setFormEditMode

(

$a_form_edit_mode

)

Set FormEditMode.

Parameters

int

$a_form_edit_mode

Form Edit Mode (IL_FORM_EDIT | IL_FORM_CREATE | IL_FORM_RE_EDIT | IL_FORM_RE_CREATE)

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

Referenced by createHtmlBlock(), editHtmlBlock(), saveHtmlBlock(), and updateHtmlBlock().

        {
                $this->form_edit_mode = $a_form_edit_mode;
        }

Here is the caller graph for this function:

ilHtmlBlockGUIGen::updateHtmlBlock

(

)

FORM HtmlBlock: Update HtmlBlock.

Definition at line 214 of file class.ilHtmlBlockGUIGen.php.

References $_POST, ilObjAdvancedEditing\_getUsedHTMLTagsAsString(), checkInputHtmlBlock(), IL_FORM_RE_EDIT, outputFormHtmlBlock(), setFormEditMode(), and ilUtil\stripSlashes().

        {
                include_once("./classes/class.ilObjAdvancedEditing.php");
                if ($this->checkInputHtmlBlock())
                {
                        
                        $this->html_block->setTitle(ilUtil::stripSlashes($_POST["block_title"]));
                        $this->html_block->setContent(ilUtil::stripSlashes($_POST["block_content"]
                                ,true, ilObjAdvancedEditing::_getUsedHTMLTagsAsString()));
                        $this->html_block->update();
                }
                else
                {
                        $this->setFormEditMode(IL_FORM_RE_EDIT);
                        return $this->outputFormHtmlBlock();
                }

        }

Here is the call graph for this function:

Field Documentation

ilHtmlBlockGUIGen::$form_edit_mode

protected

Definition at line 39 of file class.ilHtmlBlockGUIGen.php.

Referenced by getFormEditMode().

---

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

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