Public Member Functions | Protected Attributes

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

Protected Attributes

 $gui_object
 $form_edit_mode

Detailed Description

GUI class for external news feed custom block.

Author:
Alex Killing <alex.killing@gmx.de>
Version:
$Id$

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

Constructor & Destructor Documentation

ilExternalFeedBlockGUIGen::__construct (  ) 

Constructor.

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

References $_GET, and $ilCtrl.

Referenced by ilExternalFeedBlockGUI::ilExternalFeedBlockGUI(), and ilPDExternalFeedBlockGUI::ilPDExternalFeedBlockGUI().

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

        }

Here is the caller graph for this function:

Member Function Documentation

ilExternalFeedBlockGUIGen::cancelSaveFeedBlock (  ) 

FORM FeedBlock: Cancel save.

(Can be overwritten in derived classes)

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

References $ilCtrl.

        {
                global $ilCtrl;

                $ilCtrl->returnToParent($this);
        }

ilExternalFeedBlockGUIGen::cancelUpdateFeedBlock (  ) 

FORM FeedBlock: Cancel update.

(Can be overwritten in derived classes)

Reimplemented in ilExternalFeedBlockGUI.

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

References $ilCtrl.

        {
                global $ilCtrl;

                $ilCtrl->returnToParent($this);
        }

ilExternalFeedBlockGUIGen::createFeedBlock (  ) 

FORM FeedBlock: Create ExternalFeedBlock.

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

References initFormFeedBlock().

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

        {
                $this->initFormFeedBlock(IL_FORM_CREATE);
                return $this->form_gui->getHtml();

        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilExternalFeedBlockGUIGen::editFeedBlock (  ) 

FORM FeedBlock: Edit form.

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

References getValuesFeedBlock(), and initFormFeedBlock().

        {
                $this->initFormFeedBlock(IL_FORM_EDIT);
                $this->getValuesFeedBlock();
                return $this->form_gui->getHtml();

        }

Here is the call graph for this function:

& ilExternalFeedBlockGUIGen::executeCommand (  ) 

Execute command.

Reimplemented in ilExternalFeedBlockGUI, and ilPDExternalFeedBlockGUI.

Definition at line 68 of file class.ilExternalFeedBlockGUIGen.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;

        }

ilExternalFeedBlockGUIGen::exitSaveFeedBlock (  ) 

FORM FeedBlock: Exit save.

(Can be overwritten in derived classes)

Reimplemented in ilExternalFeedBlockGUI.

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

References $ilCtrl.

Referenced by saveFeedBlock().

        {
                global $ilCtrl;

                $ilCtrl->returnToParent($this);
        }

Here is the caller graph for this function:

ilExternalFeedBlockGUIGen::exitUpdateFeedBlock (  ) 

FORM FeedBlock: Exit update.

(Can be overwritten in derived classes)

Reimplemented in ilExternalFeedBlockGUI.

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

References $ilCtrl.

Referenced by updateFeedBlock().

        {
                global $ilCtrl;

                $ilCtrl->returnToParent($this);
        }

Here is the caller graph for this function:

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.

        {
                return $this->form_edit_mode;
        }

ilExternalFeedBlockGUIGen::getGuiObject (  ) 

Get GuiObject.

Returns:
object GUI object

Reimplemented from ilBlockGUI.

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

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

        {
                return $this->gui_object;
        }

Here is the caller graph for this function:

ilExternalFeedBlockGUIGen::getValuesFeedBlock (  ) 

FORM FeedBlock: Get current values for ExternalFeedBlock form.

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

Referenced by editFeedBlock().

        {
                $values = array();
                
                $values["block_title"] = $this->external_feed_block->getTitle();
                $values["block_feed_url"] = $this->external_feed_block->getFeedUrl();
                
                $this->form_gui->setValuesByArray($values);

        }

Here is the caller graph for this function:

ilExternalFeedBlockGUIGen::initFormFeedBlock ( $  a_mode  ) 

FORM FeedBlock: Init form.

Parameters:
int $a_mode Form Edit Mode (IL_FORM_EDIT | IL_FORM_CREATE)

Reimplemented in ilExternalFeedBlockGUI, and ilPDExternalFeedBlockGUI.

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

