ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
All Data Structures Namespaces Files Functions Variables Modules Pages
ilDashboardContentBlockGUI Class Reference

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

+ Inheritance diagram for ilDashboardContentBlockGUI:
+ Collaboration diagram for ilDashboardContentBlockGUI:

Public Member Functions

 __construct ()
 Constructor. More...
 
 getBlockType ()
 
 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
 getBlockType ()
 
 __construct ()
 Constructor. More...
 
 setData ($a_data)
 Set Data. More...
 
 getData ()
 Get Data. More...
 
 setPresentation (int $type)
 Set presentation. More...
 
 getPresentation ()
 Get presentation type. More...
 
 setBlockId ($a_block_id=0)
 Set Block Id. More...
 
 getBlockId ()
 Get Block Id. More...
 
 setGuiObject (&$a_gui_object)
 Set GuiObject. More...
 
 getGuiObject ()
 Get GuiObject. More...
 
 setTitle ($a_title)
 Set Title. More...
 
 getTitle ()
 Get Title. 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...
 
 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 (bool $a_admincommands)
 Set Administration Commmands. More...
 
 getAdminCommands ()
 Get Administration Commmands. 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 ()
 
 getConfigParameter ()
 
 getMoveParameter ()
 
 getRowTemplateName ()
 Get Row Template Name. More...
 
 getRowTemplateDir ()
 Get Row Template Directory. More...
 
 addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
 Add Block Command. More...
 
 getBlockCommands ()
 Get Block commands. More...
 
 getHTML ()
 Get HTML. 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...
 
 getAsynch ()
 Use this for final get before sending asynchronous output (ajax) per echo to output. More...
 
 getPaginationViewControl ()
 Fill previous/next row. More...
 
 getHTMLNew ()
 Get HTML. More...
 

Static Public Attributes

static $block_type = "dashcontent"
 

Protected Member Functions

 isRepositoryObject ()
 
- Protected Member Functions inherited from ilBlockGUI
 isRepositoryObject ()
 Returns whether block has a corresponding repository object. More...
 
 initCommands ()
 Init commands. More...
 
 fillRowColor ($a_placeholder="CSS_ROW")
 
 preloadData (array $data)
 Can be overwritten in subclasses. More...
 
 getLegacyContent ()
 Get legacy content. More...
 
 getViewControls ()
 Get view controls. More...
 
 getListItemForData (array $data)
 Get list item for data array. More...
 
 handleNavigation ()
 Handle navigation. More...
 
 loadData ()
 Load data for current page. More...
 
 getListItemGroups ()
 Get items. More...
 
 addRepoCommands ()
 Add repo commands. More...
 
 getNoItemFoundContent ()
 No item entry. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ilBlockGUI
static getScreenMode ()
 Get Screen Mode for current command. More...
 
- Data Fields inherited from ilBlockGUI
const PRES_MAIN_LEG = 0
 
const PRES_SEC_LEG = 1
 
const PRES_SEC_LIST = 2
 
const PRES_MAIN_LIST = 3
 
- Protected Attributes inherited from ilBlockGUI
 $ui
 
 $data = array()
 
 $enablenuminfo = true
 
 $footer_links = array()
 
 $block_id = 0
 
 $allow_moving = true
 
 $move = array("left" => false, "right" => false, "up" => false, "down" => false)
 
 $block_commands = array()
 
 $max_count = false
 
 $close_command = false
 
 $image = false
 
 $property = false
 
 $nav_value = ""
 
 $css_row = ""
 
 $title = ""
 
 $admincommands = false
 
 $dropdown
 
 $tpl
 
 $main_tpl
 
 $user
 
 $ctrl
 
 $access
 
 $lng
 
 $obj_def
 
 $presentation
 
 $new_rendering = false
 

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 14 of file class.ilDashboardContentBlockGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDashboardContentBlockGUI::__construct ( )

Constructor.

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilBlockGUI\setEnableNumInfo(), ilBlockGUI\setLimit(), ilBlockGUI\setPresentation(), and user().

