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.
Public Member Functions inherited from ilTable2GUI
	determineLimit ()
	Determine the limit.
	getSelectableColumns ()
	Get selectable columns.
	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= '')
	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)
	fillHeader ()
	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.
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 Member Functions
	fillRow ($a_set)
	Fill table row.
	enabledRelevance ()
	Check if relevance is visible.
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.

Additional Inherited Members
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	EXPORT_EXCEL = 1
const	EXPORT_CSV = 2
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 = 4
	$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
	$export_formats
	$export_mode
	$print_mode

Detailed Description

TableGUI class for search results.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 14 of file class.ilSearchResultTableGUI.php.

Constructor & Destructor Documentation

ilSearchResultTableGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd,
			$a_presenter
	)

Constructor.

Reimplemented from ilTable2GUI.

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

References $ilCtrl, $lng, ilTable2GUI\addColumn(), enabledRelevance(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFormAction(), ilTableGUI\setLimit(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setTitle().

        {
                global $ilCtrl, $lng, $ilAccess, $lng;
                
                $this->presenter = $a_presenter;
                parent::__construct($a_parent_obj, $a_parent_cmd);
                $this->setTitle($lng->txt("search_results"));
                $this->setLimit(999);
//              $this->setId("srcres");
                
                //$this->addColumn("", "", "1", true);
                #$this->addColumn($this->lng->txt("type"), "type", "1");
                #$this->addColumn($this->lng->txt("search_title_description"), "title_sort");
                $this->addColumn($this->lng->txt("type"), "", "1");
                $this->addColumn($this->lng->txt("search_title_description"), "");
                if($this->enabledRelevance())
                {
                        #$this->addColumn($this->lng->txt('lucene_relevance_short'),'s_relevance','50px');
                        $this->addColumn($this->lng->txt('lucene_relevance_short'),'','50px');
                        $this->setDefaultOrderField("s_relevance");
                        $this->setDefaultOrderDirection("desc");
                }
                $this->addColumn($this->lng->txt("actions"), "", "10px");
                
                $this->setEnableHeader(true);
                $this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
                $this->setRowTemplate("tpl.search_result_row.html", "Services/Search");
                //$this->disable("footer");
                $this->setEnableTitle(true);
                $this->setEnableNumInfo(false);
        }

Here is the call graph for this function:

Member Function Documentation

ilSearchResultTableGUI::enabledRelevance ( )

protected

Check if relevance is visible.

Returns

Definition at line 111 of file class.ilSearchResultTableGUI.php.

References ilSearchSettings\getInstance().

Referenced by __construct(), and fillRow().

        {
                return ilSearchSettings::getInstance()->enabledLucene() and ilSearchSettings::getInstance()->isRelevanceVisible();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilSearchResultTableGUI::fillRow (   $a_set )

protected

Fill table row.

Reimplemented from ilTable2GUI.

Definition at line 55 of file class.ilSearchResultTableGUI.php.

References $lng, $ref_id, ilTableGUI\$title, enabledRelevance(), ilLuceneSearchObjectListGUIFactory\factory(), ilUtil\getImagePath(), and ilUtil\img().

        {
                global $lng;

                $obj_id = $a_set["obj_id"];
                $ref_id = $a_set["ref_id"];
                $type   = $a_set['type'];
                $title  = $a_set['title'];
                $description = $a_set['description'];
                $relevance = $a_set['relevance'];
                
                if(!$type)
                {
                        return false;
                }
                
                include_once './Services/Search/classes/Lucene/class.ilLuceneSearchObjectListGUIFactory.php';
                $item_list_gui = ilLuceneSearchObjectListGUIFactory::factory($type);
                $item_list_gui->initItem($ref_id,$obj_id,$title,$description);
                $item_list_gui->setContainerObject($this->parent_obj);
                $item_list_gui->setSearchFragment($this->presenter->lookupContent($obj_id,0));
                $item_list_gui->setSeparateCommands(true);
                $this->presenter->appendAdditionalInformation($item_list_gui,$ref_id,$obj_id,$type);
                
                if($html = $item_list_gui->getListItemHTML($ref_id,$obj_id,$title,$description))
                {                               
                        $item_html[$ref_id]['html'] = $html;
                        $item_html[$ref_id]['type'] = $type;
                }
                
                global $lng;
                
                if($this->enabledRelevance())
                {
                        $width1 = (int) ((int) $relevance / 2);
                        $width2 = (int) ((50 - $width1));
                        
                        $this->tpl->setCurrentBlock('relev');
                        $this->tpl->setVariable('VAL_REL',sprintf("%d %%",$relevance));
                        $this->tpl->setVariable('WIDTH_A',$width1);
                        $this->tpl->setVariable('WIDTH_B',$width2);
                        $this->tpl->setVariable('IMG_A',ilUtil::getImagePath("relevance_blue.gif"));
                        $this->tpl->setVariable('IMG_B',ilUtil::getImagePath("relevance_dark.gif"));
                        $this->tpl->parseCurrentBlock();
                }

                $this->tpl->setVariable("ITEM_HTML", $html);
                $this->tpl->setVariable("ACTION_HTML", $item_list_gui->getCommandsHTML());
                $this->tpl->setVariable("TYPE_IMG", ilUtil::img(ilUtil::getImagePath("icon_$type.gif"),
                        $lng->txt("icon")." ".$lng->txt("obj_".$type)));
        }

Here is the call graph for this function:

---

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

• Services/Search/classes/class.ilSearchResultTableGUI.php