TableGUI class for search results. More...

Inheritance diagram for ilSearchResultTableGUI:

Collaboration diagram for ilSearchResultTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, ilSearchResultPresentation $a_presenter)
	Constructor. More...

	getSelectableColumns ()
	Get selectable columns. More...

	getHTML ()

	setDataAndApplySortation (array $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 ()

	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
	fillRow (array $a_set)
	Fill table row. More...

	getPossibleSortations ()
	Returns key => label. More...

	getDefaultSortation ()

	enabledRelevance ()

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
ilObjUser	$user

ilSearchResultPresentation	$presenter

ilObjectDefinition	$objDefinition

UIServices	$ui

HTTP	$http

Refinery	$refinery

Protected Attributes inherited from ilTable2GUI
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_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

TableGUI class for search results.

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

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ILIAS\Repository\ctrl(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setShowRowsSelector(), ilTable2GUI\setTitle(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->user = $DIC->user();
         $this->presenter = $a_presenter;
         $this->objDefinition = $DIC['objDefinition'];
         $this->ui = $DIC->ui();
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
 
         $this->setId("ilSearchResultsTable");
 
         $this->setId('search_' . $this->user->getId());
         parent::__construct($a_parent_obj, $a_parent_cmd);
         $this->setTitle($this->lng->txt("search_results"));
         $this->setLimit(999);
         $this->addColumn($this->lng->txt("type"), "", "1");
         $this->addColumn($this->lng->txt("search_title_description"), "");
 
         $all_cols = $this->getSelectableColumns();
         foreach ($this->getSelectedColumns() as $col) {
             $this->addColumn($all_cols[$col]['txt'], "", '50px');
         }
 
 
         $this->addColumn($this->lng->txt("actions"), "", "10px");
 
         $this->setEnableHeader(true);
         $this->setFormAction($this->ctrl->getFormAction($a_parent_obj));
         $this->setRowTemplate("tpl.search_result_row.html", "components/ILIAS/Search");
         $this->setEnableTitle(true);
         $this->setEnableNumInfo(false);
         $this->setShowRowsSelector(false);
         $this->setExternalSorting(true);
     }

Here is the call graph for this function:

Member Function Documentation

◆ enabledRelevance()

ilSearchResultTableGUI::enabledRelevance ( )

protected

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

References ilSearchSettings\getInstance().

Referenced by getDefaultSortation().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillRow()

ilSearchResultTableGUI::fillRow ( array $a_set )

protected

Fill table row.

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

References ilTable2GUI\$description, ilTableGUI\$icon, $ref_id, ilTableGUI\$title, ilObject\_getIcon(), ilObjectActivation\addListGUIActivationProperty(), factory(), ilDatePresentation\formatDate(), ilTable2GUI\getSelectedColumns(), IL_CAL_DATETIME, ilUtil\img(), ILIAS\Repository\lng(), and ilObjectPlugin\lookupTxtById().

                                             : void
     {
         $obj_id = $a_set["obj_id"];
         $ref_id = $a_set["ref_id"];
         $type = $a_set['type'];
         $title = $a_set['title'];
         $description = $a_set['description'];
 
         if (!$type || $this->objDefinition->isSideBlock($type)) {
             return;
         }
 
         $item_list_gui = ilLuceneSearchObjectListGUIFactory::factory($type);
         $item_list_gui->initItem($ref_id, $obj_id, $type, $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($title));
 
         if ($html = $item_list_gui->getListItemHTML($ref_id, $obj_id, '#SRC_HIGHLIGHT_TITLE', '#SRC_HIGHLIGHT_DESC')) {
             // replace highlighted title/description
             $html = str_replace(
                 [
                     '#SRC_HIGHLIGHT_TITLE',
                     '#SRC_HIGHLIGHT_DESC'
                 ],
                 [
                     $title,
                     strip_tags(
                         $description,
                         ['span']
                     )
                 ],
                 $html
             );
             $item_html[$ref_id]['html'] = $html;
             $item_html[$ref_id]['type'] = $type;
         }
 
         $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($a_set['create_date'], IL_CAL_DATETIME)));
                     $this->tpl->parseCurrentBlock();
             }
         }
 
 
 
         if (!$this->objDefinition->isPlugin($type)) {
             $type_txt = $this->lng->txt('icon') . ' ' . $this->lng->txt('obj_' . $type);
             $icon = ilObject::_getIcon((int) $obj_id, 'small', $type);
         } else {
             $type_txt = ilObjectPlugin::lookupTxtById($type, "obj_" . $type);
             $icon = ilObject::_getIcon((int) $obj_id, 'small', $type);
         }
 
         $this->tpl->setVariable(
             "TYPE_IMG",
             ilUtil::img(
                 $icon,
                 $type_txt,
                 '',
                 '',
                 0,
                 '',
                 'ilIcon'
             )
         );
     }

