ilSearchResultTableGUI Class Reference
TableGUI class for search results. More...
Inheritance diagram for ilSearchResultTableGUI:
Collaboration diagram for ilSearchResultTableGUI:
Public Member Functions | |
| __construct ($a_parent_obj, $a_parent_cmd, $a_presenter) | |
| Constructor. More... | |
| numericOrdering ($a_field) | |
| Should this field be sorted numeric? More... | |
| getSelectableColumns () | |
| Get selectable columns. 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) | |
| set table data @access public More... | |
| 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) @access public More... | |
| 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, $a_multipart=false) | |
| 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, $a_caption=null) | |
| Set filter command. More... | |
| getFilterCommand () | |
| Get filter command. More... | |
| setResetCommand ($a_val, $a_caption=null) | |
| 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="", $a_class=null) | |
| Add Command button. More... | |
| addCommandButtonInstance (ilButtonBase $a_button) | |
| Add Command button instance. 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="", $a_tooltip_with_html=false) | |
| 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 @access 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 () | |
| setPreventDoubleSubmission ($a_val) | |
| Set prevent double submission. More... | |
| getPreventDoubleSubmission () | |
| Get prevent double submission. More... | |
| setLimit ($a_limit=0, $a_default_limit=0) | |
| set max. More... | |
| Public Member Functions inherited from ilTableGUI | |
| ilTableGUI ($a_data=0, $a_global_tpl=true) | |
| Constructor. More... | |
| setTemplate (&$a_tpl) | |
| set template @access public More... | |
| & | getTemplateObject () |
| setData ($a_data) | |
| set table data @access public More... | |
| getData () | |
| setTitle ($a_title, $a_icon=0, $a_icon_alt=0) | |
| set table title @access public More... | |
| setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0) | |
| set table help page @access public More... | |
| setHeaderNames ($a_header_names) | |
| set table header names @access public More... | |
| getColumnCount () | |
| Returns the column count based on the number of the header row columns @access public. More... | |
| setHeaderVars ($a_header_vars, $a_header_params=0) | |
| set table header vars @access public More... | |
| setColumnWidth ($a_column_width) | |
| set table column widths @access public More... | |
| setOneColumnWidth ($a_column_width, $a_column_number) | |
| set one table column width @access 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) @access public More... | |
| setOffset ($a_offset) | |
| set dataset offset @access public More... | |
| getOffset () | |
| Get offset. More... | |
| setOrderColumn ($a_order_column=0, $a_default_column=0) | |
| set order column @access public More... | |
| getOrderColumn () | |
| Get order column. More... | |
| setOrderDirection ($a_order_direction) | |
| set order direction @access public More... | |
| getOrderDirection () | |
| Get order direction. More... | |
| setFooter ($a_style, $a_previous=0, $a_next=0) | |
| set order direction @access 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 @access 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 table row. More... | |
| enabledRelevance () | |
| Check if relevance is visible. More... | |
| Protected Member Functions inherited from ilTable2GUI | |
| prepareOutput () | |
| Anything that must be done before HTML is generated. More... | |
| isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element) | |
| Check if filter element is based on adv md. 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 Header. 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... | |
Detailed Description
TableGUI class for search results.
- Version
- $Id$
Definition at line 14 of file class.ilSearchResultTableGUI.php.
Constructor & Destructor Documentation
◆ __construct()
| ilSearchResultTableGUI::__construct | ( | $a_parent_obj, | |
| $a_parent_cmd, | |||
| $a_presenter | |||
| ) |
Constructor.
Reimplemented from ilTable2GUI.
Definition at line 20 of file class.ilSearchResultTableGUI.php.
21 {
23
25
26 $this->presenter = $a_presenter;
28 parent::__construct($a_parent_obj, $a_parent_cmd);
30 $this->setLimit(999);
31// $this->setId("srcres");
32
33 //$this->addColumn("", "", "1", true);
34 #$this->addColumn($this->lng->txt("type"), "type", "1");
35 #$this->addColumn($this->lng->txt("search_title_description"), "title_sort");
38
39 $all_cols = $this->getSelectableColumns();
41 {
43 }
44
46 {
47 #$this->addColumn($this->lng->txt('lucene_relevance_short'),'s_relevance','50px');
51 }
52
53
55
57 $this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
59 //$this->disable("footer");
63
64 include_once "Services/Object/classes/class.ilObjectActivation.php";
65 }
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
Definition: class.ilTable2GUI.php:1308
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
Definition: class.ilTable2GUI.php:508
setRowTemplate($a_template, $a_template_dir="")
Set row template.
Definition: class.ilTable2GUI.php:1125
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
Definition: class.ilTable2GUI.php:1136
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
Definition: class.ilTable2GUI.php:935
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
Definition: class.ilTable2GUI.php:1156
$GLOBALS['PHPCAS_CLIENT']
This global variable is used by the interface class phpCAS.
Definition: CAS.php:276
References $GLOBALS, $ilCtrl, $lng, ilTable2GUI\addColumn(), enabledRelevance(), ilTable2GUI\getId(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTitle().
Here is the call graph for this function:
Member Function Documentation
◆ enabledRelevance()
|
protected |
Check if relevance is visible.
- Returns
Definition at line 196 of file class.ilSearchResultTableGUI.php.
197 {
198 return ilSearchSettings::getInstance()->enabledLucene() and ilSearchSettings::getInstance()->isRelevanceVisible();
199 }
References ilSearchSettings\getInstance().
Referenced by __construct(), and fillRow().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ fillRow()
|
protected |
Fill table row.
Reimplemented from ilTable2GUI.
Definition at line 100 of file class.ilSearchResultTableGUI.php.
101 {
102 global $lng, $objDefinition;
103
104 $obj_id = $a_set["obj_id"];
106 $type = $a_set['type'];
108 $description = $a_set['description'];
109 $relevance = $a_set['relevance'];
110
111 if(!$type)
112 {
113 return false;
114 }
115
116 include_once './Services/Search/classes/Lucene/class.ilLuceneSearchObjectListGUIFactory.php';
117 $item_list_gui = ilLuceneSearchObjectListGUIFactory::factory($type);
119 $item_list_gui->setContainerObject($this->parent_obj);
120 $item_list_gui->setSearchFragment($this->presenter->lookupContent($obj_id,0));
121 $item_list_gui->setSeparateCommands(true);
122
123 ilObjectActivation::addListGUIActivationProperty($item_list_gui, $a_set);
124
125 $this->presenter->appendAdditionalInformation($item_list_gui,$ref_id,$obj_id,$type);
126
127 $this->tpl->setVariable("ACTION_HTML", $item_list_gui->getCommandsHTML());
128
130 {
133 }
134
135 $this->tpl->setVariable("HREF_IMG", $item_list_gui->default_command["link"]);
136
137 global $lng;
138
140 {
141 include_once "Services/UIComponent/ProgressBar/classes/class.ilProgressBar.php";
142 $pbar = ilProgressBar::getInstance();
143 $pbar->setCurrent($relevance);
144
145 $this->tpl->setCurrentBlock('relev');
146 $this->tpl->setVariable('REL_PBAR', $pbar->render());
147 $this->tpl->parseCurrentBlock();
148 }
149
150
152
154 {
155 switch($field)
156 {
157 case 'create_date':
158 $this->tpl->setCurrentBlock('creation');
159 $this->tpl->setVariable('CREATION_DATE', ilDatePresentation::formatDate(new ilDateTime(ilObject::_lookupCreationDate($obj_id),IL_CAL_DATETIME)));
160 $this->tpl->parseCurrentBlock();
161 }
162 }
163
164
165
166 if(!$objDefinition->isPlugin($type))
167 {
170 }
171 else
172 {
173 include_once("./Services/Component/classes/class.ilPlugin.php");
176 }
177
178 $this->tpl->setVariable(
179 "TYPE_IMG",
180 ilUtil::img(
181 $icon,
182 $type_txt,
183 '',
184 '',
185 0,
186 '',
187 'ilIcon'
188 )
189 );
190 }
static formatDate(ilDateTime $date)
Format a date @access public.
Definition: class.ilDatePresentation.php:113
static factory($a_type)
Get list gui by type This method caches all the returned list guis.
Definition: class.ilLuceneSearchObjectListGUIFactory.php:44
static addListGUIActivationProperty(ilObjectListGUI $a_list_gui, array &$a_item)
Get timing details for list gui.
Definition: class.ilObjectActivation.php:411
static _getIcon($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Get icon for repository item.
Definition: class.ilObject.php:1900
static lookupTxt($a_mod_prefix, $a_pl_id, $a_lang_var)
Lookup language text.
Definition: class.ilPlugin.php:529
static img($a_src, $a_alt="", $a_width="", $a_height="", $a_border=0, $a_id="", $a_class="")
Build img tag.
Definition: class.ilUtil.php:2087
References $html, ilTableGUI\$icon, $lng, $ref_id, ilTableGUI\$title, ilObject\_getIcon(), ilObject\_lookupCreationDate(), ilObjectActivation\addListGUIActivationProperty(), enabledRelevance(), ilLuceneSearchObjectListGUIFactory\factory(), ilDatePresentation\formatDate(), ilProgressBar\getInstance(), ilTable2GUI\getSelectedColumns(), IL_CAL_DATETIME, ilUtil\img(), and ilPlugin\lookupTxt().
Here is the call graph for this function:
◆ getSelectableColumns()
| ilSearchResultTableGUI::getSelectableColumns | ( | ) |
Get selectable columns.
- Returns
Reimplemented from ilTable2GUI.
Definition at line 83 of file class.ilSearchResultTableGUI.php.
84 {
85 global $ilSetting;
86
87
88 return array('create_date' =>
89 array(
90 'txt' => $this->lng->txt('create_date'),
91 'default' => false
92 )
93 );
94 }
References $ilSetting.
Referenced by __construct().
Here is the caller graph for this function:
◆ numericOrdering()
| ilSearchResultTableGUI::numericOrdering | ( | $a_field | ) |
Should this field be sorted numeric?
- Returns
- boolean numeric ordering; default is false
Reimplemented from ilTable2GUI.
Definition at line 67 of file class.ilSearchResultTableGUI.php.
68 {
69 switch($a_field)
70 {
71 case 'relevance':
72 return true;
73 }
74
75
76 return parent::numericOrdering($a_field);
77 }
The documentation for this class was generated from the following file:
- Services/Search/classes/class.ilSearchResultTableGUI.php
