ILIAS  eassessment Revision 61809
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
ilBlockGUI Class Reference

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)
 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)
 Add a footer text/link.
 getFooterLinks ()
 Get footer links.
 clearFooterLinks ()
 Clear footer links.
 handleDetailLevel ()
 Handle read/write current detail level.
 setConfigMode ($a_configmode)
 Handle config status.
 getConfigMode ()
 Get Config Mode (move blocks).
 getHTML ()
 Get HTML.
 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.
 fillMoveRow ()
 Fill row for Moving.
 getAllowMove ($a_direction)
 setAllowMove ($a_direction, $a_allow=true)
 fillMoveLink ($a_value, $a_img, $a_txt)

Static Public Member Functions

static getBlockType ()
static isRepositoryObject ()
static getScreenMode ()
 Get Screen Mode for current command.

Protected Member Functions

 fillRowColor ($a_placeholder="CSS_ROW")

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 = ""

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 25692 2010-09-15 09:44:16Z mwarkus

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 
)

Add Block Command.

Parameters
string$a_hrefcommand link target
string$a_texttext

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

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

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

+ 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 
)

Add a footer text/link.

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

Referenced by ilBookmarkBlockGUI\setFooterLinks(), ilPDSelectedItemsBlockGUI\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);
}

+ 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_hrefcommand link target
string$a_texttext

Definition at line 568 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 57 of file class.ilBlockGUI.php.

Referenced by ilPDSelectedItemsBlockGUI\getHTML().

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

+ Here is the caller graph for this function:

ilBlockGUI::clearFooterLinks ( )

Clear footer links.

Definition at line 618 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 243 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, ilPDNewsBlockGUI, ilUsersOnlineBlockGUI, ilPDExternalFeedBlockGUI, ilPDMailBlockGUI, ilHtmlBlockGUI, ilExternalFeedBlockGUI, ilPDTaggingBlockGUI, ilBookmarkBlockGUI, ilDummyBlockGUI, ilPDFeedbackBlockGUI, ilPDContentBlockGUI, and ilPDNotesBlockGUI.

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

References $_GET, $_POST, $_SESSION, $data, $nav_value, correctOffset(), fillRow(), fillRowColor(), getData(), getLimit(), getNavParameter(), getOffset(), getRowTemplateDir(), getRowTemplateName(), 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());
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 1236 of file class.ilBlockGUI.php.

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

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);
// ajax link
if ($i > 0)
{
$ilCtrl->setParameterByClass("ilcolumngui",
"block_id", "block_".$this->getBlockType()."_".$this->block_id);
$this->tpl->setCurrentBlock("onclick");
$this->tpl->setVariable("OC_BLOCK_ID",
"block_".$this->getBlockType()."_".$this->block_id);
$this->tpl->setVariable("OC_HREF",
$ilCtrl->getLinkTargetByClass("ilcolumngui",
"updateBlock", "", true));
$this->tpl->parseCurrentBlock();
$ilCtrl->setParameterByClass("ilcolumngui",
"block_id", "");
}
// normal link
$this->tpl->setCurrentBlock("det_link");
//$this->tpl->setVariable("DLINK", $i);
$this->tpl->setVariable("SRC_LINK",
ilUtil::getImagePath("details".$i.".gif"));
$this->tpl->setVariable("ALT_LINK",
strip_tags(str_replace(array("'",'"'), "", $this->getTitle())).
" (".$lng->txt("block")."): ".$lng->txt("details")." ".$i
);
$this->tpl->setVariable("DHREF",
$ilCtrl->getLinkTargetByClass("ilcolumngui",
""));
$this->tpl->parseCurrentBlock();
$this->tpl->touchBlock("det_item");
}
else
{
$this->tpl->setCurrentBlock("det_text");
//$this->tpl->setVariable("DTEXT", $i);
$this->tpl->setVariable("ALT_NO_LINK",
strip_tags(str_replace(array("'",'"'), "", $this->getTitle())).
" (".$lng->txt("block")."): ".$lng->txt("details")." ".$i.
" (".$lng->txt("selected").")");
$this->tpl->setVariable("SRC_NO_LINK",
ilUtil::getImagePath("details".$i."off.gif"));
$this->tpl->parseCurrentBlock();
$this->tpl->touchBlock("det_item");
}
}
// 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.gif"));
$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, ilPDSelectedItemsBlockGUI, ilPDTaggingBlockGUI, ilBookmarkBlockGUI, and ilPDContentBlockGUI.

