ilPDSelectedItemsBlockGUI Class Reference

@ilCtrl_IsCalledBy ilPDSelectedItemsBlockGUI: ilColumnGUI @ilCtrl_Calls ilPDSelectedItemsBlockGUI: ilCommonActionDispatcherGUI More...

Inheritance diagram for ilPDSelectedItemsBlockGUI:

Collaboration diagram for ilPDSelectedItemsBlockGUI:

Public Member Functions
	getViewSettings ()
	addToDeskObject ()
	Add desktop item @access public. More...
	removeFromDeskObject ()
	Remove from desktop @access public. More...
	getBlockType ()
	getHTML ()
	executeCommand ()
	fillDataSection ()
	Standard implementation for row based data. More...
	changePDItemPresentation ()
	changePDItemSorting ()
	manageObject ()
	confirmRemoveObject ()
	confirmedRemove ()
	confirmedUnsubscribe ()
	getNoItemFoundContent ()
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 ()
	addToDeskObject ()
	Add desktop item @access public. More...
	removeFromDeskObject ()
	Remove from desktop @access public. More...

Static Public Attributes
static string	$block_type = 'pditems'

Protected Member Functions
	initViewSettings ()
	returnToContext ()
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	getViewTitle ()
	getContent ()
	setContent (string $a_content)
	getGroupedCommandsForView (bool $manage=false)
	initAndShow ()
	cancel ()
	getListItemGroups ()
	getListItemForData (array $data)
	Get list item for data array. More...
	getCardForData (array $item)
	getLegacyContent ()
	Get legacy content. More...
	renderManageList (array $grouped_items)
	getRepositoryTitle ()
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
bool	$new_rendering = true
ilRbacSystem	$rbacsystem
ilSetting	$settings
ilObjectDefinition	$obj_definition
ilPDSelectedItemsBlockViewSettings	$viewSettings
ilPDSelectedItemsBlockViewGUI	$blockView
bool	$manage = false
string	$content = ''
ilLanguage	$lng
ilCtrl	$ctrl
ilObjUser	$user
Services	$http
Factory	$refinery
ilObjectService	$objectService
ilFavouritesManager	$favourites
ilTree	$tree
ilPDSelectedItemsBlockListGUIFactory	$list_factory
ilLogger	$logging
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

Private Attributes
int	$requested_item_ref_id

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

@ilCtrl_IsCalledBy ilPDSelectedItemsBlockGUI: ilColumnGUI @ilCtrl_Calls ilPDSelectedItemsBlockGUI: ilCommonActionDispatcherGUI

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

Member Function Documentation

addToDeskObject()

ilPDSelectedItemsBlockGUI::addToDeskObject

(

)

Add desktop item @access public.

Implements ilDesktopItemHandling.

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

                                     : void
    {
        $this->favourites->add($this->user->getId(), $this->requested_item_ref_id);
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt("rep_added_to_favourites"), true);
        $this->returnToContext();
    }

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

Here is the call graph for this function:

cancel()

ilPDSelectedItemsBlockGUI::cancel ( )

protected

