Inheritance diagram for ilMStListCoursesGUI:

Collaboration diagram for ilMStListCoursesGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	index ()

	listUsers ()

	applyFilter ()

	resetFilter ()

	getId ()

	cancel ()

Public Member Functions inherited from ilPropertyFormGUI
	__construct ()

	executeCommand ()

	setTableWidth (string $a_width)

	getTableWidth ()

	setMode (string $a_mode)

	getMode ()

	setTitle (string $a_title)

	getTitle ()

	setTitleIcon (string $a_titleicon)

	getTitleIcon ()

	setDescription (string $a_val)

	getDescription ()

	setTopAnchor (string $a_val)

	getTopAnchor ()

	setShowTopButtons (bool $a_val)

	getShowTopButtons ()

	setForceTopButtons (bool $a_val)

	getForceTopButtons ()

	addItem ($a_item)

	removeItemByPostVar (string $a_post_var, bool $a_remove_unused_headers=false)

	getItemByPostVar (string $a_post_var)

	setItems (array $a_items)

	getItems ()

	getInputItemsRecursive ()
	returns a flat array of all input items including the possibly existing subitems recursively More...

	setDisableStandardMessage (bool $a_val)

	getDisableStandardMessage ()

	getHideLabels ()

	setHideLabels (bool $a_value=true)

	setValuesByArray (array $a_values, bool $a_restrict_to_value_keys=false)

	setValuesByPost ()

	checkInput ()

	getInput (string $a_post_var, bool $ensureValidation=true)
	Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-POST variable, identified by the passed postvar. More...

	addCommandButton (string $a_cmd, string $a_text, string $a_id="")

	getCommandButtons ()

	clearCommandButtons ()

	getContent ()

	insertItem ( $item, bool $a_sub_item=false)

	addAsyncOnloadCode (string $code)

	getHTML ()

	getHTMLAsync ()

	getFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)
	Get file upload data. More...

	hasFileUpload (string $a_field, ?string $a_index=null, ?string $a_sub_index=null)

	moveFileUpload (string $a_target_directory, string $a_field, ?string $a_target_name=null, ?string $a_index=null, ?string $a_sub_index=null)
	Move upload to target directory. More...

Public Member Functions inherited from ilFormGUI
	setFormAction (string $a_formaction)

	getFormAction ()

	setTarget (string $a_target)

	getTarget ()

	setMultipart (bool $a_multipart)

	getMultipart ()

	setId (string $a_id)

	getId ()

	setName (string $a_name)

	getName ()

	setKeepOpen (bool $a_keepopen)

	getKeepOpen ()

	setOpenTag (bool $a_open)

	getOpenTag ()

	setCloseTag (bool $a_val)

	getCloseTag ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

	getHTML ()

	getContent ()

Data Fields
const	CMD_APPLY_FILTER = 'applyFilter'

const	CMD_INDEX = 'index'

const	CMD_GET_ACTIONS = "getActions"

const	CMD_RESET_FILTER = 'resetFilter'

Protected Member Functions
	checkAccessOrFail ()

Protected Member Functions inherited from ilPropertyFormGUI
	getRequestedPostVar ()

	getFileHash ()

	hideRequired (string $a_type)

	appendOnloadCode (string $html)

	rebuildUploadedFiles ()

Protected Attributes
ilTable2GUI	$table

ilMyStaffAccess	$access

Protected Attributes inherited from ilPropertyFormGUI
bool	$required_text = false

ilLanguage	$lng

ilCtrl	$ctrl

ilTemplate	$tpl

ilObjUser	$user = null

ilSetting	$settings = null

string	$mode = "std"

bool	$check_input_called = false

bool	$disable_standard_message = false

string	$top_anchor = "il_form_top"

string	$title = ''

string	$titleicon = ""

string	$description = ""

string	$tbl_width = ""

bool	$show_top_buttons = true

bool	$hide_labels = false

bool	$force_top_buttons = false

HTTP Services	$http

