ILIAS  Release_4_4_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Attributes
ilTestQuestionsTableGUI Class Reference
Modules/Test
+ Inheritance diagram for ilTestQuestionsTableGUI:
+ Collaboration diagram for ilTestQuestionsTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $a_write_access=false, $a_checked_move=false, $a_total=0)
 Constructor.
 getSelectableColumns ()
 fillHeader ()
 fillRow ($data)
 fill row
 setWriteAccess ($value)
 getWriteAccess ()
 setCheckedMove ($value)
 getCheckedMove ()
 setTotal ($value)
 getTotal ()
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 Constructor.
 setOpenFormTag ($a_val)
 Set open form tag.
 getOpenFormTag ()
 Get open form tag.
 setCloseFormTag ($a_val)
 Set close form tag.
 getCloseFormTag ()
 Get close form tag.
 determineLimit ()
 Determine the limit.
 determineSelectedColumns ()
 Determine selected columns.
 isColumnSelected ($a_col)
 Is given column selected?
 getSelectedColumns ()
 Get selected columns.
& executeCommand ()
 Execute command.
 resetOffset ($a_in_determination=false)
 Reset offset.
 initFilter ()
 Init filter.
 getParentObject ()
 Get parent object.
 getParentCmd ()
 Get parent command.
 setTopAnchor ($a_val)
 Set top anchor.
 getTopAnchor ()
 Get top anchor.
 setNoEntriesText ($a_text)
 Set text for an empty table.
 getNoEntriesText ()
 Get text for an empty table.
 setIsDataTable ($a_val)
 Set is data table.
 getIsDataTable ()
 Get is data table.
 setEnableTitle ($a_enabletitle)
 Set Enable Title.
 getEnableTitle ()
 Get Enable Title.
 setEnableHeader ($a_enableheader)
 Set Enable Header.
 getEnableHeader ()
 Get Enable Header.
 setEnableNumInfo ($a_val)
 Set enable num info.
 getEnableNumInfo ()
 Get enable num info.
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon.
 setDescription ($a_val)
 Set description.
 getDescription ()
 Get description.
 setOrderField ($a_order_field)
 set order column
 getOrderField ()
 setData ($a_data)
 set table data public
 getData ()
 dataExists ()
 setPrefix ($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) public
 getPrefix ()
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item.
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
 Add filter by standard type.
 getFilterItems ($a_optionals=false)
 Get filter items.
 getFilterItemByPostVar ($a_post_var)
 setFilterCols ($a_val)
 Set filter columns.
 getFilterCols ()
 Get filter columns.
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding.
 getDisableFilterHiding ()
 Get disable filter hiding.
 isFilterSelected ($a_col)
 Is given filter selected?
 getSelectedFilters ()
 Get selected filters.
 determineSelectedFilters ()
 Determine selected filters.
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links.
 setFormAction ($a_form_action)
 Set Form action parameter.
 getFormAction ()
 Get Form action parameter.
 setFormName ($a_formname)
 Set Form name.
 getFormName ()
 Get Form name.
 setId ($a_val)
 Set id.
 getId ()
 Get element id.
 setDisplayAsBlock ($a_val)
 Set display as block.
 getDisplayAsBlock ()
 Get display as block.
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button.
 setSelectAllCheckbox ($a_select_all_checkbox)
 Set the name of the checkbox that should be toggled with a select all button.
 setExternalSorting ($a_val)
 Set external sorting.
 getExternalSorting ()
 Get external sorting.
 setFilterCommand ($a_val)
 Set filter command.
 getFilterCommand ()
 Get filter command.
 setResetCommand ($a_val)
 Set reset filter command.
 getResetCommand ()
 Get reset filter command.
 setExternalSegmentation ($a_val)
 Set external segmentation.
 getExternalSegmentation ()
 Get external segmentation.
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template.
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field.
 getDefaultOrderField ()
 Get Default order field.
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction.
 getDefaultOrderDirection ()
 Get Default order direction.
 clearCommandButtons ()
 addCommandButton ($a_cmd, $a_text, $a_onclick= '', $a_id="")
 Add Command button.
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection= '')
 Add Selection List + Command button.
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection= '')
 Add Selection List + Command button for selected items.
 setCloseCommand ($a_link)
 Add command for closing table.
 addMultiCommand ($a_cmd, $a_text)
 Add Command button.
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field.
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now)
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too)
 getTopCommands ()
 Get top commands (display command buttons on top of table, too)
 addColumn ($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
 Add a column to the header.
 getNavParameter ()
 setOrderLink ($sort_field, $order_dir)
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order.
 storeNavParameter ()
 getHTML ()
 Get HTML.
 numericOrdering ($a_field)
 Should this field be sorted numeric?
 render ()
 render table public
 writeFilterToSession ()
 Write filter values to session.
 resetFilter ()
 Reset filter.
 fillFooter ()
 Fill footer row.
 getLinkbar ($a_num)
 Get previous/next linkbar.
 fillHiddenRow ()
 fillActionRow ()
 Fill Action Row.
 setHeaderHTML ($html)
 set header html
 storeProperty ($type, $value)
 Store table property.
 loadProperty ($type)
 Load table property.
 getCurrentState ()
 get current settings for order, limit, columns and filter
 setContext ($id)
 Set context.
 getContext ()
 Get context.
 setShowRowsSelector ($a_value)
 Toggle rows-per-page selector.
 getShowRowsSelector ()
 Get rows-per-page selector state.
 setShowTemplates ($a_value)
 Toggle templates.
 getShowTemplates ()
 Get template state.
 restoreTemplate ($a_name)
 Restore state from template.
 saveTemplate ($a_name)
 Save current state as template.
 deleteTemplate ($a_name)
 Delete template.
 getLimit ()
 Get limit.
 getOffset ()
 Get offset.
 setExportFormats (array $formats)
 Set available export formats.
 setPrintMode ($a_value=false)
 Toogle print mode.
 getPrintMode ()
 Get print mode.
 getExportMode ()
 Was export activated?
 exportData ($format, $send=false)
 Export and optionally send current table data.
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result.
 setRowSelectorLabel ($row_selector_label)
 getRowSelectorLabel ()
- Public Member Functions inherited from ilTableGUI
 ilTableGUI ($a_data=0, $a_global_tpl=true)
 Constructor.
 setTemplate (&$a_tpl)
 set template public
& getTemplateObject ()
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page public
 setHeaderNames ($a_header_names)
 set table header names public
 getColumnCount ()
 Returns the column count based on the number of the header row columns public.
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars public
 setColumnWidth ($a_column_width)
 set table column widths public
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width public
 setMaxCount ($a_max_count)
 set max.
 setLimit ($a_limit=0, $a_default_limit=0)
 set max.
 setOffset ($a_offset)
 set dataset offset public
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column public
 getOrderColumn ()
 Get order column.
 setOrderDirection ($a_order_direction)
 set order direction public
 getOrderDirection ()
 Get order direction.
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction public
 enable ($a_module_name)
 enables particular modules of table
 disable ($a_module_name)
 diesables particular modules of table
 sortData ()
 renderHeader ()
 setStyle ($a_element, $a_style)
 getStyle ($a_element)
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds).
 getBase ()
 Get Base script name (deprecated, only use this for workarounds).
 clearActionButtons ()
 addActionButton ($btn_name, $btn_value)

