ilAssignmentsPerParticipantTableGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilAssignmentsPerParticipantTableGUI:

Collaboration diagram for ilAssignmentsPerParticipantTableGUI:

Public Member Functions
	numericOrdering (string $a_field)
Public Member Functions inherited from ilExerciseSubmissionTableGUI
	__construct (object $a_parent_obj, string $a_parent_cmd, ilObjExercise $a_exc, int $a_item_id, ilExerciseSubmissionFeedbackGUI $feedback_gui)
	initFilter ()
	getSelectableColumns ()
	render ()
Public Member Functions inherited from ilTable2GUI
	__construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")
	setOpenFormTag (bool $a_val)
	getOpenFormTag ()
	setCloseFormTag (bool $a_val)
	getCloseFormTag ()
	determineLimit ()
	getSelectableColumns ()
	Get selectable columns. More...
	determineSelectedColumns ()
	isColumnSelected (string $col)
	getSelectedColumns ()
	resetOffset (bool $a_in_determination=false)
	initFilter ()
	getParentObject ()
	getParentCmd ()
	setTopAnchor (string $a_val)
	getTopAnchor ()
	setNoEntriesText (string $a_text)
	getNoEntriesText ()
	setIsDataTable (bool $a_val)
	getIsDataTable ()
	setEnableTitle (bool $a_enabletitle)
	getEnableTitle ()
	setEnableHeader (bool $a_enableheader)
	getEnableHeader ()
	setEnableNumInfo (bool $a_val)
	getEnableNumInfo ()
	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
	setDescription (string $a_val)
	getDescription ()
	setOrderField (string $a_order_field)
	getOrderField ()
	setData (array $a_data)
	getData ()
	dataExists ()
	setPrefix (string $a_prefix)
	getPrefix ()
	addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)
	addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
	Add filter by standard type. More...
	getFilterItems (bool $a_optionals=false)
	getFilterItemByPostVar (string $a_post_var)
	setFilterCols (int $a_val)
	getFilterCols ()
	setDisableFilterHiding (bool $a_val=true)
	getDisableFilterHiding ()
	isFilterSelected (string $a_col)
	Is given filter selected? More...
	getSelectedFilters ()
	determineSelectedFilters ()
	setCustomPreviousNext (string $a_prev_link, string $a_next_link)
	setFormAction (string $a_form_action, bool $a_multipart=false)
	getFormAction ()
	setFormName (string $a_name="")
	getFormName ()
	setId (string $a_val)
	getId ()
	setDisplayAsBlock (bool $a_val)
	getDisplayAsBlock ()
	setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)
	setExternalSorting (bool $a_val)
	getExternalSorting ()
	setFilterCommand (string $a_val, string $a_caption="")
	getFilterCommand ()
	setResetCommand (string $a_val, string $a_caption="")
	getResetCommand ()
	setExternalSegmentation (bool $a_val)
	getExternalSegmentation ()
	setRowTemplate (string $a_template, string $a_template_dir="")
	Set row template. More...
	setDefaultOrderField (string $a_defaultorderfield)
	getDefaultOrderField ()
	setDefaultOrderDirection (string $a_defaultorderdirection)
	getDefaultOrderDirection ()
	setDefaultFilterVisiblity (bool $a_status)
	getDefaultFilterVisibility ()
	clearCommandButtons ()
	addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
	addCommandButtonInstance (ilButtonBase $a_button)
	addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')
	setCloseCommand (string $a_link)
	addMultiCommand (string $a_cmd, string $a_text)
	addHiddenInput (string $a_name, string $a_value)
	addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")
	setTopCommands (bool $a_val)
	getTopCommands ()
	addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
	getNavParameter ()
	setOrderLink (string $key, string $order_dir)
	fillHeader ()
	determineOffsetAndOrder (bool $a_omit_offset=false)
	storeNavParameter ()
	getHTML ()
	Get HTML. More...
	numericOrdering (string $a_field)
	Should this field be sorted numeric? More...
	render ()
	writeFilterToSession ()
	resetFilter ()
	fillFooter ()
	getLinkbar (string $a_num)
	fillHiddenRow ()
	fillActionRow ()
	setHeaderHTML (string $html)
	storeProperty (string $type, string $value)
	loadProperty (string $type)
	getCurrentState ()
	get current settings for order, limit, columns and filter More...
	setContext (string $id)
	getContext ()
	setShowRowsSelector (bool $a_value)
	Toggle rows-per-page selector. More...
	getShowRowsSelector ()
	getLimit ()
	getOffset ()
	setExportFormats (array $formats)
	Set available export formats. More...
	setPrintMode (bool $a_value=false)
	getPrintMode ()
	getExportMode ()
	exportData (int $format, bool $send=false)
	Export and optionally send current table data. More...
	setEnableAllCommand (bool $a_value)
	setRowSelectorLabel (string $row_selector_label)
	getRowSelectorLabel ()
	setPreventDoubleSubmission (bool $a_val)
	getPreventDoubleSubmission ()
	setLimit (int $a_limit=0, int $a_default_limit=0)