Definition at line 342 of file class.ilPDSelectedItemsBlockGUI.php.

                               : void
    {
        $this->ctrl->returnToParent($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

changePDItemPresentation()

ilPDSelectedItemsBlockGUI::changePDItemPresentation

(

)

Definition at line 271 of file class.ilPDSelectedItemsBlockGUI.php.

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

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

Here is the call graph for this function:

changePDItemSorting()

ilPDSelectedItemsBlockGUI::changePDItemSorting

(

)

Definition at line 279 of file class.ilPDSelectedItemsBlockGUI.php.

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

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

Here is the call graph for this function:

confirmedRemove()

ilPDSelectedItemsBlockGUI::confirmedRemove

(

)

Definition at line 389 of file class.ilPDSelectedItemsBlockGUI.php.

                                     : void
    {
        $refIds = (array) ($this->http->request()->getParsedBody()['ref_id'] ?? []);
        if (0 === count($refIds)) {
            $this->ctrl->redirect($this, 'manage');
        }
 
        foreach ($refIds as $ref_id) {
            $this->favourites->remove($this->user->getId(), (int) $ref_id);
        }
 
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('pd_remove_multi_confirm'), true);
        $this->ctrl->redirect($this, 'manage');
    }

References $ref_id, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

confirmedUnsubscribe()

ilPDSelectedItemsBlockGUI::confirmedUnsubscribe

(

)

Definition at line 404 of file class.ilPDSelectedItemsBlockGUI.php.

                                          : void
    {
        $refIds = $this->http->wrapper()->post()->retrieve(
            'ref_id',
            $this->refinery->to()->listOf($this->refinery->kindlyTo()->int())
        );
        if (0 === count($refIds)) {
            $this->ctrl->redirect($this, 'manage');
        }
 
        foreach ($refIds as $ref_id) {
            if ($this->access->checkAccess('leave', '', (int) $ref_id)) {
                switch (ilObject::_lookupType($ref_id, true)) {
                    case 'crs':
                        $members = new ilCourseParticipants(ilObject::_lookupObjId((int) $ref_id));
                        $members->delete($this->user->getId());
 
                        $members->sendUnsubscribeNotificationToAdmins($this->user->getId());
                        $members->sendNotification(
                            ilCourseMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER,
                            $this->user->getId()
                        );
                        break;
 
                    case 'grp':
                        $members = new ilGroupParticipants(ilObject::_lookupObjId((int) $ref_id));
                        $members->delete($this->user->getId());
 
                        $members->sendNotification(
                            ilGroupMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER,
                            $this->user->getId()
                        );
                        $members->sendNotification(
                            ilGroupMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE,
                            $this->user->getId()
                        );
                        break;
 
                    default:
                        continue 2;
                }
 
                ilForumNotification::checkForumsExistsDelete($ref_id, $this->user->getId());
            }
        }
 
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('mmbr_unsubscribed_from_objs'), true);
        $this->ctrl->returnToParent($this);
    }

References $ref_id, ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\access(), ilForumNotification\checkForumsExistsDelete(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilGroupMembershipMailNotification\TYPE_NOTIFICATION_UNSUBSCRIBE, ilCourseMembershipMailNotification\TYPE_UNSUBSCRIBE_MEMBER, ilGroupMembershipMailNotification\TYPE_UNSUBSCRIBE_MEMBER, and ILIAS\Repository\user().

Here is the call graph for this function:

confirmRemoveObject()

ilPDSelectedItemsBlockGUI::confirmRemoveObject

(

)

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

                                         : string
    {
        $this->ctrl->setParameter($this, 'view', $this->viewSettings->getCurrentView());
 
        $refIds = (array) ($this->http->request()->getParsedBody()['id'] ?? []);
        if (0 === count($refIds)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'manage');
        }
 
        if ($this->viewSettings->isSelectedItemsViewActive()) {
            $question = $this->lng->txt('dash_info_sure_remove_from_favs');
            $cmd = 'confirmedRemove';
        } else {
            $question = $this->lng->txt('mmbr_info_delete_sure_unsubscribe');
            $cmd = 'confirmedUnsubscribe';
        }
 
        $cgui = new ilConfirmationGUI();
        $cgui->setHeaderText($question);
 
        $cgui->setFormAction($this->ctrl->getFormAction($this));
        $cgui->setCancel($this->lng->txt('cancel'), 'manage');
        $cgui->setConfirm($this->lng->txt('confirm'), $cmd);
 
        foreach ($refIds as $ref_id) {
            $obj_id = ilObject::_lookupObjectId((int) $ref_id);
            $title = ilObject::_lookupTitle($obj_id);
            $type = ilObject::_lookupType($obj_id);
 
            $cgui->addItem(
                'ref_id[]',
                $ref_id,
                $title,
                ilObject::_getIcon($obj_id, 'small', $type),
                $this->lng->txt('icon') . ' ' . $this->lng->txt('obj_' . $type)
            );
        }
 
        return $cgui->getHTML();
    }

