This class represents a block method of a block. More...

Inheritance diagram for ilBlockGUI:

Collaboration diagram for ilBlockGUI:

Public Member Functions
	ilBlockGUI ()
	Constructor.
	addHeaderLink ($a_href, $a_text, $status=true)
	getHeaderLinks ()
	setData ($a_data)
	Set Data.
	getData ()
	Get Data.
	setBigMode ($a_bigmode)
	Set Big Mode.
	getBigMode ()
	Get Big Mode.
	setBlockId ($a_block_id=0)
	Set Block Id.
	getBlockId ()
	Get Block Id.
	setAvailableDetailLevels ($a_max, $a_min=0)
	Set Available Detail Levels.
	setCurrentDetailLevel ($a_currentdetaillevel)
	Set Current Detail Level.
	setGuiObject (&$a_gui_object)
	Set GuiObject.
	getGuiObject ()
	Get GuiObject.
	getCurrentDetailLevel ()
	Get Current Detail Level.
	setTitle ($a_title)
	Set Title.
	getTitle ()
	Get Title.
	setImage ($a_image)
	Set Image.
	getImage ()
	Get Image.
	setOffset ($a_offset)
	Set Offset.
	getOffset ()
	Get Offset.
	correctOffset ()
	setLimit ($a_limit)
	Set Limit.
	getLimit ()
	Get Limit.
	setEnableEdit ($a_enableedit)
	Set EnableEdit.
	getEnableEdit ()
	Get EnableEdit.
	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode.
	getRepositoryMode ()
	Get RepositoryMode.
	setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
	Set Footer Info.
	getFooterInfo ($a_hide_and_icon=false)
	Get Footer Info.
	setSubtitle ($a_subtitle)
	Set Subtitle.
	getSubtitle ()
	Get Subtitle.
	setRefId ($a_refid)
	Set Ref Id (only used if isRepositoryObject() is true).
	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true).
	setAdminCommands ($a_admincommands)
	Set Administration Commmands.
	getAdminCommands ()
	Get Administration Commmands.
	setColSpan ($a_colspan)
	Set Columns Span.
	getColSpan ()
	Get Columns Span.
	setEnableDetailRow ($a_enabledetailrow)
	Set EnableDetailRow.
	getEnableDetailRow ()
	Get EnableDetailRow.
	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info.
	getEnableNumInfo ()
	Get Enable Item Number Info.
	setProperties ($a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties.
	getProperty ($a_property)
	setProperty ($a_property, $a_value)
	setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
	Set Row Template Name.
	getNavParameter ()
	getDetailParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	Get Row Template Name.
	getRowTemplateDir ()
	Get Row Template Directory.
	addBlockCommand ($a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false)
	Add Block Command.
	getBlockCommands ()
	Get Block commands.
	addHeaderCommand ($a_href, $a_text, $a_as_close=false)
	Add Header Block Command.
	getHeaderCommands ()
	Get Header Block commands.
	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.
	getFooterLinks ()
	Get footer links.
	clearFooterLinks ()
	Clear footer links.
	handleDetailLevel ()
	Handle read/write current detail level.
	getHTML ()
	Handle config status.
	fillHeaderCommands ()
	Fill header commands block.
	fillHeaderTitleBlock ()
	Fill header title block (title and.
	setDataSection ($a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used.
	fillDataSection ()
	Standard implementation for row based data.
	fillRow ($a_set)
	fillFooter ()
	fillPreviousNext ()
	Fill previous/next row.
	setPreviousNextLinks ()
	Get previous/next linkbar.
	fillFooterLinks ($a_top=false, $a_numinfo="")
	Fill footer links.
	fillDetailRow ()
	Fill Detail Setting Row.

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

Protected Member Functions
	fillRowColor ($a_placeholder="CSS_ROW")
	preloadData (array $data)
	Can be overwritten in subclasses.

Protected Attributes
	$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

Detailed Description

This class represents a block method of a block.

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

Version

Id:: class.ilBlockGUI.php 41738 2013-04-24 11:41:26Z jluetzen

Definition at line 12 of file class.ilBlockGUI.php.

Member Function Documentation

ilBlockGUI::addBlockCommand	(	$a_href,
		$a_text,
		$a_target = `""`,
		$a_img = `""`,
		$a_right_aligned = `false`,
		$a_checked = `false`
	)

Add Block Command.

Parameters

string	$a_href	command link target
string	$a_text	text

Definition at line 546 of file class.ilBlockGUI.php.

Referenced by ilWikiImportantPagesBlockGUI\getHTML(), ilExternalFeedBlockGUI\getHTML(), ilPDExternalFeedBlockGUI\getHTML(), ilPollBlockGUI\getHTML(), ilPDNewsBlockGUI\getHTML(), ilNewsForContextBlockGUI\getHTML(), ilCalendarBlockGUI\getHTML(), getHTML(), and ilCalendarSelectionBlockGUI\ilCalendarSelectionBlockGUI().

        {
                return $this->block_commands[] = 
                        array("href" => $a_href,
                                "text" => $a_text, "target" => $a_target, "img" => $a_img,
                                "right" => $a_right_aligned, "checked" => $a_checked);
        }

Here is the caller graph for this function:

ilBlockGUI::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.

Definition at line 598 of file class.ilBlockGUI.php.

Referenced by ilBookmarkBlockGUI\setFooterLinks(), ilPDSelectedItemsBlockGUI\setFooterLinks(), ilCalendarBlockGUI\setFooterLinks(), setPreviousNextLinks(), and ilNewsForContextBlockGUI\showViewFooter().

        {
                $this->footer_links[] = array(
                        "text" => $a_text,
                        "href" => $a_href,
                        "onclick" => $a_onclick,
                        "block_id" => $a_block_id,
                        "top" => $a_top,
                        "omit_separator" => $a_omit_separator,
                        "checked" => $a_checked);
        }

Here is the caller graph for this function:

ilBlockGUI::addHeaderCommand	(	$a_href,
		$a_text,
		$a_as_close = `false`
	)

Add Header Block Command.

Parameters

string	$a_href	command link target
string	$a_text	text

Definition at line 571 of file class.ilBlockGUI.php.

        {
                if ($a_as_close)
                {
                        $this->close_command = $a_href;
                }
                else
                {
                        $this->header_commands[] = 
                                array("href" => $a_href,
                                        "text" => $a_text);
                }
        }

ilBlockGUI::addHeaderLink	(	$a_href,
		$a_text,
		$status = `true`
	)

Definition at line 59 of file class.ilBlockGUI.php.

        {
                $this->header_links[] = 
                        array('href' => $a_href, 'text' => $a_text, 'status' => (bool)$status);
        }

ilBlockGUI::clearFooterLinks ( )

Clear footer links.

Definition at line 622 of file class.ilBlockGUI.php.

Referenced by ilNewsForContextBlockGUI\showViewFooter().

        {
                $this->footer_links = array();
        }

Here is the caller graph for this function:

ilBlockGUI::correctOffset ( )

Definition at line 245 of file class.ilBlockGUI.php.

References setOffset().

Referenced by fillDataSection().

        {
                if (!($this->offset < $this->max_count))
                {
                        $this->setOffset(0);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::fillDataSection ( )

Standard implementation for row based data.

Overwrite this and call setContent for other data.

Reimplemented in ilPDSelectedItemsBlockGUI, ilCalendarBlockGUI, ilNewsForContextBlockGUI, ilCalendarSelectionBlockGUI, ilPDNewsBlockGUI, ilUsersOnlineBlockGUI, ilPDExternalFeedBlockGUI, ilHtmlBlockGUI, ilExternalFeedBlockGUI, ilPDMailBlockGUI, ilPDTaggingBlockGUI, ilWikiFunctionsBlockGUI, ilWikiSearchBlockGUI, ilWikiSideBlockGUI, ilDummyBlockGUI, ilWikiImportantPagesBlockGUI, ilPDContentBlockGUI, ilBookmarkBlockGUI, and ilPDNotesBlockGUI.

Definition at line 999 of file class.ilBlockGUI.php.

References $_GET, $_POST, $_SESSION, $data, $nav_value, correctOffset(), fillRow(), fillRowColor(), getData(), getLimit(), getNavParameter(), getOffset(), getRowTemplateDir(), getRowTemplateName(), preloadData(), and setOffset().

Referenced by getHTML().

        {
                $this->nav_value = (isset($_POST[$this->getNavParameter()]) && $_POST[$this->getNavParameter()] != "")
                        ? $_POST[$this->getNavParameter()]
                        : (isset($_GET[$this->getNavParameter()]) ? $_GET[$this->getNavParameter()] : $this->nav_value);
                $this->nav_value = ($this->nav_value == "" && isset($_SESSION[$this->getNavParameter()]))
                        ? $_SESSION[$this->getNavParameter()]
                        : $this->nav_value;
                        
                $_SESSION[$this->getNavParameter()] = $this->nav_value;
                        
                $nav = explode(":", $this->nav_value);
                if (isset($nav[2]))
                {
                        $this->setOffset($nav[2]);
                }
                else
                {
                        $this->setOffset(0);
                }
                
                // data
                $this->tpl->addBlockFile("BLOCK_ROW", "block_row", $this->getRowTemplateName(),
                        $this->getRowTemplateDir());
                        
                $data = $this->getData();
                $this->max_count = count($data);
                $this->correctOffset();
                $data = array_slice($data, $this->getOffset(), $this->getLimit());
                
                $this->preloadData($data);
                
                foreach($data as $record)
                {
                        $this->tpl->setCurrentBlock("block_row");
                        $this->fillRowColor();
                        $this->fillRow($record);
                        $this->tpl->setCurrentBlock("block_row");
                        $this->tpl->parseCurrentBlock();
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::fillDetailRow ( )

Fill Detail Setting Row.

Definition at line 1267 of file class.ilBlockGUI.php.

References $block_id, $detail_min, $ilCtrl, $lng, getBlockId(), getBlockType(), getCurrentDetailLevel(), getDetailParameter(), getFooterInfo(), and ilUtil\getImagePath().

Referenced by getHTML().

        {
                global $ilCtrl, $lng;
                if ($this->enabledetailrow == false)
                {
                        return;
                }
                
                $start = ($this->detail_min < 1)
                        ? $start = 1
                        : $this->detail_min;
                
                $end = ($this->detail_max < $this->detail_min)
                        ? $this->detail_min
                        : $this->detail_max;
                
                $settings = array();
                for ($i = $start; $i <= $end; $i++)
                {
                        $settings[] = $i;
                }
                
                if ($end > $start)
                {
                        foreach ($settings as $i)
                        {
                                if (($i > $start && $i > 1))
                                {
                                        //$this->tpl->touchBlock("det_delim");
                                        //$this->tpl->touchBlock("det_item");
                                }
//                              if ($i != $this->getCurrentDetailLevel())
//                              {
                                        $ilCtrl->setParameterByClass("ilcolumngui",
                                                $this->getDetailParameter(), $i);
                                        $onclick = $onclick_id = "";
                                        
                                        // ajax link
                                        if ($i > 0)
                                        {
                                                $ilCtrl->setParameterByClass("ilcolumngui",
                                                        "block_id", "block_".$this->getBlockType()."_".$this->block_id);
                                                $onclick = $ilCtrl->getLinkTargetByClass("ilcolumngui",
                                                        "updateBlock", "", true);
                                                $onclick_id = "block_".$this->getBlockType()."_".$this->block_id;
                                                $ilCtrl->setParameterByClass("ilcolumngui",
                                                        "block_id", "");                                                                                
                                        }
                                                                                                                                                                        
                                        // normal link                                                                          
                                        //$icon = ilUtil::getImagePath("details".$i.".png");
                                        $text = $lng->txt("details")." ".$i;
                                        $url = $ilCtrl->getLinkTargetByClass("ilcolumngui",     "");
                                        
                                        if($onclick)
                                        {
                                                $onclick = "ilBlockJSHandler('".$onclick_id."','".$onclick."')";
                                        }
                                        
                                        $checked = ($i == $this->getCurrentDetailLevel());
                                        $this->dropdown[] = array("text" => $text,
                                                "image" => $icon,
                                                "href" => $url,
                                                "onclick" => $onclick,
                                                "checked" => $checked);
//                              }                               
                        }
                        
                        // info + icon in detail row
                        if ($this->getFooterInfo(true) != "")
                        {
                                $this->tpl->setCurrentBlock("det_info");
                                $this->tpl->setVariable("INFO_TEXT", $this->getFooterInfo(true));
                                $this->tpl->setVariable("ALT_DET_INFO", $lng->txt("info_short"));
                                $this->tpl->setVariable("DI_BLOCK_ID", $this->getBlockType()."_".$this->getBlockId());
                                $this->tpl->setVariable("IMG_DET_INFO", ilUtil::getImagePath("icon_info_s.png"));
                                $this->tpl->parseCurrentBlock();
                        }
                        
                        /*
                        $this->tpl->setCurrentBlock("detail_setting");
                        $this->tpl->setVariable("TXT_DETAILS", $lng->txt("details"));
                        $this->tpl->setVariable("DCOLSPAN", $this->getColSpan());
                        $this->tpl->parseCurrentBlock();
                        */
                        
                        $ilCtrl->setParameterByClass("ilcolumngui",
                                $this->getDetailParameter(), "");
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::fillFooter ( )

Reimplemented in ilNewsForContextBlockGUI, ilCalendarBlockGUI, ilPDSelectedItemsBlockGUI, ilPDTaggingBlockGUI, ilBookmarkBlockGUI, and ilPDContentBlockGUI.

Definition at line 1049 of file class.ilBlockGUI.php.

Referenced by getHTML().

{

}

Here is the caller graph for this function:

ilBlockGUI::fillFooterLinks	(	$a_top = `false`,
		$a_numinfo = `""`
	)

Fill footer links.

Returns: array linkbar or false on error

Definition at line 1176 of file class.ilBlockGUI.php.

References $ilCtrl, $lng, and getFooterLinks().

Referenced by ilPDContentBlockGUI\fillFooter(), ilBookmarkBlockGUI\fillFooter(), ilPDTaggingBlockGUI\fillFooter(), ilPDSelectedItemsBlockGUI\fillFooter(), ilCalendarBlockGUI\fillFooter(), fillPreviousNext(), and ilNewsForContextBlockGUI\showViewFooter().

        {
                global $ilCtrl, $lng;
                $first = true;
                $flinks = $this->getFooterLinks();
                
                $prefix = ($a_top) ? "top" : "foot";
                
                $has_link = false;
                $omit_separator = false;
                foreach($flinks as $flink)
                {
                        if ($flink["top"] != $a_top)
                        {
                                continue;
                        }
                        
                        if(!$a_top)
                        {                       
                                if($flink["onclick"])
                                {
                                        $flink["onclick"] = "ilBlockJSHandler('".$flink["block_id"].
                                                "','".$flink["onclick"]."')";
                                }
                                $this->dropdown[] = $flink;
                                continue;
                        }
                        
                        $has_link = true;
                        
                        if (!$first && !$omit_separator)
                        {
                                $this->tpl->touchBlock($prefix."_delim");
                                $this->tpl->touchBlock($prefix."_item");
                        }
                        // ajax link
                        if ($flink["onclick"] != "")
                        {
                                $this->tpl->setCurrentBlock($prefix."_onclick");
                                $this->tpl->setVariable("OC_BLOCK_ID",
                                        $flink["block_id"]);
                                $this->tpl->setVariable("OC_HREF",
                                        $flink["onclick"]);
                                $this->tpl->parseCurrentBlock();
                        }
                        
                        // normal link
                        if ($flink["href"] != "")
                        {
                                // normal link
                                $this->tpl->setCurrentBlock($prefix."_link");
                                $this->tpl->setVariable("FHREF",
                                        $flink["href"]);
                                $this->tpl->setVariable("FLINK", $flink["text"]);
                                $this->tpl->parseCurrentBlock();
                                $this->tpl->touchBlock($prefix."_item");
                        }
                        else
                        {
                                $this->tpl->setCurrentBlock($prefix."_text");
                                $this->tpl->setVariable("FTEXT", $flink["text"]);
                                $this->tpl->parseCurrentBlock();
                                $this->tpl->touchBlock($prefix."_item");
                        }
                                 
                        $first = false;
                        $omit_separator = $flink["omit_separator"];                     
                }
                if ($a_numinfo != "" && $has_link)
                {
                        $this->tpl->setVariable("NUMINFO", $a_numinfo);
                        $first = false;
                }
                /*
                if (!$first)
                {
                        $this->tpl->setVariable("PCOLSPAN", $this->getColSpan());
                        $this->tpl->setCurrentBlock($prefix."_row");
                        $this->tpl->parseCurrentBlock();
                }                
                */
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::fillHeaderCommands ( )

Fill header commands block.

Definition at line 899 of file class.ilBlockGUI.php.

References $close_command, $ilCtrl, $img, $lng, getDetailParameter(), getHeaderCommands(), and getRepositoryMode().

Referenced by getHTML().

        {
                global $lng, $ilCtrl;
                
                // header commands
                if (count($this->getHeaderCommands()) > 0 ||
                        ($this->detail_max > $this->detail_min && $this->detail_min == 0) ||
                        $this->close_command != "")
                {
                        foreach($this->getHeaderCommands() as $command)
                        {                       
                                $this->tpl->setCurrentBlock("header_command");
                                $this->tpl->setVariable("HREF_HCOMM", $command["href"]);
                                $this->tpl->setVariable("TXT_HCOMM", $command["text"]);
                                $this->tpl->parseCurrentBlock();
                        }
                        // close button
                        if (($this->detail_max > $this->detail_min && $this->detail_min == 0 &&
                                !$this->getRepositoryMode())
                                ||
                                $this->close_command != "")
                        {
                                $alt = $lng->txt("hide");                                                               
                                if ($this->close_command != "")
                                {
                                        $url = $this->close_command;                                    
                                }
                                else
                                {
                                        $ilCtrl->setParameterByClass("ilcolumngui",
                                                $this->getDetailParameter(), "0");
                                        $url = $ilCtrl->getLinkTargetByClass("ilcolumngui", "");                                        
                                        $ilCtrl->setParameterByClass("ilcolumngui",
                                                $this->getDetailParameter(), "");
                                }
                                
                                $this->dropdown[] = array("text" => $alt,
                                        "image" => $img,
                                        "href" => $url);
                        }
                        
                        $this->tpl->setCurrentBlock("header_commands");
                        $this->tpl->parseCurrentBlock();
                }
                
                $this->tpl->setCurrentBlock("hitem");
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::fillHeaderTitleBlock ( )

Fill header title block (title and.

Definition at line 954 of file class.ilBlockGUI.php.

References $lng, getBlockType(), getImage(), and getTitle().

Referenced by getHTML().

        {
                global $lng;
                
                // image
                if ($this->getImage() != "")
                {
                        $this->tpl->setCurrentBlock("block_img");
                        $this->tpl->setVariable("IMG_BLOCK", $this->getImage());
                        $this->tpl->setVariable("IMID",
                                "block_".$this->getBlockType()."_".$this->block_id);
                        $this->tpl->setVariable("IMG_ALT",
                                str_replace(array("'",'"'), "", strip_tags($lng->txt("icon")." ".$this->getTitle())));
                        $this->tpl->parseCurrentBlock();
                }
                // header title
                $this->tpl->setCurrentBlock("header_title");
                $this->tpl->setVariable("BTID",
                        "block_".$this->getBlockType()."_".$this->block_id);
                $this->tpl->setVariable("BLOCK_TITLE",
                        $this->getTitle());
                $this->tpl->setVariable("TXT_BLOCK",
                        $lng->txt("block"));
                $this->tpl->parseCurrentBlock();
                        
                $this->tpl->setCurrentBlock("hitem");
                $this->tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::fillPreviousNext ( )

Fill previous/next row.

Reimplemented in ilPDContentBlockGUI.

Definition at line 1064 of file class.ilBlockGUI.php.

References $ilCtrl, $lng, $max_count, fillFooterLinks(), getEnableNumInfo(), getLimit(), getOffset(), and setPreviousNextLinks().

Referenced by getHTML().

        {
                global $lng, $ilCtrl;
                $pn = false;
                                
                // table pn numinfo
                $numinfo = "";
                if ($this->getEnableNumInfo() && $this->max_count > 0)
                {
                        $start = $this->getOffset() + 1;                                // compute num info
                        $end = $this->getOffset() + $this->getLimit();
                                
                        if ($end > $this->max_count or $this->getLimit() == 0)
                        {
                                $end = $this->max_count;
                        }
                                
                        $numinfo = "(".$start."-".$end." ".strtolower($lng->txt("of"))." ".$this->max_count.")";
                }
                $this->setPreviousNextLinks();
                $this->fillFooterLinks(true, $numinfo);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::fillRow ( $a_set )

Reimplemented in ilNewsForContextBlockGUI, ilPDExternalFeedBlockGUI, ilExternalFeedBlockGUI, ilBookmarkBlockGUI, ilUsersOnlineBlockGUI, ilPDNotesBlockGUI, ilPDMailBlockGUI, and ilPollBlockGUI.

Definition at line 1041 of file class.ilBlockGUI.php.

Referenced by fillDataSection().

        {
                foreach ($a_set as $key => $value)
                {
                        $this->tpl->setVariable("VAL_".strtoupper($key), $value);
                }
        }

Here is the caller graph for this function:

ilBlockGUI::fillRowColor ( $a_placeholder = "CSS_ROW" )

finalprotected

Definition at line 1053 of file class.ilBlockGUI.php.

Referenced by fillDataSection().

        {
                $this->css_row = ($this->css_row != "ilBlockRow1")
                        ? "ilBlockRow1"
                        : "ilBlockRow2";
                $this->tpl->setVariable($a_placeholder, $this->css_row);
        }

Here is the caller graph for this function:

ilBlockGUI::getAdminCommands ( )

Get Administration Commmands.

Returns: boolean Administration Commmands

Definition at line 402 of file class.ilBlockGUI.php.

Referenced by getHTML().

        {
                return $this->admincommands;
        }

Here is the caller graph for this function:

ilBlockGUI::getBigMode ( )

Get Big Mode.

Returns: boolean Big Mode

Definition at line 105 of file class.ilBlockGUI.php.

References $bigmode.

Referenced by getHTML().

        {
                return $this->bigmode;
        }

Here is the caller graph for this function:

ilBlockGUI::getBlockCommands ( )

Get Block commands.

Returns: array block commands

Definition at line 560 of file class.ilBlockGUI.php.

References $block_commands.

Referenced by getHTML().

        {
                return $this->block_commands;
        }

Here is the caller graph for this function:

ilBlockGUI::getBlockId ( )

Get Block Id.

Returns: int Block Id

Definition at line 125 of file class.ilBlockGUI.php.

References $block_id.

Referenced by ilCalendarBlockGUI\addMiniMonth(), fillDetailRow(), getConfigParameter(), getDetailParameter(), ilExternalFeedBlockGUI\getDynamicReload(), ilPDExternalFeedBlockGUI\getDynamicReload(), ilNewsForContextBlockGUI\getDynamicReload(), ilExternalFeedBlockGUI\getHTML(), ilPDExternalFeedBlockGUI\getHTML(), ilExternalFeedBlockGUI\getJSEnabler(), ilPDExternalFeedBlockGUI\getJSEnabler(), ilNewsForContextBlockGUI\getJSEnabler(), getMoveParameter(), getNavParameter(), ilCalendarBlockGUI\ilCalendarBlockGUI(), and ilCalendarBlockGUI\setSeed().

        {
                return $this->block_id;
        }

Here is the caller graph for this function:

static ilBlockGUI::getBlockType ( )

staticabstract

ilBlockGUI::getColSpan ( )

Get Columns Span.

Returns: int Columns Span

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

References $colspan.

Referenced by ilBookmarkBlockGUI\fillFooter(), ilPDTaggingBlockGUI\fillFooter(), ilPDSelectedItemsBlockGUI\fillFooter(), ilCalendarBlockGUI\fillFooter(), and getHTML().

        {
                return $this->colspan;
        }

Here is the caller graph for this function:

ilBlockGUI::getConfigParameter ( )

final

Definition at line 510 of file class.ilBlockGUI.php.

References getBlockId(), and getBlockType().

        {
                return $this->getBlockType()."_".$this->getBlockId()."_blconf";
        }

Here is the call graph for this function:

ilBlockGUI::getCurrentDetailLevel ( )

Get Current Detail Level.

Returns: int Current Detail Level

Definition at line 180 of file class.ilBlockGUI.php.

        {
                return $this->currentdetaillevel;
        }

Here is the caller graph for this function:

ilBlockGUI::getData ( )

Get Data.

Returns: array Data

Reimplemented in ilCalendarBlockGUI.

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

References $data.

Referenced by ilExternalFeedBlockGUI\fillDataSection(), ilPDExternalFeedBlockGUI\fillDataSection(), ilPDNewsBlockGUI\fillDataSection(), ilNewsForContextBlockGUI\fillDataSection(), fillDataSection(), ilNewsForContextBlockGUI\getHTML(), ilExternalFeedBlockGUI\getOverview(), ilPDExternalFeedBlockGUI\getOverview(), ilNewsForContextBlockGUI\getOverview(), and ilNewsForContextBlockGUI\showNews().

        {
                return $this->data;
        }

Here is the caller graph for this function:

ilBlockGUI::getDetailParameter ( )

final

Definition at line 505 of file class.ilBlockGUI.php.

References getBlockId(), and getBlockType().

Referenced by fillDetailRow(), fillHeaderCommands(), and handleDetailLevel().

        {
                return $this->getBlockType()."_".$this->getBlockId()."_bldet";
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::getEnableDetailRow ( )

Get EnableDetailRow.

Returns: boolean EnableDetailRow

Definition at line 442 of file class.ilBlockGUI.php.

References $enabledetailrow.

        {
                return $this->enabledetailrow;
        }

ilBlockGUI::getEnableEdit ( )

Get EnableEdit.

Returns: boolean EnableEdit

Reimplemented in ilCalendarBlockGUI, and ilNewsForContextBlockGUI.

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

        {
                return $this->enableedit;
        }

ilBlockGUI::getEnableNumInfo ( )

Get Enable Item Number Info.

Returns: boolean Enable Item Number Info

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

References $enablenuminfo.

Referenced by ilPDContentBlockGUI\fillFooter(), and fillPreviousNext().

        {
                return $this->enablenuminfo;
        }

Here is the caller graph for this function:

ilBlockGUI::getFooterInfo ( $a_hide_and_icon = false )

Get Footer Info.

Returns: string Footer Info

Definition at line 335 of file class.ilBlockGUI.php.

References $footerinfo, and $footerinfo_icon.

Referenced by fillDetailRow(), and getHTML().

        {
                if ($a_hide_and_icon)
                {
                        return $this->footerinfo_icon;
                }
                else
                {
                        return $this->footerinfo;
                }
        }

Here is the caller graph for this function:

ilBlockGUI::getFooterLinks ( )

Get footer links.

Definition at line 614 of file class.ilBlockGUI.php.

References $footer_links.

Referenced by fillFooterLinks().

        {
                return $this->footer_links;
        }

Here is the caller graph for this function:

ilBlockGUI::getGuiObject ( )

Get GuiObject.

Returns: object GUI object

Reimplemented in ilExternalFeedBlockGUIGen.

Definition at line 170 of file class.ilBlockGUI.php.

        {
                return $this->gui_object;
        }

ilBlockGUI::getHeaderCommands ( )

Get Header Block commands.

Returns: array header block commands

Definition at line 590 of file class.ilBlockGUI.php.

References $header_commands.

Referenced by fillHeaderCommands().

        {
                return $this->header_commands;
        }

Here is the caller graph for this function:

ilBlockGUI::getHeaderLinks ( )

Definition at line 65 of file class.ilBlockGUI.php.

References $header_links.

Referenced by getHTML().

        {
                return $this->header_links;
        }

Here is the caller graph for this function:

ilBlockGUI::getHTML ( )

Handle config status.

Get HTML.

Reimplemented in ilCalendarBlockGUI, ilCalendarSelectionBlockGUI, ilNewsForContextBlockGUI, ilPDNewsBlockGUI, ilPollBlockGUI, ilPDSelectedItemsBlockGUI, ilPDExternalFeedBlockGUI, ilExternalFeedBlockGUI, ilDummyBlockGUI, ilHtmlBlockGUI, ilWikiFunctionsBlockGUI, ilWikiSearchBlockGUI, ilWikiSideBlockGUI, ilUsersOnlineBlockGUI, ilPDTaggingBlockGUI, ilPDContentBlockGUI, ilChatroomBlockGUI, ilBookmarkBlockGUI, ilPDNotesBlockGUI, ilPDMailBlockGUI, and ilPDSysMessageBlockGUI.

Definition at line 693 of file class.ilBlockGUI.php.

References $_GET, $dropdown, $ilCtrl, $ilUser, $lng, addBlockCommand(), fillDataSection(), fillDetailRow(), fillFooter(), fillHeaderCommands(), fillHeaderTitleBlock(), fillPreviousNext(), getAdminCommands(), getBigMode(), getBlockCommands(), getBlockType(), getColSpan(), getFooterInfo(), getHeaderLinks(), ilUtil\getImagePath(), getRefId(), getRepositoryMode(), and isRepositoryObject().

Referenced by ilWikiImportantPagesBlockGUI\getHTML().

        {
                global $ilCtrl, $lng, $ilAccess, $ilUser;
                
                if ($this->isRepositoryObject())
                {
                        if (!$ilAccess->checkAccess("read", "", $this->getRefId()))
                        {
                                return "";
                        }
                }
                
                $this->tpl = new ilTemplate("tpl.block.html", true, true, "Services/Block");
                
//              $this->handleConfigStatus();
                
                $this->fillDataSection();
                
                if ($this->getRepositoryMode() && $this->isRepositoryObject())
                {
                        // #10993
                        if ($this->getAdminCommands())
                        {
                                $this->tpl->setCurrentBlock("block_check");
                                $this->tpl->setVariable("BL_REF_ID", $this->getRefId());
                                $this->tpl->parseCurrentBlock();
                        }
                        
                        if ($ilAccess->checkAccess("delete", "", $this->getRefId()))
                        {
                                $this->addBlockCommand(
                                        "ilias.php?baseClass=ilRepositoryGUI&ref_id=".$_GET["ref_id"]."&cmd=delete".
                                        "&item_ref_id=".$this->getRefId(),
                                        $lng->txt("delete"));
                        }
                }
                // footer info
                if ($this->getFooterInfo() != "")
                {
                        $this->tpl->setCurrentBlock("footer_information");
                        $this->tpl->setVariable("FOOTER_INFO", $this->getFooterInfo());
                        $this->tpl->setVariable("FICOLSPAN", $this->getColSpan());
                        $this->tpl->parseCurrentBlock();
                }
                
                $this->dropdown = array();
                
                // commands
                if (count($this->getBlockCommands()) > 0)
                {
                        $has_block_command = false;
                        
                        foreach($this->getBlockCommands() as $command)
                        {
                                if(!$command["img"])
                                {
                                        $this->dropdown[] = $command;
                                        continue;
                                }                               
                                
                                $has_block_command = true;
                                
                                if ($command["target"] != "")
                                {
                                        $this->tpl->setCurrentBlock("bc_target");
                                        $this->tpl->setVariable("CMD_TARGET", $command["target"]);
                                        $this->tpl->parseCurrentBlock();
                                }
                                        
                                if ($command["img"] != "")
                                {
                                        $this->tpl->setCurrentBlock("bc_image");
                                        $this->tpl->setVariable("SRC_BC", $command["img"]);
                                        $this->tpl->setVariable("ALT_BC", $command["text"]);
                                        $this->tpl->parseCurrentBlock();
                                        $this->tpl->setCurrentBlock("block_command");
                                }
                                else
                                {
                                        $this->tpl->setCurrentBlock("block_command");
                                        $this->tpl->setVariable("CMD_TEXT", $command["text"]);
                                        $this->tpl->setVariable("BC_CLASS", 'class="il_ContainerItemCommand"');
                                }
                                $this->tpl->setVariable("CMD_HREF", $command["href"]);
                                $this->tpl->parseCurrentBlock();                                
                        }
                        
                        if($has_block_command)
                        {
                                $this->tpl->setCurrentBlock("block_commands");
                                $this->tpl->setVariable("CCOLSPAN", $this->getColSpan());
                                $this->tpl->parseCurrentBlock();                
                        }
                }
                
                // fill previous next
                $this->fillPreviousNext();
                // fill footer
                $this->fillFooter();
                
                // fill row for setting details
                $this->fillDetailRow();
                // header links
                if(count($this->getHeaderLinks()))
                {
                        $counter = 0;
                        foreach($this->getHeaderLinks() as $command)
                        {
                                if($counter > 0)
                                {
                                        $this->tpl->setCurrentBlock('head_delim');
                                        $this->tpl->touchBlock('head_delim');
                                        $this->tpl->parseCurrentBlock();
                                }
                                if($command['status'] == true)
                                {
                                        $this->tpl->setCurrentBlock('head_link');
                                        $this->tpl->setVariable('HHREF', $command['href']);
                                        $this->tpl->setVariable('HLINK', $command['text']);     
                                        $this->tpl->parseCurrentBlock();
                                }
                                else
                                {
                                        $this->tpl->setCurrentBlock('head_text');
                                        $this->tpl->setVariable('HTEXT', $command['text']);     
                                        $this->tpl->parseCurrentBlock();
                                }
                                
                                $this->tpl->setCurrentBlock('head_item');
                                $this->tpl->parseCurrentBlock();
                                
                                ++$counter;                     
                        }
                        
                        $this->tpl->setCurrentBlock('header_links');
                        $this->tpl->parseCurrentBlock();
                }
                
                // for screen readers we first output the title and the commands
                // (e.g. close icon afterwards), otherwise we first output the
                // header commands, since we want to have the close icon top right
                // and not floated after the title
                if (is_object($ilUser) && $ilUser->getPref("screen_reader_optimization"))
                {
                        $this->fillHeaderTitleBlock();
                        $this->fillHeaderCommands();
                }
                else
                {
                        $this->fillHeaderCommands();
                        $this->fillHeaderTitleBlock();
                }
                
                
                // adv selection gui
                include_once "Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php";
                $dropdown = new ilAdvancedSelectionListGUI();
                $dropdown->setUseImages(true);
                $dropdown->setHeaderIcon(ilUtil::getImagePath("icon_sett_s.png"));
                $dropdown->setId("block_dd_".$this->getBlockType()."_".$this->block_id);
                foreach($this->dropdown as $item)
                {                                               
                        if($item["href"] || $item["onclick"])
                        {
                                if ($item["checked"])
                                {
                                        $item["image"] = ilUtil::getImagePath("icon_checked_s.png");
                                }
                                $dropdown->addItem($item["text"], "", $item["href"], $item["image"],
                                        $item["text"], "", "", false, $item["onclick"]);
                        }
                }
                $dropdown = $dropdown->getHTML();
                $this->tpl->setVariable("ADV_DROPDOWN", $dropdown);
                
                        
                $this->tpl->setVariable("COLSPAN", $this->getColSpan());
                if ($this->getBigMode())
                {
                        $this->tpl->touchBlock("hclassb");
                }
                else
                {
                        $this->tpl->touchBlock("hclass");
                }
                if ($ilCtrl->isAsynch())
                {
                        // return without div wrapper
                        echo $this->tpl->getAsynch();
                }
                else
                {
                        // return incl. wrapping div with id
                        return '<div id="'."block_".$this->getBlockType()."_".$this->block_id.'">'.
                                $this->tpl->get().'</div>';
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::getImage ( )

Get Image.

Returns: string Image

Definition at line 220 of file class.ilBlockGUI.php.

References $image.

Referenced by fillHeaderTitleBlock().

        {
                return $this->image;
        }

Here is the caller graph for this function:

ilBlockGUI::getLimit ( )

Get Limit.

Returns: int Limit

Definition at line 268 of file class.ilBlockGUI.php.

Referenced by fillDataSection(), fillPreviousNext(), and setPreviousNextLinks().

        {
                return $this->limit;
        }

Here is the caller graph for this function:

ilBlockGUI::getMoveParameter ( )

final

Definition at line 515 of file class.ilBlockGUI.php.

References getBlockId(), and getBlockType().

        {
                return $this->getBlockType()."_".$this->getBlockId()."_blmove";
        }

Here is the call graph for this function:

ilBlockGUI::getNavParameter ( )

final

Definition at line 500 of file class.ilBlockGUI.php.

References getBlockId(), and getBlockType().

Referenced by fillDataSection(), and setPreviousNextLinks().

        {
                return $this->getBlockType()."_".$this->getBlockId()."_blnav";
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::getOffset ( )

Get Offset.

Returns: int Offset

Definition at line 240 of file class.ilBlockGUI.php.

Referenced by fillDataSection(), fillPreviousNext(), and setPreviousNextLinks().

        {
                return $this->offset;
        }

Here is the caller graph for this function:

ilBlockGUI::getProperty ( $a_property )

Definition at line 479 of file class.ilBlockGUI.php.

Referenced by ilNewsForContextBlockGUI\getHTML(), ilCalendarBlockGUI\getHTML(), ilNewsForContextBlockGUI\initSettingsForm(), ilNewsForContextBlockGUI\saveSettings(), and ilNewsForContextBlockGUI\showNews().

        {
                return $this->property[$a_property];
        }

Here is the caller graph for this function:

ilBlockGUI::getRefId ( )

Get Ref Id (only used if isRepositoryObject() is true).

Returns: int Ref Id

Definition at line 382 of file class.ilBlockGUI.php.

Referenced by ilPollBlockGUI\fillRow(), ilExternalFeedBlockGUI\getHTML(), ilPollBlockGUI\getHTML(), and getHTML().

        {
                return $this->refid;
        }

Here is the caller graph for this function:

ilBlockGUI::getRepositoryMode ( )

Get RepositoryMode.

Returns: boolean RepositoryMode

Definition at line 308 of file class.ilBlockGUI.php.

Referenced by fillHeaderCommands(), ilNewsForContextBlockGUI\getHTML(), and getHTML().

        {
                return $this->repositorymode;
        }

Here is the caller graph for this function:

ilBlockGUI::getRowTemplateDir ( )

Get Row Template Directory.

Returns: string Row Template Directory

Definition at line 535 of file class.ilBlockGUI.php.

Referenced by fillDataSection().

        {
                return $this->rowtemplatedir;
        }

Here is the caller graph for this function:

ilBlockGUI::getRowTemplateName ( )

Get Row Template Name.

Returns: string Row Template Name

Definition at line 525 of file class.ilBlockGUI.php.

Referenced by fillDataSection().

        {
                return $this->rowtemplatename;
        }

Here is the caller graph for this function:

static ilBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Reimplemented in ilCalendarBlockGUI, ilPDSelectedItemsBlockGUI, ilNewsForContextBlockGUI, ilPDNewsBlockGUI, ilWikiSearchBlockGUI, ilDummyBlockGUI, ilCalendarSelectionBlockGUI, ilPDExternalFeedBlockGUI, ilPDTaggingBlockGUI, ilWikiImportantPagesBlockGUI, ilHtmlBlockGUI, ilWikiFunctionsBlockGUI, ilWikiSideBlockGUI, ilChatroomBlockGUI, ilExternalFeedBlockGUI, ilBookmarkBlockGUI, ilUsersOnlineBlockGUI, ilPollBlockGUI, ilPDNotesBlockGUI, and ilPDMailBlockGUI.

Definition at line 630 of file class.ilBlockGUI.php.

References IL_SCREEN_SIDE.

        {
                return IL_SCREEN_SIDE;
        }

ilBlockGUI::getSubtitle ( )

Get Subtitle.

Returns: string Subtitle

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

        {
                return $this->subtitle;
        }

ilBlockGUI::getTitle ( )

Get Title.

Returns: string Title

Definition at line 200 of file class.ilBlockGUI.php.

Referenced by ilWikiFunctionsBlockGUI\fillDataSection(), fillHeaderTitleBlock(), ilPDNewsBlockGUI\getHTML(), ilBookmarkBlockGUI\getListRowData(), ilExternalFeedBlockGUI\showFeedItem(), and ilPDExternalFeedBlockGUI\showFeedItem().

        {
                return $this->title;
        }

Here is the caller graph for this function:

ilBlockGUI::handleDetailLevel ( )

Handle read/write current detail level.

Definition at line 638 of file class.ilBlockGUI.php.

References $_GET, $block_id, $ilCtrl, $ilUser, ilBlockSetting\_lookupDetailLevel(), ilBlockSetting\_writeDetailLevel(), getBlockType(), getDetailParameter(), and setCurrentDetailLevel().

Referenced by setAvailableDetailLevels().

        {
                global $ilUser, $ilCtrl;
                // set/get detail level
                if ($this->detail_max > $this->detail_min)
                {
                        include_once("Services/Block/classes/class.ilBlockSetting.php");
                        if (isset($_GET[$this->getDetailParameter()]))
                        {
                                ilBlockSetting::_writeDetailLevel($this->getBlockType(), $_GET[$this->getDetailParameter()],
                                        $ilUser->getId(), $this->block_id);
                                $this->setCurrentDetailLevel($_GET[$this->getDetailParameter()]);
                                if ((int) $_GET[$this->getDetailParameter()] == 0)
                                {
                                        $ilCtrl->redirectByClass("ilcolumngui", "");
                                }
                        }
                        else
                        {
                                $this->setCurrentDetailLevel(ilBlockSetting::_lookupDetailLevel($this->getBlockType(),
                                        $ilUser->getId(), $this->block_id));
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::ilBlockGUI ( )

Constructor.

Parameters

Definition at line 48 of file class.ilBlockGUI.php.

References $ilCtrl, $ilUser, $tpl, ilYuiUtil\initConnection(), and setLimit().

Referenced by ilWikiFunctionsBlockGUI\__construct(), ilWikiSideBlockGUI\__construct(), ilWikiImportantPagesBlockGUI\__construct(), ilWikiSearchBlockGUI\__construct(), ilBookmarkBlockGUI\ilBookmarkBlockGUI(), ilCalendarBlockGUI\ilCalendarBlockGUI(), ilExternalFeedBlockGUI\ilExternalFeedBlockGUI(), ilHtmlBlockGUI\ilHtmlBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDContentBlockGUI\ilPDContentBlockGUI(), ilPDExternalFeedBlockGUI\ilPDExternalFeedBlockGUI(), ilPDNewsBlockGUI\ilPDNewsBlockGUI(), ilPDNotesBlockGUI\ilPDNotesBlockGUI(), ilPDSelectedItemsBlockGUI\ilPDSelectedItemsBlockGUI(), ilPDTaggingBlockGUI\ilPDTaggingBlockGUI(), and ilUsersOnlineBlockGUI\ilUsersOnlineBlockGUI().

        {
                global $ilUser, $tpl, $ilCtrl;
                include_once("./Services/YUI/classes/class.ilYuiUtil.php");
                ilYuiUtil::initConnection();
                $tpl->addJavaScript("./Services/Block/js/ilblockcallback.js");
                $this->setLimit($ilUser->getPref("hits_per_page"));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

static ilBlockGUI::isRepositoryObject ( )

staticabstract

Reimplemented in ilPDSelectedItemsBlockGUI, ilCalendarBlockGUI, ilNewsForContextBlockGUI, ilPDNewsBlockGUI, ilPDContentBlockGUI, ilWikiSearchBlockGUI, ilDummyBlockGUI, ilPDExternalFeedBlockGUI, ilPDTaggingBlockGUI, ilCalendarSelectionBlockGUI, ilWikiImportantPagesBlockGUI, ilWikiFunctionsBlockGUI, ilWikiSideBlockGUI, ilExternalFeedBlockGUI, ilChatroomBlockGUI, ilBookmarkBlockGUI, ilUsersOnlineBlockGUI, ilPollBlockGUI, ilPDNotesBlockGUI, ilPDMailBlockGUI, and ilPDSysMessageBlockGUI.

Referenced by getHTML().

Here is the caller graph for this function:

ilBlockGUI::preloadData ( array $data )

protected

Can be overwritten in subclasses.

Only the visible part of the complete data was passed so a preload of the visible data is possible.

Parameters

array $data

Reimplemented in ilPDMailBlockGUI.

Definition at line 1364 of file class.ilBlockGUI.php.

Referenced by fillDataSection().

{

}

Here is the caller graph for this function:

ilBlockGUI::setAdminCommands ( $a_admincommands )

Set Administration Commmands.

Parameters

boolean $a_admincommands Administration Commmands

Definition at line 392 of file class.ilBlockGUI.php.

        {
                $this->admincommands = $a_admincommands;
        }

ilBlockGUI::setAvailableDetailLevels	(	$a_max,
		$a_min = `0`
	)

Set Available Detail Levels.

Parameters

int	$a_max	Max Level
int	$a_min	Min Level (Default 0)

Definition at line 136 of file class.ilBlockGUI.php.

References handleDetailLevel().

Referenced by ilPDMailBlockGUI\__construct(), ilPDSysMessageBlockGUI\__construct(), ilChatroomBlockGUI\__construct(), ilBookmarkBlockGUI\ilBookmarkBlockGUI(), ilCalendarBlockGUI\ilCalendarBlockGUI(), ilHtmlBlockGUI\ilHtmlBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDNewsBlockGUI\ilPDNewsBlockGUI(), ilPDNotesBlockGUI\ilPDNotesBlockGUI(), ilPDSelectedItemsBlockGUI\ilPDSelectedItemsBlockGUI(), ilPDTaggingBlockGUI\ilPDTaggingBlockGUI(), ilUsersOnlineBlockGUI\ilUsersOnlineBlockGUI(), ilPDSelectedItemsBlockGUI\manageObject(), ilExternalFeedBlockGUI\setBlock(), and ilPDExternalFeedBlockGUI\setBlock().

        {
                $this->detail_min = $a_min;
                $this->detail_max = $a_max;
                $this->handleDetailLevel();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::setBigMode ( $a_bigmode )

Set Big Mode.

Parameters

boolean $a_bigmode Big Mode

Definition at line 95 of file class.ilBlockGUI.php.

Referenced by ilPDContentBlockGUI\ilPDContentBlockGUI().

        {
                $this->bigmode = $a_bigmode;
        }

Here is the caller graph for this function:

ilBlockGUI::setBlockId ( $a_block_id = 0 )

Set Block Id.

Parameters

int $a_block_id Block ID

Definition at line 115 of file class.ilBlockGUI.php.

Referenced by ilCalendarBlockGUI\ilCalendarBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDCalendarBlockGUI\ilPDCalendarBlockGUI(), ilPollBlockGUI\setBlock(), ilExternalFeedBlockGUI\setBlock(), ilHtmlBlockGUI\setBlock(), and ilPDExternalFeedBlockGUI\setBlock().

        {
                $this->block_id = $a_block_id;
        }

Here is the caller graph for this function:

ilBlockGUI::setColSpan ( $a_colspan )

Set Columns Span.

Parameters

int $a_colspan Columns Span

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

Referenced by ilBookmarkBlockGUI\fillDataSection(), ilPDMailBlockGUI\fillDataSection(), ilUsersOnlineBlockGUI\fillDataSection(), and ilCalendarBlockGUI\fillDataSection().

        {
                $this->colspan = $a_colspan;
        }

Here is the caller graph for this function:

ilBlockGUI::setCurrentDetailLevel ( $a_currentdetaillevel )

Set Current Detail Level.

Parameters

int $a_currentdetaillevel Current Detail Level

Definition at line 148 of file class.ilBlockGUI.php.

Referenced by ilPDSysMessageBlockGUI\getHTML(), ilUsersOnlineBlockGUI\getListRowData(), and handleDetailLevel().

        {
                $this->currentdetaillevel = $a_currentdetaillevel;
        }

Here is the caller graph for this function:

ilBlockGUI::setData ( $a_data )

Set Data.

Parameters

array $a_data Data

Definition at line 75 of file class.ilBlockGUI.php.

Referenced by ilPDMailBlockGUI\fillDataSection(), ilBookmarkBlockGUI\getHTML(), ilPDTaggingBlockGUI\getHTML(), ilExternalFeedBlockGUI\getHTML(), ilPDExternalFeedBlockGUI\getHTML(), ilPDSelectedItemsBlockGUI\getHTML(), ilPollBlockGUI\getHTML(), ilPDNotesBlockGUI\getListRowData(), ilBookmarkBlockGUI\getListRowData(), ilUsersOnlineBlockGUI\getListRowData(), ilNewsForContextBlockGUI\hideNotifications(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDNewsBlockGUI\ilPDNewsBlockGUI(), ilNewsForContextBlockGUI\showNews(), and ilNewsForContextBlockGUI\showNotifications().

        {
                $this->data = $a_data;
        }

Here is the caller graph for this function:

ilBlockGUI::setDataSection ( $a_content )

Call this from overwritten fillDataSection(), if standard row based data is not used.

Definition at line 988 of file class.ilBlockGUI.php.

        {
                $this->tpl->setCurrentBlock("data_section");
                $this->tpl->setVariable("DATA", $a_content);
                $this->tpl->parseCurrentBlock();
        }

Here is the caller graph for this function:

ilBlockGUI::setEnableDetailRow ( $a_enabledetailrow )

Set EnableDetailRow.

Parameters

boolean $a_enabledetailrow EnableDetailRow

Definition at line 432 of file class.ilBlockGUI.php.

Referenced by ilPDNotesBlockGUI\fillDataSection(), ilBookmarkBlockGUI\fillDataSection(), ilPDTaggingBlockGUI\fillDataSection(), ilPDMailBlockGUI\fillDataSection(), ilPDNewsBlockGUI\fillDataSection(), and ilPDSelectedItemsBlockGUI\getHTML().

        {
                $this->enabledetailrow = $a_enabledetailrow;
        }

Here is the caller graph for this function:

ilBlockGUI::setEnableEdit ( $a_enableedit )

Set EnableEdit.

Parameters

boolean $a_enableedit EnableEdit

Reimplemented in ilCalendarBlockGUI, and ilNewsForContextBlockGUI.

Definition at line 278 of file class.ilBlockGUI.php.

        {
                $this->enableedit = $a_enableedit;
        }

ilBlockGUI::setEnableNumInfo ( $a_enablenuminfo )

Set Enable Item Number Info.

Parameters

boolean $a_enablenuminfo Enable Item Number Info

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

Referenced by ilWikiFunctionsBlockGUI\__construct(), ilWikiSideBlockGUI\__construct(), ilWikiImportantPagesBlockGUI\__construct(), ilWikiSearchBlockGUI\__construct(), ilPDNotesBlockGUI\fillDataSection(), ilPDMailBlockGUI\fillDataSection(), ilUsersOnlineBlockGUI\fillDataSection(), ilPDNewsBlockGUI\fillDataSection(), ilCalendarBlockGUI\getData(), ilUsersOnlineBlockGUI\getListRowData(), ilExternalFeedBlockGUI\getOverview(), ilPDExternalFeedBlockGUI\getOverview(), ilBookmarkBlockGUI\ilBookmarkBlockGUI(), ilCalendarBlockGUI\ilCalendarBlockGUI(), ilHtmlBlockGUI\ilHtmlBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDContentBlockGUI\ilPDContentBlockGUI(), ilPDSelectedItemsBlockGUI\ilPDSelectedItemsBlockGUI(), ilPDTaggingBlockGUI\ilPDTaggingBlockGUI(), and ilPDSelectedItemsBlockGUI\setFooterLinks().

        {
                $this->enablenuminfo = $a_enablenuminfo;
        }

Here is the caller graph for this function:

ilBlockGUI::setFooterInfo	(	$a_footerinfo,
		$a_hide_and_icon = `false`
	)

Set Footer Info.

Parameters

string $a_footerinfo Footer Info

Definition at line 318 of file class.ilBlockGUI.php.

Referenced by ilPDNewsBlockGUI\getHTML(), and ilNewsForContextBlockGUI\getHTML().

        {
                if ($a_hide_and_icon)
                {
                        $this->footerinfo_icon = $a_footerinfo;
                }
                else
                {
                        $this->footerinfo = $a_footerinfo;
                }
        }

Here is the caller graph for this function:

ilBlockGUI::setGuiObject ( & $a_gui_object )

Set GuiObject.

Only used for repository blocks, that are represented as real repository objects (have a ref id and permissions)

Parameters

object $a_gui_object GUI object

Reimplemented in ilExternalFeedBlockGUIGen.

Definition at line 160 of file class.ilBlockGUI.php.

        {
                $this->gui_object = $a_gui_object;
        }

ilBlockGUI::setImage ( $a_image )

Set Image.

Parameters

string $a_image Image

Definition at line 210 of file class.ilBlockGUI.php.

Referenced by ilPDMailBlockGUI\__construct(), ilPDSysMessageBlockGUI\__construct(), ilChatroomBlockGUI\__construct(), ilBookmarkBlockGUI\ilBookmarkBlockGUI(), ilCalendarBlockGUI\ilCalendarBlockGUI(), ilExternalFeedBlockGUI\ilExternalFeedBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDExternalFeedBlockGUI\ilPDExternalFeedBlockGUI(), ilPDNewsBlockGUI\ilPDNewsBlockGUI(), ilPDNotesBlockGUI\ilPDNotesBlockGUI(), ilPDTaggingBlockGUI\ilPDTaggingBlockGUI(), and ilUsersOnlineBlockGUI\ilUsersOnlineBlockGUI().

        {
                $this->image = $a_image;
        }

Here is the caller graph for this function:

ilBlockGUI::setLimit ( $a_limit )

Set Limit.

Parameters

int $a_limit Limit

Definition at line 258 of file class.ilBlockGUI.php.

Referenced by ilPDMailBlockGUI\__construct(), ilBlockGUI(), ilBookmarkBlockGUI\ilBookmarkBlockGUI(), ilCalendarBlockGUI\ilCalendarBlockGUI(), ilCalendarSelectionBlockGUI\ilCalendarSelectionBlockGUI(), ilDummyBlockGUI\ilDummyBlockGUI(), ilExternalFeedBlockGUI\ilExternalFeedBlockGUI(), ilHtmlBlockGUI\ilHtmlBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDContentBlockGUI\ilPDContentBlockGUI(), ilPDExternalFeedBlockGUI\ilPDExternalFeedBlockGUI(), ilPDNewsBlockGUI\ilPDNewsBlockGUI(), ilPDNotesBlockGUI\ilPDNotesBlockGUI(), ilPDSelectedItemsBlockGUI\ilPDSelectedItemsBlockGUI(), ilPDTaggingBlockGUI\ilPDTaggingBlockGUI(), and ilUsersOnlineBlockGUI\ilUsersOnlineBlockGUI().

        {
                $this->limit = $a_limit;
        }

Here is the caller graph for this function:

ilBlockGUI::setOffset ( $a_offset )

Set Offset.

Parameters

int $a_offset Offset

Definition at line 230 of file class.ilBlockGUI.php.

Referenced by correctOffset(), and fillDataSection().

        {
                $this->offset = $a_offset;
        }

Here is the caller graph for this function:

ilBlockGUI::setPreviousNextLinks ( )

Get previous/next linkbar.

Author: Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Returns: array linkbar or false on error

Definition at line 1097 of file class.ilBlockGUI.php.

References $block_id, $ilCtrl, $lng, addFooterLink(), getBlockType(), getLimit(), getNavParameter(), and getOffset().

Referenced by fillPreviousNext().

        {
                global $ilCtrl, $lng;
                
                // if more entries then entries per page -> show link bar
                if ($this->max_count > $this->getLimit() && ($this->getLimit() != 0))
                {
                        // previous link
                        if ($this->getOffset() >= 1)
                        {
                                $prevoffset = $this->getOffset() - $this->getLimit();
                                
                                $ilCtrl->setParameterByClass("ilcolumngui",
                                        $this->getNavParameter(), "::".$prevoffset);
                                
                                // ajax link
                                $ilCtrl->setParameterByClass("ilcolumngui",
                                        "block_id", "block_".$this->getBlockType()."_".$this->block_id);
                                $block_id = "block_".$this->getBlockType()."_".$this->block_id;
                                $onclick = $ilCtrl->getLinkTargetByClass("ilcolumngui",
                                        "updateBlock", "", true);
                                $ilCtrl->setParameterByClass("ilcolumngui",
                                        "block_id", "");
                                        
                                // normal link
                                $href = $ilCtrl->getLinkTargetByClass("ilcolumngui", "");
                                $text = $lng->txt("previous");
                                
                                $this->addFooterLink($text, $href, $onclick, $block_id, true);
                        }
                        // calculate number of pages
                        $pages = intval($this->max_count / $this->getLimit());
                        // add a page if a rest remains
                        if (($this->max_count % $this->getLimit()))
                                $pages++;
                        // show next link (if not last page)
                        if (! ( ($this->getOffset() / $this->getLimit())==($pages-1) ) && ($pages!=1) )
                        {
                                $newoffset = $this->getOffset() + $this->getLimit();
                                $ilCtrl->setParameterByClass("ilcolumngui",
                                        $this->getNavParameter(), "::".$newoffset);
                                // ajax link
                                $ilCtrl->setParameterByClass("ilcolumngui",
                                        "block_id", "block_".$this->getBlockType()."_".$this->block_id);
                                //$this->tpl->setCurrentBlock("pnonclick");
                                $block_id = "block_".$this->getBlockType()."_".$this->block_id;
                                $onclick = $ilCtrl->getLinkTargetByClass("ilcolumngui",
                                        "updateBlock", "", true);
//echo "-".$onclick."-";
                                //$this->tpl->parseCurrentBlock();
                                $ilCtrl->setParameterByClass("ilcolumngui",
                                        "block_id", "");
                                // normal link
                                $href = $ilCtrl->getLinkTargetByClass("ilcolumngui", "");
                                $text = $lng->txt("next");
                                $this->addFooterLink($text, $href, $onclick, $block_id, true);
                        }
                        $ilCtrl->setParameterByClass("ilcolumngui",
                                $this->getNavParameter(), "");
                        return true;
                }
                else
                {
                        return false;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlockGUI::setProperties ( $a_properties )

This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties.

Parameters

string $a_properties properties array (key => value)

Definition at line 474 of file class.ilBlockGUI.php.

        {
                $this->property = $a_properties;
        }

ilBlockGUI::setProperty	(	$a_property,
		$a_value
	)

Definition at line 484 of file class.ilBlockGUI.php.

        {
                $this->property[$a_property] = $a_value;
        }

ilBlockGUI::setRefId ( $a_refid )

Set Ref Id (only used if isRepositoryObject() is true).

Parameters

int $a_refid Ref Id

Definition at line 372 of file class.ilBlockGUI.php.

        {
                $this->refid = $a_refid;
        }

ilBlockGUI::setRepositoryMode ( $a_repositorymode )

Set RepositoryMode.

Parameters

boolean $a_repositorymode RepositoryMode

Definition at line 298 of file class.ilBlockGUI.php.

        {
                $this->repositorymode = $a_repositorymode;
        }

ilBlockGUI::setRowTemplate	(	$a_rowtemplatename,
		$a_rowtemplatedir = `""`
	)

Set Row Template Name.

Parameters

string $a_rowtemplatename Row Template Name

Definition at line 494 of file class.ilBlockGUI.php.

Referenced by ilPollBlockGUI\__construct(), ilPDNotesBlockGUI\fillDataSection(), ilBookmarkBlockGUI\fillDataSection(), ilPDMailBlockGUI\fillDataSection(), ilUsersOnlineBlockGUI\fillDataSection(), ilExternalFeedBlockGUI\ilExternalFeedBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDExternalFeedBlockGUI\ilPDExternalFeedBlockGUI(), and ilPDNewsBlockGUI\ilPDNewsBlockGUI().

        {
                $this->rowtemplatename = $a_rowtemplatename;
                $this->rowtemplatedir = $a_rowtemplatedir;
        }

Here is the caller graph for this function:

ilBlockGUI::setSubtitle ( $a_subtitle )

Set Subtitle.

Parameters

string $a_subtitle Subtitle

Definition at line 352 of file class.ilBlockGUI.php.

        {
                $this->subtitle = $a_subtitle;
        }

ilBlockGUI::setTitle ( $a_title )

Set Title.

Parameters

string $a_title Title

Definition at line 190 of file class.ilBlockGUI.php.

Referenced by ilPDMailBlockGUI\__construct(), ilPDSysMessageBlockGUI\__construct(), ilWikiFunctionsBlockGUI\__construct(), ilWikiSideBlockGUI\__construct(), ilWikiImportantPagesBlockGUI\__construct(), ilChatroomBlockGUI\__construct(), ilWikiSearchBlockGUI\__construct(), ilPDSelectedItemsBlockGUI\getHTML(), ilPollBlockGUI\getHTML(), ilPDNewsBlockGUI\getHTML(), ilNewsForContextBlockGUI\getHTML(), ilBookmarkBlockGUI\getListRowData(), ilBookmarkBlockGUI\ilBookmarkBlockGUI(), ilCalendarBlockGUI\ilCalendarBlockGUI(), ilCalendarSelectionBlockGUI\ilCalendarSelectionBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDNewsBlockGUI\ilPDNewsBlockGUI(), ilPDNotesBlockGUI\ilPDNotesBlockGUI(), ilPDTaggingBlockGUI\ilPDTaggingBlockGUI(), ilUsersOnlineBlockGUI\ilUsersOnlineBlockGUI(), ilExternalFeedBlockGUI\setBlock(), ilHtmlBlockGUI\setBlock(), and ilPDExternalFeedBlockGUI\setBlock().

        {
                $this->title = $a_title;
        }

Here is the caller graph for this function:

Field Documentation

ilBlockGUI::$allow_moving = true

protected

Definition at line 27 of file class.ilBlockGUI.php.

ilBlockGUI::$bigmode = false

protected

Definition at line 23 of file class.ilBlockGUI.php.

Referenced by getBigMode().

ilBlockGUI::$block_commands = array()

protected

Definition at line 33 of file class.ilBlockGUI.php.

Referenced by getBlockCommands().

ilBlockGUI::$block_id = 0

protected

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

Referenced by fillDetailRow(), getBlockId(), handleDetailLevel(), ilNewsForContextBlockGUI\handleView(), ilNewsForContextBlockGUI\hideNotifications(), ilPDNewsBlockGUI\saveSettings(), ilNewsForContextBlockGUI\saveSettings(), ilBookmarkBlockGUI\setFooterLinks(), ilPDSelectedItemsBlockGUI\setFooterLinks(), ilCalendarBlockGUI\setFooterLinks(), setPreviousNextLinks(), ilNewsForContextBlockGUI\showNotifications(), and ilNewsForContextBlockGUI\showViewFooter().

ilBlockGUI::$close_command = false

protected

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

Referenced by fillHeaderCommands().

ilBlockGUI::$colspan = 1

protected

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

Referenced by getColSpan().

ilBlockGUI::$css_row = ""

protected

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

ilBlockGUI::$data = array()

protected

Definition at line 18 of file class.ilBlockGUI.php.

Referenced by ilCalendarSelectionBlockGUI\buildPath(), fillDataSection(), getData(), ilCalendarBlockGUI\getData(), ilPDNotesBlockGUI\getListRowData(), ilBookmarkBlockGUI\getListRowData(), ilUsersOnlineBlockGUI\getListRowData(), ilPDNewsBlockGUI\getNewsData(), ilNewsForContextBlockGUI\hideNotifications(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDNewsBlockGUI\ilPDNewsBlockGUI(), and ilNewsForContextBlockGUI\showNotifications().

ilBlockGUI::$detail_max = 0

protected

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

ilBlockGUI::$detail_min = 0

protected

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

Referenced by fillDetailRow().

ilBlockGUI::$dropdown

protected

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

Referenced by getHTML().

ilBlockGUI::$enabledetailrow = true

protected

Definition at line 29 of file class.ilBlockGUI.php.

Referenced by getEnableDetailRow().

ilBlockGUI::$enablenuminfo = true

protected

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

Referenced by getEnableNumInfo().

ilBlockGUI::$footer_links = array()

protected

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

Referenced by getFooterLinks().

ilBlockGUI::$footerinfo = false

protected

Definition at line 31 of file class.ilBlockGUI.php.

Referenced by getFooterInfo().

ilBlockGUI::$footerinfo_icon = false

protected

Definition at line 32 of file class.ilBlockGUI.php.

Referenced by getFooterInfo().

ilBlockGUI::$header_commands = array()

protected

Definition at line 26 of file class.ilBlockGUI.php.

Referenced by getHeaderCommands().

ilBlockGUI::$header_links = array()

protected

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

Referenced by getHeaderLinks().

ilBlockGUI::$image = false

protected

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

Referenced by getImage().

ilBlockGUI::$max_count = false

protected

Definition at line 34 of file class.ilBlockGUI.php.

Referenced by fillPreviousNext().

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

protected

Definition at line 28 of file class.ilBlockGUI.php.

ilBlockGUI::$nav_value = ""

protected

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

Referenced by fillDataSection().

ilBlockGUI::$property = false

protected

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

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

Services/Block/classes/class.ilBlockGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Field Documentation