BlockGUI class for external feed block. More...

Inheritance diagram for ilExternalFeedBlockGUI:

Collaboration diagram for ilExternalFeedBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	getBlockType ()
	Returns string More...

	setBlock ($a_block)
	Do most of the initialisation. 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...

	getValuesFeedBlock ()
	FORM FeedBlock: Get current values for ExternalFeedBlock form. More...

	cancelSaveFeedBlock ()
	FORM FeedBlock: Cancel save. More...

	executeCommand ()
	execute command More...

	fillDataSection ()
	Fill data section. More...

	getHTML ()
	Get block HTML code. More...

	getDynamic ()

	getDynamicReload ()

	getJSEnabler ()

	disableJS ()

	enableJS ()

	fillRow ($item)
	Fill feed item row. More...

	getOverview ()
	Get overview. More...

	showFeedItem ()
	Show Feed Item. More...

	create ()
	Create Form for Block. More...

	initImportForm ($a_new_type="")
	Init object import form. More...

	importFile ()
	Import. More...

	initFormFeedBlock ($a_mode)
	FORM FeedBlock: Init form. More...

	prepareSaveFeedBlock (&$a_feed_block)
	FORM FeedBlock: Prepare Saving of FeedBlock. More...

	exitSaveFeedBlock ()
	FORM FeedBlock: Exit save. More...

	cancelUpdateFeedBlock ()
	FORM FeedBlock: Exit save. More...

	exitUpdateFeedBlock ()
	FORM FeedBlock: Exit save. More...

Public Member Functions inherited from ilBlockGUI
	getBlockType ()

	__construct ()
	Constructor. More...

	setData ($a_data)
	Set Data. More...

	getData ()
	Get Data. More...

	setPresentation (int $type)
	Set presentation. More...

	getPresentation ()
	Get presentation type. More...

	setBlockId ($a_block_id=0)
	Set Block Id. More...

	getBlockId ()
	Get Block Id. More...

	setGuiObject (&$a_gui_object)
	Set GuiObject. More...

	getGuiObject ()
	Get GuiObject. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. 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...

	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 (bool $a_admincommands)
	Set Administration Commmands. More...

	getAdminCommands ()
	Get Administration Commmands. 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 ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()
	Get Row Template Name. More...

	getRowTemplateDir ()
	Get Row Template Directory. More...

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
	Add Block Command. More...

	getBlockCommands ()
	Get Block commands. More...

	getHTML ()
	Get HTML. 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...

	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...

	getPaginationViewControl ()
	Fill previous/next row. More...

	getHTMLNew ()
	Get HTML. More...

Static Public Member Functions
static	getScreenMode ()
	Get Screen Mode for current command. More...

static	getScreenMode ()
	Get Screen Mode for current command. More...

Data Fields
const	FORM_EDIT = 0

const	FORM_CREATE = 1

const	FORM_RE_EDIT = 2

const	FORM_RE_CREATE = 2

Data Fields inherited from ilBlockGUI
const	PRES_MAIN_LEG = 0

const	PRES_SEC_LEG = 1

const	PRES_SEC_LIST = 2

const	PRES_MAIN_LIST = 3

Static Public Attributes
static	$block_type = "feed"

Protected Member Functions

isRepositoryObject ()

Returns whether block has a corresponding repository object.

Returns: bool

More...

getListItemForData (array $data)

Get list item for data array.

Parameters

array $data

Returns: null|\ILIAS\UI\Component\Item\Item

More...

Protected Member Functions inherited from ilBlockGUI

isRepositoryObject ()

Returns whether block has a corresponding repository object. More...

initCommands ()

Init commands. More...

fillRowColor ($a_placeholder="CSS_ROW")

preloadData (array $data)

Can be overwritten in subclasses. More...

getLegacyContent ()

Get legacy content. More...

getViewControls ()

Get view controls. More...

getListItemForData (array $data)

Get list item for data array. More...

handleNavigation ()

Handle navigation. More...

loadData ()

Load data for current page. More...

getListItemGroups ()

Get items. More...

addRepoCommands ()

Add repo commands. More...

getNoItemFoundContent ()