References $ref_id, $type, ilObject\_getIcon(), ilObject\_lookupObjectId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Here is the call graph for this function:

executeCommand()

ilPDSelectedItemsBlockGUI::executeCommand

(

)

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

                                    : string
    {
        $next_class = $this->ctrl->getNextClass();
        $cmd = $this->ctrl->getCmd('getHTML');
 
        switch ($next_class) {
            case 'ilcommonactiondispatchergui':
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
 
            default:
                if (method_exists($this, $cmd)) {
                    return $this->$cmd();
                }
                return $this->{$cmd . 'Object'}();
        }
        return "";
    }

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

Here is the call graph for this function:

fillDataSection()

ilPDSelectedItemsBlockGUI::fillDataSection

(

)

Standard implementation for row based data.

Overwrite this and call setContent for other data.

Reimplemented from ilBlockGUI.

Definition at line 203 of file class.ilPDSelectedItemsBlockGUI.php.

                                     : void
    {
        if ($this->getContent() === '') {
            $this->setDataSection($this->blockView->getIntroductionHtml());
        } else {
            $this->tpl->setVariable('BLOCK_ROW', $this->getContent());
        }
    }

References getContent(), and ilBlockGUI\setDataSection().

Here is the call graph for this function:

getBlockType()

ilPDSelectedItemsBlockGUI::getBlockType

(

)

Reimplemented from ilBlockGUI.

Definition at line 139 of file class.ilPDSelectedItemsBlockGUI.php.

                                  : string
    {
        return static::$block_type;
    }

getCardForData()

ilPDSelectedItemsBlockGUI::getCardForData ( array  $item )

protected

Definition at line 513 of file class.ilPDSelectedItemsBlockGUI.php.

                                                  : RepositoryObject
    {
        $itemListGui = $this->list_factory->byType($item['type']);
        ilObjectActivation::addListGUIActivationProperty($itemListGui, $item);
 
        $card = $itemListGui->getAsCard(
            (int) $item['ref_id'],
            (int) $item['obj_id'],
            (string) $item['type'],
            (string) $item['title'],
            (string) $item['description']
        );
 
        return $card;
    }

References ilObjectActivation\addListGUIActivationProperty().

Here is the call graph for this function:

getContent()

ilPDSelectedItemsBlockGUI::getContent ( )

protected

Definition at line 193 of file class.ilPDSelectedItemsBlockGUI.php.

                                   : string
    {
        return $this->content;
    }

References $content.

Referenced by fillDataSection().

Here is the caller graph for this function:

getGroupedCommandsForView()

ilPDSelectedItemsBlockGUI::getGroupedCommandsForView ( bool  $manage = false )

protected

Definition at line 212 of file class.ilPDSelectedItemsBlockGUI.php.

     : array {
        $commandGroups = [];
 
        $sortingCommands = [];
        $sortings = $this->viewSettings->getSelectableSortingModes();
        $effectiveSorting = $this->viewSettings->getEffectiveSortingMode();
        foreach ($sortings as $sorting) {
            $this->ctrl->setParameter($this, 'sorting', $sorting);
            $sortingCommands[] = [
                'txt' => $this->lng->txt('dash_sort_by_' . $sorting),
                'url' => $this->ctrl->getLinkTarget($this, 'changePDItemSorting'),
                'xxxasyncUrl' => $this->ctrl->getLinkTarget($this, 'changePDItemSorting', '', true),
                'active' => $sorting === $effectiveSorting,
            ];
            $this->ctrl->setParameter($this, 'sorting', null);
        }
 
        if (count($sortingCommands) > 1) {
            $commandGroups[] = $sortingCommands;
        }
 
        if ($manage) {
            return $commandGroups;
        }
 
        $presentationCommands = [];
        $presentations = $this->viewSettings->getSelectablePresentationModes();
        $effectivePresentation = $this->viewSettings->getEffectivePresentationMode();
        foreach ($presentations as $presentation) {
            $this->ctrl->setParameter($this, 'presentation', $presentation);
            $presentationCommands[] = [
                'txt' => $this->lng->txt('pd_presentation_mode_' . $presentation),
                'url' => $this->ctrl->getLinkTarget($this, 'changePDItemPresentation'),
                'xxxasyncUrl' => $this->ctrl->getLinkTarget($this, 'changePDItemPresentation', '', true),
                'active' => $presentation === $effectivePresentation,
            ];
            $this->ctrl->setParameter($this, 'presentation', null);
        }
 
        if (count($presentationCommands) > 1) {
            $commandGroups[] = $presentationCommands;
        }
 
        $commandGroups[] = [
            [
                'txt' => $this->viewSettings->isSelectedItemsViewActive() ?
                    $this->lng->txt('pd_remove_multiple') :
                    $this->lng->txt('pd_unsubscribe_multiple_memberships'),
                'url' => $this->ctrl->getLinkTarget($this, 'manage'),
                'asyncUrl' => null,
                'active' => false,
            ]
        ];
 
        return $commandGroups;
    }

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

Here is the call graph for this function:

getHTML()

ilPDSelectedItemsBlockGUI::getHTML

(

)

Reimplemented from ilBlockGUI.

Definition at line 154 of file class.ilPDSelectedItemsBlockGUI.php.

                             : string
    {
        global $DIC;
 
        $this->setTitle($this->getViewTitle());
 
        $DIC->database()->useSlave(true);
 
        $this->setData([['dummy']]);
 
        $DIC['ilHelp']->setDefaultScreenId(ilHelpGUI::ID_PART_SCREEN, $this->blockView->getScreenId());
 
        $this->ctrl->clearParameters($this);
 
        $DIC->database()->useSlave(false);
 
        return parent::getHTML();
    }

References $DIC, ILIAS\Repository\ctrl(), getViewTitle(), ilHelpGUI\ID_PART_SCREEN, ilBlockGUI\setData(), and ilBlockGUI\setTitle().

Here is the call graph for this function:

getLegacyContent()

ilPDSelectedItemsBlockGUI::getLegacyContent ( )

protected

Get legacy content.

Returns

string

Reimplemented from ilBlockGUI.

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

                                         : string
    {
        $groupedCommands = $this->getGroupedCommandsForView();
        foreach ($groupedCommands as $group) {
            foreach ($group as $command) {
                $asynch_url = $command['asyncUrl'] ?? "";
                $this->addBlockCommand(
                    (string) $command['url'],
                    (string) $command['txt'],
                    (string) $asynch_url
                );
            }
        }
 
        $groupedItems = $this->blockView->getItemGroups();
 
        $subs = [];
        foreach ($groupedItems as $group) {
            $cards = [];
 
            foreach ($group->getItems() as $item) {
                try {
                    $cards[] = $this->getCardForData($item);
                } catch (ilException $e) {
                    $this->logging->warning('Listing failed for item with ID ' . $item['obj_id'] . ': ' . $e->getMessage());
                    continue;
                }
            }
            if (count($cards) > 0) {
                $subs[] = $this->ui->factory()->panel()->sub(
                    $group->getLabel(),
                    $this->ui->factory()->deck($cards)->withNormalCardsSize()
                );
            }
        }
 
        if (count($subs) > 0) {
            return $this->ui->renderer()->render($subs);
        }
 
        return $this->getNoItemFoundContent();
    }

References Vendor\Package\$e, and ILIAS\Repository\ui().

Here is the call graph for this function:

getListItemForData()

ilPDSelectedItemsBlockGUI::getListItemForData ( array  $data )

protected

Get list item for data array.

Parameters

array

$data

Returns

null|\ILIAS\UI\Component\Item\Item

Reimplemented from ilBlockGUI.

Definition at line 497 of file class.ilPDSelectedItemsBlockGUI.php.

                                                      : ?Item
    {
        $itemListGui = $this->list_factory->byType($data['type']);
        ilObjectActivation::addListGUIActivationProperty($itemListGui, $data);
 
        $list_item = $itemListGui->getAsListItem(
            (int) $data['ref_id'],
            (int) $data['obj_id'],
            (string) $data['type'],
            (string) $data['title'],
            (string) $data['description']
        );
 
        return $list_item;
    }

References $data, and ilObjectActivation\addListGUIActivationProperty().

Here is the call graph for this function:

getListItemGroups()

ilPDSelectedItemsBlockGUI::getListItemGroups ( )

protected

Returns

Group[]

Reimplemented from ilBlockGUI.

Definition at line 457 of file class.ilPDSelectedItemsBlockGUI.php.

                                          : array
    {
        $groupedItems = $this->blockView->getItemGroups();
        $groupedCommands = $this->getGroupedCommandsForView();
        foreach ($groupedCommands as $group) {
            foreach ($group as $command) {
                $asynch_url = $command['asyncUrl'] ?? "";
                $this->addBlockCommand(
                    (string) $command['url'],
                    (string) $command['txt'],
                    (string) $asynch_url
                );
            }
        }
 
        $item_groups = [];
        $list_items = [];
 
        foreach ($groupedItems as $group) {
            $list_items = [];
 
            foreach ($group->getItems() as $item) {
                try {
                    $itemListGUI = $this->list_factory->byType($item['type']);
                    ilObjectActivation::addListGUIActivationProperty($itemListGUI, $item);
 
                    $list_items[] = $this->getListItemForData($item);
                } catch (ilException $e) {
                    $this->logging->warning('Listing failed for item with ID ' . $item['obj_id'] . ': ' . $e->getMessage());
                    continue;
                }
            }
            if (count($list_items) > 0) {
                $item_groups[] = $this->ui->factory()->item()->group($group->getLabel(), $list_items);
            }
        }
 
        return $item_groups;
    }

References Vendor\Package\$e, ilObjectActivation\addListGUIActivationProperty(), and ILIAS\Repository\ui().

Here is the call graph for this function:

getNoItemFoundContent()

ilPDSelectedItemsBlockGUI::getNoItemFoundContent

(

)

Reimplemented from ilBlockGUI.

Reimplemented in ilPDMembershipBlockGUI.

Definition at line 601 of file class.ilPDSelectedItemsBlockGUI.php.

                                           : string
    {
        $txt = $this->lng->txt("rep_fav_intro1") . "<br>";
        $txt .= sprintf(
            $this->lng->txt('rep_fav_intro2'),
            $this->getRepositoryTitle()
        ) . "<br>";
        $txt .= $this->lng->txt("rep_fav_intro3");
        $mbox = $this->ui->factory()->messageBox()->info($txt);
        $mbox = $mbox->withLinks([$this->ui->factory()->link()->standard($this->getRepositoryTitle(), ilLink::_getStaticLink(1, 'root', true))]);
        return $this->ui->renderer()->render($mbox);
    }

