BlockGUI class for Selected Items on Personal Desktop. More...

Inheritance diagram for ilPDSelectedItemsBlockGUI:

Collaboration diagram for ilPDSelectedItemsBlockGUI:

Public Member Functions
	__construct ()
	ilPDSelectedItemsBlockGUI constructor. More...

	getViewSettings ()

	addToDeskObject ()
	Add desktop item @access public. More...

	removeFromDeskObject ()
	Remove from desktop @access public. More...

	getBlockType ()
	Returns string More...

	getHTML ()
	Get HTML. More...

	executeCommand ()

	fillDataSection ()
	Standard implementation for row based data.Overwrite this and call setContent for other data. More...

	fillFooter ()

	changePDItemPresentation ()
	Called if the user interacted with the provided sorting options. More...

	changePDItemSorting ()
	Called if the user interacted with the provided presentation options. More...

	manageObject ()

	confirmRemoveObject ()

	confirmedRemove ()

	confirmedUnsubscribe ()

	getNoItemFoundContent ()
	No item entry. More...

Public Member Functions inherited from ilBlockGUI
	getBlockType ()

	__construct ()
	Constructor. More...

	setData ($a_data)
	Set Data. More...

	getData ()
	Get Data. More...

	setPresentation (int $type)
	Set presentation. More...

	getPresentation ()
	Get presentation type. More...

	setBlockId ($a_block_id=0)
	Set Block Id. More...

	getBlockId ()
	Get Block Id. More...

	setGuiObject (&$a_gui_object)
	Set GuiObject. More...

	getGuiObject ()
	Get GuiObject. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setOffset ($a_offset)
	Set Offset. More...

	getOffset ()
	Get Offset. More...

	correctOffset ()

	setLimit ($a_limit)
	Set Limit. More...

	getLimit ()
	Get Limit. More...

	setEnableEdit ($a_enableedit)
	Set EnableEdit. More...

	getEnableEdit ()
	Get EnableEdit. More...

	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode. More...

	getRepositoryMode ()
	Get RepositoryMode. More...

	setSubtitle ($a_subtitle)
	Set Subtitle. More...

	getSubtitle ()
	Get Subtitle. More...

	setRefId ($a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...

	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true). More...

	setAdminCommands (bool $a_admincommands)
	Set Administration Commmands. More...

	getAdminCommands ()
	Get Administration Commmands. More...

	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info. More...

	getEnableNumInfo ()
	Get Enable Item Number Info. More...

	setProperties ($a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...

	getProperty ($a_property)

	setProperty ($a_property, $a_value)

	setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
	Set Row Template Name. More...

	getNavParameter ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()
	Get Row Template Name. More...

	getRowTemplateDir ()
	Get Row Template Directory. More...

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
	Add Block Command. More...

	getBlockCommands ()
	Get Block commands. More...

	getHTML ()
	Get HTML. More...

	fillHeaderCommands ()
	Fill header commands block. More...

	fillHeaderTitleBlock ()
	Fill header title block (title and. More...

	setDataSection ($a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used. More...

	fillDataSection ()
	Standard implementation for row based data. More...

	fillRow ($a_set)

	fillFooter ()

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

	setPreviousNextLinks ()
	Get previous/next linkbar. More...

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

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

	getHTMLNew ()
	Get HTML. More...

	addToDeskObject ()
	Add desktop item @access public. More...

	removeFromDeskObject ()
	Remove from desktop @access public. More...

Static Public Member Functions
static	getScreenMode ()
	Get Screen Mode for current command. More...

static	getScreenMode ()
	Get Screen Mode for current command. More...

Static Public Attributes
static	$block_type = 'pditems'

Protected Member Functions
	initViewSettings ()
	Evaluates the view settings of this block. More...

	returnToContext ()
	Return to context. More...

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

	getViewTitle ()
	Get view title. More...

	getContent ()

	setContent (string $a_content)

	getGroupedCommandsForView ($manage=false)

	setFooterLinks ()

	renderGroupedItems (array $grouped_items, $showHeader=true)

	getViewBlockHtml ()

	initAndShow ()

	cancel ()
	Cancel. More...

	getListItemGroups ()
	Get items. More...

	getLegacyContent ()
	Get legacy content. Returns string More...

	renderManageList (array $grouped_items)

	getRepositoryTitle ()

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

	initCommands ()
	Init commands. More...

	fillRowColor ($a_placeholder="CSS_ROW")

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

	getLegacyContent ()
	Get legacy content. More...

	getViewControls ()
	Get view controls. More...

	getListItemForData (array $data)
	Get list item for data array. More...

	handleNavigation ()
	Handle navigation. More...

	loadData ()
	Load data for current page. More...

	getListItemGroups ()
	Get items. More...

	addRepoCommands ()
	Add repo commands. More...

	getNoItemFoundContent ()
	No item entry. More...

Protected Attributes
	$rbacsystem

	$settings

	$obj_definition

	$viewSettings

	$blockView

	$manage = false

	$content = ''

	$lng

	$ctrl

	$user

	$ui

	$http

	$objectService

	$favourites

	$tree

	$new_rendering = true

Protected Attributes inherited from ilBlockGUI
	$ui

	$data = array()

	$enablenuminfo = true

	$footer_links = array()

	$block_id = 0

	$allow_moving = true

	$move = array("left" => false, "right" => false, "up" => false, "down" => false)

	$block_commands = array()

	$max_count = false

	$close_command = false

	$image = false

	$property = false

	$nav_value = ""

	$css_row = ""

	$title = ""

	$admincommands = false

	$dropdown

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

	$presentation

	$new_rendering = false

Additional Inherited Members
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

Detailed Description

BlockGUI class for Selected Items on Personal Desktop.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

@ilCtrl_IsCalledBy ilPDSelectedItemsBlockGUI: ilColumnGUI @ilCtrl_Calls ilPDSelectedItemsBlockGUI: ilCommonActionDispatcherGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPDSelectedItemsBlockGUI::__construct ( )

ilPDSelectedItemsBlockGUI constructor.

Reimplemented from ilBlockGUI.

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

    {
        global $DIC;
 
        $this->rbacsystem = $DIC->rbac()->system();
        $this->settings = $DIC->settings();
        $this->obj_definition = $DIC["objDefinition"];
        $this->access = $DIC->access();
        $this->ui = $DIC->ui();
        $this->http = $DIC->http();
        $this->objectService = $DIC->object();
        $this->favourites = new ilFavouritesManager();
        $this->tree = $DIC->repositoryTree();
 
        parent::__construct();
 
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
 
        $this->lng->loadLanguageModule('pd');
        $this->lng->loadLanguageModule('cntr'); // #14158
        $this->lng->loadLanguageModule('rep'); // #14158
 
        $this->setEnableNumInfo(false);
        $this->setLimit(99999);
        $this->allow_moving = false;
 
        $this->initViewSettings();
 
        if ($this->viewSettings->isTilePresentation()) {
            $this->setPresentation(self::PRES_MAIN_LEG);
        } else {
            $this->setPresentation(self::PRES_MAIN_LIST);
        }
        $this->main_content = true;
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\FileDelivery\http(), initViewSettings(), ilBlockGUI\setEnableNumInfo(), ilBlockGUI\setLimit(), ilBlockGUI\setPresentation(), settings(), ui(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ addToDeskObject()

ilPDSelectedItemsBlockGUI::addToDeskObject ( )

Add desktop item @access public.

Implements ilDesktopItemHandling.

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

    {
        $this->favourites->add($this->user->getId(), (int) $_GET["item_ref_id"]);
        ilUtil::sendSuccess($this->lng->txt("rep_added_to_favourites"), true);
        $this->returnToContext();
    }

References $_GET, returnToContext(), and user().

Here is the call graph for this function:

◆ cancel()

ilPDSelectedItemsBlockGUI::cancel ( )

protected

Cancel.

Parameters

return

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

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

◆ changePDItemPresentation()

ilPDSelectedItemsBlockGUI::changePDItemPresentation ( )

Called if the user interacted with the provided sorting options.

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

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

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

Here is the call graph for this function:

◆ changePDItemSorting()

ilPDSelectedItemsBlockGUI::changePDItemSorting ( )

Called if the user interacted with the provided presentation options.

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

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

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

Here is the call graph for this function:

◆ confirmedRemove()

ilPDSelectedItemsBlockGUI::confirmedRemove ( )

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

    {
        $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(), $ref_id);
        }
 
        // #12909
        ilUtil::sendSuccess($this->lng->txt('pd_remove_multi_confirm'), true);
        $this->ctrl->redirect($this, 'manage');
    }

References ILIAS\FileDelivery\http(), and user().

Here is the call graph for this function:

◆ confirmedUnsubscribe()

ilPDSelectedItemsBlockGUI::confirmedUnsubscribe ( )

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

    {
        $refIds = (array) ($this->http->request()->getParsedBody()['ref_id'] ?? []);
        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':
                        // see ilObjCourseGUI:performUnsubscribeObject()
                        $members = new ilCourseParticipants(ilObject::_lookupObjId((int) $ref_id));
                        $members->delete($this->user->getId());
 
                        $members->sendUnsubscribeNotificationToAdmins($this->user->getId());
                        $members->sendNotification(
                            $members->NOTIFY_UNSUBSCRIBE,
                            $this->user->getId()
                        );
                        break;
 
                    case 'grp':
                        // see ilObjGroupGUI:performUnsubscribeObject()
                        $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:
                        // do nothing
                        continue 2;
                }
        
                include_once './Modules/Forum/classes/class.ilForumNotification.php';
                ilForumNotification::checkForumsExistsDelete($ref_id, $this->user->getId());
            }
        }
 
        ilUtil::sendSuccess($this->lng->txt('mmbr_unsubscribed_from_objs'), true);
        $this->ctrl->returnToParent($this);
    }

