Inheritance diagram for ilBadgeProfileGUI:

Collaboration diagram for ilBadgeProfileGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

Data Fields
const string	TABLE_ALL_OBJECTS_ACTION = 'ALL_OBJECTS'

final const string	BACKPACK_EMAIL = 'badge_mozilla_bp'

Private Member Functions
	getTableAction ()

	handleTableActionsCmd ()

	listBadgesCmd ()

	renderDeck (string $deck)

	manageBadgesCmd ()

	getMultiSelection ()

	activate ()

	deactivate ()

	activateInCardCmd ()

	deactivateInCardCmd ()

	setBackpackSubTabs ()

	listBackpackGroupsCmd ()

	getBackpackMail ()

	initSettingsForm ()

	editSettingsCmd (?ilPropertyFormGUI $a_form=null)

	saveSettingsCmd ()

Private Attributes
const string	LIST_BADGES_ACTION = 'listBadges'

const string	MANAGE_BADGES_ACTION = 'manageBadges'

const string	TABLE_ACTIONS = 'handleTableActions'

const string	DEFAULT_ACTION = self::LIST_BADGES_ACTION

readonly ilBadgeGUIRequest	$request

readonly ilCtrlInterface	$ctrl

readonly ilLanguage	$lng

readonly ilGlobalTemplateInterface	$tpl

readonly ilTabsGUI	$tabs

readonly ilObjUser	$user

readonly ILIAS Refinery Factory	$refinery

readonly ILIAS HTTP GlobalHttpState	$http

readonly BadgeNotificationPrefRepository	$noti_repo

readonly TileView	$tile_view

Detailed Description

Definition at line 24 of file class.ilBadgeProfileGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBadgeProfileGUI::__construct ( )

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

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->tpl = $DIC['tpl'];
        $this->tabs = $DIC->tabs();
        $this->user = $DIC->user();
        $this->refinery = $DIC->refinery();
        $this->http = $DIC->http();
        $this->request = new ilBadgeGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );
 
        $this->noti_repo = new BadgeNotificationPrefRepository();
 
        $this->tile_view = new TileView(
            $DIC,
            self::class,
            new Tile($DIC),
            new PresentationHeader($DIC, self::class)
        );
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ activate()

ilBadgeProfileGUI::activate ( )

private

Definition at line 176 of file class.ilBadgeProfileGUI.php.

                               : void
    {
        foreach ($this->getMultiSelection() as $ass) {
            // already active?
            if (!$ass->getPosition()) {
                $ass->setPosition(999);
                $ass->store();
            }
        }
 
        $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('position_updated'), true);
        $this->ctrl->redirect($this, self::MANAGE_BADGES_ACTION);
    }

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

Referenced by handleTableActionsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ activateInCardCmd()

ilBadgeProfileGUI::activateInCardCmd ( )

private

Definition at line 204 of file class.ilBadgeProfileGUI.php.

                                        : void
    {
        foreach ($this->getMultiSelection() as $ass) {
            // already active?
            if (!$ass->getPosition()) {
                $ass->setPosition(999);
                $ass->store();
            }
        }
 
        $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('position_updated'), true);
        $this->ctrl->redirect($this, self::LIST_BADGES_ACTION);
    }

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

Here is the call graph for this function:

◆ deactivate()

ilBadgeProfileGUI::deactivate ( )

private

Definition at line 190 of file class.ilBadgeProfileGUI.php.

                                 : void
    {
        foreach ($this->getMultiSelection() as $ass) {
            // already inactive?
            if ($ass->getPosition()) {
                $ass->setPosition(null);
                $ass->store();
            }
        }
 
        $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('position_updated'), true);
        $this->ctrl->redirect($this, self::MANAGE_BADGES_ACTION);
    }

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

Referenced by handleTableActionsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deactivateInCardCmd()

ilBadgeProfileGUI::deactivateInCardCmd ( )

private

Definition at line 218 of file class.ilBadgeProfileGUI.php.

                                          : void
    {
        foreach ($this->getMultiSelection() as $ass) {
            // already inactive?
            if ($ass->getPosition()) {
                $ass->setPosition(null);
                $ass->store();
            }
        }
 
        $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('position_updated'), true);
        $this->ctrl->redirect($this, self::LIST_BADGES_ACTION);
    }

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

Here is the call graph for this function:

◆ editSettingsCmd()

ilBadgeProfileGUI::editSettingsCmd ( ?ilPropertyFormGUI $a_form = null )

private

Definition at line 324 of file class.ilBadgeProfileGUI.php.

                                                                       : void
    {
        $this->ctrl->redirect($this, self::LIST_BADGES_ACTION);
    }

References ILIAS\Repository\ctrl().

Referenced by saveSettingsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilBadgeProfileGUI::executeCommand ( )

