Collaboration diagram for ilBadgeManagementGUI:

Public Member Functions
	__construct (private readonly int $parent_ref_id, int $a_parent_obj_id=null, string $a_parent_obj_type=null)

	executeCommand ()

Protected Member Functions
	setTabs (string $a_active)

	hasWrite ()

	listBadges ()

	applyBadgeFilter ()

	resetBadgeFilter ()

	addBadge (ilPropertyFormGUI $a_form=null)

	initBadgeForm (string $a_mode, ilBadgeType $a_type, string $a_type_unique_id)

	saveBadge ()

	editBadge (ilPropertyFormGUI $a_form=null)

	setBadgeFormValues (ilPropertyFormGUI $a_form, ilBadge $a_badge, ilBadgeType $a_type)

	updateBadge ()

	confirmDeleteBadges ()

	deleteBadges ()

	getBadgesFromMultiAction ()

	copyBadges ()

	clearClipboard ()

	getValidBadgesFromClipboard ()

	pasteBadges ()

	toggleBadges (bool $a_status)

	activateBadges ()

	deactivateBadges ()

	listUsers ()

	applyListUsers ()

	resetListUsers ()

	awardBadgeUserSelection ()

	applyAwardBadgeUserSelection ()

	resetAwardBadgeUserSelection ()

	assignBadge ()

	confirmDeassignBadge ()

	deassignBadge ()

Private Attributes
ilBadgeGUIRequest	$request

ilBadgeManagementSessionRepository	$session_repo

ilLanguage	$lng

ilCtrl	$ctrl

ilTabsGUI	$tabs

ilAccessHandler	$access

ilToolbarGUI	$toolbar

ilGlobalTemplateInterface	$tpl

ilObjUser	$user

ILIAS UI Factory	$ui_factory

int	$parent_obj_id

string	$parent_obj_type

Detailed Description

Class ilBadgeManagementGUI.

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

Definition at line 27 of file class.ilBadgeManagementGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBadgeManagementGUI::__construct	(	private readonly int	$parent_ref_id,
		int	$a_parent_obj_id = `null`,
		string	$a_parent_obj_type = `null`
	)

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

References $DIC, ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilBadgeHandler\getInstance(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
         $this->tabs = $DIC->tabs();
         $this->access = $DIC->access();
         $this->toolbar = $DIC->toolbar();
         $this->ui_factory = $DIC->ui()->factory();
         $this->tpl = $DIC['tpl'];
         $this->user = $DIC->user();
         $lng = $DIC->language();
         $this->parent_obj_id = $a_parent_obj_id
             ?: ilObject::_lookupObjId($parent_ref_id);
         $this->parent_obj_type = $a_parent_obj_type
             ?: ilObject::_lookupType($this->parent_obj_id);
 
         if (!ilBadgeHandler::getInstance()->isObjectActive($this->parent_obj_id)) {
             throw new ilException('inactive object');
         }
 
         $lng->loadLanguageModule('badge');
 
         $this->request = new ilBadgeGUIRequest(
             $DIC->http(),
             $DIC->refinery()
         );
 
         $this->session_repo = new ilBadgeManagementSessionRepository();
     }

Here is the call graph for this function:

Member Function Documentation

◆ activateBadges()

ilBadgeManagementGUI::activateBadges ( )

protected

Definition at line 677 of file class.ilBadgeManagementGUI.php.

References toggleBadges().

                                        : void
     {
         $this->toggleBadges(true);
     }

Here is the call graph for this function:

◆ addBadge()

ilBadgeManagementGUI::addBadge ( ilPropertyFormGUI $a_form = null )

protected

Definition at line 231 of file class.ilBadgeManagementGUI.php.

References $ctrl, $handler, $tpl, ilBadgeHandler\getInstance(), hasWrite(), initBadgeForm(), and ilGlobalTemplateInterface\setContent().

