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

	manually ()

	getViewControlsForPanel ()

	viewDashboardObject ()

	changePDItemSortingObject ()

	changePDItemPresentationObject ()

	getItemGroups ()

	addToDeskObject ()

	removeFromDeskObject ()

	removeMultipleEnabled ()

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

	addToDeskObject ()

	removeFromDeskObject ()

Protected Member Functions
	getCardForData (BlockDTO $data)

	getListItemGroups ()
	Get items. More...

	getListItemForDataDTO (BlockDTO $data)

	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...

	getLegacyContent ()
	Get legacy content. More...

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

	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
string	$content

readonly ilRbacSystem	$rbacsystem

string	$parent

readonly ilFavouritesManager	$favourites_manager

int	$requested_item_ref_id

mixed	$object_cache

readonly ilTree	$tree

readonly mixed	$obj_definition

readonly ilSetting	$settings

readonly ilLogger	$logging

readonly Services	$http

readonly Factory	$refinery

ilPDSelectedItemsBlockViewSettings	$view_settings

array	$data

Protected Attributes inherited from ilBlockGUI
ILIAS UI Renderer	$renderer

Factory	$factory

object	$gui_object

ILIAS Container Block StandardGUIRequest	$request

ILIAS Container 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)

	sortManually (array $data)

Private Attributes
RoundTrip	$manual_sort_modal = null

readonly SignalGenerator	$signal_generator

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 34 of file class.ilDashboardBlockGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDashboardBlockGUI::__construct ( )

Reimplemented from ilBlockGUI.

Reimplemented in ilDashboardRecommendedContentGUI.

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

    {
        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->obj_definition = $DIC['objDefinition'];
        $this->rbacsystem = $DIC->rbac()->system();
        $this->favourites_manager = new ilFavouritesManager();
        $this->parent = $this->ctrl->getCurrentClassPath()[0] ?? '';
        $this->signal_generator = new SignalGenerator();
        $this->init();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addCommandActions()

ilDashboardBlockGUI::addCommandActions ( )

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

                                       : void
    {
        $sortings = $this->view_settings->getSelectableSortingModes();
        if (count($sortings) > 1) {
            foreach ($sortings as $sorting) {
                if ($sorting === ilPDSelectedItemsBlockConstants::SORT_MANUALLY) {
                    global $DIC;
                    $signal = $this->signal_generator->create();
                    // $signal = $DIC['ui.signal_generator']->create();
                    $this->manual_sort_modal = $this->ui->factory()->modal()->roundtrip(
                        $this->lng->txt('dash_manual_sorting_title'),
                        [$this->manually()]
                    )->withAdditionalOnLoadCode(fn($id) => "document.getElementById('$id').addEventListener('close', () => {window.location = window.location;});");
 
                    $this->manual_sort_modal = $this->manual_sort_modal->withAdditionalOnLoadCode(fn($id) => (
                        "il.Dashboard.moveModalButtons($id)"
                    ));
                }
                $this->addSortOption(
                    $sorting,
                    '<span data-action="' . $sorting . '">' . $this->lng->txt(ilObjDashboardSettingsGUI::DASH_SORT_PREFIX . $sorting) . '</span>',
                    $sorting === $this->view_settings->getEffectiveSortingMode()
                );
            }
            $this->setSortTarget($this->ctrl->getLinkTarget($this, 'changePDItemSorting'));
        }
 
        $presentations = $this->view_settings->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->view_settings->getEffectivePresentationMode()
            );
            $this->ctrl->setParameter($this, 'presentation', null);
        }
 
        if ($this->removeMultipleEnabled()) {
            $this->addBlockCommand(
                $this->ctrl->getLinkTarget($this, 'manage'),
                $this->lng->txt('dash_' . $this->getBlockType() . '_remove_multiple'),
                '',
                $this->getRemoveModal()
            );
        }
    }

References $DIC, $id, ilBlockGUI\$presentation, ilBlockGUI\$presentations, ilBlockGUI\addPresentation(), ilBlockGUI\addSortOption(), ILIAS\Repository\ctrl(), ilObjDashboardSettingsGUI\DASH_SORT_PREFIX, ILIAS\Repository\lng(), ilBlockGUI\setSortTarget(), ilPDSelectedItemsBlockConstants\SORT_MANUALLY, and ILIAS\Repository\ui().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addCustomCommandsToActionMenu()

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

