Inheritance diagram for ilFilterGUI:

Collaboration diagram for ilFilterGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd="")

	getFilterCmd ()

	setFilterCmd ($filter_cmd)

	getFilterCols ()

	setFilterCols ($filter_cols)

	getFilters ()

	setFilters ($filters)

	getOptionalFilters ()

	setOptionalFilters ($optional_filters)

	getResetCmd ()

	setResetCmd ($reset_cmd)

	isDisableFilterHiding ()

	setDisableFilterHiding ($disable_filter_hiding)

	isFiltersDetermined ()

	setFiltersDetermined ($filters_determined)

	isSelectedFilter ()

	setSelectedFilter ($selected_filter)

	isFilterSelected ($a_col)
	Is given filter selected? More...

	getDisableFilterHiding ()
	Get disable filter hiding. More...

	getId ()

	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)

	loadProperty ($type)
	Load table property. More...

	setFormAction ($a_form_action, $a_multipart=false)
	Set Form action parameter. More...

	getFormAction ()
	Get Form action parameter. More...

	initFilter ()
	Init filter. More...

	getFilterId ()

	setFilterId ($filter_id)

	getHtml ()

	writeFilterToSession ()
	Write filter values to session. More...

	resetFilter ()
	Reset filter. More...

Data Fields
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

Protected Attributes
	$filters = array()

	$optional_filters = array()

	$filter_cmd = 'setFilter'

	$reset_cmd = 'resetFilter'

	$filter_cols = 5

	$disable_filter_hiding = false

	$selected_filter = false

	$filters_determined = false

	$filter_id = ''

Private Member Functions
	renderFilter ()
	Render Filter section. More...

Detailed Description

Class ilFilterGUI.

Author: : Nadia Ahmad nahma.nosp@m.d@da.nosp@m.tabay.nosp@m..de

Version: $Id:

Definition at line 10 of file class.ilFilterGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilFilterGUI::__construct	(	$a_parent_obj,
		$a_parent_cmd = `""`
	)

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

References $ilCtrl, and setFormAction().

         {
                 global $ilCtrl;
                 
                 $this->parent_obj = $a_parent_obj;
                 $this->parent_cmd = $a_parent_cmd;
                 $this->tpl = new ilTemplate("tpl.filter.html", true, true,      "Services/Payment");
 
                 $this->setFormAction($ilCtrl->getFormAction($this->parent_obj, $a_parent_cmd));
         }

Here is the call graph for this function:

Member Function Documentation

◆ addFilterItem()

ilFilterGUI::addFilterItem	(	$a_input_item,
		$a_optional = `false`
	)

final

Add filter item.

Filter items are property form inputs that implement the ilTableFilterItem interface

Parameters

	$a_input_item
bool	$a_optional

Definition at line 208 of file class.ilFilterGUI.php.

Referenced by addFilterItemByMetaType(), ilShopFilterGUI\initFilter(), and ilAdvancedSearchFilterGUI\initFilter().

         {
                 $a_input_item->setParent($this);
                 if (!$a_optional)
                 {
                         $this->filters[] = $a_input_item;
                 }
                 else
                 {
                         $this->optional_filters[] = $a_input_item;
                 }
 
                 // restore filter values (from stored view)
                 if($this->restore_filter_values &&
                         array_key_exists($a_input_item->getFieldId(), $this->restore_filter_values))
                 {
                         $this->setFilterValue($a_input_item, $this->restore_filter_values[$a_input_item->getFieldId()]);
                 }
         }

Here is the caller graph for this function:

◆ addFilterItemByMetaType()

ilFilterGUI::addFilterItemByMetaType	(	$id,
		$type = `self::FILTER_TEXT`,
		$a_optional = `false`,
		$caption = `NULL`
	)

Add filter by standard type.

Parameters

string	$id
int	$type
bool	$a_optional
string	$caption

Returns: object

Definition at line 237 of file class.ilFilterGUI.php.

