Inheritance diagram for ilSearchBaseGUI:

Collaboration diagram for ilSearchBaseGUI:

Public Member Functions
	__construct ()

	prepareOutput ()

	initStandardSearchForm (int $a_mode)

	getSearchAreaForm ()

	handleCommand (string $a_cmd)

	addToDeskObject ()
	Add desktop item @access public. More...

	removeFromDeskObject ()
	Remove from desktop @access public. More...

	delete ()
	Show delete confirmation. More...

	cancelDelete ()
	Cancel delete. More...

	cancelObject ()

	cancelMoveLinkObject ()

	performDelete ()

	cut ()

	link ()

	paste ()

	showLinkIntoMultipleObjectsTree ()

	showPasteTree ()

	showMoveIntoObjectTree ()

	performPasteIntoMultipleObjects ()

	clear ()
	clear clipboard More...

	enableAdministrationPanel ()

	disableAdministrationPanel ()

	keepObjectsInClipboardObject ()

	addLocator ()

	autoComplete ()

	addToDeskObject ()
	Add desktop item @access public. More...

	removeFromDeskObject ()
	Remove from desktop @access public. More...

	delete ()
	Show delete confirmation. More...

	cancelDelete ()
	Cancel delete. More...

	performDelete ()

	cut ()

	showLinkIntoMultipleObjectsTree ()

	showMoveIntoObjectTree ()

	showPasteTree ()

	performPasteIntoMultipleObjects ()

	paste ()

	clear ()
	clear clipboard More...

	enableAdministrationPanel ()

	disableAdministrationPanel ()

	cancelMoveLinkObject ()

	keepObjectsInClipboardObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Data Fields
const	SEARCH_FAST = 1

const	SEARCH_DETAILS = 2

const	SEARCH_AND = 'and'

const	SEARCH_OR = 'or'

const	SEARCH_FORM_LUCENE = 1

const	SEARCH_FORM_STANDARD = 2

const	SEARCH_FORM_USER = 3

Protected Member Functions
	initPageNumberFromQuery ()

	addPager ($result, string $a_session_key)

	buildSearchAreaPath (int $a_root_node)

	getCreationDateForm ()

	getSearchCache ()

	loadCreationFilter ()

Protected Attributes
ilUserSearchCache	$search_cache

string	$search_mode = ''

ilSearchSettings	$settings

ilPropertyFormGUI	$form = null

ClipboardManager	$clipboard

ViewManager	$container_view_manager

ilFavouritesManager	$favourites

ilCtrl	$ctrl

ILIAS	$ilias

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilLocatorGUI	$locator

ilObjUser	$user

ilTree	$tree

GlobalHttpState	$http

Factory	$refinery

ilLogger	$logger

string	$prev_link = ''

string	$next_link = ''

Detailed Description

Definition at line 41 of file class.ilSearchBaseGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSearchBaseGUI::__construct ( )

Reimplemented in ilAdvancedSearchGUI, ilSearchGUI, ilLuceneAdvancedSearchGUI, ilLuceneSearchGUI, and ilLuceneUserSearchGUI.

Definition at line 79 of file class.ilSearchBaseGUI.php.

    {
        global $DIC;
 
 
        $this->logger = $DIC->logger()->src();
        $this->ilias = $DIC['ilias'];
        $this->locator = $DIC['ilLocator'];
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->tree = $DIC->repositoryTree();
 
        $this->lng->loadLanguageModule('search');
        $this->settings = new ilSearchSettings();
        $this->favourites = new ilFavouritesManager();
        $this->user = $DIC->user();
        $this->clipboard = $DIC
            ->repository()
            ->internal()
            ->domain()
            ->clipboard();
        $this->container_view_manager = $DIC
            ->container()
            ->internal()
            ->domain()
            ->content()
            ->view();
        $this->search_cache = ilUserSearchCache::_getInstance($this->user->getId());
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
    }