Definition at line 72 of file class.ilBadgeProfileGUI.php.

                                    : void
    {
        $this->lng->loadLanguageModule('badge');
 
        switch ($this->ctrl->getNextClass()) {
            default:
                $cmd = $this->ctrl->getCmd(self::DEFAULT_ACTION);
                if ($cmd === '' || $cmd === null || !method_exists($this, $cmd . 'Cmd')) {
                    $cmd = self::DEFAULT_ACTION;
                }
                $cmd .= 'Cmd';
 
                $this->$cmd();
                break;
        }
    }

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

Here is the call graph for this function:

◆ getBackpackMail()

ilBadgeProfileGUI::getBackpackMail ( )

private

Definition at line 298 of file class.ilBadgeProfileGUI.php.

                                      : string
    {
        $mail = $this->user->getPref(self::BACKPACK_EMAIL);
        if (!$mail) {
            $mail = $this->user->getEmail();
        }
 
        return $mail;
    }

References ILIAS\Repository\user().

Referenced by initSettingsForm(), listBackpackGroupsCmd(), and saveSettingsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMultiSelection()

ilBadgeProfileGUI::getMultiSelection ( )

private

Definition at line 138 of file class.ilBadgeProfileGUI.php.

                                        : array
    {
        $badge_ids = array_filter(
            $this->http->wrapper()->query()->retrieve(
                'badge_id',
                $this->refinery->byTrying([
                    $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
                    $this->refinery->always([])
                ])
            )
        );
 
        if ($badge_ids === [self::TABLE_ALL_OBJECTS_ACTION]) {
            $badge_assignments = array_filter(
                ilBadgeAssignment::getInstancesByUserId($this->user->getId()),
                static fn(ilBadgeAssignment $ass): bool => (bool) $ass->getTimestamp()
            );
        } else {
            $badge_assignments = array_filter(
                array_map(
                    fn(int $badge_id): ilBadgeAssignment => new ilBadgeAssignment(
                        $badge_id,
                        $this->user->getId()
                    ),
                    $this->request->getBadgeIds()
                ),
                static fn(ilBadgeAssignment $ass): bool => (bool) $ass->getTimestamp()
            );
        }
 
        if (!empty($badge_assignments)) {
            return $badge_assignments;
        }
 
        $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_FAILURE, $this->lng->txt('select_one'), true);
        $this->ctrl->redirect($this, self::MANAGE_BADGES_ACTION);
    }

References ILIAS\Repository\ctrl(), ilBadgeAssignment\getInstancesByUserId(), ilBadgeAssignment\getTimestamp(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by activate(), activateInCardCmd(), deactivate(), and deactivateInCardCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSafePostCommands()

ilBadgeProfileGUI::getSafePostCommands ( )

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 89 of file class.ilBadgeProfileGUI.php.

                                         : array
    {
        return [];
    }

◆ getTableAction()

ilBadgeProfileGUI::getTableAction ( )

private

Definition at line 94 of file class.ilBadgeProfileGUI.php.

                                     : ?string
    {
        return $this->http->wrapper()->query()->retrieve(
            'badge_table_action',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always(null)
            ])
        );
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by handleTableActionsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUnsafeGetCommands()

ilBadgeProfileGUI::getUnsafeGetCommands ( )

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also: ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns: string[]

Implements ilCtrlSecurityInterface.

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

                                          : array
    {
        return [self::TABLE_ACTIONS];
    }

References TABLE_ACTIONS.

◆ handleTableActionsCmd()

ilBadgeProfileGUI::handleTableActionsCmd ( )

private

Definition at line 105 of file class.ilBadgeProfileGUI.php.

                                            : void
    {
        match ($this->getTableAction()) {
            'obj_badge_activate' => $this->activate(),
            'obj_badge_deactivate' => $this->deactivate(),
            default => $this->ctrl->redirect($this, self::DEFAULT_ACTION),
        };
    }

References activate(), ILIAS\Repository\ctrl(), deactivate(), and getTableAction().

Here is the call graph for this function:

◆ initSettingsForm()

ilBadgeProfileGUI::initSettingsForm ( )

private

Definition at line 308 of file class.ilBadgeProfileGUI.php.

                                       : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'saveSettings'));
        $form->setTitle($this->lng->txt('settings'));
 
        $email = new ilEMailInputGUI($this->lng->txt('badge_backpack_email'), 'email');
        $email->setInfo($this->lng->txt('badge_backpack_email_info'));
        $email->setValue($this->getBackpackMail());
        $form->addItem($email);
 
        $form->addCommandButton('saveSettings', $this->lng->txt('save'));
 
        return $form;
    }

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

Referenced by saveSettingsCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listBackpackGroupsCmd()

ilBadgeProfileGUI::listBackpackGroupsCmd ( )

private