No item entry. More...

Protected Attributes
	$gui_object

	$form_edit_mode

	$settings

	$rbacsystem

	$obj_definition

	$new_rendering = true

Protected Attributes inherited from ilBlockGUI
	$ui

	$data = array()

	$enablenuminfo = true

	$footer_links = array()

	$block_id = 0

	$allow_moving = true

	$move = array("left" => false, "right" => false, "up" => false, "down" => false)

	$block_commands = array()

	$max_count = false

	$close_command = false

	$image = false

	$property = false

	$nav_value = ""

	$css_row = ""

	$title = ""

	$admincommands = false

	$dropdown

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

	$presentation

	$new_rendering = false

Detailed Description

BlockGUI class for external feed block.

This is the one that is used within the repository. On the personal desktop ilPDExternalFeedBlockGUI is used.

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

Version: $Id$

@ilCtrl_IsCalledBy ilExternalFeedBlockGUI: ilColumnGUI

Definition at line 17 of file class.ilExternalFeedBlockGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilExternalFeedBlockGUI::__construct ( )

Constructor.

Reimplemented from ilBlockGUI.

Definition at line 47 of file class.ilExternalFeedBlockGUI.php.

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->access = $DIC->access();
        $this->settings = $DIC->settings();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->obj_definition = $DIC["objDefinition"];
        $lng = $DIC->language();
        
        parent::__construct();
        
        $lng->loadLanguageModule("feed");
        $this->setLimit(5);
        $this->setRowTemplate("tpl.block_external_feed_row.html", "Services/Feeds");
 
        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"));
 
        $this->setPresentation(self::PRES_SEC_LIST);
    }

References $_GET, $DIC, ilBlockGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ilBlockGUI\setLimit(), ilBlockGUI\setPresentation(), ilBlockGUI\setRowTemplate(), settings(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ cancelSaveFeedBlock()

ilExternalFeedBlockGUI::cancelSaveFeedBlock ( )

FORM FeedBlock: Cancel save.

(Can be overwritten in derived classes)

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

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

References ilBlockGUI\$ctrl.

◆ cancelUpdateFeedBlock()

ilExternalFeedBlockGUI::cancelUpdateFeedBlock ( )

FORM FeedBlock: Exit save.

(Can be overwritten in derived classes)

Definition at line 703 of file class.ilExternalFeedBlockGUI.php.

    {
        $this->getGuiObject()->cancelUpdate();
    }

References getGuiObject().

Here is the call graph for this function:

◆ create()

ilExternalFeedBlockGUI::create ( )

Create Form for Block.

Definition at line 544 of file class.ilExternalFeedBlockGUI.php.

    {
        $html1 = $this->createFeedBlock();
 
        $html2 = "";
        if (DEVMODE == 1) {
            $this->initImportForm("feed");
            $html2 = "<br/>" . $this->form->getHTML();
        }
 
        return $html1 . $html2;
    }

References createFeedBlock(), and initImportForm().

Here is the call graph for this function:

◆ createFeedBlock()

ilExternalFeedBlockGUI::createFeedBlock ( )

FORM FeedBlock: Create ExternalFeedBlock.

Definition at line 185 of file class.ilExternalFeedBlockGUI.php.

    {
        $this->initFormFeedBlock(self::FORM_CREATE);
        return $this->form_gui->getHtml();
    }

References initFormFeedBlock().

Referenced by create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disableJS()

ilExternalFeedBlockGUI::disableJS ( )

Definition at line 434 of file class.ilExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        
        $_SESSION["il_feed_js"] = "n";
        $ilUser->writePref("il_feed_js", "n");
        $ilCtrl->returnToParent($this);
    }

References $_SESSION, ilBlockGUI\$ctrl, $ilUser, and ilBlockGUI\$user.

◆ editFeedBlock()

ilExternalFeedBlockGUI::editFeedBlock ( )

FORM FeedBlock: Edit form.

Definition at line 195 of file class.ilExternalFeedBlockGUI.php.

    {
        $this->initFormFeedBlock(self::FORM_EDIT);
        $this->getValuesFeedBlock();
        return $this->form_gui->getHtml();
    }