Public Member Functions inherited from ilTableGUI
	__construct (array $a_data=[], bool $a_global_tpl=true)
	setTemplate (ilTemplate $a_tpl)
	getTemplateObject ()
	setData (array $a_data)
	Set table data. More...
	getData ()
	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
	setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")
	setHeaderNames (array $a_header_names)
	getColumnCount ()
	setHeaderVars (array $a_header_vars, array $a_header_params=[])
	setColumnWidth (array $a_column_width)
	set table column widths More...
	setOneColumnWidth (string $a_column_width, int $a_column_number)
	setMaxCount (int $a_max_count)
	set max. More...
	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...
	getLimit ()
	setPrefix (string $a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...
	setOffset (int $a_offset)
	set dataset offset More...
	getOffset ()
	setOrderColumn (string $a_order_column="", string $a_default_column="")
	getOrderColumn ()
	setOrderDirection (string $a_order_direction)
	getOrderDirection ()
	setFooter (string $a_style, string $a_previous="", string $a_next="")
	enable (string $a_module_name)
	disable (string $a_module_name)
	sortData ()
	render ()
	renderHeader ()
	setOrderLink (string $key, string $order_dir)
	setStyle (string $a_element, string $a_style)
	getStyle (string $a_element)
	setBase (string $a_base)
	getBase ()
	getFormName ()
	get the name of the parent form More...
	setFormName (string $a_name="cmd")
	getSelectAllCheckbox ()
	get the name of the checkbox that should be toggled with a select all button More...
	setSelectAllCheckbox (string $a_select_all_checkbox)
	clearActionButtons ()
	addActionButton (string $btn_name, string $btn_value)

Protected Member Functions
	initMode (int $a_item_id)
	parseData ()
	parseModeColumns ()
	fillRow (array $a_set)
Protected Member Functions inherited from ilExerciseSubmissionTableGUI
	initCourseGroupFilter ()
	isForwardingToFormDispatcher ()
	initMode (int $a_item_id)
	parseData ()
	parseModeColumns ()
	parseColumns ()
Protected Member Functions inherited from ilTable2GUI
	getRequestedValues ()
	prepareOutput ()
	Anything that must be done before HTML is generated. More...
	isFilterVisible ()
	Check if filter is visible: manually shown (session, db) or default value set. More...
	isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, ilTableFilterItem $a_element)
	Check if filter element is based on adv md. More...
	fillRow (array $a_set)
	Standard Version of Fill Row. More...
	getFilterValue (ilTableFilterItem $a_item)
	Get current filter value. More...
	setFilterValue (ilTableFilterItem $a_item, $a_value)
	fillMetaExcel (ilExcel $a_excel, int &$a_row)
	Add meta information to excel export. More...
	fillHeaderExcel (ilExcel $a_excel, int &$a_row)
	Excel Version of Fill Header. More...
	fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
	Excel Version of Fill Row. More...
	fillMetaCSV (ilCSVWriter $a_csv)
	Add meta information to csv export. More...
	fillHeaderCSV (ilCSVWriter $a_csv)
	CSV Version of Fill Header. More...
	fillRowCSV (ilCSVWriter $a_csv, array $a_set)
	CSV Version of Fill Row. More...