Protected Attributes

 $writeAccess = false
 $totalPoints = 0
 $checked_move = false
 $total = 0
 $position = 0
 $visibleOptionalColumns = array()
 $optionalColumns = array()
- Protected Attributes inherited from ilTable2GUI
 $close_command = ""
 $top_anchor = "il_table_top"
 $filters = array()
 $optional_filters = array()
 $filter_cmd = 'applyFilter'
 $reset_cmd = 'resetFilter'
 $filter_cols = 5
 $ext_sort = false
 $ext_seg = false
 $context = ""
 $mi_sel_buttons = null
 $disable_filter_hiding = false
 $selected_filter = false
 $top_commands = true
 $selectable_columns = array()
 $selected_column = array()
 $show_templates = false
 $show_rows_selector = false
 $nav_determined = false
 $limit_determined = false
 $filters_determined = false
 $columns_determined = false
 $open_form_tag = true
 $close_form_tag = true
 $export_formats
 $export_mode
 $print_mode
 $enable_command_for_all
 $row_selector_label

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all.
- 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 EXPORT_EXCEL = 1
const EXPORT_CSV = 2
const ACTION_ALL_LIMIT = 1000
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated.
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value.
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value.
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export.
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Row.
 fillRowExcel ($a_worksheet, &$a_row, $a_set)
 Excel Version of Fill Row.
 fillMetaCSV ($a_csv)
 Add meta information to csv export.
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header.
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row.

