Collaboration diagram for ilBadgeProfileGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	executeCommand ()

Data Fields
const	BACKPACK_EMAIL = "badge_mozilla_bp"

Protected Member Functions
	setTabs ()

	getSubTabs ($a_active)

	listBadges ()

	manageBadges ()

	applyFilter ()

	resetFilter ()

	getMultiSelection ()

	activate ()

	deactivate ()

	activateInCard ()

	deactivateInCard ()

	addToBackpackMulti ()

	setBackpackSubTabs ()

	listBackpackGroups ()

	prepareBadge ($a_badge_id)

	addToBackpack ()

	getBackpackMail ()

	initSettingsForm ()

	editSettings (ilPropertyFormGUI $a_form=null)

	saveSettings ()

Protected Attributes
	$ctrl

	$lng

	$tpl

	$tabs

	$user

	$access

	$factory

	$renderer

	$noti_repo

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

Constructor & Destructor Documentation

◆ __construct()

ilBadgeProfileGUI::__construct ( )

Constructor.

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

References $DIC, and 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->noti_repo = new \ILIAS\Badge\Notification\BadgeNotificationPrefRepository();
     }

Here is the call graph for this function:

Member Function Documentation

◆ activate()

ilBadgeProfileGUI::activate ( )

protected

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

References $ctrl, $ilCtrl, $lng, and getMultiSelection().

     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         
         foreach ($this->getMultiSelection() as $ass) {
             // already active?
             if (!$ass->getPosition()) {
                 $ass->setPosition(999);
                 $ass->store();
             }
         }
         
         ilUtil::sendSuccess($lng->txt("settings_saved"), true);
         $ilCtrl->redirect($this, "manageBadges");
     }

Here is the call graph for this function:

◆ activateInCard()

ilBadgeProfileGUI::activateInCard ( )

protected

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

References $ctrl, $ilCtrl, $lng, and getMultiSelection().

     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         foreach ($this->getMultiSelection() as $ass) {
             // already active?
             if (!$ass->getPosition()) {
                 $ass->setPosition(999);
                 $ass->store();
             }
         }
 
         ilUtil::sendSuccess($lng->txt("settings_saved"), true);
         $ilCtrl->redirect($this, "listBadges");
     }

Here is the call graph for this function:

◆ addToBackpack()

ilBadgeProfileGUI::addToBackpack ( )

protected

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

References $_GET, $ctrl, $ilCtrl, $res, $url, exit, ilBadgeHandler\getInstance(), and prepareBadge().

     {
         $ilCtrl = $this->ctrl;
         
         if (!$ilCtrl->isAsynch() ||
             !ilBadgeHandler::getInstance()->isObiActive()) {
             return false;
         }
         
         $res = new stdClass();
         
         $url = false;
         $badge_id = (int) $_GET["id"];
         if ($badge_id) {
             $url = $this->prepareBadge($badge_id);
         }
         
         if ($url !== false) {
             $res->error = false;
             $res->url = $url;
         } else {
             $res->error = true;
             $res->message = "missing badge id";
         }
         
         echo json_encode($res);
         exit();
     }

Here is the call graph for this function:

◆ addToBackpackMulti()

ilBadgeProfileGUI::addToBackpackMulti ( )

protected

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

References $ctrl, $ilCtrl, $lng, $res, $tabs, $tpl, $url, getMultiSelection(), ilBadge\getTitle(), prepareBadge(), and ilUtil\sendInfo().

     {
         $tpl = $this->tpl;
         $ilTabs = $this->tabs;
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         
         $res = array();
         foreach ($this->getMultiSelection() as $ass) {
             $url = $this->prepareBadge($ass->getBadgeId());
             if ($url !== false) {
                 $badge = new ilBadge($ass->getBadgeId());
                 $titles[] = $badge->getTitle();
                 $res[] = $url;
             }
         }
         
         // :TODO: use local copy instead?
         $tpl->addJavascript("https://backpack.openbadges.org/issuer.js", false);
             
         $tpl->addJavascript("Services/Badge/js/ilBadge.js");
         $tpl->addOnloadCode("il.Badge.publishMulti(['" . implode("','", $res) . "']);");
         
         $ilTabs->clearTargets();
         $ilTabs->setBackTarget(
             $lng->txt("back"),
             $ilCtrl->getLinkTarget($this, "manageBadges")
         );
         
         ilUtil::sendInfo(sprintf($lng->txt("badge_add_to_backpack_multi"), implode(", ", $titles)));
     }

