ILIAS  release_4-4 Revision
All Data Structures Namespaces Files Functions Variables Modules Pages
ilCourseObjectiveQuestionAssignmentTableGUI Class Reference

TableGUI for question assignments of course objectives. More...

+ Inheritance diagram for ilCourseObjectiveQuestionAssignmentTableGUI:
+ Collaboration diagram for ilCourseObjectiveQuestionAssignmentTableGUI:

Public Member Functions

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

Protected Member Functions

 fillRow ($a_set)
 fill row More...
 
 initQuestionAssignments ()
 init objective assignments More...
 
 sortQuestions ($a_qst_ids)
 Sort questions. More...
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Row. More...
 
 fillRowExcel ($a_worksheet, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

Private Attributes

 $mode = 0
 
 $objective = null
 
 $objective_lm = null
 
 $objective_id = 0
 
 $course_obj
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- 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
 
- Data Fields inherited from ilTableGUI
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 
- 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
 

Detailed Description

TableGUI for question assignments of course objectives.

Author
Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 35 of file class.ilCourseObjectiveQuestionAssignmentTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCourseObjectiveQuestionAssignmentTableGUI::__construct (   $a_parent_obj,
  $a_course_obj,
  $a_objective_id,
  $a_mode 
)

Constructor.

public

Parameters

Definition at line 52 of file class.ilCourseObjectiveQuestionAssignmentTableGUI.php.

References $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTableGUI\disable(), initQuestionAssignments(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTableGUI\setLimit(), ilTable2GUI\setRowTemplate(), ilCourseObjectiveQuestion\TYPE_FINAL_TEST, and ilCourseObjectiveQuestion\TYPE_SELF_ASSESSMENT.

53  {
54  global $lng,$ilCtrl;
55 
56  $this->objective_id = $a_objective_id;
57  $this->course_obj = $a_course_obj;
58 
59  $this->lng = $lng;
60  $this->lng->loadLanguageModule('crs');
61  $this->ctrl = $ilCtrl;
62 
63  parent::__construct($a_parent_obj,'materialAssignment');
64  $this->setFormName('assignments');
65  $this->addColumn($this->lng->txt('type'),'type',"1px");
66  $this->addColumn($this->lng->txt('title'),'title','99%');
67 
68  $this->setFormAction($this->ctrl->getFormAction($a_parent_obj));
69  $this->setRowTemplate("tpl.crs_objective_list_questions_row.html","Modules/Course");
70  $this->disable('sort');
71  $this->disable('header');
72  $this->disable('numinfo');
73  $this->disable('select_all');
74 
75  #$this->setDefaultOrderField('title');
76  $this->setLimit(200);
77 
78  $this->mode = $a_mode;
79  switch($a_mode)
80  {
82  $this->addCommandButton('updateSelfAssessmentAssignment',$this->lng->txt('crs_wiz_next'));
83  $this->addCommandButton('materialAssignment',$this->lng->txt('crs_wiz_back'));
84  break;
85 
87  $this->addCommandButton('updateFinalTestAssignment',$this->lng->txt('crs_wiz_next'));
88  $this->addCommandButton('selfAssessmentAssignment',$this->lng->txt('crs_wiz_back'));
89  break;
90  }
91 
92  $this->initQuestionAssignments();
93  }
setFormName($a_formname)
Set Form name.
global $ilCtrl
Definition: ilias.php:18
setLimit($a_limit=0, $a_default_limit=0)
set max.
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
Add a column to the header.
addCommandButton($a_cmd, $a_text, $a_onclick='', $a_id="")
Add Command button.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
disable($a_module_name)
diesables particular modules of table
global $lng
Definition: privfeed.php:40
setFormAction($a_form_action)
Set Form action parameter.
+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilCourseObjectiveQuestionAssignmentTableGUI::fillRow (   $a_set)
protected

fill row

protected

Parameters
arrayrow data
Returns

Definition at line 102 of file class.ilCourseObjectiveQuestionAssignmentTableGUI.php.

References ilUtil\getTypeIconPath(), ilCourseObjectiveQuestion\TYPE_FINAL_TEST, and ilCourseObjectiveQuestion\TYPE_SELF_ASSESSMENT.

103  {
104  foreach($a_set['sub'] as $sub_data)
105  {
106  if($a_set['random'])
107  {
108  break;
109  }
110 
111 
112  if($sub_data['description'])
113  {
114  $this->tpl->setVariable('QST_DESCRIPTION',$sub_data['description']);
115  }
116  $this->tpl->setCurrentBlock('qst');
117  $this->tpl->setVariable('QST_TITLE',$sub_data['title']);
118  $this->tpl->setVariable('QST_ID',$a_set['id'].'_'.$sub_data['id']);
119 
120  switch($this->mode)
121  {
123  if($this->objective_qst_obj->isSelfAssessmentQuestion($sub_data['id']))
124  {
125  $this->tpl->setVariable('QST_CHECKED','checked="checked"');
126  }
127  break;
128 
130  if($this->objective_qst_obj->isFinalTestQuestion($sub_data['id']))
131  {
132  $this->tpl->setVariable('QST_CHECKED','checked="checked"');
133  }
134  break;
135  }
136  $this->tpl->parseCurrentBlock();
137  }
138  if(count($a_set['sub']) and !$a_set['random'])
139  {
140  $this->tpl->setVariable('TXT_QUESTIONS',$this->lng->txt('objs_qst'));
141  }
142  if($a_set['random'])
143  {
144  $this->tpl->setVariable('VAL_WARN',$this->lng->txt('crs_objective_random_warn'));
145  }
146 
147  $this->tpl->setVariable('VAL_ID',$a_set['id']);
148 
149  $this->tpl->setVariable('ROW_TYPE_IMG',ilUtil::getTypeIconPath($a_set['type'],$a_set['obj_id'],'tiny'));
150  $this->tpl->setVariable('ROW_TYPE_ALT',$this->lng->txt('obj_'.$a_set['type']));
151 
152  $this->tpl->setVariable('VAL_TITLE',$a_set['title']);
153  if(strlen($a_set['description']))
154  {
155  $this->tpl->setVariable('VAL_DESC',$a_set['description']);
156  }
157  }
static getTypeIconPath($a_type, $a_obj_id, $a_size='small')
Get type icon path path Return image path for icon_xxx.pngs Or (if enabled) path to custom icon...
+ Here is the call graph for this function:

◆ initQuestionAssignments()

ilCourseObjectiveQuestionAssignmentTableGUI::initQuestionAssignments ( )
protected

init objective assignments

protected

Returns

Definition at line 214 of file class.ilCourseObjectiveQuestionAssignmentTableGUI.php.

Referenced by __construct().

215  {
216  include_once './Modules/Course/classes/class.ilCourseObjectiveQuestion.php';
217  $this->objective_qst_obj = new ilCourseObjectiveQuestion($this->objective_id);
218 
219  return true;
220  }
class ilcourseobjectiveQuestion
+ Here is the caller graph for this function:

◆ parse()

ilCourseObjectiveQuestionAssignmentTableGUI::parse (   $a_assignable)

parse

public

Parameters
arrayarray of assignable nodes (tree node data)
Returns

Definition at line 166 of file class.ilCourseObjectiveQuestionAssignmentTableGUI.php.

References $tests, ilObjTest\_instanciateQuestion(), ilObjTest\_lookupRandomTest(), ilObjectFactory\getInstanceByRefId(), ilTable2GUI\setData(), and sortQuestions().

167  {
168  global $objDefinition;
169 
170  $tests = array();
171  foreach($a_assignable as $node)
172  {
173  $tmp_data = array();
174  $subobjects = array();
175 
176  if(!$tmp_tst = ilObjectFactory::getInstanceByRefId((int) $node['ref_id'],false))
177  {
178  continue;
179  }
180 
181  include_once './Modules/Test/classes/class.ilObjTest.php';
182  $tmp_data['random'] = ilObjTest::_lookupRandomTest($node['obj_id']);
183 
184  foreach($qst = $this->sortQuestions($tmp_tst->getAllQuestions()) as $question_data)
185  {
186  $tmp_question = ilObjTest::_instanciateQuestion($question_data['question_id']);
187 
188  $sub['title'] = $tmp_question->getTitle();
189  $sub['description'] = $tmp_question->getComment();
190  $sub['id'] = $question_data['question_id'];
191 
192  $subobjects[] = $sub;
193 
194  }
195  $tmp_data['title'] = $node['title'];
196  $tmp_data['description'] = $node['description'];
197  $tmp_data['type'] = $node['type'];
198  $tmp_data['id'] = $node['child'];
199  $tmp_data['obj_id'] = $node['obj_id'];
200  $tmp_data['sub'] = $subobjects;
201 
202  $tests[] = $tmp_data;
203  }
204 
205  $this->setData($tests);
206  }
getInstanceByRefId($a_ref_id, $stop_on_error=true)
get an instance of an Ilias object by reference id
static _lookupRandomTest($a_obj_id)
Returns the fact wether the test with passed obj id is a random questions test or not...
& _instanciateQuestion($question_id)
Creates an instance of a question with a given question id.
+ Here is the call graph for this function:

◆ sortQuestions()

ilCourseObjectiveQuestionAssignmentTableGUI::sortQuestions (   $a_qst_ids)
protected

Sort questions.

protected

Parameters

Definition at line 229 of file class.ilCourseObjectiveQuestionAssignmentTableGUI.php.

References ilUtil\sortArray().

Referenced by parse().

230  {
231  return ilUtil::sortArray($a_qst_ids,'title','asc');
232  }
static sortArray($array, $a_array_sortby, $a_array_sortorder=0, $a_numeric=false, $a_keep_keys=false)
sortArray
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $course_obj

ilCourseObjectiveQuestionAssignmentTableGUI::$course_obj
private

◆ $mode

ilCourseObjectiveQuestionAssignmentTableGUI::$mode = 0
private

◆ $objective

ilCourseObjectiveQuestionAssignmentTableGUI::$objective = null
private

◆ $objective_id

ilCourseObjectiveQuestionAssignmentTableGUI::$objective_id = 0
private

◆ $objective_lm

ilCourseObjectiveQuestionAssignmentTableGUI::$objective_lm = null
private

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