BlockGUI class for external feed block on the personal desktop. More...

Inheritance diagram for ilPDExternalFeedBlockGUI:

Collaboration diagram for ilPDExternalFeedBlockGUI:

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

	getBlockType ()

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

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

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

	confirmDeleteFeedBlock ()
	Confirmation of feed block deletion. More...

	exitDeleteFeedBlock ()
	Cancel deletion of feed block. More...

	deleteFeedBlock ()
	Delete feed block. More...

Static Public Member Functions
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

Static Public Attributes
static	$block_type = "pdfeed"

Protected Member Functions
	isRepositoryObject ()

Protected Attributes
	$settings

Detailed Description

BlockGUI class for external feed block on the personal desktop.

Within the repository ilExternalFeedBlockGUI is used. is used.

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

Version: $Id$

@ilCtrl_IsCalledBy ilPDExternalFeedBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPDExternalFeedBlockGUI::__construct ( )

Constructor.

Definition at line 56 of file class.ilPDExternalFeedBlockGUI.php.

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->access = $DIC->access();
        $this->settings = $DIC->settings();
        $lng = $DIC->language();
        
        parent::__construct();
        
        $lng->loadLanguageModule("feed");
        
        $this->setLimit(5);
        $this->setRowTemplate("tpl.block_external_feed_row.html", "Services/Feeds");
    }

References $DIC, $lng, ILIAS\GlobalScreen\Provider\__construct(), settings(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ confirmDeleteFeedBlock()

ilPDExternalFeedBlockGUI::confirmDeleteFeedBlock ( )

Confirmation of feed block deletion.

Definition at line 463 of file class.ilPDExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        include_once("Services/Utilities/classes/class.ilConfirmationGUI.php");
        $c_gui = new ilConfirmationGUI();
        
        // set confirm/cancel commands
        $c_gui->setFormAction($ilCtrl->getFormAction($this, "deleteFeedBlock"));
        $c_gui->setHeaderText($lng->txt("info_delete_sure"));
        $c_gui->setCancel($lng->txt("cancel"), "exitDeleteFeedBlock");
        $c_gui->setConfirm($lng->txt("confirm"), "deleteFeedBlock");
 
        // add items to delete
        $c_gui->addItem(
            "external_feed_block_id",
            $this->feed_block->getId(),
            $this->feed_block->getTitle(),
            ilUtil::getImagePath("icon_feed.svg")
        );
        
        return $c_gui->getHTML();
    }

References $lng, and ilUtil\getImagePath().

Here is the call graph for this function:

◆ create()

ilPDExternalFeedBlockGUI::create ( )

Create Form for Block.

Definition at line 395 of file class.ilPDExternalFeedBlockGUI.php.

    {
        return $this->createFeedBlock();
    }

◆ deleteFeedBlock()

ilPDExternalFeedBlockGUI::deleteFeedBlock ( )

Delete feed block.

Definition at line 501 of file class.ilPDExternalFeedBlockGUI.php.

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

◆ disableJS()

ilPDExternalFeedBlockGUI::disableJS ( )

Definition at line 294 of file class.ilPDExternalFeedBlockGUI.php.

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

References $_SESSION, and $ilUser.

◆ enableJS()

ilPDExternalFeedBlockGUI::enableJS ( )

Definition at line 304 of file class.ilPDExternalFeedBlockGUI.php.

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

References $_SESSION, $ilUser, exit, and getHTML().

Here is the call graph for this function:

◆ executeCommand()

ilPDExternalFeedBlockGUI::executeCommand ( )

execute command

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

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

◆ exitDeleteFeedBlock()

ilPDExternalFeedBlockGUI::exitDeleteFeedBlock ( )

Cancel deletion of feed block.

Definition at line 491 of file class.ilPDExternalFeedBlockGUI.php.

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

◆ fillDataSection()

ilPDExternalFeedBlockGUI::fillDataSection ( )

Fill data section.

Definition at line 158 of file class.ilPDExternalFeedBlockGUI.php.

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

References getDynamic(), getDynamicReload(), and getOverview().

Here is the call graph for this function:

◆ fillRow()

ilPDExternalFeedBlockGUI::fillRow ( $item )

Fill feed item row.

Definition at line 317 of file class.ilPDExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
 
        $ilCtrl->setParameter($this, "feed_item_id", $item->getId());
        $this->tpl->setVariable("VAL_TITLE", $item->getTitle());
        $this->tpl->setVariable(
            "HREF_SHOW",
            $ilCtrl->getLinkTarget($this, "showFeedItem")
        );
        $ilCtrl->setParameter($this, "feed_item_id", "");
    }

◆ getBlockType()

ilPDExternalFeedBlockGUI::getBlockType ( )

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

                                   : string
    {
        return self::$block_type;
    }

References $block_type.

◆ getDynamic()

ilPDExternalFeedBlockGUI::getDynamic ( )

Definition at line 222 of file class.ilPDExternalFeedBlockGUI.php.

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

References $_SESSION, and $ilUser.

Referenced by fillDataSection(), and getHTML().

Here is the caller graph for this function:

◆ getDynamicReload()

ilPDExternalFeedBlockGUI::getDynamicReload ( )

Definition at line 244 of file class.ilPDExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $ilCtrl->setParameterByClass(
            "ilcolumngui",
            "block_id",
            "block_pdfeed_" . $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_pdfeed_" . $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("ilpdexternalfeedblockgui", "disableJS")
        );
 
        return $rel_tpl->get();
    }

