ilQuestionPoolPrintViewTableGUI 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 ilQuestionPoolPrintViewTableGUI:

Collaboration diagram for ilQuestionPoolPrintViewTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $outputmode='')
	initColumns ()
	getSelectableColumns ()
	fillRow (array $a_set)
	fill row public More...
	numericOrdering (string $a_field)
	getTotalPoints ()
	setTotalPoints ($totalPoints)
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 Attributes
	$outputmode
	$totalPoints
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

Private Member Functions
	getPointsColumnHeader ()

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 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
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...

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

Author

Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de

Version

$Id$

\

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

Constructor & Destructor Documentation

__construct()

ilQuestionPoolPrintViewTableGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd,
			$outputmode = ''
	)

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

References $DIC, ilTableGUI\$lng, $outputmode, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addCommandButton(), ILIAS\Repository\ctrl(), ilTableGUI\disable(), ilTableGUI\enable(), ILIAS\Repository\lng(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), ilTableGUI\setStyle(), and ilTable2GUI\setTitle().

    {
        $this->setId("qpl_print");
        parent::__construct($a_parent_obj, $a_parent_cmd);

        global $DIC;
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];

        $this->lng = $lng;
        $this->ctrl = $ilCtrl;
        $this->outputmode = $outputmode;
        $this->setTitle($this->lng->txt($this->outputmode));
        $this->ctrl->setParameterByClass('ilObjQuestionPoolGUI', 'output', $outputmode);

        $this->setFormName('printviewform');
        $this->setStyle('table', 'fullwidth');

        $this->addCommandButton('print', $this->lng->txt('print'), "javascript:window.print();return false;");

        $this->setRowTemplate("tpl.il_as_qpl_printview_row.html", "components/ILIAS/TestQuestionPool");

        $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, $a_parent_cmd));
        $this->setDefaultOrderField("title");
        $this->setDefaultOrderDirection("asc");

        $this->enable('sort');
        $this->enable('header');
        $this->disable('select_all');
    }

Here is the call graph for this function:

Member Function Documentation

fillRow()

ilQuestionPoolPrintViewTableGUI::fillRow

(

array

$a_set

)

fill row public

Parameters

Definition at line 131 of file class.ilQuestionPoolPrintViewTableGUI.php.

References $c, ilDatePresentation\formatDate(), ilTable2GUI\getSelectedColumns(), IL_CAL_UNIX, null, ilLegacyFormElementsUtil\prepareFormOutput(), assQuestionGUI\RENDER_PURPOSE_PREVIEW, and ilDatePresentation\setUseRelativeDates().

                                         : void
    {
        ilDatePresentation::setUseRelativeDates(false);
        $this->tpl->setVariable("TITLE", ilLegacyFormElementsUtil::prepareFormOutput($a_set['title']));
        foreach ($this->getSelectedColumns() as $c) {
            if (strcmp($c, 'description') == 0) {
                $this->tpl->setCurrentBlock('description');
                $this->tpl->setVariable(
                    "DESCRIPTION",
                    ilLegacyFormElementsUtil::prepareFormOutput((string) $a_set['description'])
                );
                $this->tpl->parseCurrentBlock();
            }
            if (strcmp($c, 'author') == 0) {
                $this->tpl->setCurrentBlock('author');
                $this->tpl->setVariable("AUTHOR", ilLegacyFormElementsUtil::prepareFormOutput((string) $a_set['author']));
                $this->tpl->parseCurrentBlock();
            }
            if (strcmp($c, 'ttype') == 0) {
                $this->tpl->setCurrentBlock('ttype');
                $this->tpl->setVariable("TYPE", ilLegacyFormElementsUtil::prepareFormOutput((string) $a_set['ttype']));
                $this->tpl->parseCurrentBlock();
            }
            if (strcmp($c, 'points') == 0) {
                $this->tpl->setCurrentBlock('points');
                $this->tpl->setVariable("POINTS", ilLegacyFormElementsUtil::prepareFormOutput((string) $a_set['points']));
                $this->tpl->parseCurrentBlock();
            }
            if (strcmp($c, 'created') == 0) {
                $this->tpl->setCurrentBlock('created');
                $this->tpl->setVariable('CREATED', ilDatePresentation::formatDate(new ilDateTime($a_set['created'], IL_CAL_UNIX)));
                $this->tpl->parseCurrentBlock();
            }
            if (strcmp($c, 'updated') == 0) {
                $this->tpl->setCurrentBlock('updated');
                $this->tpl->setVariable('UPDATED', ilDatePresentation::formatDate(new ilDateTime($a_set['updated'], IL_CAL_UNIX)));
                $this->tpl->parseCurrentBlock();
            }
        }
        if ((strcmp($this->outputmode, "detailed_output_solutions") == 0) || (strcmp($this->outputmode, "detailed_output_printview") == 0)) {
            $this->tpl->setCurrentBlock("overview_row_detail");
            $question_gui = assQuestion::instantiateQuestionGUI($a_set["question_id"]);
            $question_gui->setRenderPurpose(assQuestionGUI::RENDER_PURPOSE_PREVIEW);
            if (strcmp($this->outputmode, "detailed_output_solutions") == 0) {
                $solutionoutput = $question_gui->getSolutionOutput(0, null, false, false, false, false, true, false);
                if (strlen($solutionoutput) == 0) {
                    $solutionoutput = $question_gui->getPreview();
                }
                $this->tpl->setVariable("DETAILS", $solutionoutput);
                $this->tpl->setVariable("ROW_DETAIL_COLSPAN", $this->column_count);
            } else {
                $this->tpl->setVariable("DETAILS", $question_gui->getPreview());
                $this->tpl->setVariable("ROW_DETAIL_COLSPAN", $this->column_count);
            }
            $this->tpl->parseCurrentBlock();
        }
        ilDatePresentation::setUseRelativeDates(true);
    }