References $txt, ilLink\_getStaticLink(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Here is the call graph for this function:

getRepositoryTitle()

ilPDSelectedItemsBlockGUI::getRepositoryTitle ( )

protected

Definition at line 614 of file class.ilPDSelectedItemsBlockGUI.php.

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

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

Here is the call graph for this function:

getViewSettings()

ilPDSelectedItemsBlockGUI::getViewSettings

(

)

Definition at line 113 of file class.ilPDSelectedItemsBlockGUI.php.

                                     : ilPDSelectedItemsBlockViewSettings
    {
        return $this->viewSettings;
    }

References $viewSettings.

getViewTitle()

ilPDSelectedItemsBlockGUI::getViewTitle ( )

protected

Reimplemented in ilPDMembershipBlockGUI.

Definition at line 149 of file class.ilPDSelectedItemsBlockGUI.php.

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

Referenced by getHTML().

Here is the caller graph for this function:

initAndShow()

ilPDSelectedItemsBlockGUI::initAndShow ( )

protected

Definition at line 288 of file class.ilPDSelectedItemsBlockGUI.php.

                                    : void
    {
        $this->initViewSettings();
 
        if ($this->ctrl->isAsynch()) {
            echo $this->getHTML();
            exit;
        }
 
        $this->returnToContext();
    }

References ILIAS\Repository\ctrl(), and exit.

Here is the call graph for this function:

initViewSettings()

ilPDSelectedItemsBlockGUI::initViewSettings ( )

protected

Reimplemented in ilPDMembershipBlockGUI.

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

                                         : void
    {
        $this->viewSettings = new ilPDSelectedItemsBlockViewSettings(
            $this->user,
            ilPDSelectedItemsBlockConstants::VIEW_SELECTED_ITEMS
        );
 
        $this->viewSettings->parse();
 
        $this->blockView = ilPDSelectedItemsBlockViewGUI::bySettings($this->viewSettings);
 
        $this->ctrl->setParameter($this, 'view', $this->viewSettings->getCurrentView());
    }

References ilPDSelectedItemsBlockViewGUI\bySettings(), ILIAS\Repository\ctrl(), ILIAS\Repository\user(), and ilPDSelectedItemsBlockConstants\VIEW_SELECTED_ITEMS.

Here is the call graph for this function:

isRepositoryObject()

ilPDSelectedItemsBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Reimplemented from ilBlockGUI.

Definition at line 144 of file class.ilPDSelectedItemsBlockGUI.php.

                                           : bool
    {
        return false;
    }

manageObject()

ilPDSelectedItemsBlockGUI::manageObject

(

)

Definition at line 300 of file class.ilPDSelectedItemsBlockGUI.php.

                                  : string
    {
        $this->blockView->setIsInManageMode(true);
 
        $top_tb = new ilToolbarGUI();
        $top_tb->setFormAction($this->ctrl->getFormAction($this));
        $top_tb->setLeadingImage(ilUtil::getImagePath('arrow_upright.svg'), $this->lng->txt('actions'));
 
        $button = ilSubmitButton::getInstance();
        $grouped_items = $this->blockView->getItemGroups();
        if ($this->viewSettings->isSelectedItemsViewActive()) {
            $button->setCaption('remove');
        } else {
            $button->setCaption('pd_unsubscribe_memberships');
            foreach ($grouped_items as $group) {
                $items = $group->getItems();
                $group->setItems([]);
                foreach ($items as $item) {
                    if ($this->rbacsystem->checkAccess('leave', $item['ref_id'])) {
                        if (
                            $item['type'] !== 'crs' ||
                            ilParticipants::getInstance($item['ref_id'])->checkLastAdmin([$this->user->getId()])
                        ) {
                            $group->pushItem($item);
                        }
                    }
                }
            }
        }
        $button->setCommand('confirmRemove');
        $top_tb->addStickyItem($button);
 
        $top_tb->setCloseFormTag(false);
 
        $bot_tb = new ilToolbarGUI();
        $bot_tb->setLeadingImage(ilUtil::getImagePath('arrow_downright.svg'), $this->lng->txt('actions'));
        $bot_tb->addStickyItem($button);
        $bot_tb->setOpenFormTag(false);
 
        return $top_tb->getHTML() . $this->renderManageList($grouped_items) . $bot_tb->getHTML();
    }

References ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ilSubmitButton\getInstance(), ilParticipants\getInstance(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

removeFromDeskObject()

ilPDSelectedItemsBlockGUI::removeFromDeskObject

(

)

Remove from desktop @access public.

Implements ilDesktopItemHandling.

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

                                          : void
    {
        $this->lng->loadLanguageModule("rep");
        $this->favourites->remove($this->user->getId(), $this->requested_item_ref_id);
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt("rep_removed_from_favourites"), true);
        $this->returnToContext();
    }

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

Here is the call graph for this function:

renderManageList()

ilPDSelectedItemsBlockGUI::renderManageList ( array  $grouped_items )

protected

Definition at line 572 of file class.ilPDSelectedItemsBlockGUI.php.

                                                             : string
    {
        $ui = $this->ui;
 
        $this->ctrl->setParameter($this, "manage", "1");
        $groupedCommands = $this->getGroupedCommandsForView(true);
        foreach ($groupedCommands as $group) {
            foreach ($group as $command) {
                $this->addBlockCommand(
                    (string) $command['url'],
                    (string) $command['txt'],
                    (string) ($command['asyncUrl'] ?? "")
                );
            }
        }
 
        if (is_array($groupedCommands[0])) {
            $actions = array_map(static function ($item) use ($ui) {
                return $ui->factory()->link()->standard($item["txt"], $item["url"]);
            }, $groupedCommands[0]);
            if (count($actions) > 0) {
                $dd = $this->ui->factory()->dropdown()->standard($actions);
                $this->main_tpl->setHeaderActionMenu($ui->renderer()->render($dd));
            }
        }
 
        return (new ilDashObjectsTableRenderer($this))->render($grouped_items);
    }

References ILIAS\Repository\ctrl(), ILIAS\UI\examples\MainControls\Slate\Notification\standard(), and ILIAS\Repository\ui().

Here is the call graph for this function:

returnToContext()

ilPDSelectedItemsBlockGUI::returnToContext ( )

protected

Reimplemented in ilPDMembershipBlockGUI.

Definition at line 125 of file class.ilPDSelectedItemsBlockGUI.php.

                                        : void
    {
        $this->ctrl->setParameterByClass('ildashboardgui', 'view', $this->viewSettings->getCurrentView());
        $this->ctrl->redirectByClass('ildashboardgui', 'show');
    }

References ILIAS\Repository\ctrl().

Referenced by addToDeskObject(), and removeFromDeskObject().

Here is the call graph for this function:

Here is the caller graph for this function:

setContent()

ilPDSelectedItemsBlockGUI::setContent ( string  $a_content )

protected

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

                                                    : void
    {
        $this->content = $a_content;
    }

Field Documentation

$block_type

string ilPDSelectedItemsBlockGUI::$block_type = 'pditems'

static

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

$blockView

ilPDSelectedItemsBlockViewGUI ilPDSelectedItemsBlockGUI::$blockView

protected

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

$content

string ilPDSelectedItemsBlockGUI::$content = ''

protected

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

Referenced by getContent().

$ctrl

ilCtrl ilPDSelectedItemsBlockGUI::$ctrl

protected

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

$favourites

ilFavouritesManager ilPDSelectedItemsBlockGUI::$favourites

protected

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

$http

Services ilPDSelectedItemsBlockGUI::$http

protected

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

$list_factory

ilPDSelectedItemsBlockListGUIFactory ilPDSelectedItemsBlockGUI::$list_factory

protected

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

$lng

ilLanguage ilPDSelectedItemsBlockGUI::$lng

protected

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

$logging

ilLogger ilPDSelectedItemsBlockGUI::$logging

protected

Definition at line 53 of file class.ilPDSelectedItemsBlockGUI.php.

$manage

bool ilPDSelectedItemsBlockGUI::$manage = false

protected

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

$new_rendering

bool ilPDSelectedItemsBlockGUI::$new_rendering = true

protected

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

$obj_definition

ilObjectDefinition ilPDSelectedItemsBlockGUI::$obj_definition

protected

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

$objectService

ilObjectService ilPDSelectedItemsBlockGUI::$objectService

protected

Definition at line 49 of file class.ilPDSelectedItemsBlockGUI.php.

$rbacsystem

ilRbacSystem ilPDSelectedItemsBlockGUI::$rbacsystem

protected

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

$refinery

Factory ilPDSelectedItemsBlockGUI::$refinery

protected

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

$requested_item_ref_id

int ilPDSelectedItemsBlockGUI::$requested_item_ref_id

private

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

$settings

ilSetting ilPDSelectedItemsBlockGUI::$settings

protected

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

$tree

ilTree ilPDSelectedItemsBlockGUI::$tree

protected

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

$user

ilObjUser ilPDSelectedItemsBlockGUI::$user

protected

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

$viewSettings

ilPDSelectedItemsBlockViewSettings ilPDSelectedItemsBlockGUI::$viewSettings

protected

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

Referenced by getViewSettings().

---

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

• Services/Dashboard/ItemsBlock/classes/class.ilPDSelectedItemsBlockGUI.php