Here is the call graph for this function:

◆ applyFilter()

ilBadgeProfileGUI::applyFilter ( )

protected

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

References manageBadges().

     {
         $tbl = new ilBadgePersonalTableGUI($this, "manageBadges");
         $tbl->resetOffset();
         $tbl->writeFilterToSession();
         $this->manageBadges();
     }

Here is the call graph for this function:

◆ deactivate()

ilBadgeProfileGUI::deactivate ( )

protected

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

References $ctrl, $ilCtrl, $lng, and getMultiSelection().

     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         
         foreach ($this->getMultiSelection() as $ass) {
             // already inactive?
             if ($ass->getPosition()) {
                 $ass->setPosition(null);
                 $ass->store();
             }
         }
         
         ilUtil::sendSuccess($lng->txt("settings_saved"), true);
         $ilCtrl->redirect($this, "manageBadges");
     }

Here is the call graph for this function:

◆ deactivateInCard()

ilBadgeProfileGUI::deactivateInCard ( )

protected

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

References $ctrl, $ilCtrl, $lng, and getMultiSelection().

     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         foreach ($this->getMultiSelection() as $ass) {
             // already inactive?
             if ($ass->getPosition()) {
                 $ass->setPosition(null);
                 $ass->store();
             }
         }
 
         ilUtil::sendSuccess($lng->txt("settings_saved"), true);
         $ilCtrl->redirect($this, "listBadges");
     }

Here is the call graph for this function:

◆ editSettings()

ilBadgeProfileGUI::editSettings ( ilPropertyFormGUI $a_form = null )

protected

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

References $ctrl, $ilCtrl, $tabs, $tpl, ilBadgeHandler\getInstance(), initSettingsForm(), and setBackpackSubTabs().

