Collaboration diagram for ilBadgeProfileGUI:

Public Member Functions
	__construct ()

	executeCommand ()

Data Fields
final const	BACKPACK_EMAIL = "badge_mozilla_bp"

Protected Member Functions
	setTabs ()

	getSubTabs (string $a_active)

	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

Class ilBadgeProfileGUI.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilBadgeProfileGUI::__construct ( )

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), 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 160 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, "manageBadges");
     }

Here is the call graph for this function:

◆ activateInCard()

ilBadgeProfileGUI::activateInCard ( )

protected

Definition at line 194 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 177 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 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:

◆ deactivateInCard()

ilBadgeProfileGUI::deactivateInCard ( )

protected

Definition at line 211 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 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 334 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 72 of file class.ilBadgeProfileGUI.php.

References $ctrl, $lng, ilLanguage\loadLanguageModule(), and setTabs().

                                     : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $lng->loadLanguageModule("badge");
 
         switch ($ilCtrl->getNextClass()) {
             default:
                 $this->setTabs();
                 $cmd = $ilCtrl->getCmd("listBadges");
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getBackpackMail()

ilBadgeProfileGUI::getBackpackMail ( )

protected

Definition at line 303 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 136 of file class.ilBadgeProfileGUI.php.

References $ctrl, $id, $lng, $res, $user, and ilLanguage\txt().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubTabs()

ilBadgeProfileGUI::getSubTabs ( string $a_active )

protected

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

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

                                                    : void
     {
         $ilTabs = $this->tabs;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         $ilTabs->addTab(
             "list",
             $lng->txt("badge_profile_view"),
             $ilCtrl->getLinkTarget($this, "listBadges")
         );
         $ilTabs->addTab(
             "manage",
             $lng->txt("badge_profile_manage"),
             $ilCtrl->getLinkTarget($this, "manageBadges")
         );
         $ilTabs->activateTab($a_active);
     }

Here is the call graph for this function:

◆ initSettingsForm()

ilBadgeProfileGUI::initSettingsForm ( )

protected

Definition at line 314 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 249 of file class.ilBadgeProfileGUI.php.

References $ctrl, $lng, $tabs, $tpl, ilDatePresentation\formatDate(), getBackpackMail(), setBackpackSubTabs(), ilGlobalTemplateInterface\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, "Services/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 114 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 127 of file class.ilBadgeProfileGUI.php.

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

                                      : void
     {
         global $DIC;
 
         $table = new ilBadgePersonalTableGUI($this, "manageBadges");
         (new PresentationHeader($DIC, self::class))->show($this->lng->txt('table_view'));
         $this->tpl->setContent($table->getHTML());
     }

Here is the call graph for this function:

◆ renderDeck()

ilBadgeProfileGUI::renderDeck ( string $deck )

private

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

Referenced by listBadges().

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

Here is the caller graph for this function:

◆ saveSettings()

ilBadgeProfileGUI::saveSettings ( )

protected

Definition at line 343 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 228 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");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTabs()

ilBadgeProfileGUI::setTabs ( )

protected

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

References $ctrl, $lng, and $tabs.

Referenced by executeCommand().

                                 : void
     {
         $ilTabs = $this->tabs;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
     }

Here is the caller graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilBadgeProfileGUI::$access

protected

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

◆ $ctrl

ilCtrl ilBadgeProfileGUI::$ctrl

protected

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

Referenced by activate(), activateInCard(), deactivate(), deactivateInCard(), editSettings(), executeCommand(), getMultiSelection(), getSubTabs(), initSettingsForm(), listBackpackGroups(), saveSettings(), setBackpackSubTabs(), and setTabs().

◆ $factory

ILIAS UI Factory ilBadgeProfileGUI::$factory

protected

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

◆ $lng

ilLanguage ilBadgeProfileGUI::$lng

protected

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

Referenced by activate(), activateInCard(), deactivate(), deactivateInCard(), executeCommand(), getMultiSelection(), getSubTabs(), initSettingsForm(), listBackpackGroups(), saveSettings(), setBackpackSubTabs(), and setTabs().

◆ $noti_repo

BadgeNotificationPrefRepository ilBadgeProfileGUI::$noti_repo

protected

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

◆ $renderer

ILIAS UI Renderer ilBadgeProfileGUI::$renderer

protected

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

◆ $request

ilBadgeGUIRequest ilBadgeProfileGUI::$request

protected

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

◆ $tabs

ilTabsGUI ilBadgeProfileGUI::$tabs

protected

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

Referenced by editSettings(), getSubTabs(), listBackpackGroups(), setBackpackSubTabs(), and setTabs().

◆ $tile_view

readonly TileView ilBadgeProfileGUI::$tile_view

private

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

◆ $tpl

ilGlobalTemplateInterface ilBadgeProfileGUI::$tpl

protected

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

Referenced by editSettings(), and listBackpackGroups().

◆ $user

ilObjUser ilBadgeProfileGUI::$user

protected

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

Referenced by getBackpackMail(), getMultiSelection(), and saveSettings().

◆ BACKPACK_EMAIL

final const ilBadgeProfileGUI::BACKPACK_EMAIL = "badge_mozilla_bp"

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

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

Services/Badge/classes/class.ilBadgeProfileGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activate()

◆ activateInCard()

◆ deactivate()

◆ deactivateInCard()

◆ editSettings()

◆ executeCommand()

◆ getBackpackMail()

◆ getMultiSelection()

◆ getSubTabs()

◆ initSettingsForm()

◆ listBackpackGroups()

◆ listBadges()

◆ manageBadges()

◆ renderDeck()

◆ saveSettings()

◆ setBackpackSubTabs()

◆ setTabs()

Field Documentation

◆ $access

◆ $ctrl

◆ $factory

◆ $lng

◆ $noti_repo

◆ $renderer

◆ $request

◆ $tabs

◆ $tile_view

◆ $tpl

◆ $user

◆ BACKPACK_EMAIL