Refinery Factory	$refinery = null

ilGlobalTemplateInterface	$global_tpl = null

	$onload_code = []

Protected Attributes inherited from ilFormGUI
string	$formaction = ""

bool	$multipart = false

bool	$keepopen = false

bool	$opentag = true

string	$id = ''

string	$name = ''

string	$target = ''

bool	$prevent_double_submission = false

Private Attributes
ilGlobalTemplateInterface	$main_tpl

ILIAS HTTP Wrapper ArrayBasedRequestWrapper	$queryWrapper

ilHelpGUI	$help

Detailed Description

Class ilMStListCoursesGUI.

Author: Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch @ilCtrl_IsCalledBy ilMStListCoursesGUI: ilMyStaffGUI @ilCtrl_Calls ilMStListCoursesGUI: ilMStListCoursesTableGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilMStListCoursesGUI::__construct ( )

Reimplemented from ilPropertyFormGUI.

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

    {
        global $DIC;
        parent::__construct();
 
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->access = ilMyStaffAccess::getInstance();
        $this->help = $DIC->help();
        $this->queryWrapper = $DIC->http()->wrapper()->query();
        $this->help->setScreenIdComponent('msta');
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), and ILIAS\Repository\help().

Here is the call graph for this function:

Member Function Documentation

◆ applyFilter()

ilMStListCoursesGUI::applyFilter ( )

final

Definition at line 111 of file class.ilMStListCoursesGUI.php.

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

References index().

Here is the call graph for this function:

◆ cancel()

ilMStListCoursesGUI::cancel ( )

final

Definition at line 134 of file class.ilMStListCoursesGUI.php.

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

References $DIC.

◆ checkAccessOrFail()

ilMStListCoursesGUI::checkAccessOrFail ( )

protected

Definition at line 53 of file class.ilMStListCoursesGUI.php.

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

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by executeCommand(), and listUsers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilMStListCoursesGUI::executeCommand ( )

final

Returns: mixed

Exceptions

ilCtrlException

Reimplemented from ilPropertyFormGUI.

Definition at line 63 of file class.ilMStListCoursesGUI.php.

                                          : void
    {
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass();
 
        switch ($next_class) {
            case strtolower(\ilMStListCoursesTableGUI::class):
                $this->checkAccessOrFail();
 
                $this->ctrl->setReturn($this, self::CMD_INDEX);
                $this->table = new \ilMStListCoursesTableGUI($this, self::CMD_INDEX);
                $this->ctrl->forwardCommand($this->table);
                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(), CMD_APPLY_FILTER, CMD_GET_ACTIONS, CMD_INDEX, CMD_RESET_FILTER, ILIAS\Repository\ctrl(), and index().

Here is the call graph for this function:

◆ getId()

ilMStListCoursesGUI::getId ( )

final

Reimplemented from ilFormGUI.

Definition at line 127 of file class.ilMStListCoursesGUI.php.

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

◆ index()

ilMStListCoursesGUI::index ( )

final

Definition at line 93 of file class.ilMStListCoursesGUI.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()

ilMStListCoursesGUI::listUsers ( )

final

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

                                     : void
    {
        global $DIC;
 
        $this->checkAccessOrFail();
        $this->help->setScreenId('courses_list');
 
        $this->table = new ilMStListCoursesTableGUI($this, self::CMD_INDEX);
        $DIC->ui()->mainTemplate()->setTitle($DIC->language()->txt('mst_list_courses'));
        $DIC->ui()->mainTemplate()->setTitleIcon(ilUtil::getImagePath('icon_enrl.svg'));
        $DIC->ui()->mainTemplate()->setContent($this->table->getHTML());
    }

References $DIC, checkAccessOrFail(), ilUtil\getImagePath(), and ILIAS\Repository\help().

Referenced by index().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetFilter()

ilMStListCoursesGUI::resetFilter ( )

final

Definition at line 119 of file class.ilMStListCoursesGUI.php.

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