Definition at line 1036 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 1163 of file class.ilBlockGUI.php.

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

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

{
global $ilCtrl, $lng;
$first = true;
$flinks = $this->getFooterLinks();
$prefix = ($a_top) ? "top" : "foot";
$omit_separator = false;
foreach($flinks as $flink)
{
if ($flink["top"] != $a_top)
{
continue;
}
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 != "")
{
$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 876 of file class.ilBlockGUI.php.

References $command, $ilCtrl, $lng, getBigMode(), getDetailParameter(), getHeaderCommands(), ilUtil\getImagePath(), getRepositoryMode(), and getTitle().

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 != "" || $this->allow_moving)
{
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 != "")
{
$this->tpl->setCurrentBlock("header_close");
$this->tpl->setVariable("ALT_CLOSE",
strip_tags(str_replace(array("'",'"'), "", $this->getTitle())).
" (".$lng->txt("block")."): ".$lng->txt("close")
);
if ($this->getBigMode())
{
$this->tpl->setVariable("IMG_CLOSE", ilUtil::getImagePath("icon_close2.gif"));
}
else
{
$this->tpl->setVariable("IMG_CLOSE", ilUtil::getImagePath("icon_close2_s.gif"));
}
if ($this->close_command != "")
{
$this->tpl->setVariable("HREF_CLOSE",
$this->close_command);
}
else
{
$ilCtrl->setParameterByClass("ilcolumngui",
$this->getDetailParameter(), "0");
$this->tpl->setVariable("HREF_CLOSE",
$ilCtrl->getLinkTargetByClass("ilcolumngui",
""));
$ilCtrl->setParameterByClass("ilcolumngui",
$this->getDetailParameter(), "");
}
$this->tpl->parseCurrentBlock();
}
$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 943 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::fillMoveLink (   $a_value,
  $a_img,
  $a_txt 
)

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

References $ilCtrl, $lng, getBlockId(), getBlockType(), and ilUtil\getImagePath().

Referenced by fillMoveRow().

{
global $ilCtrl, $lng;
$ilCtrl->setParameterByClass("ilcolumngui", "block_id",
$this->getBlockType()."_".$this->getBlockId());
$ilCtrl->setParameterByClass("ilcolumngui", "move_dir",
$a_value);
$this->tpl->setCurrentBlock("move_link");
$this->tpl->setVariable("IMG_MOVE", ilUtil::getImagePath($a_img));
$this->tpl->setVariable("ALT_MOVE", $a_txt);
$this->tpl->setVariable("HREF_MOVE",
$ilCtrl->getLinkTargetByClass("ilcolumngui",
"moveBlock"));
$this->tpl->parseCurrentBlock();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilBlockGUI::fillMoveRow ( )

Fill row for Moving.

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

References $ilCtrl, $lng, fillMoveLink(), getAllowMove(), and getMoveParameter().

Referenced by getHTML().

{
global $ilCtrl, $lng;
if ($this->config_mode)
{
if ($this->getAllowMove("left"))
{
$this->fillMoveLink("left", "icon_left_s.gif", $lng->txt("move_left"));
}
if ($this->getAllowMove("up"))
{
$this->fillMoveLink("up", "icon_up_s.gif", $lng->txt("move_up"));
}
if ($this->getAllowMove("down"))
{
$this->fillMoveLink("down", "icon_down_s.gif", $lng->txt("move_down"));
}
if ($this->getAllowMove("right"))
{
$this->fillMoveLink("right", "icon_right_s.gif", $lng->txt("move_right"));
}
$ilCtrl->setParameter($this, $this->getMoveParameter(), "");
$this->tpl->setCurrentBlock("move");
$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 1051 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 ilCalendarBlockGUI, ilNewsForContextBlockGUI, ilBookmarkBlockGUI, ilPDExternalFeedBlockGUI, ilExternalFeedBlockGUI, ilUsersOnlineBlockGUI, ilPDMailBlockGUI, ilPDNotesBlockGUI, and ilPDFeedbackBlockGUI.

Definition at line 1028 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 1040 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 400 of file class.ilBlockGUI.php.

Referenced by getHTML().

{
return $this->admincommands;
}

+ Here is the caller graph for this function:

ilBlockGUI::getAllowMove (   $a_direction)

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

Referenced by fillMoveRow().

{
return $this->move[$a_direction];
}

+ Here is the caller graph for this function:

ilBlockGUI::getBigMode ( )

Get Big Mode.

Returns
boolean Big Mode

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

References $bigmode.

Referenced by fillHeaderCommands(), and getHTML().

{
return $this->bigmode;
}

+ Here is the caller graph for this function:

ilBlockGUI::getBlockCommands ( )

Get Block commands.

Returns
array block commands

Definition at line 557 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 123 of file class.ilBlockGUI.php.

References $block_id.

Referenced by ilCalendarBlockGUI\addMiniMonth(), fillDetailRow(), fillMoveLink(), 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

Reimplemented in ilPDSelectedItemsBlockGUI, ilCalendarBlockGUI, ilPDNewsBlockGUI, ilNewsForContextBlockGUI, ilPDExternalFeedBlockGUI, ilPDMailBlockGUI, ilHtmlBlockGUI, ilBookmarkBlockGUI, ilPDCalendarBlockGUI, ilPDTaggingBlockGUI, ilPDFeedbackBlockGUI, ilPDContentBlockGUI, ilDummyBlockGUI, ilPDSysMessageBlockGUI, ilExternalFeedBlockGUI, ilUsersOnlineBlockGUI, and ilPDNotesBlockGUI.

Referenced by fillDetailRow(), fillHeaderTitleBlock(), fillMoveLink(), getConfigParameter(), getDetailParameter(), getHTML(), getMoveParameter(), getNavParameter(), handleDetailLevel(), and setPreviousNextLinks().

+ Here is the caller graph for this function:

ilBlockGUI::getColSpan ( )

Get Columns Span.

Returns
int Columns Span

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

References $colspan.

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

{
return $this->colspan;
}

+ Here is the caller graph for this function:

ilBlockGUI::getConfigMode ( )

Get Config Mode (move blocks).

Returns
boolean Config Mode (move blocks)

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

{
return $this->config_mode;
}
ilBlockGUI::getConfigParameter ( )
final

Definition at line 508 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 178 of file class.ilBlockGUI.php.

Referenced by ilPDNotesBlockGUI\fillDataSection(), ilPDFeedbackBlockGUI\fillDataSection(), ilBookmarkBlockGUI\fillDataSection(), ilPDTaggingBlockGUI\fillDataSection(), ilExternalFeedBlockGUI\fillDataSection(), ilPDExternalFeedBlockGUI\fillDataSection(), ilPDMailBlockGUI\fillDataSection(), ilUsersOnlineBlockGUI\fillDataSection(), ilPDNewsBlockGUI\fillDataSection(), ilNewsForContextBlockGUI\fillDataSection(), ilCalendarBlockGUI\fillDataSection(), fillDetailRow(), ilPDNotesBlockGUI\fillRow(), ilPDMailBlockGUI\fillRow(), ilUsersOnlineBlockGUI\fillRow(), ilBookmarkBlockGUI\fillRow(), ilNewsForContextBlockGUI\fillRow(), ilPDSysMessageBlockGUI\getHTML(), ilPDNotesBlockGUI\getHTML(), ilBookmarkBlockGUI\getHTML(), ilPDTaggingBlockGUI\getHTML(), ilUsersOnlineBlockGUI\getHTML(), ilPDMailBlockGUI\getHTML(), ilHtmlBlockGUI\getHTML(), ilExternalFeedBlockGUI\getHTML(), ilPDExternalFeedBlockGUI\getHTML(), ilPDNewsBlockGUI\getHTML(), ilCalendarBlockGUI\getHTML(), ilPDSelectedItemsBlockGUI\getMembershipItemsPerLocation(), ilPDSelectedItemsBlockGUI\getMembershipItemsPerType(), ilBookmarkBlockGUI\getPDBookmarkListHTMLTree(), ilPDSelectedItemsBlockGUI\getSelectedItemsPerLocation(), ilPDSelectedItemsBlockGUI\getSelectedItemsPerType(), ilPDTaggingBlockGUI\getTagCloud(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), and ilPDNewsBlockGUI\ilPDNewsBlockGUI().

{
return $this->currentdetaillevel;
}

+ Here is the caller graph for this function:

ilBlockGUI::getData ( )

Get Data.

Returns
array Data

Definition at line 83 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 503 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 440 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 286 of file class.ilBlockGUI.php.

{
return $this->enableedit;
}
ilBlockGUI::getEnableNumInfo ( )

Get Enable Item Number Info.

Returns
boolean Enable Item Number Info

Definition at line 461 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 333 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 610 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 168 of file class.ilBlockGUI.php.

{
return $this->gui_object;
}
ilBlockGUI::getHeaderCommands ( )

Get Header Block commands.

Returns
array header block commands

Definition at line 587 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 63 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 ( )

Get HTML.

Reimplemented in ilCalendarBlockGUI, ilNewsForContextBlockGUI, ilPDNewsBlockGUI, ilPDSelectedItemsBlockGUI, ilPDExternalFeedBlockGUI, ilExternalFeedBlockGUI, ilDummyBlockGUI, ilHtmlBlockGUI, ilPDMailBlockGUI, ilUsersOnlineBlockGUI, ilPDTaggingBlockGUI, ilBookmarkBlockGUI, ilPDFeedbackBlockGUI, ilPDContentBlockGUI, ilPDNotesBlockGUI, and ilPDSysMessageBlockGUI.

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

References $_GET, $command, $ilCtrl, $lng, addBlockCommand(), fillDataSection(), fillDetailRow(), fillFooter(), fillHeaderCommands(), fillHeaderTitleBlock(), fillMoveRow(), fillPreviousNext(), getAdminCommands(), getBigMode(), getBlockCommands(), getBlockType(), getColSpan(), getFooterInfo(), getHeaderLinks(), getRefId(), getRepositoryMode(), and isRepositoryObject().

{
global $ilCtrl, $lng, $ilAccess, $ilUser;
if ($this->isRepositoryObject())
{
if (!$ilAccess->checkAccess("visible", "", $this->getRefId()))
{
return "";
}
}
$this->tpl = new ilTemplate("tpl.block.html", true, true, "Services/Block");
// $this->handleConfigStatus();
$this->fillDataSection();
if ($this->getRepositoryMode() && $this->isRepositoryObject()
&& $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(
"repository.php?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();
}
// commands
if (count($this->getBlockCommands()) > 0)
{
foreach($this->getBlockCommands() as $command)
{
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();
}
$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();
// fill row for setting details
if ($this->allow_moving)
{
$this->fillMoveRow();
}
// 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();
}
$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:

ilBlockGUI::getImage ( )

Get Image.

Returns
string Image

Definition at line 218 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 266 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 513 of file class.ilBlockGUI.php.

References getBlockId(), and getBlockType().

Referenced by fillMoveRow().

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilBlockGUI::getNavParameter ( )
final

Definition at line 498 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 238 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 477 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 380 of file class.ilBlockGUI.php.

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

{
return $this->refid;
}

+ Here is the caller graph for this function:

ilBlockGUI::getRepositoryMode ( )

Get RepositoryMode.

Returns
boolean RepositoryMode

Definition at line 306 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 533 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 523 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, ilPDNewsBlockGUI, ilNewsForContextBlockGUI, ilDummyBlockGUI, ilPDExternalFeedBlockGUI, ilPDMailBlockGUI, ilBookmarkBlockGUI, ilPDTaggingBlockGUI, ilPDFeedbackBlockGUI, ilHtmlBlockGUI, ilExternalFeedBlockGUI, ilUsersOnlineBlockGUI, and ilPDNotesBlockGUI.

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

References IL_SCREEN_SIDE.

{
return IL_SCREEN_SIDE;
}
ilBlockGUI::getSubtitle ( )

Get Subtitle.

Returns
string Subtitle

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

{
return $this->subtitle;
}
ilBlockGUI::getTitle ( )

Get Title.

Returns
string Title

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

References $title.

Referenced by fillDetailRow(), fillHeaderCommands(), 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 634 of file class.ilBlockGUI.php.

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

Referenced by setAvailableDetailLevels().

{
global $ilUser;
// 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()]);
}
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 46 of file class.ilBlockGUI.php.

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

Referenced by ilBookmarkBlockGUI\ilBookmarkBlockGUI(), ilCalendarBlockGUI\ilCalendarBlockGUI(), ilExternalFeedBlockGUI\ilExternalFeedBlockGUI(), ilHtmlBlockGUI\ilHtmlBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDContentBlockGUI\ilPDContentBlockGUI(), ilPDExternalFeedBlockGUI\ilPDExternalFeedBlockGUI(), ilPDFeedbackBlockGUI\ilPDFeedbackBlockGUI(), ilPDMailBlockGUI\ilPDMailBlockGUI(), 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, ilPDNewsBlockGUI, ilNewsForContextBlockGUI, ilPDContentBlockGUI, ilDummyBlockGUI, ilPDExternalFeedBlockGUI, ilPDMailBlockGUI, ilBookmarkBlockGUI, ilPDTaggingBlockGUI, ilPDFeedbackBlockGUI, ilPDSysMessageBlockGUI, ilExternalFeedBlockGUI, ilUsersOnlineBlockGUI, and ilPDNotesBlockGUI.

Referenced by getHTML().

+ Here is the caller graph for this function:

ilBlockGUI::setAdminCommands (   $a_admincommands)

Set Administration Commmands.

Parameters
boolean$a_admincommandsAdministration Commmands

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

{
$this->admincommands = $a_admincommands;
}
ilBlockGUI::setAllowMove (   $a_direction,
  $a_allow = true 
)

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

{
$this->move[$a_direction] = $a_allow;
//var_dump($this->move);
}
ilBlockGUI::setAvailableDetailLevels (   $a_max,
  $a_min = 0 
)

Set Available Detail Levels.

Parameters
int$a_maxMax Level
int$a_minMin Level (Default 0)

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

References handleDetailLevel().

Referenced by ilBookmarkBlockGUI\ilBookmarkBlockGUI(), ilCalendarBlockGUI\ilCalendarBlockGUI(), ilHtmlBlockGUI\ilHtmlBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDFeedbackBlockGUI\ilPDFeedbackBlockGUI(), ilPDMailBlockGUI\ilPDMailBlockGUI(), ilPDNewsBlockGUI\ilPDNewsBlockGUI(), ilPDNotesBlockGUI\ilPDNotesBlockGUI(), ilPDSelectedItemsBlockGUI\ilPDSelectedItemsBlockGUI(), ilPDSysMessageBlockGUI\ilPDSysMessageBlockGUI(), ilPDTaggingBlockGUI\ilPDTaggingBlockGUI(), ilUsersOnlineBlockGUI\ilUsersOnlineBlockGUI(), 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_bigmodeBig Mode

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

Referenced by ilPDContentBlockGUI\ilPDContentBlockGUI(), and ilPDSelectedItemsBlockGUI\ilPDSelectedItemsBlockGUI().

{
$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_idBlock ID

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

Referenced by ilCalendarBlockGUI\ilCalendarBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDCalendarBlockGUI\ilPDCalendarBlockGUI(), 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_colspanColumns Span

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

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

{
$this->colspan = $a_colspan;
}

+ Here is the caller graph for this function:

ilBlockGUI::setConfigMode (   $a_configmode)

Handle config status.

Set Config Mode (move blocks).

Parameters
boolean$a_configmodeConfig Mode (move blocks)

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

{
$this->config_mode = $a_configmode;
}
ilBlockGUI::setCurrentDetailLevel (   $a_currentdetaillevel)

Set Current Detail Level.

Parameters
int$a_currentdetaillevelCurrent Detail Level

Definition at line 146 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_dataData

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

Referenced by ilPDFeedbackBlockGUI\fillDataSection(), ilPDMailBlockGUI\fillDataSection(), ilBookmarkBlockGUI\getHTML(), ilPDTaggingBlockGUI\getHTML(), ilExternalFeedBlockGUI\getHTML(), ilPDExternalFeedBlockGUI\getHTML(), ilPDSelectedItemsBlockGUI\getHTML(), ilPDNotesBlockGUI\getListRowData(), ilUsersOnlineBlockGUI\getListRowData(), ilBookmarkBlockGUI\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 977 of file class.ilBlockGUI.php.

Referenced by ilPDNotesBlockGUI\fillDataSection(), ilPDFeedbackBlockGUI\fillDataSection(), ilDummyBlockGUI\fillDataSection(), ilBookmarkBlockGUI\fillDataSection(), ilPDTaggingBlockGUI\fillDataSection(), ilExternalFeedBlockGUI\fillDataSection(), ilHtmlBlockGUI\fillDataSection(), ilPDMailBlockGUI\fillDataSection(), ilPDExternalFeedBlockGUI\fillDataSection(), ilUsersOnlineBlockGUI\fillDataSection(), ilPDNewsBlockGUI\fillDataSection(), ilNewsForContextBlockGUI\fillDataSection(), ilCalendarBlockGUI\fillDataSection(), ilPDSelectedItemsBlockGUI\fillDataSection(), and ilUsersOnlineBlockGUI\getListRowData().

{
$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_enabledetailrowEnableDetailRow

Definition at line 430 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_enableeditEnableEdit

Reimplemented in ilCalendarBlockGUI, and ilNewsForContextBlockGUI.

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

{
$this->enableedit = $a_enableedit;
}
ilBlockGUI::setEnableNumInfo (   $a_enablenuminfo)

Set Enable Item Number Info.

Parameters
boolean$a_enablenuminfoEnable Item Number Info

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

Referenced by ilPDNotesBlockGUI\fillDataSection(), ilPDFeedbackBlockGUI\fillDataSection(), ilPDMailBlockGUI\fillDataSection(), ilUsersOnlineBlockGUI\fillDataSection(), ilPDNewsBlockGUI\fillDataSection(), 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_footerinfoFooter Info

Definition at line 316 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_objectGUI object

Reimplemented in ilExternalFeedBlockGUIGen.

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

{
$this->gui_object = $a_gui_object;
}
ilBlockGUI::setImage (   $a_image)

Set Image.

Parameters
string$a_imageImage

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

Referenced by ilBookmarkBlockGUI\ilBookmarkBlockGUI(), ilCalendarBlockGUI\ilCalendarBlockGUI(), ilExternalFeedBlockGUI\ilExternalFeedBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDExternalFeedBlockGUI\ilPDExternalFeedBlockGUI(), ilPDFeedbackBlockGUI\ilPDFeedbackBlockGUI(), ilPDMailBlockGUI\ilPDMailBlockGUI(), ilPDNewsBlockGUI\ilPDNewsBlockGUI(), ilPDNotesBlockGUI\ilPDNotesBlockGUI(), ilPDSysMessageBlockGUI\ilPDSysMessageBlockGUI(), 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_limitLimit

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

Referenced by ilBlockGUI(), ilBookmarkBlockGUI\ilBookmarkBlockGUI(), ilCalendarBlockGUI\ilCalendarBlockGUI(), ilDummyBlockGUI\ilDummyBlockGUI(), ilExternalFeedBlockGUI\ilExternalFeedBlockGUI(), ilHtmlBlockGUI\ilHtmlBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDContentBlockGUI\ilPDContentBlockGUI(), ilPDExternalFeedBlockGUI\ilPDExternalFeedBlockGUI(), ilPDFeedbackBlockGUI\ilPDFeedbackBlockGUI(), ilPDMailBlockGUI\ilPDMailBlockGUI(), 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_offsetOffset

Definition at line 228 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 1084 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_propertiesproperties array (key => value)

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

{
$this->property = $a_properties;
}
ilBlockGUI::setProperty (   $a_property,
  $a_value 
)

Definition at line 482 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_refidRef Id

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

{
$this->refid = $a_refid;
}
ilBlockGUI::setRepositoryMode (   $a_repositorymode)

Set RepositoryMode.

Parameters
boolean$a_repositorymodeRepositoryMode

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

{
$this->repositorymode = $a_repositorymode;
}
ilBlockGUI::setRowTemplate (   $a_rowtemplatename,
  $a_rowtemplatedir = "" 
)

Set Row Template Name.

Parameters
string$a_rowtemplatenameRow Template Name

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

Referenced by ilPDNotesBlockGUI\fillDataSection(), ilPDFeedbackBlockGUI\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_subtitleSubtitle

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

{
$this->subtitle = $a_subtitle;
}
ilBlockGUI::setTitle (   $a_title)

Set Title.

Parameters
string$a_titleTitle

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

Referenced by ilPDSelectedItemsBlockGUI\getHTML(), ilPDNewsBlockGUI\getHTML(), ilNewsForContextBlockGUI\getHTML(), ilBookmarkBlockGUI\getListRowData(), ilBookmarkBlockGUI\ilBookmarkBlockGUI(), ilCalendarBlockGUI\ilCalendarBlockGUI(), ilNewsForContextBlockGUI\ilNewsForContextBlockGUI(), ilPDFeedbackBlockGUI\ilPDFeedbackBlockGUI(), ilPDMailBlockGUI\ilPDMailBlockGUI(), ilPDNewsBlockGUI\ilPDNewsBlockGUI(), ilPDNotesBlockGUI\ilPDNotesBlockGUI(), ilPDSysMessageBlockGUI\ilPDSysMessageBlockGUI(), 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 getBlockId(), handleDetailLevel(), ilNewsForContextBlockGUI\handleView(), ilNewsForContextBlockGUI\hideNotifications(), ilPDNewsBlockGUI\saveSettings(), ilNewsForContextBlockGUI\saveSettings(), ilBookmarkBlockGUI\setFooterLinks(), ilPDSelectedItemsBlockGUI\setFooterLinks(), setPreviousNextLinks(), ilNewsForContextBlockGUI\showNotifications(), and ilNewsForContextBlockGUI\showViewFooter().

ilBlockGUI::$close_command = false
protected

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

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 fillDataSection(), getData(), ilPDNotesBlockGUI\getListRowData(), ilUsersOnlineBlockGUI\getListRowData(), ilBookmarkBlockGUI\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::$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: