ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilDashboardContentBlockGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

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

Public Member Functions

 __construct ()
 
 getBlockType ()
 
 setCurrentItemNumber (int $a_currentitemnumber)
 
 getCurrentItemNumber ()
 
 getHTML ()
 
 getContent ()
 
 setContent (string $a_content)
 
 fillDataSection ()
 
 fillFooter ()
 
 fillPreviousNext ()
 
- Public Member Functions inherited from ilBlockGUI
 __construct ()
 
 getBlockType ()
 
 setData (array $a_data)
 
 getData ()
 
 setPresentation (int $type)
 
 getPresentation ()
 
 setBlockId (string $a_block_id="0")
 
 getBlockId ()
 
 setGuiObject (object $a_gui_object)
 Set GuiObject. More...
 
 getGuiObject ()
 
 setTitle (string $a_title)
 
 getTitle ()
 
 setOffset (int $a_offset)
 
 getOffset ()
 
 correctOffset ()
 
 setLimit (int $a_limit)
 
 getLimit ()
 
 setEnableEdit (bool $a_enableedit)
 
 getEnableEdit ()
 
 setRepositoryMode (bool $a_repositorymode)
 
 getRepositoryMode ()
 
 setSubtitle (string $a_subtitle)
 
 getSubtitle ()
 
 setRefId (int $a_refid)
 Set Ref Id (only used if isRepositoryObject() is true). More...
 
 getRefId ()
 
 setAdminCommands (bool $a_admincommands)
 
 getAdminCommands ()
 
 setEnableNumInfo (bool $a_enablenuminfo)
 
 getEnableNumInfo ()
 
 setProperties (array $a_properties)
 This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...
 
 getProperty (string $a_property)
 
 setProperty (string $a_property, string $a_value)
 
 setRowTemplate (string $a_rowtemplatename, string $a_rowtemplatedir="")
 Set Row Template Name. More...
 
 getNavParameter ()
 
 getConfigParameter ()
 
 getMoveParameter ()
 
 getRowTemplateName ()
 
 getRowTemplateDir ()
 
 addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
 
 getBlockCommands ()
 
 getHTML ()
 
 fillHeaderCommands ()
 
 fillHeaderTitleBlock ()
 
 setDataSection (string $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 (array $a_set)
 
 fillFooter ()
 
 fillPreviousNext ()
 
 setPreviousNextLinks ()
 
 getAsynch ()
 Use this for final get before sending asynchronous output (ajax) per echo to output. More...
 
 getPaginationViewControl ()
 Fill previous/next row. More...
 
 getHTMLNew ()
 
 getNoItemFoundContent ()
 

Static Public Attributes

static string $block_type = "dashcontent"
 

Protected Member Functions

 isRepositoryObject ()
 
- Protected Member Functions inherited from ilBlockGUI
 isRepositoryObject ()
 Returns whether block has a corresponding repository object. More...
 
 specialCharsAsEntities (string $string)
 
 initCommands ()
 
 fillRowColor (string $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...
 
 send (string $output)
 Send. More...
 

Protected Attributes

int $currentitemnumber
 
string $content
 
- Protected Attributes inherited from ilBlockGUI
object $gui_object
 
ILIAS Block StandardGUIRequest $request
 
ILIAS Block BlockManager $block_manager
 
bool $repositorymode = false
 
ILIAS DI UIServices $ui
 
array $data = array()
 
bool $enablenuminfo = true
 
array $footer_links = array()
 
string $block_id = "0"
 
bool $allow_moving = true
 
array $move = array("left" => false, "right" => false, "up" => false, "down" => false)
 
array $block_commands = array()
 
int $max_count = 0
 
bool $close_command = false
 
bool $image = false
 
array $property = []
 
string $nav_value = ""
 
string $css_row = ""
 
string $title = ""
 
bool $admincommands = false
 
array $dropdown
 
ilTemplate $tpl
 
ilGlobalTemplateInterface $main_tpl
 
ilObjUser $user
 
ilCtrl $ctrl
 
ilAccessHandler $access
 
ilLanguage $lng
 
ilObjectDefinition $obj_def
 
int $presentation
 
int $requested_ref_id
 
bool $new_rendering = false
 

Additional Inherited Members

- Static Public Member Functions inherited from ilBlockGUI
static getScreenMode ()
 
- 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
 
const PRES_MAIN_TILE = 4
 

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

◆ __construct()

ilDashboardContentBlockGUI::__construct ( )

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

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

26  {
27  global $DIC;
28 
29  $this->ctrl = $DIC->ctrl();
30  $this->lng = $DIC->language();
31  $this->user = $DIC->user();
32 
34 
35  $this->setEnableNumInfo(false);
36  $this->setLimit(99999);
37  $this->setPresentation(self::PRES_MAIN_LEG);
38  $this->allow_moving = false;
39  }
setLimit(int $a_limit)
setEnableNumInfo(bool $a_enablenuminfo)
global $DIC
Definition: feed.php:28
__construct(Container $dic, ilPlugin $plugin)
setPresentation(int $type)
+ Here is the call graph for this function:

Member Function Documentation

◆ fillDataSection()

ilDashboardContentBlockGUI::fillDataSection ( )

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

References getContent().

76  : void
77  {
78  $this->tpl->setVariable("BLOCK_ROW", $this->getContent());
79  }
+ Here is the call graph for this function:

◆ fillFooter()

ilDashboardContentBlockGUI::fillFooter ( )

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

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

81  : void
82  {
83  //$this->fillFooterLinks();
84  $lng = $this->lng;
85 
86  if (is_array($this->data)) {
87  $this->max_count = count($this->data);
88  }
89 
90  // table footer numinfo
91  if ($this->getEnableNumInfo()) {
92  $numinfo = "(" . $this->getCurrentItemNumber() . " " .
93  strtolower($lng->txt("of")) . " " . $this->max_count . ")";
94 
95  if ($this->max_count > 0) {
96  $this->tpl->setVariable("NUMINFO", $numinfo);
97  }
98  }
99  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
ilLanguage $lng
+ Here is the call graph for this function:

◆ fillPreviousNext()

ilDashboardContentBlockGUI::fillPreviousNext ( )

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

101  : void
102  {
103  }

◆ getBlockType()

ilDashboardContentBlockGUI::getBlockType ( )

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

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

◆ getContent()

ilDashboardContentBlockGUI::getContent ( )

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

References $content.

Referenced by fillDataSection().

66  : string
67  {
68  return $this->content;
69  }
+ Here is the caller graph for this function:

◆ getCurrentItemNumber()

ilDashboardContentBlockGUI::getCurrentItemNumber ( )

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

References $currentitemnumber.

Referenced by fillFooter().

51  : int
52  {
54  }
+ Here is the caller graph for this function:

◆ getHTML()

ilDashboardContentBlockGUI::getHTML ( )

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

61  : string
62  {
63  return parent::getHTML();
64  }

◆ isRepositoryObject()

ilDashboardContentBlockGUI::isRepositoryObject ( )
protected

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

56  : bool
57  {
58  return false;
59  }

◆ setContent()

ilDashboardContentBlockGUI::setContent ( string  $a_content)

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

71  : void
72  {
73  $this->content = $a_content;
74  }

◆ setCurrentItemNumber()

ilDashboardContentBlockGUI::setCurrentItemNumber ( int  $a_currentitemnumber)

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

46  : void
47  {
48  $this->currentitemnumber = $a_currentitemnumber;
49  }

Field Documentation

◆ $block_type

string ilDashboardContentBlockGUI::$block_type = "dashcontent"
static

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

◆ $content

string ilDashboardContentBlockGUI::$content
protected

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

Referenced by getContent().

◆ $currentitemnumber

int ilDashboardContentBlockGUI::$currentitemnumber
protected

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

Referenced by getCurrentItemNumber().


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