References getValuesFeedBlock(), and initFormFeedBlock().

Here is the call graph for this function:

◆ enableJS()

ilExternalFeedBlockGUI::enableJS ( )

Definition at line 444 of file class.ilExternalFeedBlockGUI.php.

    {
        $ilUser = $this->user;
        
        $_SESSION["il_feed_js"] = "y";
        $ilUser->writePref("il_feed_js", "y");
        echo $this->getHTML();
        exit;
    }

References $_SESSION, $ilUser, ilBlockGUI\$user, exit, and getHTML().

Here is the call graph for this function:

◆ executeCommand()

ilExternalFeedBlockGUI::executeCommand ( )

execute command

Definition at line 280 of file class.ilExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
 
        $next_class = $ilCtrl->getNextClass();
        $cmd = $ilCtrl->getCmd("getHTML");
        switch ($next_class) {
            default:
                return $this->$cmd();
        }
    }

References ilBlockGUI\$ctrl.

◆ exitSaveFeedBlock()

ilExternalFeedBlockGUI::exitSaveFeedBlock ( )

FORM FeedBlock: Exit save.

(Can be overwritten in derived classes)

Definition at line 694 of file class.ilExternalFeedBlockGUI.php.

    {
        $this->getGuiObject()->exitSave();
    }

References getGuiObject().

Referenced by importFile(), and saveFeedBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exitUpdateFeedBlock()

ilExternalFeedBlockGUI::exitUpdateFeedBlock ( )

FORM FeedBlock: Exit save.

(Can be overwritten in derived classes)

Definition at line 712 of file class.ilExternalFeedBlockGUI.php.

    {
        $this->getGuiObject()->update($this->external_feed_block);
    }

References getGuiObject().

Referenced by updateFeedBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillDataSection()

ilExternalFeedBlockGUI::fillDataSection ( )

Fill data section.

Reimplemented from ilBlockGUI.

Definition at line 295 of file class.ilExternalFeedBlockGUI.php.

    {
        if ($this->getDynamic()) {
            $this->setDataSection($this->getDynamicReload());
        } elseif (count($this->getData()) > 0) {
            parent::fillDataSection();
        } else {
            $this->setDataSection($this->getOverview());
        }
    }

References ilBlockGUI\getData(), getDynamic(), getDynamicReload(), getOverview(), and ilBlockGUI\setDataSection().

Here is the call graph for this function:

◆ fillRow()

ilExternalFeedBlockGUI::fillRow ( $item )

Fill feed item row.

Reimplemented from ilBlockGUI.

Definition at line 457 of file class.ilExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $ilAccess = $this->access;
 
        if ($this->isRepositoryObject() && !$ilAccess->checkAccess("read", "", $this->getRefId())) {
            $this->tpl->setVariable("TXT_TITLE", $item->getTitle());
        } else {
            $ilCtrl->setParameter($this, "feed_item_id", $item->getId());
            $this->tpl->setCurrentBlock("feed_link");
            $this->tpl->setVariable("VAL_TITLE", $item->getTitle());
            $this->tpl->setVariable(
                "HREF_SHOW",
                $ilCtrl->getLinkTarget($this, "showFeedItem")
            );
            $ilCtrl->setParameter($this, "feed_item_id", "");
            $this->tpl->parseCurrentBlock();
        }
    }

References ilBlockGUI\$access, ilBlockGUI\$ctrl, and isRepositoryObject().

Here is the call graph for this function:

◆ getBlockType()

ilExternalFeedBlockGUI::getBlockType ( )

Returns: string

Reimplemented from ilBlockGUI.

Definition at line 78 of file class.ilExternalFeedBlockGUI.php.

                                   : string
    {
        return self::$block_type;
    }

References $block_type.

Referenced by prepareSaveFeedBlock().

Here is the caller graph for this function:

◆ getDynamic()

ilExternalFeedBlockGUI::getDynamic ( )