References $lng, $options, addFilterItem(), ilCombinationInputGUI\COMPARISON_ASCENDING, and ilDateTimeInputGUI\MODE_INPUT.

         {
                 global $lng;
 
                 if(!$caption)
                 {
                         $caption = $lng->txt($id);
                 }
 
                 include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
 
                 switch($type)
                 {
                         case self::FILTER_SELECT:
                                 include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
                                 $item = new ilSelectInputGUI($caption, $id);
                                 break;
 
                         case self::FILTER_DATE:
                                 include_once("./Services/Form/classes/class.ilDateTimeInputGUI.php");
                                 $item = new ilDateTimeInputGUI($caption, $id);
                                 $item->setMode(ilDateTimeInputGUI::MODE_INPUT);
                                 break;
 
                         case self::FILTER_TEXT:
                                 include_once("./Services/Form/classes/class.ilTextInputGUI.php");
                                 $item = new ilTextInputGUI($caption, $id);
                                 $item->setMaxLength(64);
                                 $item->setSize(20);
                                 // $item->setSubmitFormOnEnter(true);
                                 break;
 
                         case self::FILTER_LANGUAGE:
                                 $lng->loadLanguageModule("meta");
                                 include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
                                 $item = new ilSelectInputGUI($caption, $id);
                                 $options = array("" => $lng->txt("trac_all"));
                                 foreach ($lng->getInstalledLanguages() as $lang_key)
                                 {
                                         $options[$lang_key] = $lng->txt("meta_l_".$lang_key);
                                 }
                                 $item->setOptions($options);
                                 break;
 
                         case self::FILTER_NUMBER_RANGE:
                                 include_once("./Services/Form/classes/class.ilCombinationInputGUI.php");
                                 include_once("./Services/Form/classes/class.ilNumberInputGUI.php");
                                 $item = new ilCombinationInputGUI($caption, $id);
                                 $combi_item = new ilNumberInputGUI("", $id."_from");
                                 $item->addCombinationItem("from", $combi_item, $lng->txt("from"));
                                 $combi_item = new ilNumberInputGUI("", $id."_to");
                                 $item->addCombinationItem("to", $combi_item, $lng->txt("to"));
                                 $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
                                 $item->setMaxLength(7);
                                 $item->setSize(20);
                                 break;
 
                         case self::FILTER_DATE_RANGE:
                                 include_once("./Services/Form/classes/class.ilCombinationInputGUI.php");
                                 include_once("./Services/Form/classes/class.ilDateTimeInputGUI.php");
                                 $item = new ilCombinationInputGUI($caption, $id);
                                 $combi_item = new ilDateTimeInputGUI("", $id."_from");
                                 $item->addCombinationItem("from", $combi_item, $lng->txt("from"));
                                 $combi_item = new ilDateTimeInputGUI("", $id."_to");
                                 $item->addCombinationItem("to", $combi_item, $lng->txt("to"));
                                 $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
                                 $item->setMode(ilDateTimeInputGUI::MODE_INPUT);
                                 break;
 
                         case self::FILTER_DATETIME_RANGE:
                                 include_once("./Services/Form/classes/class.ilCombinationInputGUI.php");
                                 include_once("./Services/Form/classes/class.ilDateTimeInputGUI.php");
                                 $item = new ilCombinationInputGUI($caption, $id);
                                 $combi_item = new ilDateTimeInputGUI("", $id."_from");
                                 $combi_item->setShowTime(true);
                                 $item->addCombinationItem("from", $combi_item, $lng->txt("from"));
                                 $combi_item = new ilDateTimeInputGUI("", $id."_to");
                                 $combi_item->setShowTime(true);
                                 $item->addCombinationItem("to", $combi_item, $lng->txt("to"));
                                 $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
                                 $item->setMode(ilDateTimeInputGUI::MODE_INPUT);
                                 break;
 
                         case self::FILTER_DURATION_RANGE:
                                 $lng->loadLanguageModule("form");
                                 include_once("./Services/Form/classes/class.ilCombinationInputGUI.php");
                                 include_once("./Services/Form/classes/class.ilDurationInputGUI.php");
                                 $item = new ilCombinationInputGUI($caption, $id);
                                 $combi_item = new ilDurationInputGUI("", $id."_from");
                                 $combi_item->setShowMonths(false);
                                 $combi_item->setShowDays(true);
                                 $combi_item->setShowSeconds(true);
                                 $item->addCombinationItem("from", $combi_item, $lng->txt("from"));
                                 $combi_item = new ilDurationInputGUI("", $id."_to");
                                 $combi_item->setShowMonths(false);
                                 $combi_item->setShowDays(true);
                                 $combi_item->setShowSeconds(true);
                                 $item->addCombinationItem("to", $combi_item, $lng->txt("to"));
                                 $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
                                 break;
 
                         default:
                                 return false;
                 }
 
                 $this->addFilterItem($item, $a_optional);
                 $item->readFromSession();
                 return $item;
         }

