ilSearchFilterGUI Class Reference

Collaboration diagram for ilSearchFilterGUI:

Public Member Functions
	__construct (URI $action, bool $for_lucene)
	getHTML ()
	getFilter ()
	getData ()

Protected Attributes
ilUIFilterService	$filter_service
ILIAS UI Renderer	$renderer
ilNavigationHistory	$nav_history
Filter Standard	$filter
LOMServices	$lom_services

Detailed Description

Author

Thomas Famula famul.nosp@m.a@le.nosp@m.ifos..nosp@m.de

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

Constructor & Destructor Documentation

__construct()

ilSearchFilterGUI::__construct	(	URI	$action,
		bool	$for_lucene
	)

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

    {
        global $DIC;
 
        $this->filter_service = $DIC->uiService()->filter();
        $this->renderer = $DIC->ui()->renderer();
        $this->nav_history = $DIC["ilNavigationHistory"];
        $this->lom_services = $DIC->learningObjectMetadata();
        $field_factory = $DIC->ui()->factory()->input()->field();
        $txt = static function (string $id) use ($DIC): string {
            return $DIC->language()->txt($id);
        };
 
        $scope_options[ROOT_FOLDER_ID] = $txt("repository");
        $last_items = $this->nav_history->getItems();
        $cnt = 0;
        foreach ($last_items as $item) {
            if ($cnt++ >= 10) {
                break;
            }
            $scope_options[(string) $item["ref_id"]] = strip_tags($item["title"]);
        }
        $inputs["search_scope"] = $field_factory->select($txt("scope"), $scope_options)
                                                ->withRequired(true)
                                                ->withValue(ROOT_FOLDER_ID);
        $inputs_activated[] = true;
 
        $enabled_types = ilSearchSettings::getInstance()->getEnabledLuceneItemFilterDefinitions();
 
        if ($for_lucene) {
            $enabled_types += ilSearchSettings::getInstance()->getEnabledLuceneMimeFilterDefinitions();
        }
 
        if (ilSearchSettings::getInstance()->isLuceneItemFilterEnabled() && !empty($enabled_types)) {
            $type_options = [];
            foreach ($enabled_types as $type => $pval) {
                $type_options[$type] = $txt($pval["trans"]);
            }
            $inputs["search_type"] = $field_factory->multiSelect($txt("search_type"), $type_options);
            $inputs_activated[] = true;
        }
 
        if (ilSearchSettings::getInstance()->isDateFilterEnabled()) {
            $inputs["search_date"] = $field_factory->duration($txt("create_date"));
            $inputs_activated[] = true;
        }
 
        if ($this->lom_services->copyrightHelper()->isCopyrightSelectionActive()) {
            $cp_selection = [];
            foreach ($this->lom_services->copyrightHelper()->getAllCopyrightPresets() as $copyright) {
                if ($copyright->isDefault()) {
                    continue;
                }
                $cp_selection[$copyright->identifier()] = $copyright->title();
            }
            $inputs["search_copyright"] = $field_factory->multiSelect($txt("search_copyright"), $cp_selection);
            $inputs_activated[] = true;
        }
 
        $this->filter = $this->filter_service->standard(
            "search_filter",
            (string) $action,
            $inputs,
            $inputs_activated,
            false,
            true
        );
    }

References $DIC, $id, ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\filter(), ilSearchSettings\getInstance(), renderer(), and ROOT_FOLDER_ID.

Here is the call graph for this function:

Member Function Documentation

getData()

ilSearchFilterGUI::getData

(

)

Definition at line 115 of file class.ilSearchFilterGUI.php.

                             : ?array
    {
        return $this->filter_service->getData($this->filter);
    }

References ILIAS\Repository\filter().

Referenced by ILIAS\Search\GUI\Direct\SearchStateHandlerImpl\loadFilterToCache(), and ILIAS\Search\GUI\Lucene\SearchStateHandlerImpl\loadFilterToCache().

Here is the call graph for this function:

Here is the caller graph for this function:

getFilter()

ilSearchFilterGUI::getFilter

(

)

Definition at line 110 of file class.ilSearchFilterGUI.php.

                               : Filter\Standard
    {
        return $this->filter;
    }

References $filter.

getHTML()

ilSearchFilterGUI::getHTML

(

)

Definition at line 105 of file class.ilSearchFilterGUI.php.

                             : string
    {
        return $this->renderer->render($this->filter);
    }

References ILIAS\Repository\filter(), and renderer().

Here is the call graph for this function:

Field Documentation

$filter

Filter Standard ilSearchFilterGUI::$filter

protected

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

Referenced by getFilter().

$filter_service

ilUIFilterService ilSearchFilterGUI::$filter_service

protected

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

$lom_services

LOMServices ilSearchFilterGUI::$lom_services

protected

Definition at line 34 of file class.ilSearchFilterGUI.php.

$nav_history

ilNavigationHistory ilSearchFilterGUI::$nav_history

protected

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

$renderer

ILIAS UI Renderer ilSearchFilterGUI::$renderer

protected

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

---

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

• components/ILIAS/Search/classes/class.ilSearchFilterGUI.php