Definition at line 362 of file class.ilExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        // @todo
        return false;
 
        if ($ilCtrl->getCmdClass() != "ilcolumngui" && $ilCtrl->getCmd() != "enableJS") {
            if ($_SESSION["il_feed_js"] != "n" &&
                ($ilUser->getPref("il_feed_js") != "n" || $_SESSION["il_feed_js"] == "y")) {
                // do not get feed dynamically, if cache hit is given.
                if (!$this->feed->checkCacheHit()) {
                    return true;
                }
            }
        }
        
        return false;
    }

References $_SESSION, ilBlockGUI\$ctrl, $ilUser, and ilBlockGUI\$user.

Referenced by fillDataSection(), and getHTML().

Here is the caller graph for this function:

◆ getDynamicReload()

ilExternalFeedBlockGUI::getDynamicReload ( )

Definition at line 383 of file class.ilExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $ilCtrl->setParameterByClass(
            "ilcolumngui",
            "block_id",
            "block_feed_" . $this->getBlockId()
        );
 
        $rel_tpl = new ilTemplate("tpl.dynamic_reload.html", true, true, "Services/Feeds");
        $rel_tpl->setVariable("TXT_LOADING", $lng->txt("feed_loading_feed"));
        $rel_tpl->setVariable("BLOCK_ID", "block_feed_" . $this->getBlockId());
        $rel_tpl->setVariable(
            "TARGET",
            $ilCtrl->getLinkTargetByClass("ilcolumngui", "updateBlock", "", true)
        );
            
        // no JS
        $rel_tpl->setVariable("TXT_FEED_CLICK_HERE", $lng->txt("feed_no_js_click_here"));
        $rel_tpl->setVariable(
            "TARGET_NO_JS",
            $ilCtrl->getLinkTargetByClass("ilexternalfeedblockgui", "disableJS")
        );
 
        return $rel_tpl->get();
    }

References ilBlockGUI\$ctrl, ilBlockGUI\$lng, and ilBlockGUI\getBlockId().

Referenced by fillDataSection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFormEditMode()

ilExternalFeedBlockGUI::getFormEditMode ( )

Get FormEditMode.

Returns: int Form Edit Mode

Definition at line 176 of file class.ilExternalFeedBlockGUI.php.

    {
        return $this->form_edit_mode;
    }

References $form_edit_mode.

◆ getGuiObject()

ilExternalFeedBlockGUI::getGuiObject ( )

Get GuiObject.

Returns: object GUI object

Reimplemented from ilBlockGUI.

Definition at line 156 of file class.ilExternalFeedBlockGUI.php.

    {
        return $this->gui_object;
    }

References $gui_object.

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

Here is the caller graph for this function:

◆ getHTML()

ilExternalFeedBlockGUI::getHTML ( )

Get block HTML code.

Reimplemented from ilBlockGUI.

Definition at line 309 of file class.ilExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
        $ilAccess = $this->access;
 
 
        $feed_set = new ilSetting("feed");
        
        if ($feed_set->get("disable_rep_feeds")) {
            return "";
        }
        
        // if no dynamic reload
        if (!$this->getDynamic()) {
            $this->feed->fetch();
            $this->setData(array_map(function ($i) {
                return ["item" => $i];
            }, $this->feed->getItems()));
        }
 
        //$this->setTitle($this->feed->getChannelTitle());
        //$this->setData($this->feed->getItems());
 
        if ($ilAccess->checkAccess("write", "", $this->getRefId())) {
            $ilCtrl->setParameterByClass(
                "ilobjexternalfeedgui",
                "ref_id",
                $this->getRefId()
            );
            $ilCtrl->setParameter($this, "external_feed_block_id", $this->getBlockId());
            $this->addBlockCommand(
                $ilCtrl->getLinkTargetByClass(
                    array("ilrepositorygui", "ilobjexternalfeedgui",
                    "ilexternalfeedblockgui"),
                    "editFeedBlock"
                ),
                $lng->txt("settings")
            );
            $ilCtrl->clearParametersByClass("ilobjexternalfeedgui");
        }
 
        // JS enabler
        $add = "";
        if ($_SESSION["il_feed_js"] == "n" ||
            ($ilUser->getPref("il_feed_js") == "n" && $_SESSION["il_feed_js"] != "y")) {
            $add = $this->getJSEnabler();
        }
 
        return parent::getHTML() . $add;
    }