Detailed Description

Author
Helmut Schottmüller ilias.nosp@m.@aur.nosp@m.ealis.nosp@m..de
Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de
Version
Id:
class.ilTestQuestionsTableGUI.php 49962 2014-05-12 06:04:32Z bheyser

Definition at line 15 of file class.ilTestQuestionsTableGUI.php.

Constructor & Destructor Documentation

ilTestQuestionsTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_write_access = false,
  $a_checked_move = false,
  $a_total = 0 
)

Constructor.

public

Parameters
@return

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

References $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ilTableGUI\disable(), ilTableGUI\enable(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), getTotal(), getWriteAccess(), setCheckedMove(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTableGUI\setStyle(), and setWriteAccess().

{
$this->setId('tst_qst_lst_'.$a_parent_obj->object->getRefId());
parent::__construct($a_parent_obj, $a_parent_cmd);
global $lng, $ilCtrl;
$this->lng = $lng;
$this->ctrl = $ilCtrl;
$this->total = $a_total;
$this->setWriteAccess($a_write_access);
$this->setCheckedMove($a_checked_move);
$this->setFormName('questionbrowser');
$this->setStyle('table', 'fullwidth');
$this->addColumn('','f','1%', true);
$this->addColumn('','f','1%');
$this->visibleOptionalColumns = (array)$this->getSelectedColumns();
$this->optionalColumns = (array)$this->getSelectableColumns();
if(isset($this->visibleOptionalColumns['qid']))
{
$this->addColumn($this->optionalColumns['qid']['txt'],'qid', '');
}
$this->addColumn($this->lng->txt("tst_question_title"),'title', '');
//$this->addColumn($this->lng->txt("tst_sequence"),'sequence', '');
if( $a_parent_obj->object->areObligationsEnabled() )
{
$this->addColumn($this->lng->txt("obligatory"),'obligatory', '');
}
if(isset($this->visibleOptionalColumns['description']))
{
$this->addColumn($this->optionalColumns['description']['txt'],'description', '');
}
$this->addColumn($this->lng->txt("tst_question_type"),'type', '');
$this->addColumn($this->lng->txt("points"),'', '');
if(isset($this->visibleOptionalColumns['author']))
{
$this->addColumn($this->optionalColumns['author']['txt'],'author', '');
}
$this->addColumn($this->lng->txt("qpl"),'qpl', '');
$this->setSelectAllCheckbox('q_id');
$this->setExternalSegmentation(true);
if ($this->getWriteAccess() && !$this->getTotal())
{
$this->addMultiCommand('removeQuestions', $this->lng->txt('remove_question'));
$this->addMultiCommand('moveQuestions', $this->lng->txt('move'));
if ($this->checked_move)
{
$this->addMultiCommand('insertQuestionsBefore', $this->lng->txt('insert_before'));
$this->addMultiCommand('insertQuestionsAfter', $this->lng->txt('insert_after'));
}
//$this->addMultiCommand('copyToQuestionpool', $this->lng->txt('copy_to_questionpool'));
$this->addMultiCommand('copyQuestion', $this->lng->txt('copy'));
$this->addMultiCommand('copyAndLinkToQuestionpool', $this->lng->txt('copy_and_link_to_questionpool'));
}
$this->setRowTemplate("tpl.il_as_tst_questions_row.html", "Modules/Test");
$this->setFormAction($this->ctrl->getFormAction($a_parent_obj, $a_parent_cmd));
if( $a_parent_obj->object->areObligationsEnabled() )
{
$this->addCommandButton('saveOrderAndObligations', $this->lng->txt('saveOrderAndObligations'));
}
else
{
$this->addCommandButton('saveOrderAndObligations', $this->lng->txt('saveOrder'));
}
$this->disable('sort');
$this->enable('header');
$this->enable('select_all');
}

+ Here is the call graph for this function:

Member Function Documentation

ilTestQuestionsTableGUI::fillHeader ( )

Reimplemented from ilTable2GUI.

Definition at line 136 of file class.ilTestQuestionsTableGUI.php.

{
foreach ($this->column as $key => $column)
{
if (strcmp($column['text'], $this->lng->txt("points")) == 0)
{
$this->column[$key]['text'] = $this->lng->txt("points") . " (" . $this->totalPoints . ")";
}
}
parent::fillHeader();
}
ilTestQuestionsTableGUI::fillRow (   $data)

fill row

public

Parameters
@return

Reimplemented from ilTable2GUI.

Definition at line 155 of file class.ilTestQuestionsTableGUI.php.

References ilTableGUI\$data, $ilUser, $lng, ilObject\_getAllReferences(), assQuestion\_getQuestionTypeName(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilTable2GUI\getData(), ilUtil\getImagePath(), getTotal(), and getWriteAccess().

{
global $ilUser,$ilAccess;
$q_id = $data["question_id"];
$this->tpl->setVariable("QUESTION_ID", $q_id);
if(isset($this->visibleOptionalColumns['qid']))
{
$this->tpl->setVariable("QUESTION_ID_PRESENTATION", $q_id);
}
if ($this->getWriteAccess() && !$this->getTotal() && $data["obj_fi"] > 0)
{
if (!$data['complete']) {
$this->tpl->setVariable("IMAGE_WARNING", ilUtil::getImagePath("warning.png"));
$this->tpl->setVariable("ALT_WARNING", $this->lng->txt("warning_question_not_complete"));
$this->tpl->setVariable("TITLE_WARNING", $this->lng->txt("warning_question_not_complete"));
}
$qpl_ref_id = current(ilObject::_getAllReferences($data["obj_fi"]));
$this->tpl->setVariable("QUESTION_TITLE", "<a href=\"" . $this->ctrl->getLinkTarget($this->getParentObject(), "questions") . "&eqid=$q_id&eqpl=$qpl_ref_id" . "\">" . $data["title"] . "</a>");
// obligatory checkbox (when obligation is possible)
if( $data["obligationPossible"] )
{
$CHECKED = $data["obligatory"] ? "checked=\"checked\" " : "";
$OBLIGATORY = "<input type=\"checkbox\" name=\"obligatory[$q_id]\" value=\"1\" $CHECKED/>";
}
else
{
$OBLIGATORY = "";
}
}
else
{
global $lng;
$this->tpl->setVariable("QUESTION_TITLE", $data["title"]);
// obligatory icon
if( $data["obligatory"] )
{
$OBLIGATORY = "<img src=\"".ilUtil::getImagePath("obligatory.gif", "Modules/Test").
"\" alt=\"".$lng->txt("question_obligatory").
"\" title=\"".$lng->txt("question_obligatory")."\" />";
}
else $OBLIGATORY = '';
}
if( $this->parent_obj->object->areObligationsEnabled() )
{
$this->tpl->setVariable("QUESTION_OBLIGATORY", $OBLIGATORY);
}
$this->tpl->setVariable("QUESTION_SEQUENCE", $this->lng->txt("tst_sequence"));
if ($this->getWriteAccess() && !$this->getTotal())
{
if ($data["sequence"] != 1)
{
$this->tpl->setVariable("BUTTON_UP", "<a href=\"" . $this->ctrl->getLinkTarget($this->getParentObject(), "questions") . "&up=".$data["question_id"]."\"><img src=\"" . ilUtil::getImagePath("a_up.png") . "\" alt=\"" . $this->lng->txt("up") . "\" border=\"0\" /></a>");
}
if ($data["sequence"] != count($this->getData()))
{
$this->tpl->setVariable("BUTTON_DOWN", "<a href=\"" . $this->ctrl->getLinkTarget($this->getParentObject(), "questions") . "&down=".$data["question_id"]."\"><img src=\"" . ilUtil::getImagePath("a_down.png") . "\" alt=\"" . $this->lng->txt("down") . "\" border=\"0\" /></a>");
}
}
if(isset($this->visibleOptionalColumns['description']))
{
if($data["description"])
{
$this->tpl->setVariable("QUESTION_COMMENT", $data["description"] ? $data["description"] : '&nbsp;');
}
else
{
$this->tpl->touchBlock('question_comment_block');
}
}
include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
$this->tpl->setVariable("QUESTION_TYPE", assQuestion::_getQuestionTypeName($data["type_tag"]));
$this->tpl->setVariable("QUESTION_POINTS", $data["points"]);
$this->totalPoints += $data["points"];
if(isset($this->visibleOptionalColumns['author']))
{
$this->tpl->setVariable("QUESTION_AUTHOR", $data["author"]);
}
if (ilObject::_lookupType($data["orig_obj_fi"]) == 'qpl') {
$this->tpl->setVariable("QUESTION_POOL", ilObject::_lookupTitle($data["orig_obj_fi"]));
}
else {
$this->tpl->setVariable("QUESTION_POOL", $this->lng->txt('tst_question_not_from_pool_info'));
}
$this->position += 10;
$field = "<input type=\"text\" name=\"order[q_".$data["question_id"].
"]\" value=\"".$this->position."\" maxlength=\"3\" style=\"width:30px\" />";
$this->tpl->setVariable("QUESTION_POSITION", $field);
}

+ Here is the call graph for this function:

ilTestQuestionsTableGUI::getCheckedMove ( )

Definition at line 273 of file class.ilTestQuestionsTableGUI.php.

References $checked_move.

{
return $this->checked_move;
}
ilTestQuestionsTableGUI::getSelectableColumns ( )
Returns
array

Reimplemented from ilTable2GUI.

Definition at line 125 of file class.ilTestQuestionsTableGUI.php.

Referenced by __construct().

{
$cols = array(
'qid' => array('txt' => $this->lng->txt('question_id'), 'default' => true),
'description' => array('txt' => $this->lng->txt('description'), 'default' => false),
'author' => array('txt' => $this->lng->txt('author'), 'default' => false)
);
return $cols;
}

+ Here is the caller graph for this function:

ilTestQuestionsTableGUI::getTotal ( )

Definition at line 283 of file class.ilTestQuestionsTableGUI.php.

References $total.

Referenced by __construct(), and fillRow().

{
return $this->total;
}

+ Here is the caller graph for this function:

ilTestQuestionsTableGUI::getWriteAccess ( )

Definition at line 263 of file class.ilTestQuestionsTableGUI.php.

References $writeAccess.

Referenced by __construct(), and fillRow().

{
return $this->writeAccess;
}

+ Here is the caller graph for this function:

ilTestQuestionsTableGUI::setCheckedMove (   $value)

Definition at line 268 of file class.ilTestQuestionsTableGUI.php.

Referenced by __construct().

{
$this->checked_move = $value;
}

+ Here is the caller graph for this function:

ilTestQuestionsTableGUI::setTotal (   $value)

Definition at line 278 of file class.ilTestQuestionsTableGUI.php.

{
$this->total = $value;
}
ilTestQuestionsTableGUI::setWriteAccess (   $value)

Definition at line 258 of file class.ilTestQuestionsTableGUI.php.

Referenced by __construct().

{
$this->writeAccess = $value;
}

+ Here is the caller graph for this function:

Field Documentation

ilTestQuestionsTableGUI::$checked_move = false
protected

Definition at line 19 of file class.ilTestQuestionsTableGUI.php.

Referenced by getCheckedMove().

ilTestQuestionsTableGUI::$optionalColumns = array()
protected

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

ilTestQuestionsTableGUI::$position = 0
protected

Definition at line 22 of file class.ilTestQuestionsTableGUI.php.

ilTestQuestionsTableGUI::$total = 0
protected

Definition at line 20 of file class.ilTestQuestionsTableGUI.php.

Referenced by getTotal().

ilTestQuestionsTableGUI::$totalPoints = 0
protected

Definition at line 18 of file class.ilTestQuestionsTableGUI.php.

ilTestQuestionsTableGUI::$visibleOptionalColumns = array()
protected

Definition at line 27 of file class.ilTestQuestionsTableGUI.php.

ilTestQuestionsTableGUI::$writeAccess = false
protected

Definition at line 17 of file class.ilTestQuestionsTableGUI.php.

Referenced by getWriteAccess().

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