Inheritance diagram for ilDashboardBlockGUI:

Collaboration diagram for ilDashboardBlockGUI:

Public Member Functions
	__construct ()

	initViewSettings ()

	initData ()

	emptyHandling ()

	addCustomCommandsToActionMenu (ilObjectListGUI $itemListGui, int $ref_id)

	getNoItemFoundContent ()

	getViewSettings ()

	init ()

	getHTML ()

	setData (array $a_data)

	getData ()

	addCommandActions ()

	getRemoveModal ()

	executeCommand ()

	viewDashboardObject ()

	changePDItemSortingObject ()

	changePDItemPresentationObject ()

	getItemGroups ()

	addToDeskObject ()

	removeFromDeskObject ()

	removeMultipleEnabled ()

	getRemoveMultipleActionText ()

	confirmedRemove (array $ids)

	byType (string $a_type)

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

	checkOffset (int $offset)

	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="", ?RoundTrip $modal=null)

	getBlockCommands ()

	getHTML ()

	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...

	getPaginationViewControl ()
	Fill previous/next row. More...

	getViewControlsForPanel ()

	sortObject ()

	addSortOption (string $option, string $label, bool $active)

	setSortTarget (string $target)

	addPresentation (string $label, string $target, bool $active)

	getNoItemFoundContent ()

Protected Member Functions
	getCardForData (BlockDTO $data)

	getListItemGroups ()

	getListItemForDataDTO (BlockDTO $data)

	isRepositoryObject ()

	getLegacyContent ()

	initAndShow ()

	isRootNode (int $refId)

	getRepositoryTitle ()

	getManageFields ()

Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...

	specialCharsAsEntities (string $string)

	initCommands ()

	preloadData (array $data)
	Can be overwritten in subclasses. More...

	getLegacyContent ()
	Get legacy content. 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...

	getActionsForPanel ()

	send (string $output)
	Send. More...

Protected Attributes
ilFavouritesManager	$favourites_manager

int	$requested_item_ref_id

ilSetting	$settings

ilLogger	$logging

Services	$http

ilPDSelectedItemsBlockViewSettings	$viewSettings

array	$data

Protected Attributes inherited from ilBlockGUI
ILIAS UI Renderer	$renderer

Factory	$factory

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

Private Member Functions
	sortByDate (array $data, bool $asc=true)

	sortByTitle (array $data)

Private Attributes
string	$content

ilRbacSystem	$rbacsystem

string	$parent

mixed	$object_cache

ilTree	$tree

mixed	$objDefinition

Factory	$refinery

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

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

Constructor & Destructor Documentation

◆ __construct()