References $_SESSION, ilBlockGUI\$access, ilBlockGUI\$ctrl, $feed_set, $i, $ilUser, ilBlockGUI\$lng, ilBlockGUI\$user, ilBlockGUI\addBlockCommand(), ilBlockGUI\getBlockId(), getDynamic(), getJSEnabler(), ilBlockGUI\getRefId(), and ilBlockGUI\setData().

Referenced by enableJS().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getJSEnabler()

ilExternalFeedBlockGUI::getJSEnabler ( )

Definition at line 412 of file class.ilExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $ilCtrl->setParameterByClass(
            "ilcolumngui",
            "block_id",
            "block_feed_" . $this->getBlockId()
        );
 
        $rel_tpl = new ilTemplate("tpl.js_enabler.html", true, true, "Services/Feeds");
        $rel_tpl->setVariable("BLOCK_ID", "block_feed_" . $this->getBlockId());
        $rel_tpl->setVariable(
            "TARGET",
            $ilCtrl->getLinkTargetByClass("ilexternalfeedblockgui", "enableJS", true, "", false)
        );
            
        return $rel_tpl->get();
    }

References ilBlockGUI\$ctrl, ilBlockGUI\$lng, and ilBlockGUI\getBlockId().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getListItemForData()

ilExternalFeedBlockGUI::getListItemForData ( array $data )

protected

Get list item for data array.

Parameters

array $data

Returns: null|\ILIAS\UI\Component\Item\Item

Get list item for data array.

Parameters

array $data

Returns: null|\ILIAS\UI\Component\Item\Item

Reimplemented from ilBlockGUI.

Definition at line 737 of file class.ilExternalFeedBlockGUI.php.

                                                       : \ILIAS\UI\Component\Item\Item
    {
        $ctrl = $this->ctrl;
        $f = $this->ui->factory();
 
        $item = $data["item"];
 
        //if ($this->isRepositoryObject() && !$ilAccess->checkAccess("read", "", $this->getRefId()))
        $ctrl->setParameter($this, "feed_item_id", $item->getId());
        $button = $f->button()->shy(
            $item->getTitle(),
            $ctrl->getLinkTarget($this, "showFeedItem", "", false, false)
        );
        $ctrl->setParameter($this, "feed_item_id", "");
 
        return $f->item()->standard($button);
    }

References ilBlockGUI\$ctrl, ilBlockGUI\$data, Vendor\Package\$f, and ui().

Here is the call graph for this function:

◆ getOverview()

ilExternalFeedBlockGUI::getOverview ( )

Get overview.

Definition at line 480 of file class.ilExternalFeedBlockGUI.php.

    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        $this->setEnableNumInfo(false);
        return '<div class="small">' . ((int) count($this->getData())) . " " . $lng->txt("feed_feed_items") . "</div>";
    }

References ilBlockGUI\$ctrl, $ilUser, ilBlockGUI\$lng, ilBlockGUI\$user, ilBlockGUI\getData(), and ilBlockGUI\setEnableNumInfo().

Referenced by fillDataSection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getScreenMode()

static ilExternalFeedBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

Definition at line 94 of file class.ilExternalFeedBlockGUI.php.

    {
        global $DIC;
 
        $ilCtrl = $DIC->ctrl();
        
        switch ($ilCtrl->getCmd()) {
            case "create":
            case "edit":
            case "saveFeedBlock":
            case "updateFeedBlock":
            case "editFeedBlock":
            case "showFeedItem":
            case "confirmDeleteFeedBlock":
                return IL_SCREEN_CENTER;
                break;
                
            default:
                return IL_SCREEN_SIDE;
                break;
        }
    }

References $DIC, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

◆ getValuesFeedBlock()

ilExternalFeedBlockGUI::getValuesFeedBlock ( )

FORM FeedBlock: Get current values for ExternalFeedBlock form.

Definition at line 255 of file class.ilExternalFeedBlockGUI.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:

◆ importFile()

ilExternalFeedBlockGUI::importFile ( )

