ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilExternalFeedBlockGUIGen Class Reference

GUI class for external news feed custom block. More...

+ Inheritance diagram for ilExternalFeedBlockGUIGen:
+ Collaboration diagram for ilExternalFeedBlockGUIGen:

Public Member Functions

 __construct ()
 Constructor. More...
 
executeCommand ()
 Execute command. More...
 
 setGuiObject (&$a_gui_object)
 Set GuiObject. More...
 
 getGuiObject ()
 Get GuiObject. More...
 
 setFormEditMode ($a_form_edit_mode)
 Set FormEditMode. More...
 
 getFormEditMode ()
 Get FormEditMode. More...
 
 createFeedBlock ()
 FORM FeedBlock: Create ExternalFeedBlock. More...
 
 editFeedBlock ()
 FORM FeedBlock: Edit form. More...
 
 saveFeedBlock ()
 FORM FeedBlock: Save ExternalFeedBlock. More...
 
 updateFeedBlock ()
 FORM FeedBlock: Update ExternalFeedBlock. More...
 
 initFormFeedBlock ($a_mode)
 FORM FeedBlock: Init form. More...
 
 getValuesFeedBlock ()
 FORM FeedBlock: Get current values for ExternalFeedBlock form. More...
 
 cancelSaveFeedBlock ()
 FORM FeedBlock: Cancel save. More...
 
 cancelUpdateFeedBlock ()
 FORM FeedBlock: Cancel update. More...
 
 exitSaveFeedBlock ()
 FORM FeedBlock: Exit save. More...
 
 exitUpdateFeedBlock ()
 FORM FeedBlock: Exit update. More...
 
 prepareSaveFeedBlock (&$a_external_feed_block)
 FORM FeedBlock: Prepare Saving of ExternalFeedBlock. More...
 
 prepareFormFeedBlock (&$a_form_gui)
 FORM FeedBlock: 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, $a_html="")
 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

 $gui_object
 
 $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

GUI class for external news feed custom 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.ilExternalFeedBlockGUIGen.php.

Constructor & Destructor Documentation

◆ __construct()

ilExternalFeedBlockGUIGen::__construct ( )

Constructor.

Definition at line 46 of file class.ilExternalFeedBlockGUIGen.php.

47 {
48 global $ilCtrl;
49
50 $this->ctrl = $ilCtrl;
51
52
53 include_once("Services/Block/classes/class.ilExternalFeedBlock.php");
54 if (isset($_GET["external_feed_block_id"]) && $_GET["external_feed_block_id"] > 0)
55 {
56 $this->external_feed_block = new ilExternalFeedBlock($_GET["external_feed_block_id"]);
57 }
58
59 $this->ctrl->saveParameter($this, array("external_feed_block_id"));
60
61
62 }
$_GET["client_id"]
Custom block for external feeds.
global $ilCtrl
Definition: ilias.php:18

References $_GET, and $ilCtrl.

Member Function Documentation

◆ cancelSaveFeedBlock()

ilExternalFeedBlockGUIGen::cancelSaveFeedBlock ( )

FORM FeedBlock: Cancel save.

(Can be overwritten in derived classes)

Definition at line 266 of file class.ilExternalFeedBlockGUIGen.php.

267 {
268 global $ilCtrl;
269
270 $ilCtrl->returnToParent($this);
271 }

References $ilCtrl.

◆ cancelUpdateFeedBlock()

ilExternalFeedBlockGUIGen::cancelUpdateFeedBlock ( )

FORM FeedBlock: Cancel update.

(Can be overwritten in derived classes)

Reimplemented in ilExternalFeedBlockGUI.

Definition at line 277 of file class.ilExternalFeedBlockGUIGen.php.

278 {
279 global $ilCtrl;
280
281 $ilCtrl->returnToParent($this);
282 }

References $ilCtrl.

◆ createFeedBlock()

ilExternalFeedBlockGUIGen::createFeedBlock ( )

FORM FeedBlock: Create ExternalFeedBlock.

Definition at line 131 of file class.ilExternalFeedBlockGUIGen.php.

132 {
134 return $this->form_gui->getHtml();
135
136 }
initFormFeedBlock($a_mode)
FORM FeedBlock: Init form.

References IL_FORM_CREATE, and initFormFeedBlock().

Referenced by ilExternalFeedBlockGUI\create(), and ilPDExternalFeedBlockGUI\create().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ editFeedBlock()

ilExternalFeedBlockGUIGen::editFeedBlock ( )

FORM FeedBlock: Edit form.

Definition at line 142 of file class.ilExternalFeedBlockGUIGen.php.

143 {
145 $this->getValuesFeedBlock();
146 return $this->form_gui->getHtml();
147
148 }
getValuesFeedBlock()
FORM FeedBlock: Get current values for ExternalFeedBlock form.

References getValuesFeedBlock(), IL_FORM_EDIT, and initFormFeedBlock().

+ Here is the call graph for this function:

◆ executeCommand()

& ilExternalFeedBlockGUIGen::executeCommand ( )

Execute command.

Reimplemented in ilExternalFeedBlockGUI, and ilPDExternalFeedBlockGUI.