Reimplemented in ilDashboardRecommendedContentGUI.

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

                                                                                            : void
    {
    }

Referenced by getCardForData(), and getListItemForDataDTO().

Here is the caller graph for this function:

◆ addToDeskObject()

ilDashboardBlockGUI::addToDeskObject ( )

Implements ilDesktopItemHandling.

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

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

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

Here is the call graph for this function:

◆ byType()

ilDashboardBlockGUI::byType ( string $a_type )

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

                                          : ilObjectListGUI
    {
        $class = $this->obj_definition->getClassName($a_type);
        if (!$class) {
            throw new ilException(sprintf('Could not find a class for object type: %s', $a_type));
        }
 
        $location = $this->obj_definition->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;
    }

References $location.

Referenced by getCardForData(), and getListItemForDataDTO().

Here is the caller graph for this function:

◆ changePDItemPresentationObject()

ilDashboardBlockGUI::changePDItemPresentationObject ( )

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

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

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

Here is the call graph for this function:

◆ changePDItemSortingObject()

ilDashboardBlockGUI::changePDItemSortingObject ( )

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

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

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

Here is the call graph for this function:

◆ confirmedRemove()

ilDashboardBlockGUI::confirmedRemove ( array $ids )

Parameters

int[] $ids

Reimplemented in ilMembershipBlockGUI, ilSelectedItemsBlockGUI, ilDashboardLearningSequenceGUI, and ilDashboardRecommendedContentGUI.

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

                                               : void
    {
    }

◆ emptyHandling()

ilDashboardBlockGUI::emptyHandling ( )

abstract

Reimplemented in ilMembershipBlockGUI, ilSelectedItemsBlockGUI, ilDashboardLearningSequenceGUI, ilDashboardRecommendedContentGUI, and ilStudyProgrammeDashboardViewGUI.

Referenced by getHTML(), and getNoItemFoundContent().

Here is the caller graph for this function:

◆ executeCommand()

ilDashboardBlockGUI::executeCommand ( )

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

                                    : 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 '';
    }

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

Here is the call graph for this function:

◆ getCardForData()

ilDashboardBlockGUI::getCardForData ( BlockDTO $data )

protected

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

                                                     : ?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;
    }

References $data, addCustomCommandsToActionMenu(), byType(), and ILIAS\components\Dashboard\Block\BlockDTO\getType().

Referenced by getLegacyContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getData()

ilDashboardBlockGUI::getData ( )

Returns: array<BlockDTO[]>

Reimplemented from ilBlockGUI.

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

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

◆ getHTML()

ilDashboardBlockGUI::getHTML ( )

Reimplemented from ilBlockGUI.

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

                             : string
    {
        $this->setTitle(
            $this->lng->txt('dash_' . $this->view_settings->getViewName($this->view_settings->getView()))
        );
 
        if (!$this->data) {
            return $this->emptyHandling();
        }
 
        $this->addCommandActions();
        $this->setData($this->getItemGroups());
 
        $modal = $this->manual_sort_modal ? $this->ui->renderer()->render($this->manual_sort_modal) : '';
        return parent::getHTML() . $modal;
    }

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

Referenced by initAndShow().

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 584 of file class.ilDashboardBlockGUI.php.

                                   : array
    {
        switch ($this->view_settings->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_MANUALLY:
                return ['' => $this->sortManually($this->getData())];
            case ilPDSelectedItemsBlockConstants::SORT_BY_TYPE:
                $groups = $this->groupItemsByType();
                ksort($groups, SORT_NATURAL);
                return $groups;
            case ilPDSelectedItemsBlockConstants::SORT_BY_LOCATION:
            default:
                $groups = $this->groupItemsByLocation();
                ksort($groups, SORT_NATURAL);
                return $groups;
        }
    }

References $data, ilPDSelectedItemsBlockConstants\SORT_BY_ALPHABET, ilPDSelectedItemsBlockConstants\SORT_BY_LOCATION, ilPDSelectedItemsBlockConstants\SORT_BY_START_DATE, ilPDSelectedItemsBlockConstants\SORT_BY_TYPE, and ilPDSelectedItemsBlockConstants\SORT_MANUALLY.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getLegacyContent()

ilDashboardBlockGUI::getLegacyContent ( )

protected

Get legacy content.

Returns: string

