ILIAS  release_8 Revision v8.19-1-g4e8f2f9140c
All Data Structures Namespaces Files Functions Variables Modules Pages
ilAnswerFrequencyStatisticTableGUI Class Reference
+ Inheritance diagram for ilAnswerFrequencyStatisticTableGUI:
+ Collaboration diagram for ilAnswerFrequencyStatisticTableGUI:

Public Member Functions

 isActionsColumnEnabled ()
 
 setActionsColumnEnabled (bool $actionsColumnEnabled)
 
 getAdditionalHtml ()
 
 setAdditionalHtml (string $additionalHtml)
 
 addAdditionalHtml (string $additionalHtml)
 
 getQuestionIndex ()
 
 setQuestionIndex (int $questionIndex)
 
 initColumns ()
 
 fillRow (array $a_set)
 
- 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 ()
 
 setShowTemplates (bool $a_value)
 
 getShowTemplates ()
 
 restoreTemplate (string $a_name)
 Restore state from template. More...
 
 saveTemplate (string $a_name)
 Save current state as template. More...
 
 deleteTemplate (string $a_name)
 
 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

 buildAddAnswerAction ($data)
 
 purifyAndPrepareTextAreaOutput (string $content)
 
- 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

ilLanguage $language
 
UIServices $ui
 
RefineryFactory $refinery
 
ilCtrl $ctrl
 
assQuestion $question
 
int $questionIndex
 
bool $actionsColumnEnabled = false
 
string $additionalHtml = ''
 
- Protected Attributes inherited from ilTable2GUI
string $requested_tmpl_delete
 
string $requested_tmpl_create
 
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_templates = false
 
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 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

Definition at line 31 of file class.ilAnswerFrequencyStatisticTableGUI.php.

Member Function Documentation

◆ addAdditionalHtml()

ilAnswerFrequencyStatisticTableGUI::addAdditionalHtml ( string  $additionalHtml)
Parameters
string$additionalHtml

Definition at line 106 of file class.ilAnswerFrequencyStatisticTableGUI.php.

References $additionalHtml.

Referenced by buildAddAnswerAction().

106  : void
107  {
108  $this->additionalHtml .= $additionalHtml;
109  }
+ Here is the caller graph for this function:

◆ buildAddAnswerAction()

ilAnswerFrequencyStatisticTableGUI::buildAddAnswerAction (   $data)
protected

Definition at line 164 of file class.ilAnswerFrequencyStatisticTableGUI.php.