Definition at line 68 of file class.ilExternalFeedBlockGUIGen.php.

69 {
70 global $ilCtrl;
71
72 // get next class and command
73 $next_class = $this->ctrl->getNextClass($this);
74 $cmd = $this->ctrl->getCmd();
75
76 switch ($next_class)
77 {
78 default:
79 $html = $this->$cmd();
80 break;
81 }
82
83 return $html;
84
85 }
$html
Definition: example_001.php:87
$cmd
Definition: sahs_server.php:35

References $cmd, $html, and $ilCtrl.

◆ exitSaveFeedBlock()

ilExternalFeedBlockGUIGen::exitSaveFeedBlock ( )

FORM FeedBlock: Exit save.

(Can be overwritten in derived classes)

Reimplemented in ilExternalFeedBlockGUI.

Definition at line 288 of file class.ilExternalFeedBlockGUIGen.php.

289 {
290 global $ilCtrl;
291
292 $ilCtrl->returnToParent($this);
293 }

References $ilCtrl.

Referenced by saveFeedBlock().

+ Here is the caller graph for this function:

◆ exitUpdateFeedBlock()

ilExternalFeedBlockGUIGen::exitUpdateFeedBlock ( )

FORM FeedBlock: Exit update.

(Can be overwritten in derived classes)

Reimplemented in ilExternalFeedBlockGUI.

Definition at line 299 of file class.ilExternalFeedBlockGUIGen.php.

300 {
301 global $ilCtrl;
302
303 $ilCtrl->returnToParent($this);
304 }

References $ilCtrl.

Referenced by updateFeedBlock().

+ Here is the caller graph for this function:

◆ getFormEditMode()

ilExternalFeedBlockGUIGen::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 122 of file class.ilExternalFeedBlockGUIGen.php.

References $form_edit_mode.

◆ getGuiObject()

ilExternalFeedBlockGUIGen::getGuiObject ( )

Get GuiObject.

Returns
object GUI object

Reimplemented from ilBlockGUI.

Definition at line 102 of file class.ilExternalFeedBlockGUIGen.php.

References $gui_object.

Referenced by ilExternalFeedBlockGUI\cancelUpdateFeedBlock(), ilExternalFeedBlockGUI\exitSaveFeedBlock(), ilExternalFeedBlockGUI\exitUpdateFeedBlock(), and ilExternalFeedBlockGUI\prepareSaveFeedBlock().

+ Here is the caller graph for this function:

◆ getValuesFeedBlock()

ilExternalFeedBlockGUIGen::getValuesFeedBlock ( )

FORM FeedBlock: Get current values for ExternalFeedBlock form.

Definition at line 251 of file class.ilExternalFeedBlockGUIGen.php.

252 {
253 $values = array();
254
255 $values["block_title"] = $this->external_feed_block->getTitle();
256 $values["block_feed_url"] = $this->external_feed_block->getFeedUrl();
257
258 $this->form_gui->setValuesByArray($values);
259
260 }

Referenced by editFeedBlock().

+ Here is the caller graph for this function:

◆ initFormFeedBlock()

ilExternalFeedBlockGUIGen::initFormFeedBlock (   $a_mode)

FORM FeedBlock: Init form.

Parameters
int$a_modeForm Edit Mode (IL_FORM_EDIT | IL_FORM_CREATE)

Reimplemented in ilExternalFeedBlockGUI, and ilPDExternalFeedBlockGUI.

Definition at line 202 of file class.ilExternalFeedBlockGUIGen.php.

203 {
204 global $lng;
205
206 $lng->loadLanguageModule("block");
207
208 include("Services/Form/classes/class.ilPropertyFormGUI.php");
209
210 $this->form_gui = new ilPropertyFormGUI();
211
212
213 // Property Title
214 $text_input = new ilTextInputGUI($lng->txt("block_feed_block_title"), "block_title");
215 $text_input->setInfo("");
216 $text_input->setRequired(true);
217 $text_input->setMaxLength(200);
218 $this->form_gui->addItem($text_input);
219
220 // Property FeedUrl
221 $text_input = new ilTextInputGUI($lng->txt("block_feed_block_feed_url"), "block_feed_url");
222 $text_input->setInfo($lng->txt("block_feed_block_feed_url_info"));
223 $text_input->setRequired(true);
224 $text_input->setMaxLength(250);
225 $this->form_gui->addItem($text_input);
226
227
228 // save and cancel commands
229 if (in_array($a_mode, array(IL_FORM_CREATE,IL_FORM_RE_CREATE)))
230 {
231 $this->form_gui->addCommandButton("saveFeedBlock", $lng->txt("save"));
232 $this->form_gui->addCommandButton("cancelSaveFeedBlock", $lng->txt("cancel"));
233 }
234 else
235 {
236 $this->form_gui->addCommandButton("updateFeedBlock", $lng->txt("save"));
237 $this->form_gui->addCommandButton("cancelUpdateFeedBlock", $lng->txt("cancel"));
238 }
239
240 $this->form_gui->setTitle($lng->txt("block_feed_block_head"));
241 $this->form_gui->setFormAction($this->ctrl->getFormAction($this));
242
243 $this->prepareFormFeedBlock($this->form_gui);
244
245 }
prepareFormFeedBlock(&$a_form_gui)
FORM FeedBlock: Prepare form.
This class represents a property form user interface.
This class represents a text property in a property form.
global $lng
Definition: privfeed.php:40