Import.

@access public

Definition at line 593 of file class.ilExternalFeedBlockGUI.php.

    {
        $rbacsystem = $this->rbacsystem;
        $tpl = $this->main_tpl;
        $lng = $this->lng;
 
        $new_type = $_POST["new_type"] ? $_POST["new_type"] : $_GET["new_type"];
 
        // create permission is already checked in createObject. This check here is done to prevent hacking attempts
        if (!$rbacsystem->checkAccess("create", $_GET["ref_id"], $new_type)) {
            $this->ilias->raiseError($this->lng->txt("no_create_permission"), $this->ilias->error_obj->MESSAGE);
        }
        $this->ctrl->setParameter($this, "new_type", $new_type);
        $this->initImportForm($new_type);
        if ($this->form->checkInput()) {
            // todo: make some check on manifest file
            include_once("./Services/Export/classes/class.ilImport.php");
            $imp = new ilImport((int) $_GET['ref_id']);
            $new_id = $imp->importObject(
                $newObj,
                $_FILES["importfile"]["tmp_name"],
                $_FILES["importfile"]["name"],
                $new_type
            );
 
            // put new object id into tree
            if ($new_id > 0) {
                $newObj = ilObjectFactory::getInstanceByObjId($new_id);
                $newObj->createReference();
                $newObj->putInTree($_GET["ref_id"]);
                $newObj->setPermissions($_GET["ref_id"]);
                ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                $this->exitSaveFeedBlock();
            }
            return;
        }
 
        $this->form->setValuesByPost();
        $tpl->setContent($this->form->getHtml());
    }

References $_GET, $_POST, ilBlockGUI\$lng, ilBlockGUI\$main_tpl, $rbacsystem, ilBlockGUI\$tpl, exitSaveFeedBlock(), ilObjectFactory\getInstanceByObjId(), and initImportForm().

Here is the call graph for this function:

◆ initFormFeedBlock()

ilExternalFeedBlockGUI::initFormFeedBlock ( $a_mode )

FORM FeedBlock: Init form.

(We need to overwrite, because Generator does not know FeedUrl Inputs yet.

Parameters

int $a_mode Form Edit Mode

Definition at line 641 of file class.ilExternalFeedBlockGUI.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 ilFeedUrlInputGUI($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(self::FORM_CREATE,self::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));
    }

References ilBlockGUI\$lng.

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

Here is the caller graph for this function:

◆ initImportForm()

ilExternalFeedBlockGUI::initImportForm ( $a_new_type = "" )

Init object import form.

Parameters

string new type

Definition at line 562 of file class.ilExternalFeedBlockGUI.php.

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $lng->loadLanguageModule("feed");
 
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $this->form = new ilPropertyFormGUI();
        $this->form->setTarget("_top");
 
        // Import file
        include_once("./Services/Form/classes/class.ilFileInputGUI.php");
        $fi = new ilFileInputGUI($lng->txt("import_file"), "importfile");
        $fi->setSuffixes(array("zip"));
        $fi->setRequired(true);
        $this->form->addItem($fi);
 
        $this->form->addCommandButton("importFile", $lng->txt("import"));
        $this->form->addCommandButton("cancelSaveFeedBlock", $lng->txt("cancel"));
        $this->form->setTitle($lng->txt($a_new_type . "_import"));
 
        $ilCtrl->setParameter($this, "new_type", $a_new_type);
        $this->form->setFormAction($ilCtrl->getFormAction($this));
    }

References ilBlockGUI\$ctrl, and ilBlockGUI\$lng.

Referenced by create(), and importFile().

Here is the caller graph for this function:

◆ isRepositoryObject()

ilExternalFeedBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Returns: bool

Reimplemented from ilBlockGUI.

Definition at line 86 of file class.ilExternalFeedBlockGUI.php.

                                            : bool
    {
        return true;
    }

Referenced by fillRow().

Here is the caller graph for this function:

◆ prepareSaveFeedBlock()

ilExternalFeedBlockGUI::prepareSaveFeedBlock ( & $a_feed_block )

FORM FeedBlock: Prepare Saving of FeedBlock.