Reimplemented from ilBlockGUI.

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

                                         : 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();
    }

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

Here is the call graph for this function:

◆ getListItemForDataDTO()

ilDashboardBlockGUI::getListItemForDataDTO ( BlockDTO $data )

protected

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

                                                            : ?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;
    }

References $data, addCustomCommandsToActionMenu(), byType(), and ILIAS\components\Dashboard\Block\BlockDTO\getType().

Referenced by getListItemGroups().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getListItemGroups()

ilDashboardBlockGUI::getListItemGroups ( )

protected

Get items.

Returns: \ILIAS\UI\Component\Item\Group[]

Reimplemented from ilBlockGUI.

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

                                          : array
    {
        $groupedCards = [];
        foreach ($this->loadData() 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;
    }

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

Here is the call graph for this function:

◆ getManageFields()

ilDashboardBlockGUI::getManageFields ( )

protected

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

                                        : 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;
    }

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

Here is the call graph for this function:

◆ getNoItemFoundContent()

ilDashboardBlockGUI::getNoItemFoundContent ( )

Reimplemented from ilBlockGUI.

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

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

References emptyHandling().

Referenced by getLegacyContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRemoveModal()

ilDashboardBlockGUI::getRemoveModal ( )

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

                                    : RoundTrip
    {
        $items = $this->getManageFields();
        if ($items !== []) {
            $modal = $this->ui->factory()->modal()->roundtrip(
                $this->lng->txt('dash_' . $this->getBlockType() . '_remove_multiple'),
                [
                    $this->ui->factory()->messageBox()->confirmation($this->lng->txt('dash_' . $this->getBlockType() . '_remove_info')),
                    $this->ui->factory()->messageBox()->info($this->lng->txt('select_one')),
                ],
                $items,
                $this->ctrl->getLinkTargetByClass([ilDashboardGUI::class, $this::class], 'confirmedRemove')
            )->withSubmitLabel($this->lng->txt('dash_' . $this->getBlockType() . '_remove'));
 
            $modal = $modal->withOnLoadCode(static fn($id) => "il.Dashboard.confirmModal($id)");
        } else {
            $modal = $this->ui->factory()->modal()->roundtrip(
                $this->lng->txt('dash_' . $this->getBlockType() . '_remove_multiple'),
                $this->ui->factory()->messageBox()->info($this->lng->txt('dash_no_items_to_manage'))
            );
        }
 
        return $modal;
    }

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

Here is the call graph for this function:

◆ getRepositoryTitle()

ilDashboardBlockGUI::getRepositoryTitle ( )

protected

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

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

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

Here is the call graph for this function:

◆ getViewControlsForPanel()

ilDashboardBlockGUI::getViewControlsForPanel ( )

Returns: ViewControl\Sortation[]|ViewControl\Pagination[]

Reimplemented from ilBlockGUI.

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

                                             : array
    {
        global $DIC;
        if (!$this->manual_sort_modal) {
            return parent::getViewControlsForPanel();
        }
        $show = $this->manual_sort_modal->getShowSignal();
        $modal_signals = json_encode(['manually' => (string) $show]);
        $url = json_encode($this->ctrl->getLinkTarget($this, 'changePDItemSorting'));
        $signal = $this->signal_generator->create();
        $code = fn($id) => "il.Dashboard.showModalOnSort($id, $url, '$signal', $modal_signals)";
        $compontents = array_map(
            fn($x) => $x instanceof Sortation ? $x->withOnSort($signal)->withAdditionalOnLoadCode($code) : $x,
            parent::getViewControlsForPanel()
        );
 
        return $compontents;
    }

References $DIC, $id, $url, ILIAS\Repository\ctrl(), and ILIAS\UI\Component\ViewControl\Sortation\withOnSort().

Here is the call graph for this function:

◆ getViewSettings()

ilDashboardBlockGUI::getViewSettings ( )

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

                                     : ilPDSelectedItemsBlockViewSettings
    {
        return $this->view_settings;
    }

References $view_settings.

◆ init()

ilDashboardBlockGUI::init ( )

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

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

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

Referenced by __construct(), and initAndShow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initAndShow()

ilDashboardBlockGUI::initAndShow ( )

protected

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

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

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

Here is the call graph for this function:

◆ initData()

ilDashboardBlockGUI::initData ( )

abstract