Protected Attributes
ilObjUser	$user
Protected Attributes inherited from ilExerciseSubmissionTableGUI
ILIAS Exercise InternalDomainService	$domain
ILIAS Exercise Assignment DomainService	$ass_domain
ilExerciseSubmissionFeedbackGUI	$feedback_gui
ilAccessHandler	$access
ilObjExercise	$exc
int	$mode
array	$filter
array	$comment_modals = array()
ilExAssignment	$ass = null
array	$cols_mandatory = array("name", "status")
array	$cols_default = array("login", "submission", "idl", "calc_deadline")
array	$cols_order
ilExAssignmentTypes	$ass_types
ilExAssignmentTypeInterface	$ass_type = null
Factory	$ui_factory
Renderer	$ui_renderer
Protected Attributes inherited from ilTable2GUI
string	$requested_nav_par2 = ""
string	$requested_nav_par = ""
string	$requested_nav_par1 = ""
ILIAS Table TableGUIRequest	$table_request = null
array	$selected_columns = []
ilCtrl	$ctrl
object	$parent_obj = null
string	$parent_cmd = ""
string	$close_command = ""
string	$top_anchor = "il_table_top"
array	$filters = array()
array	$optional_filters = array()
string	$filter_cmd = 'applyFilter'
string	$reset_cmd = 'resetFilter'
int	$filter_cols = 5
bool	$ext_sort = false
bool	$ext_seg = false
string	$context = ""
array	$mi_sel_buttons = []
bool	$disable_filter_hiding = false
bool	$top_commands = true
array	$selectable_columns = array()
array	$selected_column = array()
bool	$show_rows_selector = true
bool	$rows_selector_off = false
bool	$nav_determined = false
bool	$limit_determined = false
bool	$filters_determined = false
bool	$columns_determined = false
bool	$open_form_tag = true
bool	$close_form_tag = true
array	$export_formats = []
int	$export_mode = 0
bool	$print_mode = false
bool	$enable_command_for_all = false
bool	$restore_filter = false
array	$restore_filter_values = []
bool	$default_filter_visibility = false
array	$sortable_fields = array()
bool	$prevent_double_submission = true
string	$row_selector_label = ""
bool	$select_all_on_top = false
array	$sel_buttons = []
string	$nav_value = ''
string	$noentriestext = ''
string	$css_row = ''
bool	$display_as_block = false
string	$description = ''
string	$id = ""
bool	$custom_prev_next = false
string	$reset_cmd_txt = ""
string	$defaultorderfield = ""
string	$defaultorderdirection = ""
array	$column = []
bool	$datatable = false
bool	$num_info = false
bool	$form_multipart = false
array	$row_data = []
string	$order_field = ""
array	$selected_filter = []
string	$form_action = ""
string	$formname = ""
string	$sort_order = ""
array	$buttons = []
array	$multi = []
array	$hidden_inputs = []
array	$header_commands = []
string	$row_template = ""
string	$row_template_dir = ""
string	$filter_cmd_txt = ""
string	$custom_prev = ""
string	$custom_next = ""
array	$raw_post_data = null
ilGlobalTemplateInterface	$main_tpl
Protected Attributes inherited from ilTableGUI
string	$sort_order
string	$link_params
array	$header_params
	$tpl
ilLanguage	$lng

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()
Static Public Member Functions inherited from ilTableGUI
static	linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')
Data Fields inherited from ilExerciseSubmissionTableGUI
const	MODE_BY_ASSIGNMENT = 1
const	MODE_BY_USER = 2
Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1
const	FILTER_SELECT = 2
const	FILTER_DATE = 3
const	FILTER_LANGUAGE = 4
const	FILTER_NUMBER_RANGE = 5
const	FILTER_DATE_RANGE = 6
const	FILTER_DURATION_RANGE = 7
const	FILTER_DATETIME_RANGE = 8
const	FILTER_CHECKBOX = 9
const	EXPORT_EXCEL = 1
const	EXPORT_CSV = 2
const	ACTION_ALL_LIMIT = 1000
Data Fields inherited from ilTableGUI
string	$title = ""
string	$icon = ""
string	$icon_alt = ""
string	$help_page = ""
string	$help_icon = ""
string	$help_icon_alt = ""
array	$header_names = []
array	$header_vars = []
array	$linkbar_vars = []
array	$data = []
int	$column_count = 0
array	$column_width = []
int	$max_count = 0
int	$limit = 0
bool	$max_limit = false
int	$offset = 0
string	$order_column = ""
string	$order_direction = ""
string	$footer_style = ""
string	$footer_previous = ""
string	$footer_next = ""
bool	$lang_support = true
bool	$global_tpl = false
string	$form_name = ""
string	$select_all_checkbox = ""
array	$action_buttons = []
string	$prefix = ""
string	$base = ""
array	$enabled
array	$styles

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Exercise participant table

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 24 of file class.ilAssignmentsPerParticipantTableGUI.php.