Here is the call graph for this function:

◆ getDefaultSortation()

ilSearchResultTableGUI::getDefaultSortation ( )

protected

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

References enabledRelevance().

                                             : string
     {
         return $this->enabledRelevance() ? 'relevance' : 'title_asc';
     }

Here is the call graph for this function:

◆ getHTML()

ilSearchResultTableGUI::getHTML ( )

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

References buildSortationViewControl(), and ILIAS\Repository\ui().

                              : string
     {
         $view_control = $this->ui->renderer()->render($this->buildSortationViewControl());
         return $view_control . parent::getHTML();
     }

Here is the call graph for this function:

◆ getPossibleSortations()

ilSearchResultTableGUI::getPossibleSortations ( )

protected

Returns key => label.

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

References ilTable2GUI\getSelectedColumns(), and ILIAS\Repository\lng().

                                               : array
     {
         $sorts = [
             'relevance' => $this->lng->txt('search_sort_relevance'),
             'title_asc' => $this->lng->txt('search_sort_title_asc'),
             'title_desc' => $this->lng->txt('search_sort_title_desc')
         ];
         if (in_array('create_date', $this->getSelectedColumns())) {
             $sorts = array_merge($sorts, [
                 'creation_date_desc' => $this->lng->txt('search_sort_creation_date_desc'),
                 'creation_date_asc' => $this->lng->txt('search_sort_creation_date_asc')
             ]);
         }
         return $sorts;
     }

Here is the call graph for this function:

◆ getSelectableColumns()

ilSearchResultTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns: array

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

References ILIAS\Repository\lng().

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDataAndApplySortation()

ilSearchResultTableGUI::setDataAndApplySortation ( array $set )

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

References Vendor\Package\$a, Vendor\Package\$b, ilObject\_lookupCreationDate(), getCurrentSortation(), and ilTable2GUI\getSelectedColumns().

                                                         : void
     {
         if (in_array('create_date', $this->getSelectedColumns())) {
             foreach ($set as $key => $row) {
                 $set[$key]['create_date'] = ilObject::_lookupCreationDate($row['obj_id']);
             }
         }
 
         switch ($this->getCurrentSortation()) {
             case 'relevance':
                 usort($set, function ($a, $b) {
                     return $b['relevance'] <=> $a['relevance'];
                 });
                 break;
 
             case 'title_desc':
                 usort($set, function ($a, $b) {
                     return [$b['title'], $b['relevance'] ?? ''] <=> [$a['title'], $a['relevance'] ?? ''];
                 });
                 break;
 
             case 'title_asc':
                 usort($set, function ($a, $b) {
                     return [$a['title'], $b['relevance'] ?? ''] <=> [$b['title'], $a['relevance'] ?? ''];
                 });
                 break;
 
             case 'creation_date_desc':
                 usort($set, function ($a, $b) {
                     $a_date = \DateTime::createFromFormat('m-d-Y H:i:s', $a['create_date']);
                     $b_date = \DateTime::createFromFormat('m-d-Y H:i:s', $b['create_date']);
                     return [$b_date, $b['relevance'] ?? ''] <=> [$a_date, $a['relevance'] ?? ''];
                 });
                 break;
 
             case 'creation_date_asc':
                 usort($set, function ($a, $b) {
                     $a_date = \DateTime::createFromFormat('Y-m-d H:i:s', $a['create_date']);
                     $b_date = \DateTime::createFromFormat('Y-m-d H:i:s', $b['create_date']);
                     return [$a_date, $b['relevance'] ?? ''] <=> [$b_date, $a['relevance'] ?? ''];
                 });
                 break;
         };
         parent::setData($set);
     }