22  {
23  global $DIC;
24 
25  $this->ctrl = $DIC->ctrl();
26  $this->lng = $DIC->language();
27  $this->user = $DIC->user();
28 
30 
31  $this->setEnableNumInfo(false);
32  $this->setLimit(99999);
33  $this->setPresentation(self::PRES_MAIN_LEG);
34  $this->allow_moving = false;
35  }
setEnableNumInfo($a_enablenuminfo)
Set Enable Item Number Info.
user()
Definition: user.php:4
setLimit($a_limit)
Set Limit.
__construct(Container $dic, ilPlugin $plugin)
$DIC
Definition: xapitoken.php:46
setPresentation(int $type)
Set presentation.
+ Here is the call graph for this function:

Member Function Documentation

◆ fillDataSection()

ilDashboardContentBlockGUI::fillDataSection ( )

Fill data section.

Definition at line 91 of file class.ilDashboardContentBlockGUI.php.

References getContent().

92  {
93  $this->tpl->setVariable("BLOCK_ROW", $this->getContent());
94  }
+ Here is the call graph for this function:

◆ fillFooter()

ilDashboardContentBlockGUI::fillFooter ( )

block footer

Definition at line 99 of file class.ilDashboardContentBlockGUI.php.

References ilBlockGUI\$lng, getCurrentItemNumber(), and ilBlockGUI\getEnableNumInfo().

100  {
101  //$this->fillFooterLinks();
102  $lng = $this->lng;
103 
104  if (is_array($this->data)) {
105  $this->max_count = count($this->data);
106  }
107 
108  // table footer numinfo
109  if ($this->getEnableNumInfo()) {
110  $numinfo = "(" . $this->getCurrentItemNumber() . " " .
111  strtolower($lng->txt("of")) . " " . $this->max_count . ")";
112 
113  if ($this->max_count > 0) {
114  $this->tpl->setVariable("NUMINFO", $numinfo);
115  }
116  }
117  }
getCurrentItemNumber()
Get Current Item Number.
getEnableNumInfo()
Get Enable Item Number Info.
+ Here is the call graph for this function:

◆ fillPreviousNext()

ilDashboardContentBlockGUI::fillPreviousNext ( )

Definition at line 119 of file class.ilDashboardContentBlockGUI.php.

120  {
121  }

◆ getBlockType()

ilDashboardContentBlockGUI::getBlockType ( )

Definition at line 40 of file class.ilDashboardContentBlockGUI.php.

40  : string
41  {
42  return self::$block_type;
43  }

◆ getContent()

ilDashboardContentBlockGUI::getContent ( )

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

Referenced by fillDataSection().

79  {
80  return $this->content;
81  }
+ Here is the caller graph for this function:

◆ getCurrentItemNumber()

ilDashboardContentBlockGUI::getCurrentItemNumber ( )

Get Current Item Number.

Returns
int Current Item Number

Definition at line 60 of file class.ilDashboardContentBlockGUI.php.

Referenced by fillFooter().

61  {
62  return $this->currentitemnumber;
63  }
+ Here is the caller graph for this function:

◆ getHTML()

ilDashboardContentBlockGUI::getHTML ( )

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

74  {
75  return parent::getHTML();
76  }

◆ isRepositoryObject()

ilDashboardContentBlockGUI::isRepositoryObject ( )
protected

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

68  : bool
69  {
70  return false;
71  }

◆ setContent()

ilDashboardContentBlockGUI::setContent (   $a_content)

Definition at line 83 of file class.ilDashboardContentBlockGUI.php.

References $a_content.

84  {
85  $this->content = $a_content;
86  }
$a_content
Definition: workflow.php:93

◆ setCurrentItemNumber()

ilDashboardContentBlockGUI::setCurrentItemNumber (   $a_currentitemnumber)

Set Current Item Number.

Parameters
int$a_currentitemnumberCurrent Item Number

Definition at line 50 of file class.ilDashboardContentBlockGUI.php.

51  {
52  $this->currentitemnumber = $a_currentitemnumber;
53  }

Field Documentation

◆ $block_type

ilDashboardContentBlockGUI::$block_type = "dashcontent"
static

Definition at line 16 of file class.ilDashboardContentBlockGUI.php.


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