Reimplemented in ilMembershipBlockGUI, ilSelectedItemsBlockGUI, ilDashboardRecommendedContentGUI, and ilStudyProgrammeDashboardViewGUI.

Referenced by init().

Here is the caller graph for this function:

◆ initViewSettings()

ilDashboardBlockGUI::initViewSettings ( )

abstract

Reimplemented in ilMembershipBlockGUI, ilSelectedItemsBlockGUI, ilDashboardLearningSequenceGUI, ilDashboardRecommendedContentGUI, and ilStudyProgrammeDashboardViewGUI.

Referenced by init().

Here is the caller graph for this function:

◆ isRepositoryObject()

ilDashboardBlockGUI::isRepositoryObject ( )

finalprotected

Returns whether block has a corresponding repository object.

Reimplemented from ilBlockGUI.

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

                                                 : bool
    {
        return false;
    }

◆ isRootNode()

ilDashboardBlockGUI::isRootNode ( int $refId )

finalprotected

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

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

References $refId.

◆ manually()

ilDashboardBlockGUI::manually ( )

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

                              : Ordering
    {
        $request = $this->http->request();
        $columns = [
            'title' => $this->factory->table()->column()->text('Title')
        ];
 
        $records = null;
        $proc = function ($b) use (&$records) {
            return yield from array_map(fn($x) => $b->buildOrderingRow((string) $x['id'], $x), $records);
        };
 
        $uri = new URI((string) $request->getUri());
        parse_str($uri->getQuery(), $query);
        $uri = $uri->withQuery(http_build_query(array_merge(
            $query,
            ['view' => $this->view_settings->getView()]
        )));
        $table = $this->factory->table()
            ->ordering(new \ILIAS\Dashboard\TableData($proc), $uri, '', $columns)
            ->withRequest($request);
 
        $int = $this->refinery->byTrying([$this->refinery->kindlyTo()->int(), $this->refinery->always(null)]);
 
        if ($request->getMethod() === 'POST' && $this->view_settings->getView() === $this->http->wrapper()->query()->retrieve('view', $int)) {
            $data = $table->getData();
            if ($data) {
                $this->view_settings->storeActorSortingMode('manually');
                $this->view_settings->storeActorSortingData(array_flip($data));
                $this->ctrl->redirectByClass(ilDashboardGUI::class);
            }
        }
 
        $icon_for = fn(int $obj_id) => $this->renderer->render(
            $this->ui->factory()->symbol()->icon()->custom(ilObject::_getIcon($obj_id), '')
        );
 
        $records = array_map(fn($x) => [
            'id' => $x->getRefId(),
            'title' => $icon_for($x->getObjId()) . $x->getTitle(),
        ], array_values($this->sortManually($this->getItemGroups())));
 
        return $table;
    }

References Vendor\Package\$b, $data, ilObject\_getIcon(), ILIAS\Repository\ctrl(), factory(), ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), renderer(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ preloadData()

ilDashboardBlockGUI::preloadData ( array $data )

protected

Can be overwritten in subclasses.

Only the visible part of the complete data was passed so a preload of the visible data is possible.

Parameters

array $data

Reimplemented from ilBlockGUI.

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

                                               : void
    {
        $obj_ids = [];
        foreach ($data as $group) {
            foreach ($group as $datum) {
                $obj_ids[] = $datum->getObjId();
            }
        }
        ilLPStatus::preloadListGUIData($obj_ids);
        parent::preloadData($data);
    }

References $data, and ilLPStatus\preloadListGUIData().

Here is the call graph for this function:

◆ removeFromDeskObject()

ilDashboardBlockGUI::removeFromDeskObject ( )

Implements ilDesktopItemHandling.

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

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

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

Here is the call graph for this function:

◆ removeMultipleEnabled()

ilDashboardBlockGUI::removeMultipleEnabled ( )

Reimplemented in ilMembershipBlockGUI, ilSelectedItemsBlockGUI, ilDashboardLearningSequenceGUI, and ilDashboardRecommendedContentGUI.

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

                                           : bool
    {
        return false;
    }

◆ setData()

ilDashboardBlockGUI::setData ( array $a_data )

Parameters

array<BlockDTO[]> $a_data

Reimplemented from ilBlockGUI.

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

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

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

Here is the caller graph for this function:

◆ sortByDate()

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

private

Parameters

BlockDTO[] $data

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

                                                              : 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;
    }

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

