ilExternalFeedBlockGUI Class Reference

BlockGUI class for external feed block. More...

Inheritance diagram for ilExternalFeedBlockGUI:

Collaboration diagram for ilExternalFeedBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	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...
	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 ilExternalFeedBlockGUIGen
	__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...

Static Public Member Functions
static	getBlockType ()
	Get block type. More...
static	isRepositoryObject ()
	Get block type. More...
static	getScreenMode ()
	Get Screen Mode for current command. More...
Static Public Member Functions inherited from ilBlockGUI
static	getBlockType ()
static	isRepositoryObject ()
static	getScreenMode ()
	Get Screen Mode for current command. More...

Static Public Attributes
static	$block_type = "feed"

Protected Attributes
	$settings
	$rbacsystem
	$obj_definition
Protected Attributes inherited from ilExternalFeedBlockGUIGen
	$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
Protected Member Functions inherited from ilBlockGUI
	fillRowColor ($a_placeholder="CSS_ROW")
	preloadData (array $data)
	Can be overwritten in subclasses. More...

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$

ilExternalFeedBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

__construct()

ilExternalFeedBlockGUI::__construct

(

)

Constructor.

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

References $DIC, ilBlockGUI\$lng, ilBlockGUI\setLimit(), ilBlockGUI\setRowTemplate(), settings(), and user().

    {
        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");
    }

Here is the call graph for this function:

Member Function Documentation

cancelUpdateFeedBlock()

ilExternalFeedBlockGUI::cancelUpdateFeedBlock

(

)

FORM FeedBlock: Exit save.

(Can be overwritten in derived classes)

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

References ilExternalFeedBlockGUIGen\getGuiObject().

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

Here is the call graph for this function:

create()

ilExternalFeedBlockGUI::create

(

)

Create Form for Block.

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

References $html1, $html2, ilExternalFeedBlockGUIGen\createFeedBlock(), and initImportForm().

    {
        $html1 = $this->createFeedBlock();

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

        return $html1 . $html2;
    }

Here is the call graph for this function:

disableJS()

ilExternalFeedBlockGUI::disableJS

(

)

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

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

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

enableJS()

ilExternalFeedBlockGUI::enableJS

(

)

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

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

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

Here is the call graph for this function:

executeCommand()

ilExternalFeedBlockGUI::executeCommand

(

)

execute command

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

References ilBlockGUI\$ctrl, and $ilCtrl.

    {
        $ilCtrl = $this->ctrl;

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

exitSaveFeedBlock()

ilExternalFeedBlockGUI::exitSaveFeedBlock

(

)

FORM FeedBlock: Exit save.

(Can be overwritten in derived classes)

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

References ilExternalFeedBlockGUIGen\getGuiObject().

Referenced by importFile().

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

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 574 of file class.ilExternalFeedBlockGUI.php.

References ilExternalFeedBlockGUIGen\getGuiObject().

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

Here is the call graph for this function:

fillDataSection()

ilExternalFeedBlockGUI::fillDataSection

(

)

Fill data section.

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

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

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

Here is the call graph for this function:

fillRow()

ilExternalFeedBlockGUI::fillRow

(

$item

)

Fill feed item row.

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

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

    {
        $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();
        }
    }

Here is the call graph for this function:

getBlockType()

static ilExternalFeedBlockGUI::getBlockType ( )

static

Get block type.

Returns

string Block type.

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

Referenced by prepareSaveFeedBlock().

    {
        return self::$block_type;
    }

Here is the caller graph for this function:

getDynamic()

ilExternalFeedBlockGUI::getDynamic

(

)

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

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

Referenced by fillDataSection(), and getHTML().

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

Here is the caller graph for this function:

getDynamicReload()

ilExternalFeedBlockGUI::getDynamicReload

(

)

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

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

Referenced by fillDataSection().

    {
        $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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilExternalFeedBlockGUI::getHTML

(

)

Get block HTML code.

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

References $_SESSION, ilBlockGUI\$access, ilBlockGUI\$ctrl, $feed_set, $ilCtrl, $ilSetting, $ilUser, ilBlockGUI\$lng, $settings, ilBlockGUI\$user, ilBlockGUI\addBlockCommand(), array, ilBlockGUI\getBlockId(), ilBlockGUI\getCurrentDetailLevel(), getDynamic(), getJSEnabler(), ilBlockGUI\getRefId(), and ilBlockGUI\setData().

Referenced by enableJS().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
        $ilAccess = $this->access;
        $ilSetting = $this->settings;
        
        if ($this->getCurrentDetailLevel() == 0) {
            return "";
        }

        $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($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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getJSEnabler()

ilExternalFeedBlockGUI::getJSEnabler

(

)

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

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

Referenced by getHTML().

    {
        $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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOverview()

ilExternalFeedBlockGUI::getOverview

(

)

Get overview.

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

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

Referenced by fillDataSection().

    {
        $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>";
    }

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.

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

References $DIC, $ilCtrl, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

    {
        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;
        }
    }

importFile()

ilExternalFeedBlockGUI::importFile

(

)

Import.

public

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

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

    {
        $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());
    }

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 (IL_FORM_EDIT | IL_FORM_CREATE)

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

References ilBlockGUI\$lng, array, IL_FORM_CREATE, IL_FORM_RE_CREATE, ilExternalFeedBlockGUIGen\prepareFormFeedBlock(), and ilFormPropertyGUI\setInfo().

    {
        $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(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:

initImportForm()

ilExternalFeedBlockGUI::initImportForm

(

$a_new_type = ""

)

Init object import form.

Parameters

string

new type

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

References ilBlockGUI\$ctrl, $ilCtrl, ilBlockGUI\$lng, array, and ilFileInputGUI\setSuffixes().

Referenced by create(), and importFile().

    {
        $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));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isRepositoryObject()

static ilExternalFeedBlockGUI::isRepositoryObject ( )

static

Get block type.

Returns

string Block type.

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

Referenced by fillRow().

    {
        return true;
    }

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 546 of file class.ilExternalFeedBlockGUI.php.

References getBlockType(), and ilExternalFeedBlockGUIGen\getGuiObject().

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

Here is the call graph for this function:

setBlock()

ilExternalFeedBlockGUI::setBlock

(

$a_block

)

Do most of the initialisation.

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

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

    {
        $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
        $this->setAvailableDetailLevels(2);
        
        $ilCtrl->setParameter($this, "block_id", $this->feed_block->getId());
    }

Here is the call graph for this function:

showFeedItem()

ilExternalFeedBlockGUI::showFeedItem

(

)

Show Feed Item.

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

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

    {
        $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
        }
        
        include_once("./Services/PersonalDesktop/classes/class.ilPDContentBlockGUI.php");
        $content_block = new ilPDContentBlockGUI();
        $content_block->setContent($tpl->get());
        $content_block->setTitle($this->getTitle());
        $content_block->setImage(ilUtil::getImagePath("icon_feed.svg"));
        $content_block->addHeaderCommand(
            $ilCtrl->getParentReturn($this),
            $lng->txt("close"),
            true
        );

        return $content_block->getHTML();
    }

Here is the call graph for this function:

Field Documentation

$block_type

ilExternalFeedBlockGUI::$block_type = "feed"

static

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

$obj_definition

ilExternalFeedBlockGUI::$obj_definition

protected

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

$rbacsystem

ilExternalFeedBlockGUI::$rbacsystem

protected

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

Referenced by importFile().

$settings

ilExternalFeedBlockGUI::$settings

protected

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

Referenced by getHTML().

---

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

• Services/Block/classes/class.ilExternalFeedBlockGUI.php