References $lng, IL_FORM_CREATE, IL_FORM_RE_CREATE, and prepareFormFeedBlock().

Referenced by createFeedBlock(), editFeedBlock(), saveFeedBlock(), and updateFeedBlock().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ prepareFormFeedBlock()

ilExternalFeedBlockGUIGen::prepareFormFeedBlock ( $a_form_gui)

FORM FeedBlock: Prepare form.

(Can be overwritten in derived classes)

Parameters
object$a_form_guiilPropertyFormGUI instance.

Definition at line 321 of file class.ilExternalFeedBlockGUIGen.php.

322 {
323
324 }

Referenced by ilExternalFeedBlockGUI\initFormFeedBlock(), initFormFeedBlock(), and ilPDExternalFeedBlockGUI\initFormFeedBlock().

+ Here is the caller graph for this function:

◆ prepareSaveFeedBlock()

ilExternalFeedBlockGUIGen::prepareSaveFeedBlock ( $a_external_feed_block)

FORM FeedBlock: Prepare Saving of ExternalFeedBlock.

Parameters
object$a_external_feed_blockExternalFeedBlock object.

Reimplemented in ilExternalFeedBlockGUI, and ilPDExternalFeedBlockGUI.

Definition at line 311 of file class.ilExternalFeedBlockGUIGen.php.

312 {
313
314 }

Referenced by saveFeedBlock().

+ Here is the caller graph for this function:

◆ saveFeedBlock()

ilExternalFeedBlockGUIGen::saveFeedBlock ( )

FORM FeedBlock: Save ExternalFeedBlock.

Definition at line 154 of file class.ilExternalFeedBlockGUIGen.php.

155 {
157 if ($this->form_gui->checkInput())
158 {
159 $this->external_feed_block = new ilExternalFeedBlock();
160 $this->external_feed_block->setTitle($this->form_gui->getInput("block_title"));
161 $this->external_feed_block->setFeedUrl($this->form_gui->getInput("block_feed_url"));
162 $this->prepareSaveFeedBlock($this->external_feed_block);
163 $this->external_feed_block->create();
164 $this->exitSaveFeedBlock();
165 }
166 else
167 {
168 $this->form_gui->setValuesByPost();
169 return $this->form_gui->getHtml();
170 }
171
172 }
exitSaveFeedBlock()
FORM FeedBlock: Exit save.
prepareSaveFeedBlock(&$a_external_feed_block)
FORM FeedBlock: Prepare Saving of ExternalFeedBlock.

References exitSaveFeedBlock(), IL_FORM_CREATE, initFormFeedBlock(), and prepareSaveFeedBlock().

+ Here is the call graph for this function:

◆ setFormEditMode()

ilExternalFeedBlockGUIGen::setFormEditMode (   $a_form_edit_mode)

Set FormEditMode.

Parameters
int$a_form_edit_modeForm Edit Mode (IL_FORM_EDIT | IL_FORM_CREATE | IL_FORM_RE_EDIT | IL_FORM_RE_CREATE)

Definition at line 112 of file class.ilExternalFeedBlockGUIGen.php.

113 {
114 $this->form_edit_mode = $a_form_edit_mode;
115 }

◆ setGuiObject()

ilExternalFeedBlockGUIGen::setGuiObject ( $a_gui_object)

Set GuiObject.

Parameters
object$a_gui_objectGUI object

Reimplemented from ilBlockGUI.

Definition at line 92 of file class.ilExternalFeedBlockGUIGen.php.

93 {
94 $this->gui_object = $a_gui_object;
95 }

◆ updateFeedBlock()

ilExternalFeedBlockGUIGen::updateFeedBlock ( )

FORM FeedBlock: Update ExternalFeedBlock.

Definition at line 178 of file class.ilExternalFeedBlockGUIGen.php.

179 {
181 if ($this->form_gui->checkInput())
182 {
183
184 $this->external_feed_block->setTitle($this->form_gui->getInput("block_title"));
185 $this->external_feed_block->setFeedUrl($this->form_gui->getInput("block_feed_url"));
186 $this->external_feed_block->update();
187 $this->exitUpdateFeedBlock();
188 }
189 else
190 {
191 $this->form_gui->setValuesByPost();
192 return $this->form_gui->getHtml();
193 }
194
195 }
exitUpdateFeedBlock()
FORM FeedBlock: Exit update.

References exitUpdateFeedBlock(), IL_FORM_EDIT, and initFormFeedBlock().

+ Here is the call graph for this function:

Field Documentation

◆ $form_edit_mode

ilExternalFeedBlockGUIGen::$form_edit_mode
protected

Definition at line 40 of file class.ilExternalFeedBlockGUIGen.php.

Referenced by getFormEditMode().

◆ $gui_object

ilExternalFeedBlockGUIGen::$gui_object
protected

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

Referenced by getGuiObject().


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