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)
	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)
	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, $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 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)
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 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...

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 = true
	$rows_selector_off = 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
	$restore_filter
	$restore_filter_values
	$sortable_fields = array()
	$prevent_double_submission = true
	$row_selector_label

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

__construct()

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

Constructor.

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

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().

        {
                global $ilCtrl, $lng, $ilAccess, $lng;

                $this->setId("ilSearchResultsTable");

                $this->presenter = $a_presenter;
                $this->setId('search_'.$GLOBALS['ilUser']->getId());
                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"), "type", "1");
                $this->addColumn($this->lng->txt("search_title_description"), "title");

                $all_cols = $this->getSelectableColumns();
                foreach($this->getSelectedColumns() as $col)
                {
                        $this->addColumn($all_cols[$col]['txt'], $col,'50px');
                }

                if($this->enabledRelevance())
                {
                        #$this->addColumn($this->lng->txt('lucene_relevance_short'),'s_relevance','50px');
                        $this->addColumn($this->lng->txt('lucene_relevance_short'),'relevance','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);
                $this->setShowRowsSelector(false);
                
                include_once "Services/Object/classes/class.ilObjectActivation.php";
        }

Here is the call graph for this function:

Member Function Documentation

enabledRelevance()

ilSearchResultTableGUI::enabledRelevance ( )

protected

Check if relevance is visible.

Returns

Definition at line 196 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:

fillRow()

ilSearchResultTableGUI::fillRow (   $a_set )

protected

Fill table row.

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

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().

        {
                global $lng, $objDefinition;

                $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);              
                
                ilObjectActivation::addListGUIActivationProperty($item_list_gui, $a_set);               
                
                $this->presenter->appendAdditionalInformation($item_list_gui,$ref_id,$obj_id,$type);
                
                $this->tpl->setVariable("ACTION_HTML", $item_list_gui->getCommandsHTML());                              

                if($html = $item_list_gui->getListItemHTML($ref_id,$obj_id,$title,$description))
                {                               
                        $item_html[$ref_id]['html'] = $html;
                        $item_html[$ref_id]['type'] = $type;
                }
                        
                $this->tpl->setVariable("HREF_IMG", $item_list_gui->default_command["link"]);           
                
                global $lng;
                
                if($this->enabledRelevance())
                {                       
                        include_once "Services/UIComponent/ProgressBar/classes/class.ilProgressBar.php";
                        $pbar = ilProgressBar::getInstance();
                        $pbar->setCurrent($relevance); 
                        
                        $this->tpl->setCurrentBlock('relev');
                        $this->tpl->setVariable('REL_PBAR', $pbar->render());                           
                        $this->tpl->parseCurrentBlock();
                }
                

                $this->tpl->setVariable("ITEM_HTML", $html);
                
                foreach($this->getSelectedColumns() as $field)
                {
                        switch($field)
                        {
                                case 'create_date':
                                        $this->tpl->setCurrentBlock('creation');
                                        $this->tpl->setVariable('CREATION_DATE',  ilDatePresentation::formatDate(new ilDateTime(ilObject::_lookupCreationDate($obj_id),IL_CAL_DATETIME)));
                                        $this->tpl->parseCurrentBlock();
                        }
                }
                
                

                if(!$objDefinition->isPlugin($type))
                {
                        $type_txt = $lng->txt('icon').' '.$lng->txt('obj_'.$type);
                        $icon = ilObject::_getIcon($obj_id,'small',$type);
                }
                else
                {
                        include_once("./Services/Component/classes/class.ilPlugin.php");
                        $type_txt = ilPlugin::lookupTxt("rep_robj", $type, "obj_".$type);
                        $icon = ilObject::_getIcon($obj_id,'small',$type);
                }

                $this->tpl->setVariable(
                        "TYPE_IMG",
                        ilUtil::img(
                                $icon,
                                $type_txt,
                                '',
                                '',
                                0,
                                '',
                                'ilIcon'
                        )
                );
        }

Here is the call graph for this function:

getSelectableColumns()

ilSearchResultTableGUI::getSelectableColumns

(

)

Get selectable columns.

Returns

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

References $ilSetting.

Referenced by __construct().

        {               
                global $ilSetting;

                
                return array('create_date' =>
                                                array(
                                                        'txt' => $this->lng->txt('create_date'),
                                                        'default' => false
                        )
                );
        }

Here is the caller graph for this function:

numericOrdering()

ilSearchResultTableGUI::numericOrdering

(

$a_field

)

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

        {
                switch($a_field)
                {
                        case 'relevance':
                                return true;
                }
                
                
                return parent::numericOrdering($a_field);
        }

---

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

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