References $lng, and prepareFormFeedBlock().

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

        {
                global $lng;
                
                $lng->loadLanguageModule("block");
                
                include("Services/Form/classes/class.ilPropertyFormGUI.php");
                
                $this->form_gui = new ilPropertyFormGUI();
                
                
                // Property Title
                $text_input = new ilTextInputGUI($lng->txt("block_feed_block_title"), "block_title");
                $text_input->setInfo("");
                $text_input->setRequired(true);
                $text_input->setMaxLength(200);
                $this->form_gui->addItem($text_input);
                
                // Property FeedUrl
                $text_input = new ilTextInputGUI($lng->txt("block_feed_block_feed_url"), "block_feed_url");
                $text_input->setInfo($lng->txt("block_feed_block_feed_url_info"));
                $text_input->setRequired(true);
                $text_input->setMaxLength(250);
                $this->form_gui->addItem($text_input);
                
                
                // save and cancel commands
                if (in_array($a_mode, array(IL_FORM_CREATE,IL_FORM_RE_CREATE)))
                {
                        $this->form_gui->addCommandButton("saveFeedBlock", $lng->txt("save"));
                        $this->form_gui->addCommandButton("cancelSaveFeedBlock", $lng->txt("cancel"));
                }
                else
                {
                        $this->form_gui->addCommandButton("updateFeedBlock", $lng->txt("save"));
                        $this->form_gui->addCommandButton("cancelUpdateFeedBlock", $lng->txt("cancel"));
                }
                
                $this->form_gui->setTitle($lng->txt("block_feed_block_head"));
                $this->form_gui->setFormAction($this->ctrl->getFormAction($this));
                
                $this->prepareFormFeedBlock($this->form_gui);

        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilExternalFeedBlockGUIGen::prepareFormFeedBlock ( &$  a_form_gui  ) 

FORM FeedBlock: Prepare form.

(Can be overwritten in derived classes)

Parameters:
object $a_form_gui ilPropertyFormGUI instance.

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

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

        {

        }

Here is the caller graph for this function:

ilExternalFeedBlockGUIGen::prepareSaveFeedBlock ( &$  a_external_feed_block  ) 

FORM FeedBlock: Prepare Saving of ExternalFeedBlock.

Parameters:
object $a_external_feed_block ExternalFeedBlock object.

Reimplemented in ilExternalFeedBlockGUI, and ilPDExternalFeedBlockGUI.

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

Referenced by saveFeedBlock().

        {

        }

Here is the caller graph for this function:

ilExternalFeedBlockGUIGen::saveFeedBlock (  ) 

FORM FeedBlock: Save ExternalFeedBlock.

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

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

        {
                $this->initFormFeedBlock(IL_FORM_CREATE);
                if ($this->form_gui->checkInput())
                {
                        $this->external_feed_block = new ilExternalFeedBlock();
                        $this->external_feed_block->setTitle($this->form_gui->getInput("block_title"));
                        $this->external_feed_block->setFeedUrl($this->form_gui->getInput("block_feed_url"));
                        $this->prepareSaveFeedBlock($this->external_feed_block);
                        $this->external_feed_block->create();
                        $this->exitSaveFeedBlock();
                }
                else
                {
                        $this->form_gui->setValuesByPost();
                        return $this->form_gui->getHtml();
                }

        }

Here is the call graph for this function:

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

        {
                $this->form_edit_mode = $a_form_edit_mode;
        }

ilExternalFeedBlockGUIGen::setGuiObject ( &$  a_gui_object  ) 

Set GuiObject.

Parameters:
object $a_gui_object GUI object

Reimplemented from ilBlockGUI.

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

        {
                $this->gui_object = $a_gui_object;
        }

ilExternalFeedBlockGUIGen::updateFeedBlock (  ) 

FORM FeedBlock: Update ExternalFeedBlock.

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

References exitUpdateFeedBlock(), and initFormFeedBlock().

        {
                $this->initFormFeedBlock(IL_FORM_EDIT);
                if ($this->form_gui->checkInput())
                {
                        
                        $this->external_feed_block->setTitle($this->form_gui->getInput("block_title"));
                        $this->external_feed_block->setFeedUrl($this->form_gui->getInput("block_feed_url"));
                        $this->external_feed_block->update();
                        $this->exitUpdateFeedBlock();
                }
                else
                {
                        $this->form_gui->setValuesByPost();
                        return $this->form_gui->getHtml();
                }

        }

Here is the call graph for this function:

Field Documentation

ilExternalFeedBlockGUIGen::$form_edit_mode [protected]

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

ilExternalFeedBlockGUIGen::$gui_object [protected]

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

The documentation for this class was generated from the following file:
Generated on Fri Dec 13 2013 17:57:14 for ILIAS Release_3_9_x_branch .rev 46835 by  doxygen 1.7.1