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...

Data Fields
final const	BACKPACK_EMAIL = 'badge_mozilla_bp'

Protected Member Functions
	listBadges ()

	manageBadges ()

	getMultiSelection ()

	activate ()

	deactivate ()

	activateInCard ()

	deactivateInCard ()

	setBackpackSubTabs ()

	listBackpackGroups ()

	getBackpackMail ()

	initSettingsForm ()

	editSettings (?ilPropertyFormGUI $a_form=null)

	saveSettings ()

Protected Attributes
ilBadgeGUIRequest	$request

ilCtrl	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilTabsGUI	$tabs

ilObjUser	$user

ilAccessHandler	$access

ILIAS UI Factory	$factory

ILIAS UI Renderer	$renderer

BadgeNotificationPrefRepository	$noti_repo

Private Member Functions
	renderDeck (string $deck)

Private Attributes
readonly TileView	$tile_view

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilBadgeProfileGUI::__construct ( )

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), factory(), ILIAS\Repository\lng(), renderer(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->tpl = $DIC['tpl'];
         $this->tabs = $DIC->tabs();
         $this->user = $DIC->user();
         $this->access = $DIC->access();
         $this->factory = $DIC->ui()->factory();
         $this->renderer = $DIC->ui()->renderer();
         $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)
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ activate()

ilBadgeProfileGUI::activate ( )

protected

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

References $ctrl, $lng, getMultiSelection(), ilCtrl\redirect(), and ilLanguage\txt().

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ activateInCard()

ilBadgeProfileGUI::activateInCard ( )

protected

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

References $ctrl, $lng, getMultiSelection(), ilCtrl\redirect(), and ilLanguage\txt().

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

Here is the call graph for this function:

◆ deactivate()

ilBadgeProfileGUI::deactivate ( )

protected

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

References $ctrl, $lng, getMultiSelection(), null, ilCtrl\redirect(), and ilLanguage\txt().

Referenced by executeCommand().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deactivateInCard()

ilBadgeProfileGUI::deactivateInCard ( )

protected

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

References $ctrl, $lng, getMultiSelection(), null, ilCtrl\redirect(), and ilLanguage\txt().

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

Here is the call graph for this function:

◆ editSettings()

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

protected

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

References $ctrl, $tabs, and $tpl.

Referenced by saveSettings().

                                                                       : void
     {
         $tpl = $this->tpl;
         $ilCtrl = $this->ctrl;
         $ilTabs = $this->tabs;
 
         $ilCtrl->redirect($this, 'listBadges');
     }

Here is the caller graph for this function:

◆ executeCommand()

ilBadgeProfileGUI::executeCommand ( )

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

References $ctrl, $DIC, $lng, activate(), deactivate(), and ilLanguage\loadLanguageModule().

                                     : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $lng->loadLanguageModule('badge');
 
         switch ($ilCtrl->getNextClass()) {
             default:
                 $cmd = $ilCtrl->getCmd('listBadges');
 
                 global $DIC;
                 $query = $DIC->http()->wrapper()->query();
                 $action = '';
                 $parameter = 'badge_table_action';
                 if ($cmd === 'action' && $this->query->has($parameter)) {
                     $action = $this->query->retrieve($parameter, $DIC->refinery()->kindlyTo()->string());
                     $cmd = 'listBadges';
                 }
                 if ($action === 'obj_badge_activate') {
                     $this->activate();
                 } elseif ($action === 'obj_badge_deactivate') {
                     $this->deactivate();
                 }
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getBackpackMail()

ilBadgeProfileGUI::getBackpackMail ( )

protected

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

References $user, and ilObjUser\getPref().

Referenced by initSettingsForm(), listBackpackGroups(), and saveSettings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMultiSelection()

ilBadgeProfileGUI::getMultiSelection ( )

protected

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

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

Referenced by activate(), activateInCard(), deactivate(), and deactivateInCard().

                                           : array
     {
         $ids = $this->request->getBadgeIds();
         if (count($ids) > 0) {
             $res = [];
             foreach ($ids as $id) {
                 $ass = new ilBadgeAssignment($id, $this->user->getId());
                 if ($ass->getTimestamp()) {
                     $res[] = $ass;
                 }
             }
 
             return $res;
         }
 
         $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
         $this->ctrl->redirect($this, 'manageBadges');
     }

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 96 of file class.ilBadgeProfileGUI.php.

                                          : array
     {
         return [];
     }

◆ 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 101 of file class.ilBadgeProfileGUI.php.

                                           : array
     {
         return ['action'];
     }

◆ initSettingsForm()

ilBadgeProfileGUI::initSettingsForm ( )

protected

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

References $ctrl, $lng, getBackpackMail(), ilFormPropertyGUI\setInfo(), and ilLanguage\txt().

Referenced by saveSettings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listBackpackGroups()

ilBadgeProfileGUI::listBackpackGroups ( )

protected

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

References $ctrl, $lng, $tabs, $tpl, ilDatePresentation\formatDate(), getBackpackMail(), setBackpackSubTabs(), ILIAS\UICore\GlobalTemplate\setContent(), ilDatePresentation\setUseRelativeDates(), and ilLanguage\txt().

                                            : void
     {
         $lng = $this->lng;
         $tpl = $this->tpl;
         $ilCtrl = $this->ctrl;
         $ilTabs = $this->tabs;
 
         $this->setBackpackSubTabs();
         $ilTabs->activateSubTab('backpack_badges');
 
         $this->tpl->setOnScreenMessage('info', $lng->txt('badge_backpack_gallery_info'));
 
         $bp = new ilBadgeBackpack($this->getBackpackMail());
         $bp_groups = $bp->getGroups();
 
         if (!count($bp_groups)) {
             $this->tpl->setOnScreenMessage('info', $lng->txt('badge_backpack_no_groups'));
             return;
         }
 
         $tmpl = new ilTemplate('tpl.badge_backpack.html', true, true, 'components/ILIAS/Badge/');
 
         $tmpl->setVariable('BACKPACK_TITLE', $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 $idx => $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();
         }
 
         $tpl->setContent($tmpl->get());
     }

Here is the call graph for this function:

◆ listBadges()

ilBadgeProfileGUI::listBadges ( )

protected

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

References renderDeck().

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

Here is the call graph for this function:

◆ manageBadges()

ilBadgeProfileGUI::manageBadges ( )

protected

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

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ renderDeck()

ilBadgeProfileGUI::renderDeck ( string $deck )

private

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

Referenced by listBadges().

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

Here is the caller graph for this function:

◆ saveSettings()

ilBadgeProfileGUI::saveSettings ( )

protected

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

References $ctrl, $lng, $user, ilObjUser\_writePref(), ilBadgeAssignment\clearBadgeCache(), editSettings(), getBackpackMail(), initSettingsForm(), and ilLanguage\txt().

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

Here is the call graph for this function:

◆ setBackpackSubTabs()

ilBadgeProfileGUI::setBackpackSubTabs ( )

protected

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

References $ctrl, $lng, $tabs, and ilLanguage\txt().

Referenced by listBackpackGroups().

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