Collaboration diagram for ilMStListCertificatesGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	index ()

	listUsers ()

	applyFilter ()

	resetFilter ()

	getId ()

	cancel ()

Data Fields
const string	CMD_APPLY_FILTER = 'applyFilter'

const string	CMD_INDEX = 'index'

const string	CMD_GET_ACTIONS = "getActions"

const string	CMD_RESET_FILTER = 'resetFilter'

Protected Member Functions
	checkAccessOrFail ()

	getCertificateIDFromQuery ()

	checkAccessToCertificateOrFail ()

	hasAccessToCertificate (int $certificate_id)

Protected Attributes
ilTable2GUI	$table

ilMyStaffAccess	$access

Private Attributes
ilGlobalTemplateInterface	$main_tpl

ilCtrlInterface	$ctrl

ilLanguage	$language

HTTP	$http

Refinery	$refinery

ilMStListCertificates	$certificates_fetcher

Detailed Description

Class ilMStListCertificatesGUI.

Author: Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch @ilCtrl_IsCalledBy ilMStListCertificatesGUI: ilMyStaffGUI @ilCtrl_Calls ilMStListCertificatesGUI: ilFormPropertyDispatchGUI @ilCtrl_Calls ilMStListCertificatesGUI: ilUserCertificateApiGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilMStListCertificatesGUI::__construct ( )

Definition at line 47 of file class.ilMStListCertificatesGUI.php.

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->language = $DIC->language();
        $this->access = ilMyStaffAccess::getInstance();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->certificates_fetcher = new ilMStListCertificates($DIC);
    }

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

◆ applyFilter()

ilMStListCertificatesGUI::applyFilter ( )

final

Definition at line 148 of file class.ilMStListCertificatesGUI.php.

                                       : void
    {
        $this->table = new ilMStListCertificatesTableGUI($this, self::CMD_APPLY_FILTER);
        $this->table->writeFilterToSession();
        $this->table->resetOffset();
        $this->index();
    }

References index().

Here is the call graph for this function:

◆ cancel()

ilMStListCertificatesGUI::cancel ( )

final

Definition at line 171 of file class.ilMStListCertificatesGUI.php.

                                  : void
    {
        $this->ctrl->redirect($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ checkAccessOrFail()

ilMStListCertificatesGUI::checkAccessOrFail ( )

protected

Definition at line 59 of file class.ilMStListCertificatesGUI.php.

                                          : void
    {
        if ($this->access->hasCurrentUserAccessToCertificates()) {
            return;
        } else {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt("permission_denied"), true);
            $this->ctrl->redirectByClass(ilDashboardGUI::class, "");
        }
    }

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by executeCommand(), and listUsers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkAccessToCertificateOrFail()

ilMStListCertificatesGUI::checkAccessToCertificateOrFail ( )

protected

Definition at line 84 of file class.ilMStListCertificatesGUI.php.

                                                       : void
    {
        $certificate_id = $this->getCertificateIDFromQuery();
        if ($certificate_id === null || !$this->hasAccessToCertificate($certificate_id)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt("permission_denied"), true);
            $this->ctrl->redirectByClass(ilDashboardGUI::class, "");
        }
    }

References ILIAS\Repository\ctrl(), getCertificateIDFromQuery(), hasAccessToCertificate(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilMStListCertificatesGUI::executeCommand ( )

final

Definition at line 99 of file class.ilMStListCertificatesGUI.php.

                                          : void
    {
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass();
 
        switch ($next_class) {
            case strtolower(ilFormPropertyDispatchGUI::class):
                $this->checkAccessOrFail();
 
                $this->ctrl->setReturn($this, self::CMD_INDEX);
                $this->table = new ilMStListCertificatesTableGUI($this, self::CMD_INDEX);
                $this->table->executeCommand();
                break;
            case strtolower(ilUserCertificateApiGUI::class):
                $this->checkAccessOrFail();
                $this->checkAccessToCertificateOrFail();
                $this->ctrl->forwardCommand(new ilUserCertificateApiGUI());
                break;
            default:
                switch ($cmd) {
                    case self::CMD_RESET_FILTER:
                    case self::CMD_APPLY_FILTER:
                    case self::CMD_INDEX:
                    case self::CMD_GET_ACTIONS:
                        $this->$cmd();
                        break;
                    default:
                        $this->index();
                        break;
                }
                break;
        }
    }

References checkAccessOrFail(), checkAccessToCertificateOrFail(), CMD_APPLY_FILTER, CMD_GET_ACTIONS, CMD_INDEX, CMD_RESET_FILTER, ILIAS\Repository\ctrl(), and index().

Here is the call graph for this function:

◆ getCertificateIDFromQuery()

ilMStListCertificatesGUI::getCertificateIDFromQuery ( )

protected

Definition at line 69 of file class.ilMStListCertificatesGUI.php.

                                                  : ?int
    {
        /*
         * The parameter certificate_id is handled by the certificate component,
         * but at this point we can only get to it via the query.
         */
        if (!$this->http->wrapper()->query()->has('certificate_id')) {
            return null;
        }
        return $this->http->wrapper()->query()->retrieve(
            'certificate_id',
            $this->refinery->kindlyTo()->int()
        );
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by checkAccessToCertificateOrFail().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilMStListCertificatesGUI::getId ( )

final

Definition at line 164 of file class.ilMStListCertificatesGUI.php.

                                 : string
    {
        $this->table = new ilMStListCertificatesTableGUI($this, self::CMD_INDEX);
 
        return $this->table->getId();
    }

◆ hasAccessToCertificate()

ilMStListCertificatesGUI::hasAccessToCertificate ( int $certificate_id )

protected

Definition at line 93 of file class.ilMStListCertificatesGUI.php.

                                                                  : bool
    {
        $valid_certificates = $this->certificates_fetcher->getData();
        return key_exists($certificate_id, $valid_certificates);
    }

Referenced by checkAccessToCertificateOrFail().

Here is the caller graph for this function:

◆ index()

ilMStListCertificatesGUI::index ( )

final

Definition at line 133 of file class.ilMStListCertificatesGUI.php.

                                 : void
    {
        $this->listUsers();
    }

References listUsers().

Referenced by applyFilter(), executeCommand(), and resetFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listUsers()

ilMStListCertificatesGUI::listUsers ( )

final

Definition at line 138 of file class.ilMStListCertificatesGUI.php.

                                     : void
    {
        $this->checkAccessOrFail();
 
        $this->table = new ilMStListCertificatesTableGUI($this, self::CMD_INDEX);
        $this->main_tpl->setTitle($this->language->txt('mst_list_certificates'));
        $this->main_tpl->setTitleIcon(ilUtil::getImagePath('standard/icon_cert.svg'));
        $this->main_tpl->setContent($this->table->getHTML());
    }

References checkAccessOrFail(), ilUtil\getImagePath(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by index().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetFilter()

ilMStListCertificatesGUI::resetFilter ( )

final

Definition at line 156 of file class.ilMStListCertificatesGUI.php.

                                       : void
    {
        $this->table = new ilMStListCertificatesTableGUI($this, self::CMD_RESET_FILTER);
        $this->table->resetOffset();
        $this->table->resetFilter();
        $this->index();
    }