Here is the call graph for this function:

◆ getDisableFilterHiding()

ilFilterGUI::getDisableFilterHiding ( )

Get disable filter hiding.

Returns: boolean

Definition at line 191 of file class.ilFilterGUI.php.

References $disable_filter_hiding.

Referenced by getHtml(), and renderFilter().

         {
                 return $this->disable_filter_hiding;
         }

Here is the caller graph for this function:

◆ getFilterCmd()

ilFilterGUI::getFilterCmd ( )

Returns: string

Definition at line 50 of file class.ilFilterGUI.php.

References $filter_cmd.

         {
                 return $this->filter_cmd;
         }

◆ getFilterCols()

ilFilterGUI::getFilterCols ( )

Returns: int

Definition at line 66 of file class.ilFilterGUI.php.

References $filter_cols.

Referenced by renderFilter().

         {
                 return $this->filter_cols;
         }

Here is the caller graph for this function:

◆ getFilterId()

ilFilterGUI::getFilterId ( )

Definition at line 582 of file class.ilFilterGUI.php.

References $filter_id.

Referenced by getHtml().

         {
                 return $this->filter_id;
         }

Here is the caller graph for this function:

◆ getFilterItemByPostVar()

ilFilterGUI::getFilterItemByPostVar ( $a_post_var )

final

Parameters

$a_post_var

Returns: bool

Definition at line 365 of file class.ilFilterGUI.php.

References getFilterItems().

         {
                 foreach ($this->getFilterItems() as $item)
                 {
                         if ($item->getPostVar() == $a_post_var)
                         {
                                 return $item;
                         }
                 }
                 foreach ($this->getFilterItems(true) as $item)
                 {
                         if ($item->getPostVar() == $a_post_var)
                         {
                                 return $item;
                         }
                 }
                 return false;
         }

Here is the call graph for this function:

◆ getFilterItems()

ilFilterGUI::getFilterItems ( $a_optionals = false )

final

Get filter items.

Parameters

bool $a_optionals

Returns: array

Definition at line 352 of file class.ilFilterGUI.php.

References $filters, and $optional_filters.

Referenced by getFilterItemByPostVar(), renderFilter(), resetFilter(), and writeFilterToSession().

         {
                 if (!$a_optionals)
                 {
                         return $this->filters;
                 }
                 return $this->optional_filters;
         }

Here is the caller graph for this function:

◆ getFilters()

ilFilterGUI::getFilters ( )

Returns: array

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

References $filters.

         {
                 return $this->filters;
         }

◆ getFormAction()

ilFilterGUI::getFormAction ( )

final

Get Form action parameter.

Returns: string Form action

Definition at line 421 of file class.ilFilterGUI.php.

Referenced by getHtml().

         {
                 return $this->form_action;
         }

Here is the caller graph for this function:

◆ getHtml()

ilFilterGUI::getHtml ( )

Definition at line 591 of file class.ilFilterGUI.php.