References $lng.

Referenced by fillDataSection().

Here is the caller graph for this function:

◆ getHTML()

ilPDExternalFeedBlockGUI::getHTML ( )

Get block HTML code.

Definition at line 172 of file class.ilPDExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
        $ilSetting = $this->settings;
        
 
        if ($ilSetting->get("block_limit_pdfeed") == 0) {
            return "";
        }
 
 
        // if no dynamic reload
        if (!$this->getDynamic()) {
            $this->feed->fetch();
            $this->setData($this->feed->getItems());
        }
 
        $ilCtrl->setParameter(
            $this,
            "external_feed_block_id",
            $this->getBlockId()
        );
        $this->addBlockCommand(
            $ilCtrl->getLinkTarget(
                $this,
                "editFeedBlock"
            ),
            $lng->txt("edit")
        );
        $this->addBlockCommand(
            $ilCtrl->getLinkTarget(
                $this,
                "confirmDeleteFeedBlock"
            ),
            $lng->txt("delete")
        );
        $ilCtrl->setParameter($this, "external_feed_block_id", "");
 
        // 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, $ilSetting, $ilUser, $lng, $settings, getDynamic(), and getJSEnabler().

Referenced by enableJS().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getJSEnabler()

ilPDExternalFeedBlockGUI::getJSEnabler ( )

Definition at line 273 of file class.ilPDExternalFeedBlockGUI.php.

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

Referenced by getHTML().

Here is the caller graph for this function:

◆ getOverview()

ilPDExternalFeedBlockGUI::getOverview ( )

Get overview.

Definition at line 333 of file class.ilPDExternalFeedBlockGUI.php.

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

References $lng.

Referenced by fillDataSection().

Here is the caller graph for this function:

◆ getScreenMode()

static ilPDExternalFeedBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Definition at line 94 of file class.ilPDExternalFeedBlockGUI.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.

◆ initFormFeedBlock()

ilPDExternalFeedBlockGUI::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 406 of file class.ilPDExternalFeedBlockGUI.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));
        
        $this->prepareFormFeedBlock($this->form_gui);
    }

References $lng.

◆ isRepositoryObject()

ilPDExternalFeedBlockGUI::isRepositoryObject ( )

protected

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

                                            : bool
    {
        return false;
    }

◆ prepareSaveFeedBlock()

ilPDExternalFeedBlockGUI::prepareSaveFeedBlock ( & $a_feed_block )

FORM FeedBlock: Prepare Saving of FeedBlock.

Parameters

object $a_feed_block FeedBlock object.

Definition at line 451 of file class.ilPDExternalFeedBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
        
        $a_feed_block->setContextObjId($ilCtrl->getContextObjId());
        $a_feed_block->setContextObjType($ilCtrl->getContextObjType());
        $a_feed_block->setType("pdfeed");
    }

◆ setBlock()

ilPDExternalFeedBlockGUI::setBlock ( $a_block )

Do most of the initialisation.

Definition at line 120 of file class.ilPDExternalFeedBlockGUI.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());
    }

◆ showFeedItem()

ilPDExternalFeedBlockGUI::showFeedItem ( )

Show Feed Item.

Definition at line 344 of file class.ilPDExternalFeedBlockGUI.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, $lng, and $tpl.

Field Documentation

◆ $block_type

ilPDExternalFeedBlockGUI::$block_type = "pdfeed"

static

Definition at line 51 of file class.ilPDExternalFeedBlockGUI.php.

Referenced by getBlockType().

◆ $settings

ilPDExternalFeedBlockGUI::$settings

protected

Definition at line 49 of file class.ilPDExternalFeedBlockGUI.php.

Referenced by getHTML().

◆ FORM_CREATE

const ilPDExternalFeedBlockGUI::FORM_CREATE = 1

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

◆ FORM_EDIT

const ilPDExternalFeedBlockGUI::FORM_EDIT = 0

Definition at line 41 of file class.ilPDExternalFeedBlockGUI.php.

◆ FORM_RE_CREATE

const ilPDExternalFeedBlockGUI::FORM_RE_CREATE = 2

Definition at line 44 of file class.ilPDExternalFeedBlockGUI.php.

◆ FORM_RE_EDIT

const ilPDExternalFeedBlockGUI::FORM_RE_EDIT = 2

Definition at line 43 of file class.ilPDExternalFeedBlockGUI.php.

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

Services/Feeds/classes/class.ilPDExternalFeedBlockGUI.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

◆ confirmDeleteFeedBlock()

◆ create()

◆ deleteFeedBlock()

◆ disableJS()

◆ enableJS()

◆ executeCommand()

◆ exitDeleteFeedBlock()

◆ fillDataSection()

◆ fillRow()

◆ getBlockType()

◆ getDynamic()

◆ getDynamicReload()

◆ getHTML()

◆ getJSEnabler()

◆ getOverview()

◆ getScreenMode()

◆ initFormFeedBlock()

◆ isRepositoryObject()

◆ prepareSaveFeedBlock()

◆ setBlock()

◆ showFeedItem()

Field Documentation

◆ $block_type

◆ $settings

◆ FORM_CREATE

◆ FORM_EDIT

◆ FORM_RE_CREATE

◆ FORM_RE_EDIT