References ilTableGUI\$data, addAdditionalHtml(), ILIAS\Repository\ctrl(), getQuestionIndex(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\refinery(), and ILIAS\Repository\ui().

Referenced by fillRow().

164  : string
165  {
166  $ui_factory = $this->ui->factory();
167  $ui_renderer = $this->ui->renderer();
168 
169  $answer_form_builder = new ilAddAnswerFormBuilder($this->parent_obj, $ui_factory, $this->refinery, $this->language, $this->ctrl);
170 
171  $data['question_id'] = $this->question->getId();
172  $data['question_index'] = $this->getQuestionIndex();
173 
174  $form = $answer_form_builder->buildAddAnswerForm($data);
175  $modal = $ui_factory->modal()->roundtrip($this->question->getTitleForHTMLOutput(), $form);
176 
177  $show_modal_button = $ui_factory->button()->standard(
178  $this->language->txt('tst_corr_add_as_answer_btn'),
179  $modal->getShowSignal()
180  );
181 
182  $this->addAdditionalHtml($ui_renderer->render($modal));
183 
184  return $ui_renderer->render($show_modal_button);
185  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillRow()

ilAnswerFrequencyStatisticTableGUI::fillRow ( array  $a_set)

Definition at line 141 of file class.ilAnswerFrequencyStatisticTableGUI.php.

References buildAddAnswerAction(), ilHtmlPurifierFactory\getInstanceByType(), and isActionsColumnEnabled().

141  : void
142  {
143  $this->tpl->setCurrentBlock('answer');
144  $this->tpl->setVariable('ANSWER', ilHtmlPurifierFactory::getInstanceByType('qpl_usersolution')->purify($a_set['answer']));
145  $this->tpl->parseCurrentBlock();
146 
147  $this->tpl->setCurrentBlock('frequency');
148  $this->tpl->setVariable('FREQUENCY', $a_set['frequency']);
149  $this->tpl->parseCurrentBlock();
150 
151  if ($this->isActionsColumnEnabled()) {
152  if (isset($a_set['addable'])) {
153  $this->tpl->setCurrentBlock('actions');
154  $this->tpl->setVariable('ACTIONS', $this->buildAddAnswerAction($a_set));
155  $this->tpl->parseCurrentBlock();
156  } else {
157  $this->tpl->setCurrentBlock('actions');
158  $this->tpl->touchBlock('actions');
159  $this->tpl->parseCurrentBlock();
160  }
161  }
162  }
static getInstanceByType(string $type)
+ Here is the call graph for this function:

◆ getAdditionalHtml()

ilAnswerFrequencyStatisticTableGUI::getAdditionalHtml ( )
Returns
string

Definition at line 90 of file class.ilAnswerFrequencyStatisticTableGUI.php.

References $additionalHtml.

◆ getQuestionIndex()

ilAnswerFrequencyStatisticTableGUI::getQuestionIndex ( )
Returns
int

Definition at line 114 of file class.ilAnswerFrequencyStatisticTableGUI.php.

References $questionIndex.

Referenced by buildAddAnswerAction().

+ Here is the caller graph for this function:

◆ initColumns()

ilAnswerFrequencyStatisticTableGUI::initColumns ( )

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

References ilTable2GUI\addColumn(), ilTable2GUI\getData(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and setActionsColumnEnabled().

127  : void
128  {
129  $this->addColumn($this->language->txt('tst_corr_answ_stat_tbl_header_answer'), '');
130  $this->addColumn($this->language->txt('tst_corr_answ_stat_tbl_header_frequency'), '');
131 
132  foreach ($this->getData() as $row) {
133  if (isset($row['addable'])) {
134  $this->setActionsColumnEnabled(true);
135  $this->addColumn('', '', '1%');
136  break;
137  }
138  }
139  }
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)
+ Here is the call graph for this function:

◆ isActionsColumnEnabled()

ilAnswerFrequencyStatisticTableGUI::isActionsColumnEnabled ( )
Returns
bool

Definition at line 74 of file class.ilAnswerFrequencyStatisticTableGUI.php.

References $actionsColumnEnabled.

Referenced by fillRow().

+ Here is the caller graph for this function:

◆ purifyAndPrepareTextAreaOutput()

ilAnswerFrequencyStatisticTableGUI::purifyAndPrepareTextAreaOutput ( string  $content)
protected

Definition at line 187 of file class.ilAnswerFrequencyStatisticTableGUI.php.

References ilLegacyFormElementsUtil\prepareTextareaOutput().

187  : string
188  {
189  $purified_content = $this->getHtmlQuestionContentPurifier()->purify($content);
190  if ($this->isAdditionalContentEditingModePageObject()
191  || !(new ilSetting('advanced_editing'))->get('advanced_editing_javascript_editor') === 'tinymce') {
192  $purified_content = nl2br($purified_content);
193  }
195  $purified_content,
196  true,
197  true
198  );
199  }
static prepareTextareaOutput(string $txt_output, bool $prepare_for_latex_output=false, bool $omitNl2BrWhenTextArea=false)
Prepares a string for a text area output where latex code may be in it If the text is HTML-free...
+ Here is the call graph for this function:

◆ setActionsColumnEnabled()

ilAnswerFrequencyStatisticTableGUI::setActionsColumnEnabled ( bool  $actionsColumnEnabled)
Parameters
bool$actionsColumnEnabled

Definition at line 82 of file class.ilAnswerFrequencyStatisticTableGUI.php.

References $actionsColumnEnabled.

Referenced by ilKprimChoiceAnswerFreqStatTableGUI\initColumns(), and initColumns().

82  : void
83  {
84  $this->actionsColumnEnabled = $actionsColumnEnabled;
85  }
+ Here is the caller graph for this function:

◆ setAdditionalHtml()

ilAnswerFrequencyStatisticTableGUI::setAdditionalHtml ( string  $additionalHtml)
Parameters
string$additionalHtml

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

References $additionalHtml.

98  : void
99  {
100  $this->additionalHtml = $additionalHtml;
101  }

◆ setQuestionIndex()

ilAnswerFrequencyStatisticTableGUI::setQuestionIndex ( int  $questionIndex)
Parameters
int$questionIndex

Definition at line 122 of file class.ilAnswerFrequencyStatisticTableGUI.php.

References $questionIndex.

122  : void
123  {
124  $this->questionIndex = $questionIndex;
125  }

Field Documentation

◆ $actionsColumnEnabled

bool ilAnswerFrequencyStatisticTableGUI::$actionsColumnEnabled = false
protected

◆ $additionalHtml

string ilAnswerFrequencyStatisticTableGUI::$additionalHtml = ''
protected

◆ $ctrl

ilCtrl ilAnswerFrequencyStatisticTableGUI::$ctrl
protected

Definition at line 36 of file class.ilAnswerFrequencyStatisticTableGUI.php.

◆ $language

ilLanguage ilAnswerFrequencyStatisticTableGUI::$language
protected

Definition at line 33 of file class.ilAnswerFrequencyStatisticTableGUI.php.

◆ $question

assQuestion ilAnswerFrequencyStatisticTableGUI::$question
protected

◆ $questionIndex

int ilAnswerFrequencyStatisticTableGUI::$questionIndex
protected

◆ $refinery

RefineryFactory ilAnswerFrequencyStatisticTableGUI::$refinery
protected

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

◆ $ui

UIServices ilAnswerFrequencyStatisticTableGUI::$ui
protected

Definition at line 34 of file class.ilAnswerFrequencyStatisticTableGUI.php.


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