ilDashboardBlockGUI::__construct ( )

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), emptyHandling(), ILIAS\FileDelivery\http(), init(), initData(), initViewSettings(), ILIAS\Repository\refinery(), and ILIAS\Repository\settings().

     {
         parent::__construct();
         global $DIC;
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
         $this->logging = $DIC->logger()->root();
         $this->settings = $DIC->settings();
         $this->object_cache = $DIC['ilObjDataCache'];
         $this->tree = $DIC->repositoryTree();
         $this->objDefinition = $DIC['objDefinition'];
         $this->rbacsystem = $DIC->rbac()->system();
         $this->favourites_manager = new ilFavouritesManager();
         $this->parent = $this->ctrl->getCurrentClassPath()[0] ?? '';
         $this->init();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCommandActions()

ilDashboardBlockGUI::addCommandActions ( )

Definition at line 356 of file class.ilDashboardBlockGUI.php.

References ilBlockGUI\$presentation, ilBlockGUI\$presentations, ilBlockGUI\addBlockCommand(), ilBlockGUI\addPresentation(), ilBlockGUI\addSortOption(), ILIAS\Repository\ctrl(), ilObjDashboardSettingsGUI\DASH_SORT_PREFIX, getRemoveModal(), getRemoveMultipleActionText(), ILIAS\Repository\lng(), null, removeMultipleEnabled(), ilBlockGUI\setSortTarget(), and ILIAS\Repository\ui().

Referenced by getHTML().

                                        : void
     {
         $sortings = $this->viewSettings->getSelectableSortingModes();
         if (count($sortings) > 1) {
             foreach ($sortings as $sorting) {
                 $this->addSortOption(
                     $sorting,
                     $this->lng->txt(ilObjDashboardSettingsGUI::DASH_SORT_PREFIX . $sorting),
                     $sorting === $this->viewSettings->getEffectiveSortingMode()
                 );
             }
             $this->setSortTarget($this->ctrl->getLinkTarget($this, 'changePDItemSorting'));
         }
 
         $presentations = $this->viewSettings->getSelectablePresentationModes();
         foreach ($presentations as $presentation) {
             $this->ctrl->setParameter($this, 'presentation', $presentation);
             $this->addPresentation(
                 $this->ui->renderer()->render($this->ui->factory()->symbol()->glyph()->{$presentation . 'View'}()),
                 $this->ctrl->getLinkTarget($this, 'changePDItemPresentation'),
                 $presentation === $this->viewSettings->getEffectivePresentationMode()
             );
             $this->ctrl->setParameter($this, 'presentation', null);
         }
 
         if ($this->removeMultipleEnabled()) {
             $this->addBlockCommand(
                 $this->ctrl->getLinkTarget($this, 'manage'),
                 $this->getRemoveMultipleActionText(),
                 '',
                 $this->getRemoveModal()
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCustomCommandsToActionMenu()

ilDashboardBlockGUI::addCustomCommandsToActionMenu	(	ilObjectListGUI	$itemListGui,
		int	$ref_id
	)

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

Referenced by getCardForData(), and getListItemForDataDTO().

                                                                                             : void
     {
     }

Here is the caller graph for this function:

◆ addToDeskObject()

ilDashboardBlockGUI::addToDeskObject ( )

Implements ilDesktopItemHandling.

Definition at line 522 of file class.ilDashboardBlockGUI.php.

References $requested_item_ref_id, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

                                      : void
     {
         $this->favourites_manager->add($this->user->getId(), $this->requested_item_ref_id);
         $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('rep_added_to_favourites'), true);
         $this->ctrl->redirectByClass(ilDashboardGUI::class, 'show');
     }

Here is the call graph for this function:

◆ byType()

ilDashboardBlockGUI::byType ( string $a_type )

Definition at line 547 of file class.ilDashboardBlockGUI.php.

References $location.

Referenced by getCardForData(), and getListItemForDataDTO().

                                           : ilObjectListGUI
     {
         $class = $this->objDefinition->getClassName($a_type);
         if (!$class) {
             throw new ilException(sprintf('Could not find a class for object type: %s', $a_type));
         }
 
         $location = $this->objDefinition->getLocation($a_type);
         if (!$location) {
             throw new ilException(sprintf('Could not find a class location for object type: %s', $a_type));
         }
 
         $full_class = 'ilObj' . $class . 'ListGUI';
         $item_list_gui = new $full_class();
 
         $item_list_gui->setContainerObject($this);
         $item_list_gui->enableNotes(false);
         $item_list_gui->enableComments(false);
         $item_list_gui->enableTags(false);
 
         $item_list_gui->enableIcon(true);
         $item_list_gui->enableDelete(false);
         $item_list_gui->enableCut(false);
         $item_list_gui->enableCopy(false);
         $item_list_gui->enableLink(false);
         $item_list_gui->enableInfoScreen(true);
 
         $item_list_gui->enableCommands(true, true);
 
         return $item_list_gui;
     }

Here is the caller graph for this function:

◆ changePDItemPresentationObject()

ilDashboardBlockGUI::changePDItemPresentationObject ( )

Definition at line 493 of file class.ilDashboardBlockGUI.php.

References ILIAS\FileDelivery\http(), initAndShow(), and ilUtil\stripSlashes().

                                                     : string
     {
         $this->viewSettings->storeActorPresentationMode(
             ilUtil::stripSlashes((string) ($this->http->request()->getQueryParams()['presentation'] ?? ''))
         );
         return $this->initAndShow();
     }

Here is the call graph for this function:

◆ changePDItemSortingObject()

ilDashboardBlockGUI::changePDItemSortingObject ( )

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

References ILIAS\FileDelivery\http(), initAndShow(), and ilUtil\stripSlashes().

                                                : string
     {
         $this->viewSettings->storeActorSortingMode(
             ilUtil::stripSlashes((string) ($this->http->request()->getQueryParams()['sorting'] ?? ''))
         );
 
         return $this->initAndShow();
     }

Here is the call graph for this function:

◆ confirmedRemove()

ilDashboardBlockGUI::confirmedRemove ( array $ids )

Parameters

int[] $ids

Definition at line 543 of file class.ilDashboardBlockGUI.php.

Referenced by executeCommand().

                                                : void
     {
     }

Here is the caller graph for this function:

◆ emptyHandling()

ilDashboardBlockGUI::emptyHandling ( )

abstract

Referenced by __construct(), getHTML(), and getNoItemFoundContent().

Here is the caller graph for this function:

◆ executeCommand()

ilDashboardBlockGUI::executeCommand ( )

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

References confirmedRemove(), ILIAS\Repository\ctrl(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getManageFields(), ILIAS\FileDelivery\http(), and ILIAS\Repository\ui().

                                     : string
     {
         $next_class = $this->ctrl->getNextClass();
         $cmd = $this->ctrl->getCmd('getHTML');
 
         switch ($next_class) {
             case strtolower(ilCommonActionDispatcherGUI::class):
                 $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                 if ($gui instanceof ilCommonActionDispatcherGUI) {
                     $this->ctrl->forwardCommand($gui);
                 }
                 break;
 
             default:
                 switch ($cmd) {
                     case 'confirmedRemove':
                         $form = $this->ui->factory()->input()->container()->form()->standard('', $this->getManageFields())->withRequest($this->http->request());
                         $this->confirmedRemove(array_merge(...array_filter($form->getData())));
                         // no break
                     default:
                         if (method_exists($this, $cmd . 'Object')) {
                             return $this->{$cmd . 'Object'}();
                         }
                 }
         }
         return '';
     }

Here is the call graph for this function:

◆ getCardForData()

ilDashboardBlockGUI::getCardForData ( BlockDTO $data )

protected

Definition at line 77 of file class.ilDashboardBlockGUI.php.

References addCustomCommandsToActionMenu(), byType(), ILIAS\components\Dashboard\Block\BlockDTO\getDescription(), ILIAS\components\Dashboard\Block\BlockDTO\getObjId(), ILIAS\components\Dashboard\Block\BlockDTO\getRefId(), ILIAS\components\Dashboard\Block\BlockDTO\getTitle(), and ILIAS\components\Dashboard\Block\BlockDTO\getType().

Referenced by getLegacyContent().

                                                      : ?RepositoryObject
     {
         $itemListGui = $this->byType($data->getType());
         $this->addCustomCommandsToActionMenu($itemListGui, $data->getRefId());
         $card = $itemListGui->getAsCard(
             $data->getRefId(),
             $data->getObjId(),
             $data->getType(),
             $data->getTitle(),
             $data->getDescription()
         );
 
         return $card;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getData()

ilDashboardBlockGUI::getData ( )

Returns: array<BlockDTO[]>

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

References ilBlockGUI\$title, ilObjectPlugin\getPluginObjectByType(), ILIAS\components\Dashboard\Block\BlockDTO\getRefId(), getRepositoryTitle(), isRootNode(), ILIAS\Repository\lng(), sortByDate(), and sortByTitle().

Referenced by getItemGroups().

                              : array
     {
         return parent::getData();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilDashboardBlockGUI::getHTML ( )

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

References addCommandActions(), emptyHandling(), getItemGroups(), ILIAS\Repository\lng(), setData(), and ilBlockGUI\setTitle().

Referenced by initAndShow().

                              : string
     {
         $this->setTitle(
             $this->lng->txt('dash_' . $this->viewSettings->getViewName($this->viewSettings->getCurrentView()))
         );
 
         if (!$this->data) {
             return $this->emptyHandling();
         }
 
         $this->addCommandActions();
         $this->setData($this->getItemGroups());
 
         return parent::getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItemGroups()

ilDashboardBlockGUI::getItemGroups ( )

Returns: array<BlockDTO[]>

Definition at line 504 of file class.ilDashboardBlockGUI.php.

References $data, getData(), ilPDSelectedItemsBlockConstants\SORT_BY_ALPHABET, ilPDSelectedItemsBlockConstants\SORT_BY_LOCATION, ilPDSelectedItemsBlockConstants\SORT_BY_START_DATE, ilPDSelectedItemsBlockConstants\SORT_BY_TYPE, and sortByTitle().

Referenced by getHTML(), and getManageFields().

                                    : array
     {
         switch ($this->viewSettings->getEffectiveSortingMode()) {
             case ilPDSelectedItemsBlockConstants::SORT_BY_ALPHABET:
                 $data = $this->getData();
                 $data = array_merge(...array_values($data));
                 $data = $this->sortByTitle($data);
                 return ['' => $data];
             case ilPDSelectedItemsBlockConstants::SORT_BY_START_DATE:
                 return $this->groupItemsByStartDate();
             case ilPDSelectedItemsBlockConstants::SORT_BY_TYPE:
                 return $this->groupItemsByType();
             case ilPDSelectedItemsBlockConstants::SORT_BY_LOCATION:
             default:
                 return $this->groupItemsByLocation();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLegacyContent()

ilDashboardBlockGUI::getLegacyContent ( )

protected

Definition at line 140 of file class.ilDashboardBlockGUI.php.

References ilBlockGUI\$title, factory(), getCardForData(), getNoItemFoundContent(), ilBlockGUI\loadData(), renderer(), and ILIAS\Repository\ui().

                                          : string
     {
         $groupedCards = [];
         foreach ($this->loadData() as $title => $group) {
             $cards = array_filter(array_map($this->getCardForData(...), $group));
             if ($cards) {
                 $groupedCards[] = $this->ui->factory()->panel()->sub(
                     (string) $title,
                     $this->factory->deck($cards)->withNormalCardsSize()
                 );
             }
         }
 
         if ($groupedCards) {
             return $this->renderer->render($groupedCards);
         }
 
         return $this->getNoItemFoundContent();
     }

Here is the call graph for this function:

◆ getListItemForDataDTO()

ilDashboardBlockGUI::getListItemForDataDTO ( BlockDTO $data )

protected

Definition at line 118 of file class.ilDashboardBlockGUI.php.

References addCustomCommandsToActionMenu(), byType(), ILIAS\components\Dashboard\Block\BlockDTO\getAdditionalData(), ILIAS\components\Dashboard\Block\BlockDTO\getDescription(), ILIAS\components\Dashboard\Block\BlockDTO\getObjId(), ILIAS\components\Dashboard\Block\BlockDTO\getRefId(), ILIAS\components\Dashboard\Block\BlockDTO\getTitle(), and ILIAS\components\Dashboard\Block\BlockDTO\getType().

Referenced by getListItemGroups().

                                                             : ?Item
     {
         $itemListGui = $this->byType($data->getType());
         $this->addCustomCommandsToActionMenu($itemListGui, $data->getRefId());
         $list_item = $itemListGui->getAsListItem(
             $data->getRefId(),
             $data->getObjId(),
             $data->getType(),
             $data->getTitle(),
             $data->getDescription()
         );
 
         $list_item = $list_item->withProperties($list_item->getProperties() + $data->getAdditionalData());
 
         return $list_item;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getListItemGroups()

ilDashboardBlockGUI::getListItemGroups ( )

protected

Definition at line 92 of file class.ilDashboardBlockGUI.php.

References ilBlockGUI\$title, factory(), getListItemForDataDTO(), ilBlockGUI\loadData(), null, and ilLPStatus\preloadListGUIData().

                                           : array
     {
         $data = $this->loadData();
         $groupedCards = [];
         $obj_ids = [];
         foreach ($data as $group) {
             foreach ($group as $datum) {
                 $obj_ids[] = $datum->getObjId();
             }
         }
         ilLPStatus::preloadListGUIData($obj_ids);
 
         foreach ($data as $title => $group) {
             $items = [];
             foreach ($group as $datum) {
                 $item = $this->getListItemForDataDTO($datum);
                 if ($item !== null) {
                     $items[] = $item;
                 }
             }
             $groupedCards[] = $this->factory->item()->group((string) $title, $items);
         }
 
         return $groupedCards;
     }

Here is the call graph for this function:

◆ getManageFields()

ilDashboardBlockGUI::getManageFields ( )

protected

Definition at line 421 of file class.ilDashboardBlockGUI.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ilObject\_getIcon(), ilParticipants\getInstance(), getItemGroups(), ILIAS\Repository\refinery(), and ILIAS\Repository\ui().

Referenced by executeCommand(), and getRemoveModal().

                                         : array
     {
         $inputs = [];
         foreach ($this->getItemGroups() as $key => $item_group) {
             $options = [];
             foreach ($item_group as $item) {
                 $icon = $this->ui->renderer()->render($this->ui->factory()->symbol()->icon()->custom(ilObject::_getIcon($item->getObjId()), ''));
                 if ($this instanceof ilMembershipBlockGUI) {
                     if ($this->rbacsystem->checkAccess('leave', $item->getRefId())) {
                         if ($item->getType() === 'crs' || $item->getType() === 'grp') {
                             $members_obj = ilParticipants::getInstance($item->getRefId());
                             if (!$members_obj->checkLastAdmin([$this->user->getId()])) {
                                 continue;
                             }
                         }
                         $options[$item->getRefId()] = $icon . $item->getTitle();
                     }
                 } else {
                     $options[$item->getRefId()] = $icon . $item->getTitle();
                 }
             }
             if ($options !== []) {
                 $inputs[] = $this->ui->factory()->input()->field()->multiSelect((string) $key, $options)
                     ->withAdditionalTransformation($this->refinery->to()->listOf($this->refinery->kindlyTo()->int()));
             }
         }
 
         return $inputs;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNoItemFoundContent()

ilDashboardBlockGUI::getNoItemFoundContent ( )

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

References emptyHandling().

Referenced by getLegacyContent().

                                            : string
     {
         return $this->emptyHandling();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRemoveModal()

ilDashboardBlockGUI::getRemoveModal ( )

Definition at line 391 of file class.ilDashboardBlockGUI.php.

References $id, ILIAS\Repository\ctrl(), getManageFields(), getRemoveMultipleActionText(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by addCommandActions().

                                     : RoundTrip
     {
         $items = $this->getManageFields();
         if ($items !== []) {
             if ($this->viewSettings->isSelectedItemsViewActive()) {
                 $question = $this->lng->txt('dash_info_sure_remove_from_favs');
             } else {
                 $question = $this->lng->txt('mmbr_info_delete_sure_unsubscribe');
             }
             $modal = $this->ui->factory()->modal()->roundtrip(
                 $this->getRemoveMultipleActionText(),
                 [
                     $this->ui->factory()->messageBox()->confirmation($question),
                     $this->ui->factory()->messageBox()->info($this->lng->txt('select_one')),
                 ],
                 $items,
                 $this->ctrl->getLinkTargetByClass([ilDashboardGUI::class, $this::class], 'confirmedRemove')
             )->withSubmitLabel($this->getRemoveMultipleActionText());
 
             $modal = $modal->withOnLoadCode(static fn($id) => "il.Dashboard.confirmModal($id)");
         } else {
             $modal = $this->ui->factory()->modal()->roundtrip(
                 $this->getRemoveMultipleActionText(),
                 $this->ui->factory()->messageBox()->info($this->lng->txt('pd_no_items_to_manage'))
             );
         }
 
         return $modal;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRemoveMultipleActionText()

ilDashboardBlockGUI::getRemoveMultipleActionText ( )

abstract

Referenced by addCommandActions(), getRemoveModal(), and removeFromDeskObject().

Here is the caller graph for this function:

◆ getRepositoryTitle()

ilDashboardBlockGUI::getRepositoryTitle ( )

protected

Definition at line 344 of file class.ilDashboardBlockGUI.php.

References $nd, ilBlockGUI\$title, and ILIAS\Repository\lng().

Referenced by ilSelectedItemsBlockGUI\emptyHandling(), and getData().

                                            : string
     {
         $nd = $this->tree->getNodeData($this->tree->getRootId());
         $title = $nd['title'];
 
         if ($title === 'ILIAS') {
             $title = $this->lng->txt('repository');
         }
 
         return $title;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getViewSettings()

ilDashboardBlockGUI::getViewSettings ( )

Definition at line 165 of file class.ilDashboardBlockGUI.php.

References $viewSettings.

                                      : ilPDSelectedItemsBlockViewSettings
     {
         return $this->viewSettings;
     }

◆ init()

ilDashboardBlockGUI::init ( )

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

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), initData(), initViewSettings(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ilBlockGUI\setPresentation().

Referenced by __construct(), and initAndShow().

                           : void
     {
         $this->lng->loadLanguageModule('dash');
         $this->lng->loadLanguageModule('rep');
         $this->lng->loadLanguageModule('pd');
         $this->initViewSettings();
         $this->viewSettings->parse();
         $this->requested_item_ref_id = (int) ($this->http->request()->getQueryParams()['item_ref_id'] ?? 0);
         $this->initData();
 
         $this->ctrl->setParameter($this, 'view', $this->viewSettings->getCurrentView());
         if ($this->viewSettings->isTilePresentation()) {
             $this->setPresentation(self::PRES_MAIN_LEG);
         } else {
             $this->setPresentation(self::PRES_SEC_LIST);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initAndShow()

ilDashboardBlockGUI::initAndShow ( )

protected

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

References ILIAS\Repository\ctrl(), getHTML(), and init().

Referenced by changePDItemPresentationObject(), changePDItemSortingObject(), and viewDashboardObject().

                                     : string
     {
         $this->init();
         if ($this->parent === ilDashboardGUI::class) {
             $this->ctrl->redirectByClass(ilDashboardGUI::class, 'show');
         }
 
         return $this->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initData()

ilDashboardBlockGUI::initData ( )

abstract

Referenced by __construct(), init(), and ilDashboardLearningSequenceGUI\initViewSettings().

Here is the caller graph for this function:

◆ initViewSettings()

ilDashboardBlockGUI::initViewSettings ( )

abstract

Referenced by __construct(), and init().

Here is the caller graph for this function:

◆ isRepositoryObject()

ilDashboardBlockGUI::isRepositoryObject ( )

protected

Definition at line 135 of file class.ilDashboardBlockGUI.php.

                                            : bool
     {
         return false;
     }

◆ isRootNode()

ilDashboardBlockGUI::isRootNode ( int $refId )

protected

Definition at line 339 of file class.ilDashboardBlockGUI.php.

References $refId.

Referenced by getData().

                                              : bool
     {
         return $this->tree->getRootId() === $refId;
     }

Here is the caller graph for this function:

◆ removeFromDeskObject()

ilDashboardBlockGUI::removeFromDeskObject ( )

Implements ilDesktopItemHandling.

Definition at line 529 of file class.ilDashboardBlockGUI.php.

References $requested_item_ref_id, ILIAS\Repository\ctrl(), getRemoveMultipleActionText(), ILIAS\Repository\lng(), removeMultipleEnabled(), and ILIAS\Repository\user().

                                           : void
     {
         $this->favourites_manager->remove($this->user->getId(), $this->requested_item_ref_id);
         $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('rep_removed_from_favourites'), true);
         $this->ctrl->redirectByClass(ilDashboardGUI::class, 'show');
     }

Here is the call graph for this function:

◆ removeMultipleEnabled()

ilDashboardBlockGUI::removeMultipleEnabled ( )

abstract

Referenced by addCommandActions(), and removeFromDeskObject().

Here is the caller graph for this function:

◆ setData()

ilDashboardBlockGUI::setData ( array $a_data )

Parameters

array<BlockDTO[]> $a_data

Definition at line 217 of file class.ilDashboardBlockGUI.php.

Referenced by getHTML(), ilStudyProgrammeDashboardViewGUI\initData(), ilMembershipBlockGUI\initData(), ilDashboardRecommendedContentGUI\initData(), ilSelectedItemsBlockGUI\initData(), and ilDashboardLearningSequenceGUI\initViewSettings().

                                           : void
     {
         $this->data = array_filter(
             array_map(
                 static fn($group) => array_filter($group, static fn($item) => $item instanceof BlockDTO),
                 $a_data
             )
         );
     }

Here is the caller graph for this function:

◆ sortByDate()

ilDashboardBlockGUI::sortByDate	(	array	$data,
		bool	$asc = `true`
	)

private

Parameters

BlockDTO[] $data

Definition at line 582 of file class.ilDashboardBlockGUI.php.

References $data, ILIAS\components\Dashboard\Block\BlockDTO\getStartDate(), and IL_CAL_UNIX.

Referenced by getData().

                                                               : array
     {
         usort(
             $data,
             static fn(BlockDTO $left, BlockDTO $right): int =>
             ($asc ? -1 : 1) *
             (($right->getStartDate()?->get(IL_CAL_UNIX) ?? 0) - ($left->getStartDate()?->get(IL_CAL_UNIX) ?? 0))
         );
         return $data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sortByTitle()

ilDashboardBlockGUI::sortByTitle ( array $data )

private

Parameters

BlockDTO[] $data

Definition at line 596 of file class.ilDashboardBlockGUI.php.

References $data, and ILIAS\components\Dashboard\Block\BlockDTO\getTitle().

Referenced by getData(), and getItemGroups().

                                              : array
     {
         usort(
             $data,
             static fn(BlockDTO $left, BlockDTO $right): int => strcmp($left->getTitle(), $right->getTitle())
         );
         return $data;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ viewDashboardObject()

ilDashboardBlockGUI::viewDashboardObject ( )

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

References initAndShow().

                                          : void
     {
         $this->initAndShow();
     }

Here is the call graph for this function:

Field Documentation

◆ $content

string ilDashboardBlockGUI::$content

private

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

◆ $data

array ilDashboardBlockGUI::$data

protected

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

Referenced by getItemGroups(), ilMembershipBlockGUI\initData(), ilSelectedItemsBlockGUI\initData(), ilDashboardLearningSequenceGUI\initViewSettings(), sortByDate(), and sortByTitle().

◆ $favourites_manager

ilFavouritesManager ilDashboardBlockGUI::$favourites_manager

protected

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

◆ $http

Services ilDashboardBlockGUI::$http

protected

Definition at line 44 of file class.ilDashboardBlockGUI.php.

◆ $logging

ilLogger ilDashboardBlockGUI::$logging

protected

Definition at line 43 of file class.ilDashboardBlockGUI.php.

◆ $objDefinition

mixed ilDashboardBlockGUI::$objDefinition

private

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

◆ $object_cache

mixed ilDashboardBlockGUI::$object_cache

private

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

◆ $parent

string ilDashboardBlockGUI::$parent

private

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

◆ $rbacsystem

ilRbacSystem ilDashboardBlockGUI::$rbacsystem

private

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

◆ $refinery

Factory ilDashboardBlockGUI::$refinery

private

Definition at line 45 of file class.ilDashboardBlockGUI.php.

◆ $requested_item_ref_id

int ilDashboardBlockGUI::$requested_item_ref_id

protected

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

Referenced by addToDeskObject(), removeFromDeskObject(), and ilDashboardRecommendedContentGUI\removeRecommendationObject().

◆ $settings

ilSetting ilDashboardBlockGUI::$settings

protected

Definition at line 42 of file class.ilDashboardBlockGUI.php.

Referenced by ilFavouritesListGUI\__construct().

◆ $tree

ilTree ilDashboardBlockGUI::$tree

private

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

◆ $viewSettings

ilPDSelectedItemsBlockViewSettings ilDashboardBlockGUI::$viewSettings

protected

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

Referenced by getViewSettings().

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

components/ILIAS/Dashboard/Block/classes/class.ilDashboardBlockGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCommandActions()

◆ addCustomCommandsToActionMenu()

◆ addToDeskObject()

◆ byType()

◆ changePDItemPresentationObject()

◆ changePDItemSortingObject()

◆ confirmedRemove()

◆ emptyHandling()

◆ executeCommand()

◆ getCardForData()

◆ getData()

◆ getHTML()

◆ getItemGroups()

◆ getLegacyContent()

◆ getListItemForDataDTO()

◆ getListItemGroups()

◆ getManageFields()

◆ getNoItemFoundContent()

◆ getRemoveModal()

◆ getRemoveMultipleActionText()

◆ getRepositoryTitle()

◆ getViewSettings()

◆ init()

◆ initAndShow()

◆ initData()

◆ initViewSettings()

◆ isRepositoryObject()

◆ isRootNode()

◆ removeFromDeskObject()

◆ removeMultipleEnabled()

◆ setData()

◆ sortByDate()

◆ sortByTitle()

◆ viewDashboardObject()

Field Documentation

◆ $content

◆ $data

◆ $favourites_manager

◆ $http

◆ $logging

◆ $objDefinition

◆ $object_cache

◆ $parent

◆ $rbacsystem

◆ $refinery

◆ $requested_item_ref_id

◆ $settings

◆ $tree

◆ $viewSettings