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

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

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.

Reimplemented from ilBlockGUI.

Reimplemented in ilExternalFeedBlockGUI, and ilPDExternalFeedBlockGUI.

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
 
        parent::__construct();
 
        $this->ctrl = $ilCtrl;
        
        
        include_once("Services/Block/classes/class.ilExternalFeedBlock.php");
        if (isset($_GET["external_feed_block_id"]) && $_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"));
    }

References $_GET, $DIC, and $ilCtrl.

Member Function Documentation

◆ cancelSaveFeedBlock()

ilExternalFeedBlockGUIGen::cancelSaveFeedBlock ( )

FORM FeedBlock: Cancel save.

(Can be overwritten in derived classes)

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

    {
        $ilCtrl = $this->ctrl;
 
        $ilCtrl->returnToParent($this);
    }

References ilBlockGUI\$ctrl, and $ilCtrl.

◆ cancelUpdateFeedBlock()

ilExternalFeedBlockGUIGen::cancelUpdateFeedBlock ( )

FORM FeedBlock: Cancel update.

(Can be overwritten in derived classes)

Reimplemented in ilExternalFeedBlockGUI.

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

    {
        $ilCtrl = $this->ctrl;
 
        $ilCtrl->returnToParent($this);
    }

References ilBlockGUI\$ctrl, and $ilCtrl.

◆ createFeedBlock()

ilExternalFeedBlockGUIGen::createFeedBlock ( )

FORM FeedBlock: Create ExternalFeedBlock.

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

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

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

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

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

    {
        $ilCtrl = $this->ctrl;
        
        // 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;
    }

References ilBlockGUI\$ctrl, $html, and $ilCtrl.

◆ exitSaveFeedBlock()

ilExternalFeedBlockGUIGen::exitSaveFeedBlock ( )

FORM FeedBlock: Exit save.

(Can be overwritten in derived classes)

Reimplemented in ilExternalFeedBlockGUI.

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

    {
        $ilCtrl = $this->ctrl;
 
        $ilCtrl->returnToParent($this);
    }

References ilBlockGUI\$ctrl, and $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 293 of file class.ilExternalFeedBlockGUIGen.php.

    {
        $ilCtrl = $this->ctrl;
 
        $ilCtrl->returnToParent($this);
    }

References ilBlockGUI\$ctrl, and $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 121 of file class.ilExternalFeedBlockGUIGen.php.

    {
        return $this->form_edit_mode;
    }

References $form_edit_mode.

◆ getGuiObject()

ilExternalFeedBlockGUIGen::getGuiObject ( )

Get GuiObject.

Returns: object GUI object

Reimplemented from ilBlockGUI.

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

    {
        return $this->gui_object;
    }

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

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

Referenced by editFeedBlock().

Here is the caller graph for this function:

◆ initFormFeedBlock()

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

    {
        $lng = $this->lng;
        
        $lng->loadLanguageModule("block");
        
        require_once("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);
    }

References ilBlockGUI\$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_gui ilPropertyFormGUI instance.

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

315 {

316 }

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_block ExternalFeedBlock object.

Reimplemented in ilExternalFeedBlockGUI, and ilPDExternalFeedBlockGUI.

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

306 {

307 }

Referenced by saveFeedBlock().

Here is the caller graph for this function:

◆ saveFeedBlock()

ilExternalFeedBlockGUIGen::saveFeedBlock ( )

FORM FeedBlock: Save ExternalFeedBlock.

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

    {
        $this->initFormFeedBlock(IL_FORM_CREATE);
 
        $this->external_feed_block = new ilExternalFeedBlock();
 
        if ($this->form_gui->checkInput() &&
            !$this->external_feed_block->isFeedUrlLocal($this->form_gui->getInput("block_feed_url"))) {
            $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 {
            if ($this->external_feed_block->isFeedUrlLocal($this->form_gui->getInput("block_feed_url"))) {
                ilUtil::sendFailure($this->lng->txt("feed_no_local_url"), true);
            }
            $this->form_gui->setValuesByPost();
            return $this->form_gui->getHtml();
        }
    }

References exitSaveFeedBlock(), IL_FORM_CREATE, initFormFeedBlock(), prepareSaveFeedBlock(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ setFormEditMode()

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

    {
        $this->form_edit_mode = $a_form_edit_mode;
    }

◆ setGuiObject()

ilExternalFeedBlockGUIGen::setGuiObject ( & $a_gui_object )

Set GuiObject.

Parameters

object $a_gui_object GUI object

Reimplemented from ilBlockGUI.

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

    {
        $this->gui_object = $a_gui_object;
    }

◆ updateFeedBlock()

ilExternalFeedBlockGUIGen::updateFeedBlock ( )

FORM FeedBlock: Update ExternalFeedBlock.

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

    {
        $this->initFormFeedBlock(IL_FORM_EDIT);
        $this->external_feed_block->isFeedUrlLocal($_POST["block_feed_url"]);
        if ($this->form_gui->checkInput() &&
            !!$this->external_feed_block->isFeedUrlLocal($this->form_gui->getInput("block_feed_url"))) {
            $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 {
            if ($this->external_feed_block->isFeedUrlLocal($this->form_gui->getInput("block_feed_url"))) {
                ilUtil::sendFailure($this->lng->txt("feed_no_local_url"), true);
            }
            $this->form_gui->setValuesByPost();
            return $this->form_gui->getHtml();
        }
    }

References $_POST, exitUpdateFeedBlock(), IL_FORM_EDIT, initFormFeedBlock(), and ilUtil\sendFailure().

Here is the call graph for this function:

Field Documentation

◆ $form_edit_mode

ilExternalFeedBlockGUIGen::$form_edit_mode

protected

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

Referenced by getFormEditMode().

◆ $gui_object

ilExternalFeedBlockGUIGen::$gui_object

protected

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

Referenced by getGuiObject().

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

Services/Block/classes/class.ilExternalFeedBlockGUIGen.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cancelSaveFeedBlock()

◆ cancelUpdateFeedBlock()

◆ createFeedBlock()

◆ editFeedBlock()

◆ executeCommand()

◆ exitSaveFeedBlock()

◆ exitUpdateFeedBlock()

◆ getFormEditMode()

◆ getGuiObject()

◆ getValuesFeedBlock()

◆ initFormFeedBlock()

◆ prepareFormFeedBlock()

◆ prepareSaveFeedBlock()

◆ saveFeedBlock()

◆ setFormEditMode()

◆ setGuiObject()

◆ updateFeedBlock()

Field Documentation

◆ $form_edit_mode

◆ $gui_object