References $ilUser, $lng, getDisableFilterHiding(), getFilterId(), getFormAction(), getId(), and renderFilter().

         {
                 global $lng,$ilUser;
                 
                 $this->tpl->setCurrentBlock("tbl_form_header");
                 $this->tpl->setVariable("FORMACTION", $this->getFormAction());
                 $this->tpl->setVariable("FORMNAME", $this->getFilterId());
                 $this->tpl->parseCurrentBlock();
 
                 $this->tpl->setCurrentBlock("filter_activation");
                 $this->tpl->setVariable("TXT_ACTIVATE_FILTER", $lng->txt("show_filter"));
                 $this->tpl->setVariable("FILA_ID", $this->getId());
                 
                 if ($this->getId() != "")
                 {
                         $this->tpl->setVariable("SAVE_URLA", "./ilias.php?baseClass=ilTablePropertiesStorage&table_id=".
                                 $this->getId()."&cmd=showFilter&user_id=".$ilUser->getId());
                         $this->tpl->parseCurrentBlock();
                 }
                 
                 if (!$this->getDisableFilterHiding())
                 {
                         $this->tpl->setCurrentBlock("filter_deactivation");
 
                         if ($this->getId() != "")
                         {
                                 $this->tpl->setVariable("TXT_HIDE", $lng->txt("hide_filter"));
 
                                 $this->tpl->setVariable("SAVE_URL", "./ilias.php?baseClass=ilTablePropertiesStorage&table_id=".
                                         $this->getId()."&cmd=hideFilter&user_id=".$ilUser->getId());
                                 $this->tpl->setVariable("FILD_ID", $this->getId());
                         }
                         $this->tpl->parseCurrentBlock();
 
                 }
 
                 $this->renderFilter();
                 $this->tpl->touchBlock("tbl_form_footer");
                 return $this->tpl->get();
         }

Here is the call graph for this function:

◆ getId()

ilFilterGUI::getId ( )

Definition at line 198 of file class.ilFilterGUI.php.

Referenced by getHtml(), loadProperty(), and renderFilter().

         {
                 return 'shop';
         }

Here is the caller graph for this function:

◆ getOptionalFilters()

ilFilterGUI::getOptionalFilters ( )

Returns: array

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

References $optional_filters.

         {
                 return $this->optional_filters;
         }

◆ getResetCmd()

ilFilterGUI::getResetCmd ( )

Returns: string

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

References $reset_cmd.

         {
                 return $this->reset_cmd;
         }

◆ initFilter()

ilFilterGUI::initFilter ( )

Init filter.

Overwrite this to initialize all filter input property objects.

Definition at line 431 of file class.ilFilterGUI.php.

432 {

433 }

◆ isDisableFilterHiding()

ilFilterGUI::isDisableFilterHiding ( )

Returns: boolean

Definition at line 130 of file class.ilFilterGUI.php.

References $disable_filter_hiding.

         {
                 return $this->disable_filter_hiding;
         }

◆ isFiltersDetermined()

ilFilterGUI::isFiltersDetermined ( )

Returns: boolean

Definition at line 146 of file class.ilFilterGUI.php.

References $filters_determined.

         {
                 return $this->filters_determined;
         }

◆ isFilterSelected()

ilFilterGUI::isFilterSelected ( $a_col )

Is given filter selected?

Parameters

string $a_col column name

Returns: boolean

Definition at line 181 of file class.ilFilterGUI.php.

Referenced by renderFilter().

         {
                 return $this->selected_filter[$a_col];
         }

Here is the caller graph for this function:

◆ isSelectedFilter()

ilFilterGUI::isSelectedFilter ( )

Returns: boolean

Definition at line 162 of file class.ilFilterGUI.php.

References $selected_filter.

         {
                 return $this->selected_filter;
         }

◆ loadProperty()

ilFilterGUI::loadProperty ( $type )

Load table property.

Parameters

string $type

Returns: mixed