Parameters

object $a_feed_block FeedBlock object.

Definition at line 684 of file class.ilExternalFeedBlockGUI.php.

    {
        $this->getGuiObject()->save($a_feed_block);
        $a_feed_block->setType($this->getBlockType());
    }

References getBlockType(), and getGuiObject().

Referenced by saveFeedBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveFeedBlock()

ilExternalFeedBlockGUI::saveFeedBlock ( )

FORM FeedBlock: Save ExternalFeedBlock.

Definition at line 206 of file class.ilExternalFeedBlockGUI.php.

    {
        $this->initFormFeedBlock(self::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(), initFormFeedBlock(), prepareSaveFeedBlock(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ setBlock()

ilExternalFeedBlockGUI::setBlock ( $a_block )

Do most of the initialisation.

Definition at line 120 of file class.ilExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
 
        // init block
        $this->feed_block = $a_block;
        $this->setTitle($this->feed_block->getTitle());
        $this->setBlockId($this->feed_block->getId());
        
        // get feed object
        include_once("./Services/Feeds/classes/class.ilExternalFeed.php");
        $this->feed = new ilExternalFeed();
        $this->feed->setUrl($this->feed_block->getFeedUrl());
        
        // init details
 
        $ilCtrl->setParameter($this, "block_id", $this->feed_block->getId());
    }

References ilBlockGUI\$ctrl, ilBlockGUI\setBlockId(), and ilBlockGUI\setTitle().

Here is the call graph for this function:

◆ setFormEditMode()

ilExternalFeedBlockGUI::setFormEditMode ( $a_form_edit_mode )

Set FormEditMode.

Parameters

int $a_form_edit_mode Form Edit Mode

Definition at line 166 of file class.ilExternalFeedBlockGUI.php.

    {
        $this->form_edit_mode = $a_form_edit_mode;
    }

◆ setGuiObject()

ilExternalFeedBlockGUI::setGuiObject ( & $a_gui_object )

Set GuiObject.

Parameters

object $a_gui_object GUI object

Reimplemented from ilBlockGUI.

Definition at line 146 of file class.ilExternalFeedBlockGUI.php.

    {
        $this->gui_object = $a_gui_object;
    }

◆ showFeedItem()

ilExternalFeedBlockGUI::showFeedItem ( )

Show Feed Item.

Definition at line 493 of file class.ilExternalFeedBlockGUI.php.

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        include_once("./Services/News/classes/class.ilNewsItem.php");
 
        $this->feed->fetch();
        foreach ($this->feed->getItems() as $item) {
            if ($item->getId() == $_GET["feed_item_id"]) {
                $c_item = $item;
                break;
            }
        }
        
        $tpl = new ilTemplate("tpl.show_feed_item.html", true, true, "Services/Feeds");
        
        if (is_object($c_item)) {
            if (trim($c_item->getSummary()) != "") {            // summary
                $tpl->setCurrentBlock("content");
                $tpl->setVariable("VAL_CONTENT", $c_item->getSummary());
                $tpl->parseCurrentBlock();
            }
            if (trim($c_item->getDate()) != "" || trim($c_item->getAuthor()) != "") {           // date
                $tpl->setCurrentBlock("date_author");
                if (trim($c_item->getAuthor()) != "") {
                    $tpl->setVariable("VAL_AUTHOR", $c_item->getAuthor() . " - ");
                }
                $tpl->setVariable("VAL_DATE", $c_item->getDate());
                $tpl->parseCurrentBlock();
            }
 
            if (trim($c_item->getLink()) != "") {               // link
                $tpl->setCurrentBlock("plink");
                $tpl->setVariable("HREF_LINK", $c_item->getLink());
                $tpl->setVariable("TXT_LINK", $lng->txt("feed_open_source_page"));
                $tpl->parseCurrentBlock();
            }
            $tpl->setVariable("VAL_TITLE", $c_item->getTitle());                        // title
        }
        
        $content_block = new ilDashboardContentBlockGUI();
        $content_block->setContent($tpl->get());
        $content_block->setTitle($this->getTitle());
 
        return $content_block->getHTML();
    }

References $_GET, ilBlockGUI\$ctrl, ilBlockGUI\$lng, ilBlockGUI\$tpl, and ilBlockGUI\getTitle().

Here is the call graph for this function:

◆ updateFeedBlock()

ilExternalFeedBlockGUI::updateFeedBlock ( )

FORM FeedBlock: Update ExternalFeedBlock.

Definition at line 232 of file class.ilExternalFeedBlockGUI.php.

    {
        $this->initFormFeedBlock(self::FORM_EDIT);
        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"));
            }
            $this->form_gui->setValuesByPost();
            return $this->form_gui->getHtml();
        }
    }