Here is the call graph for this function:

◆ sortByTitle()

ilDashboardBlockGUI::sortByTitle ( array $data )

private

Parameters

BlockDTO[] $data

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

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

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

Here is the call graph for this function:

◆ sortManually()

ilDashboardBlockGUI::sortManually ( array $data )

private

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

                                              : array
    {
        $data = array_merge(...array_values($data));
        $new_at_botton = 'bot' === ($this->view_settings->getEffectiveSortingOptions()['new_items'] ?? 'bot');
        $default = $new_at_botton ? INF : -INF;
        $manual_sorting = $this->view_settings->getEffectiveSortingData();
        usort($data, fn(BlockDTO $l, BlockDTO $r) => (
            ($manual_sorting[$l->getRefId()] ?? $default) <=> ($manual_sorting[$r->getRefId()] ?? $default)
        ));
 
        return $data;
    }

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

Here is the call graph for this function:

◆ viewDashboardObject()

ilDashboardBlockGUI::viewDashboardObject ( )

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

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

Field Documentation

◆ $content

string ilDashboardBlockGUI::$content

protected

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

Referenced by ILIAS\UI\Implementation\Component\Table\PresentationRow\getContent(), and ILIAS\UI\Implementation\Component\Table\PresentationRow\withContent().

◆ $data

array ilDashboardBlockGUI::$data

protected

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

Referenced by getCardForData(), getListItemForDataDTO(), ilMembershipBlockGUI\initData(), ilSelectedItemsBlockGUI\initData(), and preloadData().

◆ $favourites_manager

readonly ilFavouritesManager ilDashboardBlockGUI::$favourites_manager

protected

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

◆ $http

readonly Services ilDashboardBlockGUI::$http

protected

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

◆ $logging

readonly ilLogger ilDashboardBlockGUI::$logging

protected

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

◆ $manual_sort_modal

RoundTrip ilDashboardBlockGUI::$manual_sort_modal = null

private

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

◆ $obj_definition

readonly mixed ilDashboardBlockGUI::$obj_definition

protected

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

◆ $object_cache

mixed ilDashboardBlockGUI::$object_cache

protected

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

◆ $parent

string ilDashboardBlockGUI::$parent

protected

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

◆ $rbacsystem

readonly ilRbacSystem ilDashboardBlockGUI::$rbacsystem

protected

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

◆ $refinery

readonly Factory ilDashboardBlockGUI::$refinery

protected

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

◆ $requested_item_ref_id

int ilDashboardBlockGUI::$requested_item_ref_id

protected

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

◆ $settings

readonly ilSetting ilDashboardBlockGUI::$settings

protected

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

Referenced by ilFavouritesListGUI\__construct().

◆ $signal_generator

readonly SignalGenerator ilDashboardBlockGUI::$signal_generator

private

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

Referenced by ILIAS\UI\Implementation\Component\Table\PresentationRow\__construct(), ILIAS\UI\Implementation\Component\Table\AbstractTable\__construct(), ILIAS\UI\Implementation\Component\Table\Ordering\__construct(), ILIAS\UI\Implementation\Component\Table\Presentation\__construct(), and ILIAS\UI\Implementation\Component\Table\Presentation\getSignalGenerator().

◆ $tree

readonly ilTree ilDashboardBlockGUI::$tree

protected

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

◆ $view_settings

ilPDSelectedItemsBlockViewSettings ilDashboardBlockGUI::$view_settings

protected

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

◆ getRepositoryTitle()

◆ getViewControlsForPanel()

◆ getViewSettings()

◆ init()

◆ initAndShow()

◆ initData()

◆ initViewSettings()

◆ isRepositoryObject()

◆ isRootNode()

◆ manually()

◆ preloadData()

◆ removeFromDeskObject()

◆ removeMultipleEnabled()

◆ setData()

◆ sortByDate()

◆ sortByTitle()

◆ sortManually()

◆ viewDashboardObject()

Field Documentation

◆ $content

◆ $data

◆ $favourites_manager

◆ $http

◆ $logging

◆ $manual_sort_modal

◆ $obj_definition

◆ $object_cache

◆ $parent

◆ $rbacsystem

◆ $refinery

◆ $requested_item_ref_id

◆ $settings

◆ $signal_generator

◆ $tree

◆ $view_settings