GUI class for HTML Block. More...
Inheritance diagram for ilHtmlBlockGUIGen:
Collaboration diagram for ilHtmlBlockGUIGen:
Public Member Functions | |
| __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... | |
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() | |
| $footerinfo = false | |
| $footerinfo_icon = false | |
| $block_commands = array() | |
| $max_count = false | |
| $close_command = false | |
| $image = false | |
| $property = false | |
| $nav_value = "" | |
| $css_row = "" | |
| $dropdown | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ilBlockGUI | |
| static | getBlockType () |
| static | isRepositoryObject () |
| static | getScreenMode () |
| Get Screen Mode for current command. More... | |
| Protected Member Functions inherited from ilBlockGUI | |
| fillRowColor ($a_placeholder="CSS_ROW") | |
| preloadData (array $data) | |
| Can be overwritten in subclasses. More... | |
Detailed Description
Constructor & Destructor Documentation
◆ __construct()
| ilHtmlBlockGUIGen::__construct | ( | ) |
Constructor.
Definition at line 45 of file class.ilHtmlBlockGUIGen.php.
References $_GET, and $ilCtrl.
Member Function Documentation
◆ checkInputHtmlBlock()
| 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().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ createHtmlBlock()
| 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().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ editHtmlBlock()
| ilHtmlBlockGUIGen::editHtmlBlock | ( | ) |
FORM HtmlBlock: Edit form.
Definition at line 168 of file class.ilHtmlBlockGUIGen.php.
References IL_FORM_EDIT, outputFormHtmlBlock(), and setFormEditMode().
Here is the call graph for this function:
◆ executeCommand()
| & ilHtmlBlockGUIGen::executeCommand | ( | ) |
◆ getFormEditMode()
| 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().
Here is the caller graph for this function:
◆ getValuesHtmlBlock()
| 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().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ outputFormHtmlBlock()
| 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().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ prepareFormHtmlBlock()
| 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:
◆ prepareSaveHtmlBlock()
| ilHtmlBlockGUIGen::prepareSaveHtmlBlock | ( | & | $a_html_block | ) |
FORM HtmlBlock: Prepare Saving of HtmlBlock.
- Parameters
-
object $a_html_block HtmlBlock object.
Definition at line 297 of file class.ilHtmlBlockGUIGen.php.
Referenced by saveHtmlBlock().
Here is the caller graph for this function:
◆ saveHtmlBlock()
| ilHtmlBlockGUIGen::saveHtmlBlock | ( | ) |
FORM HtmlBlock: Save HtmlBlock.
Definition at line 190 of file class.ilHtmlBlockGUIGen.php.
References $_POST, ilObjAdvancedEditing\_getUsedHTMLTagsAsString(), checkInputHtmlBlock(), IL_FORM_RE_CREATE, outputFormHtmlBlock(), prepareSaveHtmlBlock(), setFormEditMode(), and ilUtil\stripSlashes().
Here is the call graph for this function:
◆ setFormEditMode()
| 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().
Here is the caller graph for this function:
◆ updateHtmlBlock()
| 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().
Here is the call graph for this function:
Field Documentation
◆ $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