Member Function Documentation

fillRow()

ilAssignmentsPerParticipantTableGUI::fillRow ( array  $a_set )

protected

Exceptions

ilDatabaseException
ilDateTimeException
ilObjectNotFoundException

Definition at line 178 of file class.ilAssignmentsPerParticipantTableGUI.php.

References ilTable2GUI\$ctrl, ilTable2GUI\getId(), ilCtrl\setParameter(), and ILIAS\Repository\user().

                                            : void
    {
        $ilCtrl = $this->ctrl;
        $ilCtrl->setParameter($this->parent_obj, "member_id", $this->user->getId());
        $ilCtrl->setParameter($this->parent_obj, "ass_id", $a_set["ass"]->getId());

        // multi-select id
        $this->tpl->setVariable("NAME_ID", "sel_ass_ids");
        $this->tpl->setVariable("LISTED_NAME_ID", "listed_ass_ids");
        $this->tpl->setVariable("VAL_ID", $a_set["ass"]->getId());

        $this->parseRow($this->user->getId(), $a_set["ass"], $a_set);

        $ilCtrl->setParameter($this->parent_obj, "ass_id", "");
        $ilCtrl->setParameter($this->parent_obj, "member_id", $this->user->getId());
    }

Here is the call graph for this function:

initMode()

ilAssignmentsPerParticipantTableGUI::initMode ( int  $a_item_id )

protected

Definition at line 28 of file class.ilAssignmentsPerParticipantTableGUI.php.