Definition at line 249 of file class.ilBadgeProfileGUI.php.

                                            : void
    {
        $this->setBackpackSubTabs();
        $this->tabs->activateSubTab('backpack_badges');
 
        $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_INFO, $this->lng->txt('badge_backpack_gallery_info'));
 
        $bp = new ilBadgeBackpack($this->getBackpackMail());
        $bp_groups = $bp->getGroups();
 
        if (!count($bp_groups)) {
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_INFO, $this->lng->txt('badge_backpack_no_groups'));
            return;
        }
 
        $tmpl = new ilTemplate('tpl.badge_backpack.html', true, true, 'components/ILIAS/Badge/');
 
        $tmpl->setVariable('BACKPACK_TITLE', $this->lng->txt('badge_backpack_list'));
 
        ilDatePresentation::setUseRelativeDates(false);
 
        foreach ($bp_groups as $group_id => $group) {
            $bp_badges = $bp->getBadges($group_id);
            if (count($bp_badges)) {
                foreach ($bp_badges as $badge) {
                    $tmpl->setCurrentBlock('badge_bl');
                    $tmpl->setVariable('BADGE_TITLE', $badge['title']);
                    $tmpl->setVariable('BADGE_DESC', $badge['description']);
                    $tmpl->setVariable('BADGE_IMAGE', $badge['image_url']);
                    $tmpl->setVariable('BADGE_CRITERIA', $badge['criteria_url']);
                    $tmpl->setVariable('BADGE_ISSUER', $badge['issuer_name']);
                    $tmpl->setVariable('BADGE_ISSUER_URL', $badge['issuer_url']);
                    $tmpl->setVariable('BADGE_DATE', ilDatePresentation::formatDate($badge['issued_on']));
                    $tmpl->parseCurrentBlock();
                }
            }
 
            $tmpl->setCurrentBlock('group_bl');
            $tmpl->setVariable('GROUP_TITLE', $group['title']);
            $tmpl->parseCurrentBlock();
        }
 
        $this->tpl->setContent($tmpl->get());
    }

References ilDatePresentation\formatDate(), getBackpackMail(), ILIAS\Repository\lng(), setBackpackSubTabs(), ilDatePresentation\setUseRelativeDates(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ listBadgesCmd()

ilBadgeProfileGUI::listBadgesCmd ( )

private

Definition at line 119 of file class.ilBadgeProfileGUI.php.

                                    : void
    {
        $this->tpl->setContent($this->renderDeck($this->tile_view->show()));
        $this->noti_repo->updateLastCheckedTimestamp();
    }

References renderDeck().

Here is the call graph for this function:

◆ manageBadgesCmd()

ilBadgeProfileGUI::manageBadgesCmd ( )

private

Definition at line 132 of file class.ilBadgeProfileGUI.php.

                                      : void
    {
        $tpl = new ilBadgePersonalTableGUI();
        $tpl->renderTable(ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTarget($this, self::TABLE_ACTIONS));
    }

References $tpl, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ renderDeck()

ilBadgeProfileGUI::renderDeck ( string $deck )

private

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

                                             : string
    {
        $template = new ilTemplate('tpl.badge_backpack.html', true, true, 'components/ILIAS/Badge/');
        $template->setVariable('DECK', $deck);
        return $template->get();
    }

Referenced by listBadgesCmd().

Here is the caller graph for this function:

◆ saveSettingsCmd()

ilBadgeProfileGUI::saveSettingsCmd ( )

private

Definition at line 329 of file class.ilBadgeProfileGUI.php.

                                      : void
    {
        $form = $this->initSettingsForm();
        if ($form->checkInput()) {
            $new_email = $form->getInput('email');
            $old_email = $this->getBackpackMail();
 
            $this->user->writePref(self::BACKPACK_EMAIL, $new_email);
 
            // if email was changed: delete badge files
            if ($new_email !== $old_email) {
                ilBadgeAssignment::clearBadgeCache($this->user->getId());
            }
 
            $this->tpl->setOnScreenMessage($this->tpl::MESSAGE_TYPE_SUCCESS, $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, 'editSettings');
        }
 
        $form->setValuesByPost();
        $this->editSettingsCmd($form);
    }

References ilBadgeAssignment\clearBadgeCache(), ILIAS\Repository\ctrl(), editSettingsCmd(), getBackpackMail(), initSettingsForm(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ setBackpackSubTabs()

ilBadgeProfileGUI::setBackpackSubTabs ( )

private

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

                                         : void
    {
        $this->tabs->addSubTab(
            'backpack_badges',
            $this->lng->txt('obj_bdga'),
            $this->ctrl->getLinkTarget($this, 'listBackpackGroups')
        );
 
        $this->tabs->addSubTab(
            'backpack_settings',
            $this->lng->txt('settings'),
            $this->ctrl->getLinkTarget($this, 'editSettings')
        );
 
        $this->tabs->activateTab('backpack_badges');
    }