References ilObject\_lookupObjId(), ilObject\_lookupType(), ilForumNotification\checkForumsExistsDelete(), ILIAS\FileDelivery\http(), ilGroupMembershipMailNotification\TYPE_NOTIFICATION_UNSUBSCRIBE, ilGroupMembershipMailNotification\TYPE_UNSUBSCRIBE_MEMBER, and user().

Here is the call graph for this function:

◆ confirmRemoveObject()

ilPDSelectedItemsBlockGUI::confirmRemoveObject ( )

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

    {
        $this->ctrl->setParameter($this, 'view', $this->viewSettings->getCurrentView());
 
        $refIds = (array) ($this->http->request()->getParsedBody()['id'] ?? []);
        if (0 === count($refIds)) {
            ilUtil::sendFailure($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';
        }
 
        include_once('./Services/Utilities/classes/class.ilConfirmationGUI.php');
        $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 ilBlockGUI\$title, $type, ilObject\_lookupObjectId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ILIAS\FileDelivery\http(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ executeCommand()

ilPDSelectedItemsBlockGUI::executeCommand ( )

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

    {
        $next_class = $this->ctrl->getNextClass();
        $cmd = $this->ctrl->getCmd('getHTML');
 
        switch ($next_class) {
            case 'ilcommonactiondispatchergui':
                include_once('Services/Object/classes/class.ilCommonActionDispatcherGUI.php');
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
                
            default:
                if (method_exists($this, $cmd)) {
                    return $this->$cmd();
                } else {
                    return $this->{$cmd . 'Object'}();
                }
        }
    }

References 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 315 of file class.ilPDSelectedItemsBlockGUI.php.

    {
        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:

◆ fillFooter()

ilPDSelectedItemsBlockGUI::fillFooter ( )

Reimplemented from ilBlockGUI.

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

    {
        /*
        $this->tpl->setVariable('FCOLSPAN', $this->getColSpan());
        if ($this->tpl->blockExists('block_footer')) {
            $this->tpl->setCurrentBlock('block_footer');
            $this->tpl->parseCurrentBlock();
        }
        */
    }

◆ getBlockType()

ilPDSelectedItemsBlockGUI::getBlockType ( )

Returns: string

Reimplemented from ilBlockGUI.

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

                                   : string
    {
        return static::$block_type;
    }

◆ getContent()

ilPDSelectedItemsBlockGUI::getContent ( )

protected

Returns: string

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

                                    : string
    {
        return $this->content;
    }

References $content.

Referenced by fillDataSection(), and setFooterLinks().

Here is the caller graph for this function:

◆ getGroupedCommandsForView()

ilPDSelectedItemsBlockGUI::getGroupedCommandsForView ( $manage = false )

protected

Returns: array

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

                                                                  : array
    {
        $commandGroups = [];
 
        $sortingCommands = [];
        $sortings = $this->viewSettings->getSelectableSortingModes();
        $effectiveSorting = $this->viewSettings->getEffectiveSortingMode();
        // @todo: set checked on $sorting === $effectiveSorting
        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();
        // @todo: set checked on $presentation === $effectivePresentation
        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 $manage, and ilBlockGUI\$presentation.

Referenced by getLegacyContent(), getListItemGroups(), renderManageList(), and setFooterLinks().

Here is the caller graph for this function:

◆ getHTML()

ilPDSelectedItemsBlockGUI::getHTML ( )

Get HTML.

Reimplemented from ilBlockGUI.

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

    {
        global $DIC;
 
        $this->setTitle($this->getViewTitle());
 
        $DIC->database()->useSlave(true);
 
        // workaround to show details row
        $this->setData([['dummy']]);
 
        /*
        ilObjectListGUI::prepareJSLinks('',
            $this->ctrl->getLinkTargetByClass(['ilcommonactiondispatchergui', 'ilnotegui'], '', '', true, false),
            $this->ctrl->getLinkTargetByClass(['ilcommonactiondispatchergui', 'iltagginggui'], '', '', true, false)
        );*/
 
        $DIC['ilHelp']->setDefaultScreenId(ilHelpGUI::ID_PART_SCREEN, $this->blockView->getScreenId());
 
        //              $this->setContent($this->getViewBlockHtml());
 
        //              if ('' === $this->getContent()) {
        //                      $this->setEnableDetailRow(false);
        //              }
 
        $this->ctrl->clearParameters($this);
 
        $DIC->database()->useSlave(false);
 
        return parent::getHTML();
    }

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

Referenced by initAndShow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLegacyContent()

ilPDSelectedItemsBlockGUI::getLegacyContent ( )

protected

Get legacy content.

Returns: string

Reimplemented from ilBlockGUI.

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

                                          : string
    {
        $renderer = $this->ui->renderer();
        $factory = $this->ui->factory();
 
        $this->list_factory = new ilPDSelectedItemsBlockListGUIFactory($this, $this->blockView);
 
        $groupedCommands = $this->getGroupedCommandsForView();
        foreach ($groupedCommands as $group) {
            foreach ($group as $command) {
                $this->addBlockCommand(
                    (string) $command['url'],
                    (string) $command['txt'],
                    (string) $command['asyncUrl']
                );
            }
        }
 
        $groupedItems = $this->blockView->getItemGroups();
 
        $subs = [];
        foreach ($groupedItems as $group) {
            $cards = [];
 
            foreach ($group->getItems() as $item) {
                try {
                    $itemListGUI = $this->list_factory->byType($item['type']);
                    ilObjectActivation::addListGUIActivationProperty($itemListGUI, $item);
 
                    $cards[] = $this->getCardForData($item);
                } catch (ilException $e) {
                    continue;
                }
            }
            if (count($cards) > 0) {
                $subs[] = $factory->panel()->sub(
                    $group->getLabel(),
                    $factory->deck($cards)->withNormalCardsSize()
                );
            }
        }
 
 
        return $renderer->render($subs);
    }

References Vendor\Package\$e, $factory, ilBlockGUI\addBlockCommand(), ilObjectActivation\addListGUIActivationProperty(), getGroupedCommandsForView(), and ui().

Here is the call graph for this function:

◆ getListItemGroups()

ilPDSelectedItemsBlockGUI::getListItemGroups ( )

protected

Get items.

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

Reimplemented from ilBlockGUI.

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

                                           : array
    {
        global $DIC;
        $factory = $DIC->ui()->factory();
 
        //              $data = $this->loadData();
 
        $this->list_factory = new ilPDSelectedItemsBlockListGUIFactory($this, $this->blockView);
 
        $groupedItems = $this->blockView->getItemGroups();
        $groupedCommands = $this->getGroupedCommandsForView();
        foreach ($groupedCommands as $group) {
            foreach ($group as $command) {
                $this->addBlockCommand(
                    (string) $command['url'],
                    (string) $command['txt'],
                    (string) $command['asyncUrl']
                );
            }
        }
 
 
 
        $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) {
                    continue;
                }
            }
            if (count($list_items) > 0) {
                $item_groups[] = $factory->item()->group((string) $group->getLabel(), $list_items);
            }
        }
 
        /* @todo: checkboxes
        if ($this->blockView->isInManageMode() && $this->blockView->supportsSelectAll()) {
            // #11355 - see ContainerContentGUI::renderSelectAllBlock()
            $this->tpl->setCurrentBlock('select_all_row');
            $this->tpl->setVariable('CHECKBOXNAME', 'ilToolbarSelectAll');
            $this->tpl->setVariable('SEL_ALL_PARENT', 'ilToolbar');
            $this->tpl->setVariable('SEL_ALL_CB_NAME', 'id');
            $this->tpl->setVariable('TXT_SELECT_ALL', $this->lng->txt('select_all'));
            $this->tpl->parseCurrentBlock();
        }
 
        return $this->tpl->get();
        */
 
        return $item_groups;
    }

References $DIC, Vendor\Package\$e, $factory, ilBlockGUI\addBlockCommand(), ilObjectActivation\addListGUIActivationProperty(), getGroupedCommandsForView(), and ilBlockGUI\getListItemForData().

Here is the call graph for this function:

◆ getNoItemFoundContent()

ilPDSelectedItemsBlockGUI::getNoItemFoundContent ( )

No item entry.

Returns: string

Reimplemented from ilBlockGUI.

Reimplemented in ilPDMembershipBlockGUI.

Definition at line 892 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(), and ui().

Here is the call graph for this function:

◆ getRepositoryTitle()

ilPDSelectedItemsBlockGUI::getRepositoryTitle ( )

protected

Returns: string

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

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

References $nd, and ilBlockGUI\$title.

◆ getScreenMode()

static ilPDSelectedItemsBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

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

    {
        $cmd = $_GET['cmd'];
        if ($cmd == 'post') {
            $cmd = $_POST['cmd'];
            $cmd = array_shift(array_keys($cmd));
        }
 
        switch ($cmd) {
            case 'confirmRemove':
            case 'manage':
                return IL_SCREEN_FULL;
 
            default:
                return IL_SCREEN_SIDE;
        }
    }

References $_GET, $_POST, IL_SCREEN_FULL, and IL_SCREEN_SIDE.

◆ getViewBlockHtml()

ilPDSelectedItemsBlockGUI::getViewBlockHtml ( )

protected

Returns: string

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

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

References renderGroupedItems().

Here is the call graph for this function:

◆ getViewSettings()

ilPDSelectedItemsBlockGUI::getViewSettings ( )

Returns: ilPDSelectedItemsBlockViewSettings

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

                                      : ilPDSelectedItemsBlockViewSettings
    {
        return $this->viewSettings;
    }

References $viewSettings.

◆ getViewTitle()

ilPDSelectedItemsBlockGUI::getViewTitle ( )

protected

Get view title.

Returns: string

Reimplemented in ilPDMembershipBlockGUI.

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

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

Referenced by getHTML().

Here is the caller graph for this function:

◆ initAndShow()

ilPDSelectedItemsBlockGUI::initAndShow ( )

protected

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

    {
        $this->initViewSettings();
 
        if ($this->ctrl->isAsynch()) {
            echo $this->getHTML();
            exit;
        }
 
        if ($_GET["manage"]) {
            $this->ctrl->redirect($this, 'manage');
        }
 
        $this->returnToContext();
    }

References $_GET, exit, getHTML(), initViewSettings(), and returnToContext().

Referenced by changePDItemPresentation(), and changePDItemSorting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initViewSettings()

ilPDSelectedItemsBlockGUI::initViewSettings ( )

protected

Evaluates the view settings of this block.

Reimplemented in ilPDMembershipBlockGUI.

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

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

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

Referenced by __construct(), and initAndShow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRepositoryObject()

ilPDSelectedItemsBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Returns: bool

Reimplemented from ilBlockGUI.

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

                                            : bool
    {
        return false;
    }

◆ manageObject()

ilPDSelectedItemsBlockGUI::manageObject ( )

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

    {
        $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 ilUtil\getImagePath(), ilParticipants\getInstance(), ilSubmitButton\getInstance(), renderManageList(), and user().

Here is the call graph for this function:

◆ removeFromDeskObject()

ilPDSelectedItemsBlockGUI::removeFromDeskObject ( )

Remove from desktop @access public.

Implements ilDesktopItemHandling.

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

    {
        $this->lng->loadLanguageModule("rep");
        $this->favourites->remove($this->user->getId(), (int) $_GET["item_ref_id"]);
        ilUtil::sendSuccess($this->lng->txt("rep_removed_from_favourites"), true);
        $this->returnToContext();
    }

References $_GET, returnToContext(), and user().

Here is the call graph for this function:

◆ renderGroupedItems()

ilPDSelectedItemsBlockGUI::renderGroupedItems	(	array	$grouped_items,
			$showHeader = `true`
	)

protected

Parameters

ilPDSelectedItemsBlockGroup[]	$grouped_items
bool	$showHeader

Returns: string

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

                                                                                    : string
    {
        if (0 === count($grouped_items)) {
            return '';
        }
 
        $listFactory = new ilPDSelectedItemsBlockListGUIFactory($this, $this->blockView);
 
        if ($this->viewSettings->isTilePresentation()) {
            $renderer = new ilPDObjectsTileRenderer(
                $this->blockView,
                $this->ui->factory(),
                $this->ui->renderer(),
                $listFactory,
                $this->user,
                $this->lng,
                $this->objectService,
                $this->ctrl
            );
            
            return $renderer->render($grouped_items, $showHeader);
        }
 
        $renderer = new ilPDObjectsListRenderer(
            $this->blockView,
            $this->ui->factory(),
            $this->ui->renderer(),
            $listFactory,
            $this->user,
            $this->lng,
            $this->objectService,
            $this->ctrl
        );
 
        return $renderer->render($grouped_items, $showHeader);
    }

References ui().

Referenced by getViewBlockHtml().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderManageList()

ilPDSelectedItemsBlockGUI::renderManageList ( array $grouped_items )

protected

Definition at line 857 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']
                );
            }
        }
 
        // action drop down
        if (is_array($groupedCommands[0])) {
            $actions = array_map(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 $ui, ilBlockGUI\addBlockCommand(), getGroupedCommandsForView(), standard(), and ui().

Referenced by manageObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ returnToContext()

ilPDSelectedItemsBlockGUI::returnToContext ( )

protected

Return to context.

Parameters

return

Reimplemented in ilPDMembershipBlockGUI.

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

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

Referenced by addToDeskObject(), initAndShow(), and removeFromDeskObject().

Here is the caller graph for this function:

◆ setContent()

ilPDSelectedItemsBlockGUI::setContent ( string $a_content )

protected

Parameters

string $a_content

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

    {
        $this->content = $a_content;
    }

References $a_content.

◆ setFooterLinks()

ilPDSelectedItemsBlockGUI::setFooterLinks ( )

protected

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

    {
        if ('' === $this->getContent()) {
            $this->setEnableNumInfo(false);
            return;
        }
 
        if ($this->blockView->isInManageMode()) {
            return;
        }
 
        // @todo: handle $command['active']
        $groupedCommands = $this->getGroupedCommandsForView();
        foreach ($groupedCommands as $group) {
            foreach ($group as $command) {
                $this->addBlockCommand(
                    $command['url'],
                    $command['txt'],
                    $command['asyncUrl']
                );
            }
        }
    }