Here is the call graph for this function:

getPointsColumnHeader()

ilQuestionPoolPrintViewTableGUI::getPointsColumnHeader ( )

private

Definition at line 89 of file class.ilQuestionPoolPrintViewTableGUI.php.

References getTotalPoints(), and ILIAS\Repository\lng().

Referenced by initColumns().

                                            : string
    {
        return $this->lng->txt("points") . ' (' . $this->getTotalPoints() . ')';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSelectableColumns()

ilQuestionPoolPrintViewTableGUI::getSelectableColumns

(

)

Definition at line 94 of file class.ilQuestionPoolPrintViewTableGUI.php.

References $DIC, ilTableGUI\$lng, and ilLanguage\txt().

                                          : array
    {
        global $DIC;
        $lng = $DIC['lng'];
        $cols["description"] = [
            "txt" => $lng->txt("description"),
            "default" => true
        ];
        $cols["author"] = [
            "txt" => $lng->txt("author"),
            "default" => true
        ];
        $cols["ttype"] = [
            "txt" => $lng->txt("question_type"),
            "default" => true
        ];
        $cols["points"] = [
            "txt" => $lng->txt("points"),
            "default" => true
        ];
        $cols["created"] = [
            "txt" => $lng->txt("create_date"),
            "default" => true
        ];
        $cols["updated"] = [
            "txt" => $lng->txt("last_update"),
            "default" => true
        ];
        return $cols;
    }

Here is the call graph for this function:

getTotalPoints()

ilQuestionPoolPrintViewTableGUI::getTotalPoints

(

)

Definition at line 203 of file class.ilQuestionPoolPrintViewTableGUI.php.

References $totalPoints.

Referenced by getPointsColumnHeader().

    {
        return $this->totalPoints;
    }

Here is the caller graph for this function:

initColumns()

ilQuestionPoolPrintViewTableGUI::initColumns

(

)

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

References $c, ilTable2GUI\addColumn(), getPointsColumnHeader(), ilTable2GUI\getSelectedColumns(), and ILIAS\Repository\lng().

                                 : void
    {
        $this->addColumn($this->lng->txt("title"), 'title', '');

        foreach ($this->getSelectedColumns() as $c) {
            if (strcmp($c, 'description') == 0) {
                $this->addColumn($this->lng->txt("description"), 'description', '');
            }
            if (strcmp($c, 'author') == 0) {
                $this->addColumn($this->lng->txt("author"), 'author', '');
            }
            if (strcmp($c, 'ttype') == 0) {
                $this->addColumn($this->lng->txt("question_type"), 'ttype', '');
            }
            if (strcmp($c, 'points') == 0) {
                $this->addColumn($this->getPointsColumnHeader(), 'points', '');
            }
            if (strcmp($c, 'created') == 0) {
                $this->addColumn($this->lng->txt("create_date"), 'created', '');
            }
            if (strcmp($c, 'updated') == 0) {
                $this->addColumn($this->lng->txt("last_update"), 'updated', '');
            }
        }
    }

Here is the call graph for this function:

numericOrdering()

ilQuestionPoolPrintViewTableGUI::numericOrdering

(

string

$a_field

)

Parameters

string

$a_field

Returns

bool

Definition at line 194 of file class.ilQuestionPoolPrintViewTableGUI.php.

                                                    : bool
    {
        if (in_array($a_field, ['points', 'created', 'updated'])) {
            return true;
        }

        return false;
    }

setTotalPoints()

ilQuestionPoolPrintViewTableGUI::setTotalPoints

(

$totalPoints

)

Definition at line 208 of file class.ilQuestionPoolPrintViewTableGUI.php.

References $totalPoints.

                                                : void
    {
        $this->totalPoints = $totalPoints;
    }

Field Documentation

$outputmode

ilQuestionPoolPrintViewTableGUI::$outputmode

protected

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

Referenced by __construct().

$totalPoints

ilQuestionPoolPrintViewTableGUI::$totalPoints

protected

Definition at line 30 of file class.ilQuestionPoolPrintViewTableGUI.php.

Referenced by getTotalPoints(), and setTotalPoints().

---

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

• components/ILIAS/TestQuestionPool/classes/tables/class.ilQuestionPoolPrintViewTableGUI.php