Referenced by saveBadge().

                                                                  : void
     {
         $ilCtrl = $this->ctrl;
         $tpl = $this->tpl;
 
         $type_id = $this->request->getType();
         if (!$type_id ||
             !$this->hasWrite()) {
             $ilCtrl->redirect($this, 'listBadges');
         }
 
         $ilCtrl->setParameter($this, 'type', $type_id);
 
         $handler = ilBadgeHandler::getInstance();
         $type = $handler->getTypeInstanceByUniqueId($type_id);
         if (!$type) {
             $ilCtrl->redirect($this, 'listBadges');
         }
 
         if (!$a_form) {
             $a_form = $this->initBadgeForm('create', $type, $type_id);
         }
 
         $tpl->setContent($a_form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyAwardBadgeUserSelection()

ilBadgeManagementGUI::applyAwardBadgeUserSelection ( )

protected

Definition at line 776 of file class.ilBadgeManagementGUI.php.

References awardBadgeUserSelection().

                                                      : void
     {
         $tbl = new ilBadgeUserTableGUI($this, 'awardBadgeUserSelection', $this->parent_ref_id);
         $tbl->resetOffset();
         $tbl->writeFilterToSession();
         $this->awardBadgeUserSelection();
     }

Here is the call graph for this function:

◆ applyBadgeFilter()

ilBadgeManagementGUI::applyBadgeFilter ( )

protected

Definition at line 210 of file class.ilBadgeManagementGUI.php.

References hasWrite(), and listBadges().

                                          : void
     {
         $tbl = new ilBadgeTableGUI($this, 'listBadges', $this->parent_obj_id, $this->hasWrite());
         $tbl->resetOffset();
         $tbl->writeFilterToSession();
         $this->listBadges();
     }

Here is the call graph for this function:

◆ applyListUsers()

ilBadgeManagementGUI::applyListUsers ( )

protected

Definition at line 720 of file class.ilBadgeManagementGUI.php.

References listUsers().

                                        : void
     {
         $tbl = new ilBadgeUserTableGUI($this, 'listUsers', $this->parent_ref_id);
         $tbl->resetOffset();
         $tbl->writeFilterToSession();
         $this->listUsers();
     }

Here is the call graph for this function:

◆ assignBadge()

ilBadgeManagementGUI::assignBadge ( )

protected

Definition at line 792 of file class.ilBadgeManagementGUI.php.

References $ctrl, $lng, $user, ilBadgeAssignment\exists(), ilBadgeHandler\getInstance(), hasWrite(), and ilLanguage\txt().

                                     : void
     {
         $ilCtrl = $this->ctrl;
         $ilUser = $this->user;
         $lng = $this->lng;
 
         $user_ids = $this->request->getIds();
         $badge_id = $this->request->getBadgeId();
         if (!$user_ids ||
             !$badge_id ||
             !$this->hasWrite()) {
             $ilCtrl->redirect($this, 'listUsers');
         }
 
         $new_badges = [];
         foreach ($user_ids as $user_id) {
             if (!ilBadgeAssignment::exists($badge_id, (int) $user_id)) {
                 $ass = new ilBadgeAssignment($badge_id, (int) $user_id);
                 $ass->setAwardedBy($ilUser->getId());
                 $ass->store();
 
                 $new_badges[$user_id][] = $badge_id;
             }
         }
 
         ilBadgeHandler::getInstance()->sendNotification($new_badges, $this->parent_ref_id);
 
         $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
         $ilCtrl->redirect($this, 'listUsers');
     }

Here is the call graph for this function:

◆ awardBadgeUserSelection()

ilBadgeManagementGUI::awardBadgeUserSelection ( )

protected

Definition at line 736 of file class.ilBadgeManagementGUI.php.

References $ctrl, $lng, $tabs, $tpl, ilBadgeHandler\getInstance(), hasWrite(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

Referenced by applyAwardBadgeUserSelection(), and resetAwardBadgeUserSelection().

                                                 : void
     {
         $ilCtrl = $this->ctrl;
         $tpl = $this->tpl;
         $ilTabs = $this->tabs;
         $lng = $this->lng;
 
         $bid = $this->request->getBadgeId();
         if (!$bid ||
             !$this->hasWrite()) {
             $ilCtrl->redirect($this, 'listUsers');
         }
 
         $manual = array_keys(
             ilBadgeHandler::getInstance()->getAvailableManualBadges($this->parent_obj_id, $this->parent_obj_type)
         );
         if (!in_array($bid, $manual, true)) {
             $ilCtrl->redirect($this, 'listUsers');
         }
 
         $back_target = 'listUsers';
         if ($this->request->getTgt() === 'bdgl') {
             $ilCtrl->saveParameter($this, 'tgt');
             $back_target = 'listBadges';
         }
 
         $ilTabs->clearTargets();
         $ilTabs->setBackTarget(
             $lng->txt('back'),
             $ilCtrl->getLinkTarget($this, $back_target)
         );
 
         $ilCtrl->setParameter($this, 'bid', $bid);
 
         $badge = new ilBadge($bid);
 
         $tbl = new ilBadgeUserTableGUI($this, 'awardBadgeUserSelection', $this->parent_ref_id, $badge);
         $tpl->setContent($tbl->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearClipboard()

ilBadgeManagementGUI::clearClipboard ( )

protected

Definition at line 617 of file class.ilBadgeManagementGUI.php.

References $ctrl, and ilCtrl\redirect().

                                        : void
     {
         $ilCtrl = $this->ctrl;
 
         $this->session_repo->clear();
         $ilCtrl->redirect($this, 'listBadges');
     }

Here is the call graph for this function:

◆ confirmDeassignBadge()

ilBadgeManagementGUI::confirmDeassignBadge ( )

protected

Definition at line 823 of file class.ilBadgeManagementGUI.php.

References $ctrl, $lng, $tabs, $tpl, ilTabsGUI\clearTargets(), ilBadgeAssignment\getAssignedUsers(), ilUserUtil\getNamePresentation(), hasWrite(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                              : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $tpl = $this->tpl;
         $ilTabs = $this->tabs;
 
         $user_ids = $this->request->getIds();
         $badge_id = $this->request->getBadgeId();
         if (!$user_ids ||
             !$badge_id ||
             !$this->hasWrite()) {
             $ilCtrl->redirect($this, 'listUsers');
         }
 
         $ilTabs->clearTargets();
         $ilTabs->setBackTarget(
             $lng->txt('back'),
             $ilCtrl->getLinkTarget($this, 'listUsers')
         );
 
         $badge = new ilBadge($badge_id);
 
         $ilCtrl->setParameter($this, 'bid', $badge->getId());
 
         $confirmation_gui = new ilConfirmationGUI();
         $confirmation_gui->setFormAction($ilCtrl->getFormAction($this));
         $confirmation_gui->setHeaderText(
             sprintf($lng->txt('badge_assignment_deletion_confirmation'), $badge->getTitle())
         );
         $confirmation_gui->setCancel($lng->txt('cancel'), 'listUsers');
         $confirmation_gui->setConfirm($lng->txt('delete'), 'deassignBadge');
 
         $assigned_users = ilBadgeAssignment::getAssignedUsers($badge->getId());
 
         foreach ($user_ids as $user_id) {
             if (in_array($user_id, $assigned_users)) {
                 $confirmation_gui->addItem(
                     'id[]',
                     $user_id,
                     ilUserUtil::getNamePresentation($user_id, false, false, '', true)
                 );
             }
         }
 
         $tpl->setContent($confirmation_gui->getHTML());
     }

Here is the call graph for this function:

◆ confirmDeleteBadges()

ilBadgeManagementGUI::confirmDeleteBadges ( )

protected

Definition at line 531 of file class.ilBadgeManagementGUI.php.

References $ctrl, $lng, $tabs, $tpl, getBadgesFromMultiAction(), ilBadgeAssignment\getInstancesByBadgeId(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                             : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $tpl = $this->tpl;
         $ilTabs = $this->tabs;
 
         $badge_ids = $this->getBadgesFromMultiAction();
 
         $ilTabs->clearTargets();
         $ilTabs->setBackTarget(
             $lng->txt('back'),
             $ilCtrl->getLinkTarget($this, 'listBadges')
         );
 
         $confirmation_gui = new ilConfirmationGUI();
         $confirmation_gui->setFormAction($ilCtrl->getFormAction($this));
         $confirmation_gui->setHeaderText($lng->txt('badge_deletion_confirmation'));
         $confirmation_gui->setCancel($lng->txt('cancel'), 'listBadges');
         $confirmation_gui->setConfirm($lng->txt('delete'), 'deleteBadges');
 
         foreach ($badge_ids as $badge_id) {
             $badge = new ilBadge($badge_id);
             $confirmation_gui->addItem(
                 'id[]',
                 (string) $badge_id,
                 $badge->getTitle() .
                 ' (' . count(ilBadgeAssignment::getInstancesByBadgeId($badge_id)) . ')'
             );
         }
 
         $tpl->setContent($confirmation_gui->getHTML());
     }

Here is the call graph for this function:

◆ copyBadges()

ilBadgeManagementGUI::copyBadges ( )

protected

Definition at line 602 of file class.ilBadgeManagementGUI.php.

References $ctrl, and getBadgesFromMultiAction().

                                    : void
     {
         $ilCtrl = $this->ctrl;
 
         $badge_ids = $this->getBadgesFromMultiAction();
 
         $clip_ids = $this->session_repo->getBadgeIds();
         $clip_ids = array_unique(
             array_merge($clip_ids, $badge_ids)
         );
         $this->session_repo->setBadgeIds($clip_ids);
 
         $ilCtrl->redirect($this, 'listBadges');
     }

Here is the call graph for this function:

◆ deactivateBadges()

ilBadgeManagementGUI::deactivateBadges ( )

protected

Definition at line 682 of file class.ilBadgeManagementGUI.php.

References toggleBadges().

                                          : void
     {
         $this->toggleBadges(false);
     }

Here is the call graph for this function:

◆ deassignBadge()

ilBadgeManagementGUI::deassignBadge ( )

protected

Definition at line 871 of file class.ilBadgeManagementGUI.php.

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

                                       : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $user_ids = $this->request->getIds();
         $badge_id = $this->request->getBadgeId();
         if (!$user_ids ||
             !$badge_id ||
             !$this->hasWrite()) {
             $ilCtrl->redirect($this, 'listUsers');
         }
 
         foreach ($user_ids as $user_id) {
             $ass = new ilBadgeAssignment($badge_id, (int) $user_id);
             $ass->delete();
         }
 
         $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
         $ilCtrl->redirect($this, 'listUsers');
     }

Here is the call graph for this function:

◆ deleteBadges()

ilBadgeManagementGUI::deleteBadges ( )

protected

Definition at line 565 of file class.ilBadgeManagementGUI.php.

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

                                      : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $badge_ids = $this->getBadgesFromMultiAction();
 
         foreach ($badge_ids as $badge_id) {
             $badge = new ilBadge($badge_id);
             $badge->delete();
         }
 
         $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
         $ilCtrl->redirect($this, 'listBadges');
     }

Here is the call graph for this function:

◆ editBadge()

ilBadgeManagementGUI::editBadge ( ilPropertyFormGUI $a_form = null )

protected

Definition at line 429 of file class.ilBadgeManagementGUI.php.

References $ctrl, $lng, $tpl, ilBadgeHandler\getInstance(), hasWrite(), initBadgeForm(), setBadgeFormValues(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

Referenced by updateBadge().

                                                                   : void
     {
         $ilCtrl = $this->ctrl;
         $tpl = $this->tpl;
         $lng = $this->lng;
 
         $badge_id = $this->request->getBadgeId();
         if (!$badge_id ||
             !$this->hasWrite()) {
             $ilCtrl->redirect($this, 'listBadges');
         }
 
         $ilCtrl->setParameter($this, 'bid', $badge_id);
 
         $badge = new ilBadge($badge_id);
 
         $static_cnt = ilBadgeHandler::getInstance()->countStaticBadgeInstances($badge);
         if ($static_cnt) {
             $this->tpl->setOnScreenMessage('info', sprintf($lng->txt('badge_edit_with_published'), $static_cnt));
         }
 
         if (!$a_form) {
             $type = $badge->getTypeInstance();
             $a_form = $this->initBadgeForm('edit', $type, $badge->getTypeId());
             $this->setBadgeFormValues($a_form, $badge, $type);
         }
 
         $tpl->setContent($a_form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilBadgeManagementGUI::executeCommand ( )

Definition at line 77 of file class.ilBadgeManagementGUI.php.

References $ctrl, $handler, ilBadgeHandler\getInstance(), ilCtrl\getNextClass(), ilBadge\getTypeId(), initBadgeForm(), and setBadgeFormValues().

                                     : void
     {
         $ilCtrl = $this->ctrl;
 
         $next_class = $ilCtrl->getNextClass($this);
         $cmd = $ilCtrl->getCmd('listBadges');
 
         switch ($next_class) {
             case 'ilpropertyformgui':
                 // ajax - update
                 if ($this->request->getBadgeId()) {
                     $badge = new ilBadge($this->request->getBadgeId());
                     $type = $badge->getTypeInstance();
                     $form = $this->initBadgeForm('edit', $type, $badge->getTypeId());
                     $this->setBadgeFormValues($form, $badge, $type);
                 } // ajax- create
                 else {
                     $type_id = $this->request->getType();
                     $ilCtrl->setParameter($this, 'type', $type_id);
                     $handler = ilBadgeHandler::getInstance();
                     $type = $handler->getTypeInstanceByUniqueId($type_id);
                     $form = $this->initBadgeForm('create', $type, $type_id);
                 }
                 $ilCtrl->forwardCommand($form);
                 break;
 
             default:
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getBadgesFromMultiAction()

ilBadgeManagementGUI::getBadgesFromMultiAction ( )

protected

Returns: int[]

Definition at line 589 of file class.ilBadgeManagementGUI.php.

References $ctrl, hasWrite(), and ilCtrl\redirect().

Referenced by confirmDeleteBadges(), copyBadges(), deleteBadges(), and toggleBadges().

                                                  : array
     {
         $ilCtrl = $this->ctrl;
 
         $badge_ids = $this->request->getIds();
         if (!$badge_ids ||
             !$this->hasWrite()) {
             $ilCtrl->redirect($this, 'listBadges');
         }
 
         return $badge_ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getValidBadgesFromClipboard()

ilBadgeManagementGUI::getValidBadgesFromClipboard ( )

protected

Returns: ilBadge[]

Definition at line 628 of file class.ilBadgeManagementGUI.php.

References $res, and ilBadgeHandler\getInstance().

Referenced by listBadges(), and pasteBadges().

                                                     : array
     {
         $res = [];
 
         $valid_types = array_keys(ilBadgeHandler::getInstance()->getAvailableTypesForObjType($this->parent_obj_type));
 
         foreach ($this->session_repo->getBadgeIds() as $badge_id) {
             $badge = new ilBadge($badge_id);
             if (in_array($badge->getTypeId(), $valid_types, true)) {
                 $res[] = $badge;
             }
         }
 
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasWrite()

ilBadgeManagementGUI::hasWrite ( )

protected

Definition at line 130 of file class.ilBadgeManagementGUI.php.

References $access, and ilRBACAccessHandler\checkAccess().

Referenced by addBadge(), applyBadgeFilter(), assignBadge(), awardBadgeUserSelection(), confirmDeassignBadge(), deassignBadge(), editBadge(), getBadgesFromMultiAction(), listBadges(), listUsers(), pasteBadges(), resetBadgeFilter(), saveBadge(), and updateBadge().

                                  : bool
     {
         $ilAccess = $this->access;
         return $ilAccess->checkAccess('write', '', $this->parent_ref_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initBadgeForm()

ilBadgeManagementGUI::initBadgeForm	(	string	$a_mode,
		ilBadgeType	$a_type,
		string	$a_type_unique_id
	)

protected

Definition at line 257 of file class.ilBadgeManagementGUI.php.

References $ctrl, $lng, $valid, ilBadgeType\getCaption(), ilBadgeType\getConfigGUIInstance(), ilBadgeImageTemplate\getInstancesByType(), ilTextAreaInputGUI\setMaxNumOfChars(), ilFormPropertyGUI\setRequired(), ilFileInputGUI\setSuffixes(), and ilLanguage\txt().

Referenced by addBadge(), editBadge(), executeCommand(), saveBadge(), and updateBadge().

      : ilPropertyFormGUI {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         $form = new ilPropertyFormGUI();
         $form->setFormAction($ilCtrl->getFormAction($this, 'saveBadge'));
         $form->setTitle($lng->txt('badge_badge') . ' "' . $a_type->getCaption() . '"');
 
         $active = new ilCheckboxInputGUI($lng->txt('active'), 'act');
         $form->addItem($active);
 
         $title = new ilTextInputGUI($lng->txt('title'), 'title');
         $title->setMaxLength(255);
         $title->setRequired(true);
         $form->addItem($title);
 
         $desc = new ilTextAreaInputGUI($lng->txt('description'), 'desc');
         $desc->setMaxNumOfChars(4000);
         $desc->setRequired(true);
         $form->addItem($desc);
 
         $crit = new ilTextAreaInputGUI($lng->txt('badge_criteria'), 'crit');
         $crit->setMaxNumOfChars(4000);
         $crit->setRequired(true);
         $form->addItem($crit);
 
         if ($a_mode === 'create') {
             // upload
 
             $img_mode = new ilRadioGroupInputGUI($lng->txt('image'), 'img_mode');
             $img_mode->setRequired(true);
             $img_mode->setValue('tmpl');
             $form->addItem($img_mode);
 
             $img_mode_tmpl = new ilRadioOption($lng->txt('badge_image_from_template'), 'tmpl');
             $img_mode->addOption($img_mode_tmpl);
 
             $img_mode_up = new ilRadioOption($lng->txt('badge_image_from_upload'), 'up');
             $img_mode->addOption($img_mode_up);
 
             $img_upload = new ilImageFileInputGUI($lng->txt('file'), 'img');
             $img_upload->setRequired(true);
             $img_upload->setSuffixes(['png', 'svg']);
             $img_mode_up->addSubItem($img_upload);
 
             // templates
 
             $valid_templates = ilBadgeImageTemplate::getInstancesByType($a_type_unique_id);
             if (count($valid_templates)) {
                 $options = [];
                 $options[''] = $lng->txt('please_select');
                 foreach ($valid_templates as $tmpl) {
                     $options[$tmpl->getId()] = $tmpl->getTitle();
                 }
 
                 $tmpl = new ilSelectInputGUI($lng->txt('badge_image_template_form'), 'tmpl');
                 $tmpl->setRequired(true);
                 $tmpl->setOptions($options);
                 $img_mode_tmpl->addSubItem($tmpl);
             } else {
                 // no templates, activate upload
                 $img_mode_tmpl->setDisabled(true);
                 $img_mode->setValue('up');
             }
         } else {
             $img_upload = new ilImageFileInputGUI($lng->txt('image'), 'img');
             $img_upload->setSuffixes(['png', 'svg']);
             $img_upload->setAllowDeletion(false);
             $img_upload->setUseCache(false);
             $form->addItem($img_upload);
         }
 
         $valid = new ilTextInputGUI($lng->txt('badge_valid'), 'valid');
         $valid->setMaxLength(255);
         $form->addItem($valid);
 
         $custom = $a_type->getConfigGUIInstance();
         if ($custom instanceof ilBadgeTypeGUI) {
             $custom->initConfigForm($form, $this->parent_ref_id);
         }
 
         // :TODO: valid date/period
 
         if ($a_mode === 'create') {
             $form->addCommandButton('saveBadge', $lng->txt('save'));
         } else {
             $form->addCommandButton('updateBadge', $lng->txt('save'));
         }
         $form->addCommandButton('listBadges', $lng->txt('cancel'));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listBadges()

ilBadgeManagementGUI::listBadges ( )

protected

Definition at line 136 of file class.ilBadgeManagementGUI.php.

References $ctrl, $handler, $id, $lng, $toolbar, $tpl, ilTooltipGUI\addTooltip(), ilBadge\getExtendedTypeCaption(), ilBadgeHandler\getInstance(), getValidBadgesFromClipboard(), hasWrite(), ilLanguage\loadLanguageModule(), ilGlobalTemplateInterface\setContent(), setTabs(), and ilLanguage\txt().

Referenced by applyBadgeFilter(), and resetBadgeFilter().

                                    : void
     {
         $ilToolbar = $this->toolbar;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         $tpl = $this->tpl;
 
         $this->setTabs('badges');
 
         if ($this->hasWrite()) {
             $handler = ilBadgeHandler::getInstance();
             $valid_types = $handler->getAvailableTypesForObjType($this->parent_obj_type);
             if ($valid_types) {
                 $options = [];
                 foreach ($valid_types as $id => $type) {
                     $ilCtrl->setParameter($this, 'type', $id);
                     $options[$id] = $this->ui_factory->link()->standard(
                         $this->parent_obj_type !== 'bdga' ? ilBadge::getExtendedTypeCaption($type) : $type->getCaption(
                         ),
                         $ilCtrl->getLinkTarget($this, 'addBadge')
                     );
                     $ilCtrl->setParameter($this, 'type', null);
                 }
                 asort($options);
                 $options = array_values($options);
 
                 $ilToolbar->addComponent(
                     $this->ui_factory->dropdown()->standard($options)->withLabel($lng->txt('badge_create'))
                 );
             } else {
                 $this->tpl->setOnScreenMessage('info', $lng->txt('badge_no_valid_types_for_obj'));
             }
 
             $clip_ids = $this->session_repo->getBadgeIds();
             if (count($clip_ids) > 0) {
                 if ($valid_types) {
                     $ilToolbar->addSeparator();
                 }
 
                 $tt = [];
                 foreach ($this->getValidBadgesFromClipboard() as $badge) {
                     $tt[] = $badge->getTitle();
                 }
                 $ttid = 'bdgpst';
                 ilTooltipGUI::addTooltip(
                     $ttid,
                     implode('<br />', $tt),
                     '',
                     'bottom center',
                     'top center',
                     false
                 );
 
                 $lng->loadLanguageModule('content');
                 $ilToolbar->addButton(
                     $lng->txt('cont_paste_from_clipboard') .
                     ' (' . count($tt) . ')',
                     $ilCtrl->getLinkTarget($this, 'pasteBadges'),
                     '',
                     null,
                     '',
                     $ttid
                 );
                 $ilToolbar->addButton(
                     $lng->txt('clear_clipboard'),
                     $ilCtrl->getLinkTarget($this, 'clearClipboard')
                 );
             }
         }
 
         $tbl = new ilBadgeTableGUI($this, 'listBadges', $this->parent_obj_id, $this->hasWrite());
         $tpl->setContent($tbl->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listUsers()

ilBadgeManagementGUI::listUsers ( )

protected

Definition at line 692 of file class.ilBadgeManagementGUI.php.

References $ctrl, $lng, $toolbar, $tpl, ilBadgeHandler\getInstance(), hasWrite(), ilGlobalTemplateInterface\setContent(), ilSelectInputGUI\setOptions(), setTabs(), and ilLanguage\txt().

Referenced by applyListUsers(), and resetListUsers().

                                   : void
     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         $ilToolbar = $this->toolbar;
         $tpl = $this->tpl;
 
         $this->setTabs('users');
 
         if ($this->hasWrite()) {
             $manual = ilBadgeHandler::getInstance()->getAvailableManualBadges(
                 $this->parent_obj_id,
                 $this->parent_obj_type
             );
             if (count($manual)) {
                 $drop = new ilSelectInputGUI($lng->txt('badge_badge'), 'bid');
                 $drop->setOptions($manual);
                 $ilToolbar->addInputItem($drop, true);
 
                 $ilToolbar->setFormAction($ilCtrl->getFormAction($this, 'awardBadgeUserSelection'));
                 $ilToolbar->addFormButton($lng->txt('badge_award_badge'), 'awardBadgeUserSelection');
             }
         }
 
         $tbl = new ilBadgeUserTableGUI($this, 'listUsers', $this->parent_ref_id);
         $tpl->setContent($tbl->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pasteBadges()

ilBadgeManagementGUI::pasteBadges ( )

protected

Definition at line 644 of file class.ilBadgeManagementGUI.php.

References $ctrl, getValidBadgesFromClipboard(), hasWrite(), and ilCtrl\redirect().

                                     : void
     {
         $ilCtrl = $this->ctrl;
 
         $clip_ids = $this->session_repo->getBadgeIds();
         if (!$this->hasWrite() || count($clip_ids) === 0) {
             $ilCtrl->redirect($this, 'listBadges');
         }
 
         foreach ($this->getValidBadgesFromClipboard() as $badge) {
             $badge->copy($this->parent_obj_id);
         }
 
         $ilCtrl->redirect($this, 'listBadges');
     }

Here is the call graph for this function:

◆ resetAwardBadgeUserSelection()

ilBadgeManagementGUI::resetAwardBadgeUserSelection ( )

protected

Definition at line 784 of file class.ilBadgeManagementGUI.php.

References awardBadgeUserSelection().

                                                      : void
     {
         $tbl = new ilBadgeUserTableGUI($this, 'awardBadgeUserSelection', $this->parent_ref_id);
         $tbl->resetOffset();
         $tbl->resetFilter();
         $this->awardBadgeUserSelection();
     }

Here is the call graph for this function:

◆ resetBadgeFilter()

ilBadgeManagementGUI::resetBadgeFilter ( )

protected

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

References hasWrite(), and listBadges().

                                          : void
     {
         $tbl = new ilBadgeTableGUI($this, 'listBadges', $this->parent_obj_id, $this->hasWrite());
         $tbl->resetOffset();
         $tbl->resetFilter();
         $this->listBadges();
     }

Here is the call graph for this function:

◆ resetListUsers()

ilBadgeManagementGUI::resetListUsers ( )

protected

Definition at line 728 of file class.ilBadgeManagementGUI.php.

References listUsers().

                                        : void
     {
         $tbl = new ilBadgeUserTableGUI($this, 'listUsers', $this->parent_ref_id);
         $tbl->resetOffset();
         $tbl->resetFilter();
         $this->listUsers();
     }

Here is the call graph for this function:

◆ saveBadge()

ilBadgeManagementGUI::saveBadge ( )

protected

Definition at line 354 of file class.ilBadgeManagementGUI.php.

References $ctrl, Vendor\Package\$e, $handler, $lng, addBadge(), ilBadgeImageTemplate\delete(), ilBadgeHandler\getInstance(), hasWrite(), initBadgeForm(), and ilLanguage\txt().

                                   : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $type_id = $this->request->getType();
         if (!$type_id ||
             !$this->hasWrite()) {
             $ilCtrl->redirect($this, 'listBadges');
         }
 
         $ilCtrl->setParameter($this, 'type', $type_id);
 
         $handler = ilBadgeHandler::getInstance();
         $type = $handler->getTypeInstanceByUniqueId($type_id);
         if (!$type) {
             $ilCtrl->redirect($this, 'listBadges');
         }
 
         $form = $this->initBadgeForm('create', $type, $type_id);
         $custom = $type->getConfigGUIInstance();
 
         if ($form->checkInput() &&
             (!$custom || $custom->validateForm($form))) {
             $badge = new ilBadge();
             $badge->setParentId($this->parent_obj_id); // :TODO: ref_id?
             $badge->setTypeId($type_id);
             $badge->setActive($form->getInput('act'));
             $badge->setTitle($form->getInput('title'));
             $badge->setDescription($form->getInput('desc'));
             $badge->setCriteria($form->getInput('crit'));
             $badge->setValid($form->getInput('valid'));
 
             if ($custom instanceof ilBadgeTypeGUI) {
                 $badge->setConfiguration($custom->getConfigFromForm($form));
             }
 
             $badge->create();
 
 
 
             try {
                 if ($form->getInput('img_mode') === 'up') {
                     $badge->uploadImage($_FILES['img']);
                 } else {
                     $tmpl = new ilBadgeImageTemplate($form->getInput('tmpl'));
                     $badge->importImage($tmpl->getImage(), $tmpl->getImagePath());
                 }
             } catch (BadgeException $e) {
                 $delete = false;
                 switch ($e->getCode()) {
                     case BadgeException::EXCEPTION_FILE_NOT_FOUND:
                         $this->tpl->setOnScreenMessage('failure', $lng->txt('badge_uploaded_image_file_not_found'), true);
                         $delete = true;
                         break;
                     case BadgeException::EXCEPTION_MOVE_UPLOADED_IMAGE_FAILED:
                         $this->tpl->setOnScreenMessage('failure', $lng->txt('badge_create_image_processing_failed'), true);
                         $delete = true;
                         break;
                 }
 
                 if ($delete) {
                     $badge->delete();
                     $ilCtrl->redirect($this, "listBadges");
                 }
             }
 
             $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
             $ilCtrl->redirect($this, 'listBadges');
         }
 
         $form->setValuesByPost();
         $this->addBadge($form);
     }

Here is the call graph for this function:

◆ setBadgeFormValues()

ilBadgeManagementGUI::setBadgeFormValues	(	ilPropertyFormGUI	$a_form,
		ilBadge	$a_badge,
		ilBadgeType	$a_type
	)

protected

Definition at line 459 of file class.ilBadgeManagementGUI.php.

References ilBadgeType\getConfigGUIInstance(), ilBadge\getConfiguration(), ilBadge\getCriteria(), ilBadge\getDescription(), ilBadge\getImage(), ilBadge\getImagePath(), ilPropertyFormGUI\getItemByPostVar(), ilBadge\getTitle(), ilBadge\getValid(), and ilBadge\isActive().

Referenced by editBadge(), and executeCommand().

      : void {
         $a_form->getItemByPostVar('act')->setChecked($a_badge->isActive());
         $a_form->getItemByPostVar('title')->setValue($a_badge->getTitle());
         $a_form->getItemByPostVar('desc')->setValue($a_badge->getDescription());
         $a_form->getItemByPostVar('crit')->setValue($a_badge->getCriteria());
         $a_form->getItemByPostVar('img')->setValue($a_badge->getImage());
         $a_form->getItemByPostVar('img')->setImage($a_badge->getImagePath());
         $a_form->getItemByPostVar('valid')->setValue($a_badge->getValid());
 
         $custom = $a_type->getConfigGUIInstance();
         if ($custom instanceof ilBadgeTypeGUI) {
             $custom->importConfigToForm($a_form, $a_badge->getConfiguration());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTabs()

ilBadgeManagementGUI::setTabs ( string $a_active )

protected

Definition at line 109 of file class.ilBadgeManagementGUI.php.

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

Referenced by listBadges(), and listUsers().

                                                 : void
     {
         $ilTabs = $this->tabs;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         $ilTabs->addSubTab(
             'badges',
             $lng->txt('obj_bdga'),
             $ilCtrl->getLinkTarget($this, 'listBadges')
         );
 
         $ilTabs->addSubTab(
             'users',
             $lng->txt('users'),
             $ilCtrl->getLinkTarget($this, 'listUsers')
         );
 
         $ilTabs->activateSubTab($a_active);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toggleBadges()

ilBadgeManagementGUI::toggleBadges ( bool $a_status )

protected

Definition at line 660 of file class.ilBadgeManagementGUI.php.

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

Referenced by activateBadges(), and deactivateBadges().

                                                    : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $badge_ids = $this->getBadgesFromMultiAction();
 
         foreach ($badge_ids as $badge_id) {
             $badge = new ilBadge($badge_id);
             $badge->setActive($a_status);
             $badge->update();
         }
 
         $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
         $ilCtrl->redirect($this, 'listBadges');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateBadge()

ilBadgeManagementGUI::updateBadge ( )

protected

Definition at line 478 of file class.ilBadgeManagementGUI.php.

References $ctrl, Vendor\Package\$e, $lng, editBadge(), hasWrite(), initBadgeForm(), and ilLanguage\txt().

                                     : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $badge_id = $this->request->getBadgeId();
         if (!$badge_id ||
             !$this->hasWrite()) {
             $ilCtrl->redirect($this, 'listBadges');
         }
 
         $ilCtrl->setParameter($this, 'bid', $badge_id);
 
         $badge = new ilBadge($badge_id);
         $type = $badge->getTypeInstance();
         $custom = $type->getConfigGUIInstance();
         if ($custom &&
             !($custom instanceof ilBadgeTypeGUI)) {
             $custom = null;
         }
         $form = $this->initBadgeForm('update', $type, $badge->getTypeId());
         if ($form->checkInput() &&
             (!$custom || $custom->validateForm($form))) {
             $badge->setActive($form->getInput('act'));
             $badge->setTitle($form->getInput('title'));
             $badge->setDescription($form->getInput('desc'));
             $badge->setCriteria($form->getInput('crit'));
             $badge->setValid($form->getInput('valid'));
 
             if ($custom) {
                 $badge->setConfiguration($custom->getConfigFromForm($form));
             }
 
             $badge->update();
 
             try {
                 $badge->uploadImage($_FILES["img"]);
             } catch (BadgeException $e) {
                 if ($e->getCode() === BadgeException::EXCEPTION_MOVE_UPLOADED_IMAGE_FAILED) {
                     $this->tpl->setOnScreenMessage('failure', $lng->txt('badge_update_image_processing_failed'), true);
                     $ilCtrl->redirect($this, "listBadges");
                 }
             }
 
             $this->tpl->setOnScreenMessage('success', $lng->txt('settings_saved'), true);
             $ilCtrl->redirect($this, 'listBadges');
         }
 
         $this->tpl->setOnScreenMessage('failure', $lng->txt('form_input_not_valid'));
         $form->setValuesByPost();
         $this->editBadge($form);
     }