References exitUpdateFeedBlock(), initFormFeedBlock(), and ilUtil\sendFailure().

Here is the call graph for this function:

Field Documentation

◆ $block_type

ilExternalFeedBlockGUI::$block_type = "feed"

static

Definition at line 42 of file class.ilExternalFeedBlockGUI.php.

Referenced by getBlockType().

◆ $form_edit_mode

ilExternalFeedBlockGUI::$form_edit_mode

protected

Definition at line 25 of file class.ilExternalFeedBlockGUI.php.

Referenced by getFormEditMode().

◆ $gui_object

ilExternalFeedBlockGUI::$gui_object

protected

Definition at line 24 of file class.ilExternalFeedBlockGUI.php.

Referenced by getGuiObject().

◆ $new_rendering

ilExternalFeedBlockGUI::$new_rendering = true

protected

Definition at line 721 of file class.ilExternalFeedBlockGUI.php.

◆ $obj_definition

ilExternalFeedBlockGUI::$obj_definition

protected

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

◆ $rbacsystem

ilExternalFeedBlockGUI::$rbacsystem

protected

Definition at line 35 of file class.ilExternalFeedBlockGUI.php.

Referenced by importFile().

◆ $settings

ilExternalFeedBlockGUI::$settings

protected

Definition at line 30 of file class.ilExternalFeedBlockGUI.php.

◆ FORM_CREATE

const ilExternalFeedBlockGUI::FORM_CREATE = 1

Definition at line 20 of file class.ilExternalFeedBlockGUI.php.

◆ FORM_EDIT

const ilExternalFeedBlockGUI::FORM_EDIT = 0

Definition at line 19 of file class.ilExternalFeedBlockGUI.php.

◆ FORM_RE_CREATE

const ilExternalFeedBlockGUI::FORM_RE_CREATE = 2

Definition at line 22 of file class.ilExternalFeedBlockGUI.php.

◆ FORM_RE_EDIT

const ilExternalFeedBlockGUI::FORM_RE_EDIT = 2

Definition at line 21 of file class.ilExternalFeedBlockGUI.php.

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

Modules/ExternalFeed/classes/class.ilExternalFeedBlockGUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cancelSaveFeedBlock()

◆ cancelUpdateFeedBlock()

◆ create()

◆ createFeedBlock()

◆ disableJS()

◆ editFeedBlock()

◆ enableJS()

◆ executeCommand()

◆ exitSaveFeedBlock()

◆ exitUpdateFeedBlock()

◆ fillDataSection()

◆ fillRow()

◆ getBlockType()

◆ getDynamic()

◆ getDynamicReload()

◆ getFormEditMode()

◆ getGuiObject()

◆ getHTML()

◆ getJSEnabler()

◆ getListItemForData()

◆ getOverview()

◆ getScreenMode()

◆ getValuesFeedBlock()

◆ importFile()

◆ initFormFeedBlock()

◆ initImportForm()

◆ isRepositoryObject()

◆ prepareSaveFeedBlock()

◆ saveFeedBlock()

◆ setBlock()

◆ setFormEditMode()

◆ setGuiObject()

◆ showFeedItem()

◆ updateFeedBlock()

Field Documentation

◆ $block_type

◆ $form_edit_mode

◆ $gui_object

◆ $new_rendering

◆ $obj_definition

◆ $rbacsystem

◆ $settings

◆ FORM_CREATE

◆ FORM_EDIT

◆ FORM_RE_CREATE

◆ FORM_RE_EDIT