Referenced by saveSettings().

     {
         $tpl = $this->tpl;
         $ilCtrl = $this->ctrl;
         $ilTabs = $this->tabs;
         
         if (!ilBadgeHandler::getInstance()->isObiActive()) {
             $ilCtrl->redirect($this, "listBadges");
         }
         
         $this->setBackpackSubTabs();
         $ilTabs->activateSubTab("backpack_settings");
     
         if (!$a_form) {
             $a_form = $this->initSettingsForm();
         }
         
         $tpl->setContent($a_form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilBadgeProfileGUI::executeCommand ( )

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

References $ctrl, $ilCtrl, $lng, $tpl, and setTabs().

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $tpl = $this->tpl;
         
         $lng->loadLanguageModule("badge");
         
         //$tpl->setTitle($lng->txt("obj_bdga"));
         //$tpl->setTitleIcon(ilUtil::getImagePath("icon_bdga.svg"));
                                 
         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 543 of file class.ilBadgeProfileGUI.php.

References $ilUser, and $user.

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

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

Here is the caller graph for this function:

◆ getMultiSelection()

ilBadgeProfileGUI::getMultiSelection ( )

protected

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

References $_GET, $_POST, $ctrl, $ilCtrl, $ilUser, $lng, $res, $user, and ilUtil\sendFailure().

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

     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         $ilUser = $this->user;
         
         $ids = $_POST["badge_id"];
         if (!$ids && is_numeric($_GET["badge_id"])) {
             $ids = array($_GET["badge_id"]);
         }
         if (is_array($ids)) {
             $res = array();
             foreach ($ids as $id) {
                 $ass = new ilBadgeAssignment($id, $ilUser->getId());
                 if ($ass->getTimestamp()) {
                     $res[] = $ass;
                 }
             }
             
             return $res;
         } else {
             ilUtil::sendFailure($lng->txt("select_one"), true);
             $ilCtrl->redirect($this, "manageBadges");
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubTabs()

ilBadgeProfileGUI::getSubTabs ( $a_active )

protected

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

References $ctrl, $ilCtrl, $lng, $tabs, and ilBadgeHandler\getInstance().

Referenced by listBadges(), and manageBadges().

     {
         $ilTabs = $this->tabs;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         if (ilBadgeHandler::getInstance()->isObiActive()) {
             $ilTabs->addSubTab(
                 "list",
                 $lng->txt("badge_profile_view"),
                 $ilCtrl->getLinkTarget($this, "listBadges")
             );
             $ilTabs->addSubTab(
                 "manage",
                 $lng->txt("badge_profile_manage"),
                 $ilCtrl->getLinkTarget($this, "manageBadges")
             );
             $ilTabs->activateTab("ilias_badges");
             $ilTabs->activateSubTab($a_active);
         } else {
             $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:

Here is the caller graph for this function:

◆ initSettingsForm()

ilBadgeProfileGUI::initSettingsForm ( )

protected

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

References $ctrl, $email, $ilCtrl, $lng, and getBackpackMail().

Referenced by editSettings(), and saveSettings().

     {
         $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 432 of file class.ilBadgeProfileGUI.php.

References $ctrl, $ilCtrl, $lng, $tabs, $tpl, ilDatePresentation\formatDate(), getBackpackMail(), ilBadgeHandler\getInstance(), ilUtil\sendInfo(), setBackpackSubTabs(), and ilDatePresentation\setUseRelativeDates().

     {
         $lng = $this->lng;
         $tpl = $this->tpl;
         $ilCtrl = $this->ctrl;
         $ilTabs = $this->tabs;
         
         if (!ilBadgeHandler::getInstance()->isObiActive()) {
             $ilCtrl->redirect($this, "listBadges");
         }
                 
         $this->setBackpackSubTabs();
         $ilTabs->activateSubTab("backpack_badges");
         
         ilUtil::sendInfo($lng->txt("badge_backpack_gallery_info"));
                 
         $bp = new ilBadgeBackpack($this->getBackpackMail());
         $bp_groups = $bp->getGroups();
 
         if (!is_array($bp_groups)) {
             ilUtil::sendInfo(sprintf($lng->txt("badge_backpack_connect_failed"), $this->getBackpackMail()));
             return;
         } elseif (!sizeof($bp_groups)) {
             ilUtil::sendInfo($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 (sizeof($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 158 of file class.ilBadgeProfileGUI.php.

References $data, $ilUser, $tpl, $url, $user, ilObject\_getAllReferences(), ilLink\_getLink(), ilBadgeAssignment\getInstancesByUserId(), getSubTabs(), ilDatePresentation\setUseRelativeDates(), and ilUtil\sortArray().

     {
         $tpl = $this->tpl;
         $ilUser = $this->user;
             
         $this->getSubTabs("list");
         
         $data = array();
         
         // see ilBadgePersonalTableGUI::getItems()
         foreach (ilBadgeAssignment::getInstancesByUserId($ilUser->getId()) as $ass) {
             $badge = new ilBadge($ass->getBadgeId());
             
             $data[] = array(
                 "id" => $badge->getId(),
                 "title" => $badge->getTitle(),
                 "description" => $badge->getDescription(),
                 "image" => $badge->getImagePath(),
                 "name" => $badge->getImage(),
                 "issued_on" => $ass->getTimestamp(),
                 "active" => (bool) $ass->getPosition(),
                 "object" => $badge->getParentMeta(),
                 "renderer" => new ilBadgeRenderer($ass)
             );
         }
         
         // :TODO:
         $data = ilUtil::sortArray($data, "issued_on", "desc", true);
 
         $tmpl = new ilTemplate("tpl.badge_backpack.html", true, true, "Services/Badge");
 
         ilDatePresentation::setUseRelativeDates(false);
 
         $cards = array();
         $badge_components = array();
 
         foreach ($data as $badge) {
             $modal = $this->factory->modal()->roundtrip(
                 $badge["title"],
                 $this->factory->legacy($badge["renderer"]->renderModalContent())
             )->withCancelButtonLabel("ok");
             $image = $this->factory->image()->responsive($badge["image"], $badge["name"])
                 ->withAction($modal->getShowSignal());
 
             $this->ctrl->setParameter($this, "badge_id", $badge["id"]);
             $url = $this->ctrl->getLinkTarget($this, $badge["active"]
                 ? "deactivateInCard"
                 : "activateInCard");
             $this->ctrl->setParameter($this, "badge_id", "");
             $profile_button = $this->factory->button()->standard(
                 $this->lng->txt(!$badge["active"] ? "badge_add_to_profile" : "badge_remove_from_profile"),
                 $url
             );
 
             if ($badge["object"]["type"] != "bdga") {
                 $parent_icon = $this->factory->symbol()->icon()->custom(
                     ilObject::_getIcon($badge["object"]["id"], "big", $badge["object"]["type"]),
                     $this->lng->txt("obj_" . $badge["object"]["type"]),
                     "medium"
                 );
 
                 $parent_ref_id = array_shift(ilObject::_getAllReferences($badge["object"]["id"]));
                 if ($this->access->checkAccess("read", "", $parent_ref_id)) {
                     $parent_link = $this->factory->link()->standard($badge["object"]["title"], ilLink::_getLink($parent_ref_id));
                 } else {
                     $parent_link = $this->factory->legacy($badge["object"]["title"]);
                 }
 
                 $badge_sections = [
                     $this->factory->listing()->descriptive([
                         $this->lng->txt("object") => $this->factory->legacy(
                             $this->renderer->render($parent_icon) . $this->renderer->render($parent_link)
                         )
                     ]),
                     $profile_button
                 ];
             } else {
                 $badge_sections = [$profile_button];
             }
 
             $cards[] = $this->factory->card()->standard($badge["title"], $image)->withSections($badge_sections)
                 ->withTitleAction($modal->getShowSignal());
 
             $badge_components[] = $modal;
         }
 
         $deck = $this->factory->deck($cards)->withNormalCardsSize();
         $badge_components[] = $deck;
 
         $tmpl->setVariable("DECK", $this->renderer->render($badge_components));
         $tpl->setContent($tmpl->get());
 
         $this->noti_repo->updateLastCheckedTimestamp();
     }

Here is the call graph for this function:

◆ manageBadges()

ilBadgeProfileGUI::manageBadges ( )

protected

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

References $tpl, and getSubTabs().

Referenced by applyFilter(), and resetFilter().

     {
         $tpl = $this->tpl;
             
         $this->getSubTabs("manage");
         
         $tbl = new ilBadgePersonalTableGUI($this, "manageBadges");
         
         $tpl->setContent($tbl->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareBadge()

ilBadgeProfileGUI::prepareBadge ( $a_badge_id )

protected

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

References $ilUser, $url, and $user.

Referenced by addToBackpack(), and addToBackpackMulti().

     {
         $ilUser = $this->user;
         
         // check if current user has given badge
         $ass = new ilBadgeAssignment($a_badge_id, $ilUser->getId());
         if ($ass->getTimestamp()) {
             $url = null;
             try {
                 $url = $ass->getStaticUrl();
             } catch (Exception $ex) {
             }
             if ($url) {
                 return $url;
             }
         }
         
         return false;
     }

Here is the caller graph for this function:

◆ resetFilter()

ilBadgeProfileGUI::resetFilter ( )

protected

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

References manageBadges().

     {
         $tbl = new ilBadgePersonalTableGUI($this, "manageBadges");
         $tbl->resetOffset();
         $tbl->resetFilter();
         $this->manageBadges();
     }

Here is the call graph for this function:

◆ saveSettings()

ilBadgeProfileGUI::saveSettings ( )

protected

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

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

     {
         $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());
             }
                     
             ilUtil::sendSuccess($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 411 of file class.ilBadgeProfileGUI.php.

References $ctrl, $ilCtrl, $lng, and $tabs.

Referenced by editSettings(), and listBackpackGroups().

     {
         $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 caller graph for this function:

◆ setTabs()

ilBadgeProfileGUI::setTabs ( )

protected

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

References $ctrl, $ilCtrl, $lng, $tabs, and ilBadgeHandler\getInstance().

Referenced by executeCommand().

     {
         $ilTabs = $this->tabs;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         if (ilBadgeHandler::getInstance()->isObiActive()) {
             $ilTabs->addTab(
                 "ilias_badges",
                 $lng->txt("badge_personal_badges"),
                 $ilCtrl->getLinkTarget($this, "listBadges")
             );
 
             $ilTabs->addTab(
                 "backpack_badges",
                 $lng->txt("badge_backpack_list"),
                 $ilCtrl->getLinkTarget($this, "listBackpackGroups")
             );
         }
     }