Definition at line 390 of file class.ilFilterGUI.php.

References $ilUser, and getId().

Referenced by renderFilter().

         {
                 global $ilUser;
 
                 if(is_object($ilUser) && $this->getId() != "" && $ilUser->getId() != ANONYMOUS_USER_ID)
                 {
                         include_once("./Services/Table/classes/class.ilTablePropertiesStorage.php");
                         $tab_prop = new ilTablePropertiesStorage();
 
                         return $tab_prop->getProperty($this->getId(), $ilUser->getId(), $type);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderFilter()

ilFilterGUI::renderFilter ( )

private

Render Filter section.

Definition at line 439 of file class.ilFilterGUI.php.

References $lng, $tpl, getDisableFilterHiding(), getFilterCols(), getFilterItems(), getId(), ilYuiUtil\initConnection(), isFilterSelected(), and loadProperty().

Referenced by getHtml().

         {
                 global $lng, $tpl;
 
                 $filter = $this->getFilterItems();
                 $opt_filter = $this->getFilterItems(true);
 
                 $tpl->addJavascript("./Services/Table/js/ServiceTable.js");
 
                 if (count($filter) == 0 && count($opt_filter) == 0)
                 {
                         return;
                 }
 
                 include_once("./Services/YUI/classes/class.ilYuiUtil.php");
                 ilYuiUtil::initConnection();
 
                 $ccnt = 0;
 
                 // render standard filter
                 if (count($filter) > 0)
                 {
                         foreach ($filter as $item)
                         {
                                 if ($ccnt >= $this->getFilterCols())
                                 {
                                         $this->tpl->setCurrentBlock("filter_row");
                                         $this->tpl->parseCurrentBlock();
                                         $ccnt = 0;
                                 }
                                 $this->tpl->setCurrentBlock("filter_item");
                                 $this->tpl->setVariable("OPTION_NAME",
                                         $item->getTitle());
                                 $this->tpl->setVariable("F_INPUT_ID",
                                         $item->getFieldId());
                                 $this->tpl->setVariable("INPUT_HTML",
                                         $item->getTableFilterHTML());
                                 $this->tpl->parseCurrentBlock();
                                 $ccnt++;
                         }
                 }
 
                 // render optional filter
                 if (count($opt_filter) > 0)
                 {
                         $this->determineSelectedFilters();
 
                         foreach ($opt_filter as $item)
                         {
                                 if($this->isFilterSelected($item->getPostVar()))
                                 {
                                         if ($ccnt >= $this->getFilterCols())
                                         {
                                                 $this->tpl->setCurrentBlock("filter_row");
                                                 $this->tpl->parseCurrentBlock();
                                                 $ccnt = 0;
                                         }
                                         $this->tpl->setCurrentBlock("filter_item");
                                         $this->tpl->setVariable("OPTION_NAME",
                                                 $item->getTitle());
                                         $this->tpl->setVariable("F_INPUT_ID",
                                                 $item->getFieldId());
                                         $this->tpl->setVariable("INPUT_HTML",
                                                 $item->getTableFilterHTML());
                                         $this->tpl->parseCurrentBlock();
                                         $ccnt++;
                                 }
                         }
 
                         // filter selection
                         $items = array();
                         foreach ($opt_filter as $item)
                         {
                                 $k = $item->getPostVar();
                                 $items[$k] = array("txt" => $item->getTitle(),
                                                                    "selected" => $this->isFilterSelected($k));
                         }
 
                         include_once("./Services/UIComponent/CheckboxListOverlay/classes/class.ilCheckboxListOverlayGUI.php");
                         $cb_over = new ilCheckboxListOverlayGUI("tbl_filters_".$this->getId());
                         $cb_over->setLinkTitle($lng->txt("optional_filters"));
                         $cb_over->setItems($items);
 
                         $cb_over->setFormCmd($this->getParentCmd());
                         $cb_over->setFieldVar("tblff".$this->getId());
                         $cb_over->setHiddenVar("tblfsf".$this->getId());
 
                         $this->tpl->setCurrentBlock("filter_select");
 
                         // apply should be the first submit because of enter/return, inserting hidden submit
                         $this->tpl->setVariable("HIDDEN_CMD_APPLY", $this->filter_cmd);
 
                         $this->tpl->setVariable("FILTER_SELECTOR", $cb_over->getHTML());
                         $this->tpl->parseCurrentBlock();
                 }
 
                 // if any filter
                 if($ccnt > 0 || count($opt_filter) > 0)
                 {
                         $this->tpl->setVariable("TXT_FILTER", $lng->txt("filter"));
 
                         if($ccnt > 0)
                         {
                                 if ($ccnt < $this->getFilterCols())
                                 {
                                         for($i = $ccnt; $i<=$this->getFilterCols(); $i++)
                                         {
                                                 $this->tpl->touchBlock("filter_empty_cell");
                                         }
                                 }
                                 $this->tpl->setCurrentBlock("filter_row");
                                 $this->tpl->parseCurrentBlock();
 
                                 $this->tpl->setCurrentBlock("filter_buttons");
                                 $this->tpl->setVariable("CMD_APPLY", $this->filter_cmd);
                                 $this->tpl->setVariable("TXT_APPLY", $lng->txt("apply_filter"));
                                 $this->tpl->setVariable("CMD_RESET", $this->reset_cmd);
                                 $this->tpl->setVariable("TXT_RESET", $lng->txt("reset_filter"));
                         }
                         else if(count($opt_filter) > 0)
                         {
                                 $this->tpl->setCurrentBlock("optional_filter_hint");
                                 $this->tpl->setVariable('TXT_OPT_HINT', $lng->txt('optional_filter_hint'));
                                 $this->tpl->parseCurrentBlock();
                         }
 
                         $this->tpl->setCurrentBlock("filter_section");
                         $this->tpl->setVariable("FIL_ID", $this->getId());
                         $this->tpl->parseCurrentBlock();
 
                         // (keep) filter hidden?
                         if ($this->loadProperty("filter") != 1)
                         {
                                 if (!$this->getDisableFilterHiding())
                                 {
                                         $this->tpl->setCurrentBlock("filter_hidden");
                                         $this->tpl->setVariable("FI_ID", $this->getId());
                                         $this->tpl->parseCurrentBlock();
                                 }
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetFilter()

ilFilterGUI::resetFilter ( )

Reset filter.

Definition at line 667 of file class.ilFilterGUI.php.

References $_REQUEST, $lng, and getFilterItems().

         {
                 global $lng;
 
                 $filter = $this->getFilterItems();
                 $opt_filter = $this->getFilterItems(true);
 
                 foreach ($filter as $item)
                 {
                         if ($item->checkInput())
                         {
 //                              $item->setValueByArray($_POST);
                                 $item->clearFromSession();
                         }
                 }
                 foreach ($opt_filter as $item)
                 {
                         if ($item->checkInput())
                         {
 //                              $item->setValueByArray($_POST);
                                 $item->clearFromSession();
                         }
                 }
 
                 // #13209
                 unset($_REQUEST["tbltplcrt"]);
                 unset($_REQUEST["tbltpldel"]);
         }

Here is the call graph for this function:

◆ setDisableFilterHiding()

ilFilterGUI::setDisableFilterHiding ( $disable_filter_hiding )

Parameters

boolean $disable_filter_hiding

Definition at line 138 of file class.ilFilterGUI.php.

References $disable_filter_hiding.

         {
                 $this->disable_filter_hiding = $disable_filter_hiding;
         }

◆ setFilterCmd()

ilFilterGUI::setFilterCmd ( $filter_cmd )

Parameters

string $filter_cmd

Definition at line 58 of file class.ilFilterGUI.php.

References $filter_cmd.

         {
                 $this->filter_cmd = $filter_cmd;
         }

◆ setFilterCols()

ilFilterGUI::setFilterCols ( $filter_cols )

Parameters

int $filter_cols

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

References $filter_cols.

Referenced by ilAdvancedSearchFilterGUI\__construct().

         {
                 $this->filter_cols = $filter_cols;
         }

Here is the caller graph for this function:

◆ setFilterId()

ilFilterGUI::setFilterId ( $filter_id )

Definition at line 586 of file class.ilFilterGUI.php.

References $filter_id.

Referenced by ilAdvancedSearchFilterGUI\__construct(), and ilShopFilterGUI\__construct().

         {
                 $this->filter_id = $filter_id;
         }

Here is the caller graph for this function:

◆ setFilters()

ilFilterGUI::setFilters ( $filters )

Parameters

array $filters

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

References $filters.

         {
                 $this->filters = $filters;
         }

◆ setFiltersDetermined()

ilFilterGUI::setFiltersDetermined ( $filters_determined )

Parameters

boolean $filters_determined

Definition at line 154 of file class.ilFilterGUI.php.

References $filters_determined.

         {
                 $this->filters_determined = $filters_determined;
         }

◆ setFormAction()

ilFilterGUI::setFormAction	(	$a_form_action,
		$a_multipart = `false`
	)

final

Set Form action parameter.

Parameters

string	$a_form_action	Form action
bool	$a_multipart	Form multipart status

Definition at line 410 of file class.ilFilterGUI.php.

Referenced by __construct().

         {
                 $this->form_action = $a_form_action;
                 $this->form_multipart = (bool)$a_multipart;
         }

Here is the caller graph for this function:

◆ setOptionalFilters()

ilFilterGUI::setOptionalFilters ( $optional_filters )

Parameters

array $optional_filters

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

References $optional_filters.

         {
                 $this->optional_filters = $optional_filters;
         }

◆ setResetCmd()

ilFilterGUI::setResetCmd ( $reset_cmd )

Parameters

string $reset_cmd

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

References $reset_cmd.

         {
                 $this->reset_cmd = $reset_cmd;
         }

◆ setSelectedFilter()

ilFilterGUI::setSelectedFilter ( $selected_filter )

Parameters

boolean $selected_filter

Definition at line 170 of file class.ilFilterGUI.php.

References $selected_filter.

         {
                 $this->selected_filter = $selected_filter;
         }

◆ writeFilterToSession()

ilFilterGUI::writeFilterToSession ( )

Write filter values to session.

Definition at line 635 of file class.ilFilterGUI.php.

References $_POST, $_REQUEST, $lng, and getFilterItems().

         {
                 global $lng;
 
                 $filter = $this->getFilterItems();
                 $opt_filter = $this->getFilterItems(true);
 
                 foreach ($filter as $item)
                 {
                         if ($item->checkInput())
                         {
                                 $item->setValueByArray($_POST);
                                 $item->writeToSession();
                         }
                 }
                 foreach ($opt_filter as $item)
                 {
                         if ($item->checkInput())
                         {
                                 $item->setValueByArray($_POST);
                                 $item->writeToSession();
                         }
                 }
 
                 // #13209
                 unset($_REQUEST["tbltplcrt"]);
                 unset($_REQUEST["tbltpldel"]);
         }

Here is the call graph for this function:

Field Documentation

◆ $disable_filter_hiding

ilFilterGUI::$disable_filter_hiding = false

protected

Definition at line 18 of file class.ilFilterGUI.php.

Referenced by getDisableFilterHiding(), isDisableFilterHiding(), and setDisableFilterHiding().

◆ $filter_cmd

ilFilterGUI::$filter_cmd = 'setFilter'

protected

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

Referenced by getFilterCmd(), and setFilterCmd().

◆ $filter_cols

ilFilterGUI::$filter_cols = 5

protected

Definition at line 16 of file class.ilFilterGUI.php.

Referenced by getFilterCols(), and setFilterCols().

◆ $filter_id

ilFilterGUI::$filter_id = ''

protected

Definition at line 23 of file class.ilFilterGUI.php.

Referenced by getFilterId(), and setFilterId().

◆ $filters

ilFilterGUI::$filters = array()

protected

Definition at line 12 of file class.ilFilterGUI.php.

Referenced by getFilterItems(), getFilters(), and setFilters().

◆ $filters_determined

ilFilterGUI::$filters_determined = false

protected

Definition at line 21 of file class.ilFilterGUI.php.

Referenced by isFiltersDetermined(), and setFiltersDetermined().

◆ $optional_filters

ilFilterGUI::$optional_filters = array()

protected

Definition at line 13 of file class.ilFilterGUI.php.

Referenced by getFilterItems(), getOptionalFilters(), and setOptionalFilters().

◆ $reset_cmd

ilFilterGUI::$reset_cmd = 'resetFilter'

protected

Definition at line 15 of file class.ilFilterGUI.php.

Referenced by getResetCmd(), and setResetCmd().

◆ $selected_filter

ilFilterGUI::$selected_filter = false

protected

Definition at line 19 of file class.ilFilterGUI.php.

Referenced by isSelectedFilter(), and setSelectedFilter().

◆ FILTER_DATE

const ilFilterGUI::FILTER_DATE = 3

Definition at line 28 of file class.ilFilterGUI.php.

◆ FILTER_DATE_RANGE

const ilFilterGUI::FILTER_DATE_RANGE = 6

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

◆ FILTER_DATETIME_RANGE

const ilFilterGUI::FILTER_DATETIME_RANGE = 8

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

◆ FILTER_DURATION_RANGE

const ilFilterGUI::FILTER_DURATION_RANGE = 7

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

◆ FILTER_LANGUAGE

const ilFilterGUI::FILTER_LANGUAGE = 4

Definition at line 29 of file class.ilFilterGUI.php.

◆ FILTER_NUMBER_RANGE

const ilFilterGUI::FILTER_NUMBER_RANGE = 5

Definition at line 30 of file class.ilFilterGUI.php.

◆ FILTER_SELECT

const ilFilterGUI::FILTER_SELECT = 2

Definition at line 27 of file class.ilFilterGUI.php.

◆ FILTER_TEXT

const ilFilterGUI::FILTER_TEXT = 1

Definition at line 26 of file class.ilFilterGUI.php.

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

Services/Payment/classes/class.ilFilterGUI.php

Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFilterItem()

◆ addFilterItemByMetaType()

◆ getDisableFilterHiding()

◆ getFilterCmd()

◆ getFilterCols()

◆ getFilterId()

◆ getFilterItemByPostVar()

◆ getFilterItems()

◆ getFilters()

◆ getFormAction()

◆ getHtml()

◆ getId()

◆ getOptionalFilters()

◆ getResetCmd()

◆ initFilter()

◆ isDisableFilterHiding()

◆ isFiltersDetermined()

◆ isFilterSelected()

◆ isSelectedFilter()

◆ loadProperty()

◆ renderFilter()

◆ resetFilter()

◆ setDisableFilterHiding()

◆ setFilterCmd()

◆ setFilterCols()

◆ setFilterId()

◆ setFilters()

◆ setFiltersDetermined()

◆ setFormAction()

◆ setOptionalFilters()

◆ setResetCmd()

◆ setSelectedFilter()

◆ writeFilterToSession()

Field Documentation

◆ $disable_filter_hiding

◆ $filter_cmd

◆ $filter_cols

◆ $filter_id

◆ $filters

◆ $filters_determined

◆ $optional_filters

◆ $reset_cmd

◆ $selected_filter

◆ FILTER_DATE

◆ FILTER_DATE_RANGE

◆ FILTER_DATETIME_RANGE

◆ FILTER_DURATION_RANGE

◆ FILTER_LANGUAGE

◆ FILTER_NUMBER_RANGE

◆ FILTER_SELECT

◆ FILTER_TEXT