References $DIC, ilUserSearchCache\_getInstance(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), ILIAS\Repository\logger(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ addLocator()

ilSearchBaseGUI::addLocator ( )

Definition at line 380 of file class.ilSearchBaseGUI.php.

                                : void
    {
        $this->locator->addItem($this->lng->txt('search'), $this->ctrl->getLinkTarget($this));
        $this->tpl->setLocator();
    }

References ILIAS\Repository\lng(), and ILIAS\Repository\locator().

Here is the call graph for this function:

◆ addPager()

ilSearchBaseGUI::addPager	(		$result,
		string	$a_session_key
	)

protected

Todo:: check wether result is ilSearchResult or ilLuceneSearchResult and add interface or base class.

Definition at line 389 of file class.ilSearchBaseGUI.php.

                                                               : bool
    {
        $max_page = max(ilSession::get($a_session_key), $this->search_cache->getResultPageNumber());
        ilSession::set($a_session_key, $max_page);
 
        if ($max_page == 1 and
            (count($result->getResults()) < $result->getMaxHits())) {
            return true;
        }
 
        if ($this->search_cache->getResultPageNumber() > 1) {
            $this->ctrl->setParameter($this, 'page_number', $this->search_cache->getResultPageNumber() - 1);
            $this->prev_link = $this->ctrl->getLinkTarget($this, 'performSearch');
        }
        for ($i = 1;$i <= $max_page;$i++) {
            if ($i == $this->search_cache->getResultPageNumber()) {
                continue;
            }
 
            $this->ctrl->setParameter($this, 'page_number', $i);
            $link = '<a href="' . $this->ctrl->getLinkTarget($this, 'performSearch') . '" /a>' . $i . '</a> ';
        }
        if (count($result->getResults()) >= $result->getMaxHits()) {
            $this->ctrl->setParameter($this, 'page_number', $this->search_cache->getResultPageNumber() + 1);
            $this->next_link = $this->ctrl->getLinkTarget($this, 'performSearch');
        }
        $this->ctrl->clearParameters($this);
        return false;
    }

References $i, ILIAS\Repository\ctrl(), ilSession\get(), and ilSession\set().

Referenced by ilAdvancedSearchGUI\performAdvMDSearch(), ilAdvancedSearchGUI\performSearch(), ilSearchGUI\performSearch(), ilLuceneAdvancedSearchGUI\performSearch(), ilLuceneSearchGUI\performSearch(), ilAdvancedSearchGUI\showSavedAdvMDResults(), ilAdvancedSearchGUI\showSavedResults(), ilSearchGUI\showSavedResults(), ilLuceneAdvancedSearchGUI\showSavedResults(), and ilLuceneSearchGUI\showSavedResults().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addToDeskObject()

ilSearchBaseGUI::addToDeskObject ( )

Add desktop item @access public.

Implements ilDesktopItemHandling.

Definition at line 254 of file class.ilSearchBaseGUI.php.

                                     : void
    {
        if ($this->http->wrapper()->query()->has('item_ref_id')) {
            $this->favourites->add(
                $this->user->getId(),
                $this->http->wrapper()->query()->retrieve(
                    'item_ref_id',
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        $this->showSavedResults();
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ autoComplete()

ilSearchBaseGUI::autoComplete ( )

Reimplemented in ilSearchGUI.

Definition at line 435 of file class.ilSearchBaseGUI.php.

                                  : void
    {
        $query = '';
        if ($this->http->wrapper()->post()->has('term')) {
            $query = $this->http->wrapper()->post()->retrieve(
                'term',
                $this->refinery->kindlyTo()->string()
            );
        }
        $list = ilSearchAutoComplete::getList($query);
        echo $list;
        exit;
    }

References $query, exit, ilSearchAutoComplete\getList(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ buildSearchAreaPath()

ilSearchBaseGUI::buildSearchAreaPath ( int $a_root_node )

protected

Definition at line 419 of file class.ilSearchBaseGUI.php.

                                                            : string
    {
        $path_arr = $this->tree->getPathFull($a_root_node, ROOT_FOLDER_ID);
        $counter = 0;
        $path = '';
        foreach ($path_arr as $data) {
            if ($counter++) {
                $path .= " > ";
                $path .= $data['title'];
            } else {
                $path .= $this->lng->txt('repository');
            }
        }
        return $path;
    }

References $data, $path, ILIAS\Repository\lng(), and ROOT_FOLDER_ID.

Here is the call graph for this function:

◆ cancelDelete()

ilSearchBaseGUI::cancelDelete ( )

Cancel delete.

Implements ilAdministrationCommandHandling.

Definition at line 288 of file class.ilSearchBaseGUI.php.

                                  : void
    {
        $this->showSavedResults();
    }

◆ cancelMoveLinkObject()

ilSearchBaseGUI::cancelMoveLinkObject ( )

Implements ilAdministrationCommandHandling.

Definition at line 298 of file class.ilSearchBaseGUI.php.

                                          : void
    {
        $this->showSavedResults();
    }

◆ cancelObject()

ilSearchBaseGUI::cancelObject ( )

Definition at line 293 of file class.ilSearchBaseGUI.php.

                                  : void
    {
        $this->showSavedResults();
    }

◆ clear()

ilSearchBaseGUI::clear ( )

clear clipboard

Implements ilAdministrationCommandHandling.

Definition at line 353 of file class.ilSearchBaseGUI.php.

                           : void
    {
        $this->clipboard->clear();
        $this->ctrl->redirect($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ cut()

ilSearchBaseGUI::cut ( )

Implements ilAdministrationCommandHandling.

Definition at line 309 of file class.ilSearchBaseGUI.php.

                         : void
    {
        $admin = new ilAdministrationCommandGUI($this);
        $admin->cut();
    }

◆ delete()

ilSearchBaseGUI::delete ( )

Show delete confirmation.

Implements ilAdministrationCommandHandling.

Definition at line 282 of file class.ilSearchBaseGUI.php.

                            : void
    {
        $admin = new ilAdministrationCommandGUI($this);
        $admin->delete();
    }

◆ disableAdministrationPanel()

ilSearchBaseGUI::disableAdministrationPanel ( )

Implements ilAdministrationCommandHandling.

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

                                                : void
    {
        $this->container_view_manager->setContentView();
        $this->ctrl->redirect($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ enableAdministrationPanel()

ilSearchBaseGUI::enableAdministrationPanel ( )

Implements ilAdministrationCommandHandling.

Definition at line 359 of file class.ilSearchBaseGUI.php.

                                               : void
    {
        $this->container_view_manager->setAdminView();
        $this->ctrl->redirect($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getCreationDateForm()

ilSearchBaseGUI::getCreationDateForm ( )

protected

Definition at line 449 of file class.ilSearchBaseGUI.php.

                                            : ilPropertyFormGUI
    {
        $options = $this->search_cache->getCreationFilter();
 
        $form = new ilPropertyFormGUI();
        $form->setOpenTag(false);
        $form->setCloseTag(false);
 
        $enabled = new ilCheckboxInputGUI($this->lng->txt('search_filter_cd'), 'screation');
        $enabled->setValue('1');
        $enabled->setChecked((bool) ($options['enabled'] ?? false));
        $form->addItem($enabled);
 
 
        $limit_sel = new ilSelectInputGUI('', 'screation_ontype');
        $limit_sel->setValue($options['ontype'] ?? '');
        $limit_sel->setOptions(
            array(
                    1 => $this->lng->txt('search_created_after'),
                    2 => $this->lng->txt('search_created_before'),
                    3 => $this->lng->txt('search_created_on')
            )
        );
        $enabled->addSubItem($limit_sel);
 
 
        if ($options['date'] ?? false) {
            $now = new ilDate($options['date'] ?? 0, IL_CAL_UNIX);
        } else {
            $now = new ilDate(time(), IL_CAL_UNIX);
        }
        $ds = new ilDateTimeInputGUI('', 'screation_date');
        $ds->setRequired(true);
        $ds->setDate($now);
        $enabled->addSubItem($ds);
 
        $form->setFormAction($this->ctrl->getFormAction($this, 'performSearch'));
 
        return $form;
    }

References ILIAS\LTI\ToolProvider\$enabled, $form, ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), IL_CAL_UNIX, ILIAS\Repository\lng(), ilFormGUI\setCloseTag(), ilFormGUI\setFormAction(), and ilFormGUI\setOpenTag().

Referenced by loadCreationFilter(), ilSearchGUI\showSearch(), and ilLuceneSearchGUI\showSearchForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSearchAreaForm()

ilSearchBaseGUI::getSearchAreaForm ( )

Definition at line 210 of file class.ilSearchBaseGUI.php.

                                       : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setOpenTag(false);
        $form->setCloseTag(false);
 
        // term combination
        $radg = new ilHiddenInputGUI('search_term_combination');
        $radg->setValue((string) ilSearchSettings::getInstance()->getDefaultOperator());
        $form->addItem($radg);
 
        // search area
        $ti = new ilRepositorySelectorInputGUI($this->lng->txt("search_area"), "area");
        $ti->setSelectText($this->lng->txt("search_select_search_area"));
        $form->addItem($ti);
        $ti->readFromSession();
 
        // alex, 15.8.2012: Added the following lines to get the value
        // from the main menu top right input search form
        if ($this->http->wrapper()->post()->has('root_id')) {
            $ti->setValue(
                $this->http->wrapper()->post()->retrieve(
                    'root_id',
                    $this->refinery->kindlyTo()->string()
                )
            );
            $ti->writeToSession();
        }
        $form->setFormAction($this->ctrl->getFormAction($this, 'performSearch'));
 
        return $form;
    }

References $form, ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), ilSearchSettings\getInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilFormGUI\setCloseTag(), ilFormGUI\setFormAction(), and ilFormGUI\setOpenTag().

Referenced by ilSearchGUI\executeCommand(), ilLuceneSearchGUI\executeCommand(), ilSearchGUI\showSearch(), ilLuceneSearchGUI\showSearchForm(), ilSearchGUI\storeRoot(), and ilLuceneSearchGUI\storeRoot().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSearchCache()

ilSearchBaseGUI::getSearchCache ( )

protected

Definition at line 490 of file class.ilSearchBaseGUI.php.

                                       : ilUserSearchCache
    {
        return $this->search_cache;
    }

References $search_cache.

Referenced by ilSearchGUI\__construct(), ilSearchGUI\parseDateFromCreationFilter(), and ilSearchGUI\parseOperatorFromCreationFilter().

Here is the caller graph for this function:

◆ handleCommand()

ilSearchBaseGUI::handleCommand ( string $a_cmd )

Definition at line 244 of file class.ilSearchBaseGUI.php.

                                                : void
    {
        if (method_exists($this, $a_cmd)) {
            $this->$a_cmd();
        } else {
            $a_cmd .= 'Object';
            $this->$a_cmd();
        }
    }

Referenced by ilAdvancedSearchGUI\executeCommand(), ilSearchGUI\executeCommand(), ilLuceneAdvancedSearchGUI\executeCommand(), ilLuceneSearchGUI\executeCommand(), and ilLuceneUserSearchGUI\executeCommand().

Here is the caller graph for this function:

◆ initPageNumberFromQuery()

ilSearchBaseGUI::initPageNumberFromQuery ( )

protected

Definition at line 112 of file class.ilSearchBaseGUI.php.

                                                : int
    {
        if ($this->http->wrapper()->query()->has('page_number')) {
            return $this->http->wrapper()->query()->retrieve(
                'page_number',
                $this->refinery->kindlyTo()->int()
            );
        }
        return 0;
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by ilAdvancedSearchGUI\initUserSearchCache(), ilLuceneAdvancedSearchGUI\initUserSearchCache(), ilLuceneSearchGUI\initUserSearchCache(), ilLuceneUserSearchGUI\initUserSearchCache(), ilAdvancedSearchGUI\performAdvMDSearch(), ilAdvancedSearchGUI\performSearch(), and ilSearchGUI\performSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initStandardSearchForm()

ilSearchBaseGUI::initStandardSearchForm ( int $a_mode )

Definition at line 135 of file class.ilSearchBaseGUI.php.

                                                       : ilPropertyFormGUI
    {
        $this->form = new ilPropertyFormGUI();
        $this->form->setOpenTag(false);
        $this->form->setCloseTag(false);
 
        // term combination
        $radg = new ilHiddenInputGUI('search_term_combination');
        $radg->setValue((string) ilSearchSettings::getInstance()->getDefaultOperator());
        $this->form->addItem($radg);
 
        if (ilSearchSettings::getInstance()->isLuceneItemFilterEnabled()) {
            if ($a_mode == self::SEARCH_FORM_STANDARD) {
                // search type
                $radg = new ilRadioGroupInputGUI($this->lng->txt("search_type"), "type");
                $radg->setValue(
                    $this->getType() ==
                        ilSearchBaseGUI::SEARCH_FAST ?
                        (string) ilSearchBaseGUI::SEARCH_FAST :
                        (string) ilSearchBaseGUI::SEARCH_DETAILS
                );
                $op1 = new ilRadioOption($this->lng->txt("search_fast_info"), (string) ilSearchBaseGUI::SEARCH_FAST);
                $radg->addOption($op1);
                $op2 = new ilRadioOption($this->lng->txt("search_details_info"), (string) ilSearchBaseGUI::SEARCH_DETAILS);
            } else {
                $op2 = new ilCheckboxInputGUI($this->lng->txt('search_filter_by_type'), 'item_filter_enabled');
                $op2->setValue('1');
            }
 
 
            $cbgr = new ilCheckboxGroupInputGUI('', 'filter_type');
            $cbgr->setUseValuesAsKeys(true);
            $details = $this->getDetails();
            $det = false;
            foreach (ilSearchSettings::getInstance()->getEnabledLuceneItemFilterDefinitions() as $type => $data) {
                $cb = new ilCheckboxOption($this->lng->txt($data['trans']), $type);
                if (isset($details[$type])) {
                    $det = true;
                }
                $cbgr->addOption($cb);
            }
            $mimes = [];
            if ($a_mode == self::SEARCH_FORM_LUCENE) {
                if (ilSearchSettings::getInstance()->isLuceneMimeFilterEnabled()) {
                    $mimes = $this->getMimeDetails();
                    foreach (ilSearchSettings::getInstance()->getEnabledLuceneMimeFilterDefinitions() as $type => $data) {
                        $op3 = new ilCheckboxOption($this->lng->txt($data['trans']), $type);
                        if (isset($mimes[$type])) {
                            $det = true;
                        }
                        $cbgr->addOption($op3);
                    }
                }
            }
 
            $cbgr->setValue(array_merge((array) $details, (array) $mimes));
            $op2->addSubItem($cbgr);
 
            if ($a_mode != self::SEARCH_FORM_STANDARD && $det) {
                $op2->setChecked(true);
            }
 
            if ($a_mode == ilSearchBaseGUI::SEARCH_FORM_STANDARD) {
                $radg->addOption($op2);
                $this->form->addItem($radg);
            } else {
                $this->form->addItem($op2);
            }
        }
 
        $this->form->setFormAction($this->ctrl->getFormAction($this, 'performSearch'));
        return $this->form;
    }

References $data, ILIAS\LTI\ToolProvider\$details, $form, $type, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilSearchSettings\getInstance(), ILIAS\Repository\lng(), SEARCH_DETAILS, SEARCH_FAST, and SEARCH_FORM_STANDARD.

Referenced by ilSearchGUI\__construct(), ilLuceneSearchGUI\executeCommand(), ilLuceneUserSearchGUI\executeCommand(), and ilSearchGUI\showSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ keepObjectsInClipboardObject()

ilSearchBaseGUI::keepObjectsInClipboardObject ( )

Implements ilAdministrationCommandHandling.

Definition at line 374 of file class.ilSearchBaseGUI.php.

                                                  : void
    {
        $this->ctrl->redirect($this);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ link()

ilSearchBaseGUI::link ( )

Definition at line 316 of file class.ilSearchBaseGUI.php.

                          : void
    {
        $admin = new ilAdministrationCommandGUI($this);
        $admin->link();
    }

◆ loadCreationFilter()

ilSearchBaseGUI::loadCreationFilter ( )

protected

Returns: array<{enabled: bool, type: string, ontype: int, date: ilDate, duration: int}>

Definition at line 498 of file class.ilSearchBaseGUI.php.

                                           : array
    {
        if (!$this->settings->isDateFilterEnabled()) {
            return array();
        }
 
 
        $form = $this->getCreationDateForm();
        $options = array();
        if ($form->checkInput()) {
            $options['enabled'] = $form->getInput('screation');
            $options['type'] = $form->getInput('screation_type');
            $options['ontype'] = $form->getInput('screation_ontype');
            $options['date'] = $form->getItemByPostVar('screation_date')->getDate()->get(IL_CAL_UNIX);
            $options['duration'] = $form->getInput('screation_duration');
        }
        return $options;
    }

References $form, ilPropertyFormGUI\checkInput(), getCreationDateForm(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), IL_CAL_UNIX, and ILIAS\Repository\settings().

Referenced by ilSearchGUI\__construct(), and ilLuceneSearchGUI\initUserSearchCache().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ paste()

ilSearchBaseGUI::paste ( )

Implements ilAdministrationCommandHandling.

Definition at line 322 of file class.ilSearchBaseGUI.php.

                           : void
    {
        $admin = new ilAdministrationCommandGUI($this);
        $admin->paste();
    }

◆ performDelete()

ilSearchBaseGUI::performDelete ( )

Implements ilAdministrationCommandHandling.

Definition at line 303 of file class.ilSearchBaseGUI.php.

                                   : void
    {
        $admin = new ilAdministrationCommandGUI($this);
        $admin->performDelete();
    }

◆ performPasteIntoMultipleObjects()

ilSearchBaseGUI::performPasteIntoMultipleObjects ( )

Implements ilAdministrationCommandHandling.

Definition at line 347 of file class.ilSearchBaseGUI.php.

                                                     : void
    {
        $admin = new ilAdministrationCommandGUI($this);
        $admin->performPasteIntoMultipleObjects();
    }

◆ prepareOutput()

ilSearchBaseGUI::prepareOutput ( )

Reimplemented in ilAdvancedSearchGUI, ilSearchGUI, ilLuceneAdvancedSearchGUI, ilLuceneSearchGUI, and ilLuceneUserSearchGUI.

Definition at line 124 of file class.ilSearchBaseGUI.php.

                                   : void
    {
        $this->tpl->loadStandardTemplate();
 
        $this->tpl->setTitleIcon(
            ilObject::_getIcon(0, "big", "src"),
            ""
        );
        $this->tpl->setTitle($this->lng->txt("search"));
    }

References ilObject\_getIcon(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ removeFromDeskObject()

ilSearchBaseGUI::removeFromDeskObject ( )

Remove from desktop @access public.

Implements ilDesktopItemHandling.

Definition at line 268 of file class.ilSearchBaseGUI.php.

                                          : void
    {
        if ($this->http->wrapper()->query()->has('item_ref_id')) {
            $this->favourites->remove(
                $this->user->getId(),
                $this->http->wrapper()->query()->retrieve(
                    'item_ref_id',
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        $this->showSavedResults();
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ showLinkIntoMultipleObjectsTree()

ilSearchBaseGUI::showLinkIntoMultipleObjectsTree ( )

Implements ilAdministrationCommandHandling.

Definition at line 328 of file class.ilSearchBaseGUI.php.

                                                     : void
    {
        $admin = new ilAdministrationCommandGUI($this);
        $admin->showLinkIntoMultipleObjectsTree();
    }

◆ showMoveIntoObjectTree()

ilSearchBaseGUI::showMoveIntoObjectTree ( )

Implements ilAdministrationCommandHandling.

Definition at line 341 of file class.ilSearchBaseGUI.php.

                                            : void
    {
        $admin = new ilAdministrationCommandGUI($this);
        $admin->showMoveIntoObjectTree();
    }

◆ showPasteTree()

ilSearchBaseGUI::showPasteTree ( )

Implements ilAdministrationCommandHandling.

Definition at line 334 of file class.ilSearchBaseGUI.php.

                                   : void
    {
        $admin = new ilAdministrationCommandGUI($this);
        $admin->showPasteTree();
    }

Field Documentation

◆ $clipboard

ClipboardManager ilSearchBaseGUI::$clipboard

protected

Definition at line 59 of file class.ilSearchBaseGUI.php.

◆ $container_view_manager

ViewManager ilSearchBaseGUI::$container_view_manager

protected

Definition at line 60 of file class.ilSearchBaseGUI.php.

◆ $ctrl

ilCtrl ilSearchBaseGUI::$ctrl

protected

Definition at line 63 of file class.ilSearchBaseGUI.php.

◆ $favourites

ilFavouritesManager ilSearchBaseGUI::$favourites

protected

Definition at line 61 of file class.ilSearchBaseGUI.php.

◆ $form

ilPropertyFormGUI ilSearchBaseGUI::$form = null

protected

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

Referenced by ilSearchGUI\executeCommand(), ilLuceneSearchGUI\executeCommand(), getCreationDateForm(), getSearchAreaForm(), ilAdvancedSearchGUI\initAdvancedMetaDataForm(), initStandardSearchForm(), loadCreationFilter(), ilSearchGUI\storeRoot(), and ilLuceneSearchGUI\storeRoot().

◆ $http

GlobalHttpState ilSearchBaseGUI::$http

protected

Definition at line 70 of file class.ilSearchBaseGUI.php.

◆ $ilias

ILIAS ilSearchBaseGUI::$ilias

protected

Definition at line 64 of file class.ilSearchBaseGUI.php.

◆ $lng

ilLanguage ilSearchBaseGUI::$lng

protected

Definition at line 65 of file class.ilSearchBaseGUI.php.

◆ $locator

ilLocatorGUI ilSearchBaseGUI::$locator

protected

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

◆ $logger

ilLogger ilSearchBaseGUI::$logger

protected

Definition at line 73 of file class.ilSearchBaseGUI.php.

◆ $next_link

string ilSearchBaseGUI::$next_link = ''

protected

Definition at line 77 of file class.ilSearchBaseGUI.php.

◆ $prev_link

string ilSearchBaseGUI::$prev_link = ''

protected

Definition at line 76 of file class.ilSearchBaseGUI.php.

◆ $refinery

Factory ilSearchBaseGUI::$refinery

protected

Definition at line 71 of file class.ilSearchBaseGUI.php.

◆ $search_cache

ilUserSearchCache ilSearchBaseGUI::$search_cache

protected

Definition at line 54 of file class.ilSearchBaseGUI.php.

Referenced by getSearchCache().

◆ $search_mode

string ilSearchBaseGUI::$search_mode = ''

protected

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

◆ $settings

ilSearchSettings ilSearchBaseGUI::$settings

protected

Definition at line 57 of file class.ilSearchBaseGUI.php.

◆ $tpl

ilGlobalTemplateInterface ilSearchBaseGUI::$tpl

protected

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

◆ $tree

ilTree ilSearchBaseGUI::$tree

protected

Definition at line 69 of file class.ilSearchBaseGUI.php.

◆ $user

ilObjUser ilSearchBaseGUI::$user

protected

Definition at line 68 of file class.ilSearchBaseGUI.php.

◆ SEARCH_AND

const ilSearchBaseGUI::SEARCH_AND = 'and'

Definition at line 47 of file class.ilSearchBaseGUI.php.

◆ SEARCH_DETAILS

const ilSearchBaseGUI::SEARCH_DETAILS = 2

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

Referenced by ilSearchGUI\__getFilter(), ilSearchGUI\__searchMeta(), ilSearchGUI\__searchObjects(), ilLuceneSearchGUI\getType(), ilLuceneUserSearchGUI\getType(), initStandardSearchForm(), and ilSearchGUI\performSearch().

◆ SEARCH_FAST

const ilSearchBaseGUI::SEARCH_FAST = 1

Definition at line 45 of file class.ilSearchBaseGUI.php.

Referenced by ilSearchGUI\__construct(), ilSearchGUI\getType(), and initStandardSearchForm().

◆ SEARCH_FORM_LUCENE

const ilSearchBaseGUI::SEARCH_FORM_LUCENE = 1

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

Referenced by ilLuceneSearchGUI\executeCommand().

◆ SEARCH_FORM_STANDARD

const ilSearchBaseGUI::SEARCH_FORM_STANDARD = 2

Definition at line 51 of file class.ilSearchBaseGUI.php.

Referenced by ilSearchGUI\__construct(), initStandardSearchForm(), and ilSearchGUI\showSearch().

◆ SEARCH_FORM_USER

const ilSearchBaseGUI::SEARCH_FORM_USER = 3

Definition at line 52 of file class.ilSearchBaseGUI.php.

Referenced by ilLuceneUserSearchGUI\executeCommand().

◆ SEARCH_OR

const ilSearchBaseGUI::SEARCH_OR = 'or'

Definition at line 48 of file class.ilSearchBaseGUI.php.

Referenced by ilSearchGUI\getCombination().

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

Services/Search/classes/class.ilSearchBaseGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addLocator()

◆ addPager()

◆ addToDeskObject()

◆ autoComplete()

◆ buildSearchAreaPath()

◆ cancelDelete()

◆ cancelMoveLinkObject()

◆ cancelObject()

◆ clear()

◆ cut()

◆ delete()

◆ disableAdministrationPanel()

◆ enableAdministrationPanel()

◆ getCreationDateForm()

◆ getSearchAreaForm()

◆ getSearchCache()

◆ handleCommand()

◆ initPageNumberFromQuery()

◆ initStandardSearchForm()

◆ keepObjectsInClipboardObject()

◆ link()

◆ loadCreationFilter()

◆ paste()

◆ performDelete()

◆ performPasteIntoMultipleObjects()

◆ prepareOutput()

◆ removeFromDeskObject()

◆ showLinkIntoMultipleObjectsTree()

◆ showMoveIntoObjectTree()

◆ showPasteTree()

Field Documentation

◆ $clipboard

◆ $container_view_manager

◆ $ctrl

◆ $favourites

◆ $form

◆ $http

◆ $ilias

◆ $lng

◆ $locator

◆ $logger

◆ $next_link

◆ $prev_link

◆ $refinery

◆ $search_cache

◆ $search_mode

◆ $settings

◆ $tpl

◆ $tree

◆ $user

◆ SEARCH_AND

◆ SEARCH_DETAILS

◆ SEARCH_FAST

◆ SEARCH_FORM_LUCENE

◆ SEARCH_FORM_STANDARD

◆ SEARCH_FORM_USER

◆ SEARCH_OR