ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilPDContentBlockGUI Class Reference

BlockGUI class for (centered) Content on Personal Desktop. More...

+ Inheritance diagram for ilPDContentBlockGUI:
+ Collaboration diagram for ilPDContentBlockGUI:

Public Member Functions

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

Static Public Member Functions

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

Static Public Attributes

static $block_type = "pdcontent"
 

Additional Inherited Members

- Protected Member Functions inherited from ilBlockGUI
 fillRowColor ($a_placeholder="CSS_ROW")
 
 preloadData (array $data)
 Can be overwritten in subclasses. More...
 
- Protected Attributes inherited from ilBlockGUI
 $data = array()
 
 $colspan = 1
 
 $enablenuminfo = true
 
 $detail_min = 0
 
 $detail_max = 0
 
 $bigmode = false
 
 $footer_links = array()
 
 $block_id = 0
 
 $header_commands = array()
 
 $allow_moving = true
 
 $move = array("left" => false, "right" => false, "up" => false, "down" => false)
 
 $enabledetailrow = true
 
 $header_links = array()
 
 $footerinfo = false
 
 $footerinfo_icon = false
 
 $block_commands = array()
 
 $max_count = false
 
 $close_command = false
 
 $image = false
 
 $property = false
 
 $nav_value = ""
 
 $css_row = ""
 
 $dropdown
 

Detailed Description

BlockGUI class for (centered) Content on Personal Desktop.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilPDContentBlockGUI::__construct ( )

Constructor.

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

References $ilCtrl, $ilUser, $lng, ilBlockGUI\setBigMode(), ilBlockGUI\setEnableNumInfo(), and ilBlockGUI\setLimit().

40  {
41  global $ilCtrl, $lng, $ilUser;
42 
43  parent::__construct();
44 
45  //$this->setTitle($lng->txt("selected_items"));
46  $this->setEnableNumInfo(false);
47  $this->setLimit(99999);
48  //$this->setColSpan(2);
49  $this->setBigMode(true);
50  $this->allow_moving = false;
51  }
setBigMode($a_bigmode)
Set Big Mode.
setEnableNumInfo($a_enablenuminfo)
Set Enable Item Number Info.
global $ilCtrl
Definition: ilias.php:18
$ilUser
Definition: imgupload.php:18
setLimit($a_limit)
Set Limit.
global $lng
Definition: privfeed.php:17
+ Here is the call graph for this function:

Member Function Documentation

◆ fillDataSection()

ilPDContentBlockGUI::fillDataSection ( )

Fill data section.

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

References $ilUser, and getContent().

112  {
113  global $ilUser;
114 
115  $this->tpl->setVariable("BLOCK_ROW", $this->getContent());
116  }
$ilUser
Definition: imgupload.php:18
+ Here is the call graph for this function:

◆ fillFooter()

ilPDContentBlockGUI::fillFooter ( )

block footer

Definition at line 121 of file class.ilPDContentBlockGUI.php.

References $ilCtrl, $lng, data, ilBlockGUI\fillFooterLinks(), and ilBlockGUI\getEnableNumInfo().

122  {
123  //$this->fillFooterLinks();
124  global $lng, $ilCtrl;
125 
126  $footer = false;
127 
128  if (is_array($this->data))
129  {
130  $this->max_count = count($this->data);
131  }
132 
133  // table footer numinfo
134  if ($this->getEnableNumInfo())
135  {
136  $numinfo = "(".$this->getCurrentItemNumber()." ".
137  strtolower($lng->txt("of"))." ".$this->max_count.")";
138 
139  if ($this->max_count > 0)
140  {
141  $this->tpl->setVariable("NUMINFO", $numinfo);
142  }
143  $footer = true;
144  $this->fillFooterLinks(true, $numinfo);
145  }
146  }
Add some data
fillFooterLinks($a_top=false, $a_numinfo="")
Fill footer links.
global $ilCtrl
Definition: ilias.php:18
getEnableNumInfo()
Get Enable Item Number Info.
global $lng
Definition: privfeed.php:17
PHPExcel root directory.
Definition: Database.php:30
+ Here is the call graph for this function:

◆ fillPreviousNext()

ilPDContentBlockGUI::fillPreviousNext ( )

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

149  {
150  }

◆ getBlockType()

static ilPDContentBlockGUI::getBlockType ( )
static

Get block type.

Returns
string Block type.

Definition at line 58 of file class.ilPDContentBlockGUI.php.

59  {
60  return self::$block_type;
61  }

◆ getContent()

ilPDContentBlockGUI::getContent ( )

Definition at line 98 of file class.ilPDContentBlockGUI.php.

Referenced by fillDataSection().

99  {
100  return $this->content;
101  }
+ Here is the caller graph for this function:

◆ getCurrentItemNumber()

ilPDContentBlockGUI::getCurrentItemNumber ( )

Get Current Item Number.

Returns
int Current Item Number

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

79  {
80  return $this->currentitemnumber;
81  }

◆ getHTML()

ilPDContentBlockGUI::getHTML ( )

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

94  {
95  return parent::getHTML();
96  }

◆ isRepositoryObject()

static ilPDContentBlockGUI::isRepositoryObject ( )
static

Get block type.

Returns
string Block type.

Definition at line 88 of file class.ilPDContentBlockGUI.php.

89  {
90  return false;
91  }

◆ setContent()

ilPDContentBlockGUI::setContent (   $a_content)

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

References $a_content.

104  {
105  $this->content = $a_content;
106  }
$a_content
Definition: workflow.php:94

◆ setCurrentItemNumber()

ilPDContentBlockGUI::setCurrentItemNumber (   $a_currentitemnumber)

Set Current Item Number.

Parameters
int$a_currentitemnumberCurrent Item Number

Definition at line 68 of file class.ilPDContentBlockGUI.php.

69  {
70  $this->currentitemnumber = $a_currentitemnumber;
71  }

Field Documentation

◆ $block_type

ilPDContentBlockGUI::$block_type = "pdcontent"
static

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


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