class.ilBadgeProfileGUI.php

Go to the documentation of this file.

<?php

use ILIAS\Badge\Notification\BadgeNotificationPrefRepository;
use ILIAS\Badge\TileView;
use ILIAS\Badge\PresentationHeader;
use ILIAS\Badge\Tile;

class ilBadgeProfileGUI implements ilCtrlSecurityInterface
{
    final public const BACKPACK_EMAIL = 'badge_mozilla_bp';

    protected ilBadgeGUIRequest $request;
    protected ilCtrl $ctrl;
    protected ilLanguage $lng;
    protected ilGlobalTemplateInterface $tpl;
    protected ilTabsGUI $tabs;
    protected ilObjUser $user;
    protected ilAccessHandler $access;
    protected \ILIAS\UI\Factory $factory;
    protected \ILIAS\UI\Renderer $renderer;
    protected BadgeNotificationPrefRepository $noti_repo;
    private readonly TileView $tile_view;

    public function __construct()
    {
        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)
        );
    }

    public function executeCommand(): 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;
        }
    }

    public function getSafePostCommands(): array
    {
        return [];
    }

    public function getUnsafeGetCommands(): array
    {
        return ['action'];
    }

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

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

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

    protected function getMultiSelection(): 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');
    }

    protected function activate(): 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');
    }

    protected function deactivate(): 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');
    }

    protected function activateInCard(): 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');
    }

    protected function deactivateInCard(): 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');
    }

    protected function setBackpackSubTabs(): 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');
    }

    protected function listBackpackGroups(): 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());
    }

    //
    // settings
    //

    protected function getBackpackMail(): string
    {
        $ilUser = $this->user;

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

    protected function initSettingsForm(): 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;
    }

    protected function editSettings(?ilPropertyFormGUI $a_form = null): void
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;

        $ilCtrl->redirect($this, 'listBadges');
    }

    protected function saveSettings(): 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);
    }
}