References ilTableGUI\$lng, ilObjUser\_lookupName(), ilTable2GUI\setId(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setTitle(), ilLanguage\txt(), and ILIAS\Repository\user().

                                               : void
    {
        $lng = $this->lng;

        $this->mode = self::MODE_BY_USER;

        // global id for all exercises
        $this->setId("exc_part");

        if ($a_item_id > 0) {
            $name = ilObjUser::_lookupName($a_item_id);
            if (trim($name["login"]) !== '' && trim($name["login"]) !== '0') {
                $this->user = new ilObjUser($a_item_id);

                $this->setTitle(
                    $lng->txt("exc_participant") . ": " .
                        $name["lastname"] . ", " . $name["firstname"] . " [" . $name["login"] . "]"
                );
            }
        }

        $this->setSelectAllCheckbox("ass");
    }

Here is the call graph for this function:

numericOrdering()

ilAssignmentsPerParticipantTableGUI::numericOrdering

(

string

$a_field

)

Definition at line 195 of file class.ilAssignmentsPerParticipantTableGUI.php.

                                                    : bool
    {
        return $a_field === "order_nr";
    }

parseData()

ilAssignmentsPerParticipantTableGUI::parseData ( )

protected

Exceptions

ilExcUnknownAssignmentTypeException

Definition at line 55 of file class.ilAssignmentsPerParticipantTableGUI.php.

References ilExerciseSubmissionTableGUI\$access, ilExerciseSubmissionTableGUI\$ass, ilTable2GUI\$ctrl, ilTableGUI\$data, $user_id, ilObjUser\_lookupFullname(), ilTable2GUI\addCommandButton(), ILIAS\Repository\filter(), ilExAssignmentTeam\getAssignmentTeamMap(), ilExAssignment\getInstancesByExercise(), ilTable2GUI\getParentCmd(), ilTable2GUI\getParentObject(), IL_CAL_DATETIME, ILIAS\Repository\lng(), null, ilTable2GUI\setDescription(), and ILIAS\Repository\user().

                                  : array
    {
        $ilAccess = $this->access;
        $ilCtrl = $this->ctrl;
        $this->addCommandButton("saveStatusParticipant", $this->lng->txt("save"));

        // #14650 - invalid user
        if (!$this->user) {
            $ilCtrl->setParameter($this->getParentObject(), "member_id", "");
            $ilCtrl->setParameter($this->getParentObject(), "part_id", ""); // #20073
            $ilCtrl->redirect($this->getParentObject(), $this->getParentCmd());
        }

        // #18327
        if (!$ilAccess->checkAccessOfUser($this->user->getId(), "read", "", $this->exc->getRefId()) &&
            is_array($info = $ilAccess->getInfo())) {
            $this->setDescription('<span class="warning">' . $info[0]['text'] . '</span>');
        }

        $data = array();
        foreach (ilExAssignment::getInstancesByExercise($this->exc->getId()) as $ass) {
            // ilExAssignment::getMemberListData()
            $member_status = $ass->getMemberStatus($this->user->getId());

            // filter
            if ($this->filter["status"] &&
                $member_status->getStatus() != $this->filter["status"]) {
                continue;
            }

            $submission = new ilExSubmission($ass, $this->user->getId());
            $idl = $ass->getIndividualDeadlines();

            if ($this->filter["subm"]) {
                if ($this->filter["subm"] == "y" &&
                    !$submission->getLastSubmission()) {
                    continue;
                } elseif ($this->filter["subm"] == "n" &&
                    $submission->getLastSubmission()) {
                    continue;
                }
            }

            if ($this->filter["subm_after"]) {
                if (is_null($submission->getLastSubmission())) {
                    continue;
                } else {
                    if ($submission->getLastSubmission() <
                        $this->filter["subm_after"]->get(IL_CAL_DATETIME)) {
                        continue;
                    }
                }
            }
            if ($this->filter["subm_before"]) {
                if (is_null($submission->getLastSubmission())) {
                    continue;
                } else {
                    if ($submission->getLastSubmission() >
                        $this->filter["subm_before"]->get(IL_CAL_DATETIME)) {
                        continue;
                    }
                }
            }

            $row = array(
                "ass" => $ass,
                "submission_obj" => $submission,
                "name" => $ass->getTitle(),
                "status" => $member_status->getStatus(),
                "mark" => $member_status->getMark(),
                "sent_time" => $member_status->getSentTime(),
                "status_time" => $member_status->getStatusTime(),
                "feedback_time" => $member_status->getFeedbackTime(),
                "submission" => $submission->getLastSubmission(),
                "notice" => $member_status->getNotice(),
                "comment" => $member_status->getComment(),
                "order_nr" => $ass->getOrderNr()
            );

            if ($ass->hasTeam()) {
                $team_map = ilExAssignmentTeam::getAssignmentTeamMap($ass->getId());

                $row["team"] = array();
                foreach ($submission->getTeam()->getMembers() as $user_id) {
                    $row["team"][$user_id] = ilObjUser::_lookupFullname($user_id);
                }
                asort($row["team"]);

                $team_id = $team_map[$this->user->getId()] ?? null;
                if (is_numeric($team_id)) {
                    $idl_team_id = "t" . $team_id;
                    if (array_key_exists($idl_team_id, $idl)) {
                        $row["idl"] = $idl[$idl_team_id];
                    }
                }
            } else {
                if (array_key_exists($this->user->getId(), $idl)) {
                    $row["idl"] = $idl[$this->user->getId()];
                }
            }

            $data[] = $row;
        }

        return $data;
    }

Here is the call graph for this function:

parseModeColumns()

ilAssignmentsPerParticipantTableGUI::parseModeColumns ( )

protected

Definition at line 162 of file class.ilAssignmentsPerParticipantTableGUI.php.

References ILIAS\Repository\lng().

                                         : array
    {
        $cols = array();

        $cols["name"] = array($this->lng->txt("exc_assignment"), "order_nr");
        $cols["team_members"] = array($this->lng->txt("exc_tbl_team"));
        $cols["idl"] = array($this->lng->txt("exc_tbl_individual_deadline"), "idl");

        return $cols;
    }

Here is the call graph for this function:

Field Documentation

$user

ilObjUser ilAssignmentsPerParticipantTableGUI::$user

protected

Definition at line 26 of file class.ilAssignmentsPerParticipantTableGUI.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/Exercise/classes/class.ilAssignmentsPerParticipantTableGUI.php