ilObjSearchSettingsGUI Class Reference

Inheritance diagram for ilObjSearchSettingsGUI:

Collaboration diagram for ilObjSearchSettingsGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference, $a_prepare_output=true)
	Constructor public. More...
	executeCommand ()
	cancelObject ()
	settingsObject ()
	Show settings public. More...
	saveSettingsObject ()
	Save settings public. More...
	getAdminTabs ()
	getTabs ()
	get tabs public More...
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...
	addToDeskObject ()
	removeFromDeskObject ()

Protected Member Functions
	initFormSettings ()
	Init settings form. More...
	updateSettingsObject ()
	Update Settings. More...
	luceneSettingsObject (ilPropertyFormGUI $form=null)
	Lucene settings. More...
	initFormLuceneSettings ()
	Show lucene settings form. More...
	saveLuceneSettingsObject ()
	Save Lucene settings. More...
	refreshLuceneSettings ()
	Refresh lucene server settings. More...
	advancedLuceneSettingsObject ()
	show advanced settings More...
	saveAdvancedLuceneSettingsObject ()
	Save advanced settings. More...
	initSubTabs ($a_section)
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$dic
	$error
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$rbacsystem
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service
	$favourites

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Detailed Description

Definition at line 17 of file class.ilObjSearchSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjSearchSettingsGUI::__construct	(		$a_data,
			$a_id,
			$a_call_by_reference,
			$a_prepare_output = true
	)

Constructor public.

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

References $DIC, ilObjectGUI\$ilErr, and ILIAS\GlobalScreen\Provider\__construct().

    {
        global $DIC, $ilErr;
        $this->dic = $DIC;
        $this->error = $ilErr;
        $this->type = "seas";
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);

        $this->lng->loadLanguageModule('search');
    }

Here is the call graph for this function:

Member Function Documentation

advancedLuceneSettingsObject()

ilObjSearchSettingsGUI::advancedLuceneSettingsObject ( )

protected

show advanced settings

Definition at line 583 of file class.ilObjSearchSettingsGUI.php.

References ilLuceneAdvancedSearchSettings\getInstance(), and initSubTabs().

Referenced by saveAdvancedLuceneSettingsObject().

    {
        $this->initSubTabs('lucene');
        $this->tabs_gui->setTabActive('lucene_advanced_settings');
        
        include_once './Services/Search/classes/Lucene/class.ilLuceneAdvancedSearchActivationTableGUI.php';
        include_once './Services/Search/classes/Lucene/class.ilLuceneAdvancedSearchSettings.php';
        
        $table = new ilLuceneAdvancedSearchActivationTableGUI($this, 'advancedLuceneSettings');
        $table->setTitle($this->lng->txt('lucene_advanced_settings_table'));
        $table->parse(ilLuceneAdvancedSearchSettings::getInstance());
        
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancelObject()

ilObjSearchSettingsGUI::cancelObject

(

)

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

References ilUtil\sendInfo().

    {
        ilUtil::sendInfo($this->lng->txt("msg_cancel"), true);
        $this->ctrl->redirect($this, "settings");
    }

Here is the call graph for this function:

executeCommand()

ilObjSearchSettingsGUI::executeCommand

(

)

Definition at line 43 of file class.ilObjSearchSettingsGUI.php.

References $ret, and ilObjectGUI\prepareOutput().

    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        $this->prepareOutput();

        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $ret = &$this->ctrl->forwardCommand($perm_gui);
                break;

            default:
                if ($cmd == "" || $cmd == "view") {
                    $cmd = "settings";
                }
                $cmd .= "Object";
                $this->$cmd();

                break;
        }
        return true;
    }

Here is the call graph for this function:

getAdminTabs()

ilObjSearchSettingsGUI::getAdminTabs

(

)

Definition at line 133 of file class.ilObjSearchSettingsGUI.php.

References getTabs().

    {
        $this->getTabs();
    }

Here is the call graph for this function:

getTabs()

ilObjSearchSettingsGUI::getTabs

(

)

get tabs public

Parameters

object

tabs gui object

Definition at line 143 of file class.ilObjSearchSettingsGUI.php.

References $DIC, and ilObjectGUI\$rbacsystem.

Referenced by getAdminTabs().

    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];

        if ($rbacsystem->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "settings",
                $this->ctrl->getLinkTarget($this, "settings"),
                array("settings","", "view"),
                "",
                ""
            );
        }

        if ($rbacsystem->checkAccess('read', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'lucene_advanced_settings',
                $this->ctrl->getLinkTarget($this, 'advancedLuceneSettings')
            );
        }

        if ($rbacsystem->checkAccess('read', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'lucene_settings_tab',
                $this->ctrl->getLinkTarget($this, 'luceneSettings')
            );
        }


        if ($rbacsystem->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                "perm_settings",
                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"),
                array("perm","info","owner"),
                'ilpermissiongui'
            );
        }
    }

Here is the caller graph for this function:

initFormLuceneSettings()

ilObjSearchSettingsGUI::initFormLuceneSettings ( )

protected

Show lucene settings form.

Parameters

Definition at line 411 of file class.ilObjSearchSettingsGUI.php.

References ilObjectGUI\$access, $GLOBALS, ILIAS\GlobalScreen\Provider\$if, ilSearchSettings\getInstance(), ilSearchSettings\getLuceneMimeFilterDefinitions(), ilCheckboxInputGUI\setChecked(), ilCheckboxInputGUI\setOptionTitle(), ilFormPropertyGUI\setRequired(), settings(), and ilCheckboxInputGUI\setValue().

Referenced by luceneSettingsObject(), and saveLuceneSettingsObject().

    {
        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        include_once './Services/Search/classes/class.ilSearchSettings.php';
        
        $this->settings = ilSearchSettings::getInstance();
        
        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this, 'cancel'));
        
        $this->form->setTitle($this->lng->txt('lucene_settings_title'));
        
        $access = $GLOBALS['DIC']->access();
        if ($access->checkAccess('write', '', $this->object->getRefId())) {
            $this->form->addCommandButton('saveLuceneSettings', $this->lng->txt('save'));
        }
        
        
        
        // Item filter
        $if = new ilCheckboxInputGUI($this->lng->txt('search_mime_filter_form'), 'mime_enabled');
        $if->setValue(1);
        $if->setChecked($this->settings->isLuceneMimeFilterEnabled());
        $if->setInfo($this->lng->txt('search_mime_filter_form_info'));
        $this->form->addItem($if);
        
        $mimes = $this->settings->getLuceneMimeFilter();
        foreach (ilSearchSettings::getLuceneMimeFilterDefinitions() as $mime => $def) {
            $ch = new ilCheckboxInputGUI($this->lng->txt($def['trans']), 'mime[' . $mime . ']');
            if (isset($mimes[$mime]) and $mimes[$mime]) {
                $ch->setChecked(true);
            }
            $ch->setValue(1);
            $if->addSubItem($ch);
        }
        
        $prefix = new ilCheckboxInputGUI($this->lng->txt('lucene_prefix_wildcard'), 'prefix');
        $prefix->setValue(1);
        $prefix->setInfo($this->lng->txt('lucene_prefix_wildcard_info'));
        $prefix->setChecked($this->settings->isPrefixWildcardQueryEnabled());
        $this->form->addItem($prefix);
        

        $numFrag = new ilNumberInputGUI($this->lng->txt('lucene_num_fragments'), 'fragmentCount');
        $numFrag->setRequired(true);
        $numFrag->setSize(2);
        $numFrag->setMaxLength(2);
        $numFrag->setMinValue(1);
        $numFrag->setMaxValue(10);
        $numFrag->setInfo($this->lng->txt('lucene_num_frag_info'));
        $numFrag->setValue($this->settings->getFragmentCount());
        $this->form->addItem($numFrag);
        
        $sizeFrag = new ilNumberInputGUI($this->lng->txt('lucene_size_fragments'), 'fragmentSize');
        $sizeFrag->setRequired(true);
        $sizeFrag->setSize(2);
        $sizeFrag->setMaxLength(4);
        $sizeFrag->setMinValue(10);
        $sizeFrag->setMaxValue(1000);
        $sizeFrag->setInfo($this->lng->txt('lucene_size_frag_info'));
        $sizeFrag->setValue($this->settings->getFragmentSize());
        $this->form->addItem($sizeFrag);
        
        $maxSub = new ilNumberInputGUI($this->lng->txt('lucene_max_sub'), 'maxSubitems');
        $maxSub->setRequired(true);
        $maxSub->setSize(2);
        $maxSub->setMaxLength(2);
        $maxSub->setMinValue(1);
        $maxSub->setMaxValue(10);
        $maxSub->setInfo($this->lng->txt('lucene_max_sub_info'));
        $maxSub->setValue($this->settings->getMaxSubitems());
        $this->form->addItem($maxSub);
        
        $relevance = new ilCheckboxInputGUI($this->lng->txt('lucene_relevance'), 'relevance');
        $relevance->setOptionTitle($this->lng->txt('lucene_show_relevance'));
        $relevance->setInfo($this->lng->txt('lucene_show_relevance_info'));
        $relevance->setValue(1);
        $relevance->setChecked($this->settings->isRelevanceVisible());
        $this->form->addItem($relevance);
        
        // begin-patch mime_filter
        $subrel = new ilCheckboxInputGUI('', 'subrelevance');
        $subrel->setOptionTitle($this->lng->txt('lucene_show_sub_relevance'));
        $subrel->setValue(1);
        $subrel->setChecked($this->settings->isSubRelevanceVisible());
        $relevance->addSubItem($subrel);
        // end-patch mime_filter
        
        $last_index = new ilDateTimeInputGUI($this->lng->txt('lucene_last_index_time'), 'last_index');
        $last_index->setRequired(true);
        $last_index->setShowTime(true);
        $last_index->setDate($this->settings->getLastIndexTime());
        $last_index->setInfo($this->lng->txt('lucene_last_index_time_info'));
        $this->form->addItem($last_index);
    
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initFormSettings()

ilObjSearchSettingsGUI::initFormSettings ( )

protected

Init settings form.

Returns

void

Definition at line 188 of file class.ilObjSearchSettingsGUI.php.

References ilObjectGUI\$access, $DIC, $GLOBALS, ILIAS\GlobalScreen\Provider\$if, $ilDB, $index, ilObjectGUI\$lng, ilObjectGUI\$settings, $si, $type, ilSearchSettings\getLuceneItemFilterDefinitions(), ilSearchSettings\INDEX_SEARCH, ilSearchSettings\LIKE_SEARCH, ilSearchSettings\LUCENE_SEARCH, ilSearchSettings\OPERATOR_AND, ilSearchSettings\OPERATOR_OR, ilCheckboxInputGUI\setChecked(), ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setRequired().

Referenced by settingsObject(), and updateSettingsObject().

    {
        global $DIC;

        $lng = $DIC['lng'];
        $ilDB = $DIC['ilDB'];

        $access = $GLOBALS['DIC']->access();
        
        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        include_once './Services/Search/classes/class.ilSearchSettings.php';
        
        $settings = new ilSearchSettings();
        
        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this, 'updateSettings'));
        
        if ($access->checkAccess('write', '', $this->object->getRefId())) {
            $this->form->addCommandButton('updateSettings', $this->lng->txt('save'));
        }
        $this->form->setTitle($this->lng->txt('seas_settings'));
        
        // Max hits
        $hits = new ilSelectInputGUI($this->lng->txt('seas_max_hits'), 'max_hits');
        $hits->setValue($settings->getMaxHits());
        $hits->setRequired(true);
        for ($value = 5; $value <= 50; $value += 5) {
            $values[$value] = $value;
        }
        $hits->setOptions($values);
        $hits->setInfo($this->lng->txt('seas_max_hits_info'));
        $this->form->addItem($hits);
        
        
        // Search type
        $type = new ilRadioGroupInputGUI($this->lng->txt('search_type'), 'search_type');
        
        if ($settings->enabledLucene()) {
            $type->setValue(ilSearchSettings::LUCENE_SEARCH);
        } elseif ($settings->enabledIndex()) {
            $type->setValue(ilSearchSettings::INDEX_SEARCH);
        } else {
            $type->setValue(ilSearchSettings::LIKE_SEARCH);
        }
        $type->setRequired(true);
        $this->form->addItem($type);

        // Default operator
        $operator = new ilRadioGroupInputGUI($this->lng->txt('lucene_default_operator'), 'operator');
        $operator->setRequired(true);
        $operator->setInfo($this->lng->txt('lucene_default_operator_info'));
        $operator->setValue($settings->getDefaultOperator());
        
        $and = new ilRadioOption($this->lng->txt('lucene_and'), ilSearchSettings::OPERATOR_AND);
        $operator->addOption($and);
        
        $or = new ilRadioOption($this->lng->txt('lucene_or'), ilSearchSettings::OPERATOR_OR);
        $operator->addOption($or);
        $this->form->addItem($operator);
        
        // user search
        $us = new ilCheckboxInputGUI($this->lng->txt('search_user_search_form'), 'user_search_enabled');
        $us->setInfo($this->lng->txt('search_user_search_info_form'));
        $us->setValue(1);
        $us->setChecked($settings->isLuceneUserSearchEnabled());
        $this->form->addItem($us);
        
        
        // Item filter
        $if = new ilCheckboxInputGUI($this->lng->txt('search_item_filter_form'), 'if');
        $if->setValue(1);
        $if->setChecked($settings->isLuceneItemFilterEnabled());
        $if->setInfo($this->lng->txt('search_item_filter_form_info'));
        $this->form->addItem($if);

        $filter = $settings->getLuceneItemFilter();
        foreach (ilSearchSettings::getLuceneItemFilterDefinitions() as $obj => $def) {
            $ch = new ilCheckboxInputGUI($this->lng->txt($def['trans']), 'filter[' . $obj . ']');
            if (isset($filter[$obj]) and $filter[$obj]) {
                $ch->setChecked(true);
            }
            $ch->setValue(1);
            $if->addSubItem($ch);
        }
        
        $cdate = new ilCheckboxInputGUI($this->lng->txt('search_cdate_filter'), 'cdate');
        $cdate->setInfo($this->lng->txt('search_cdate_filter_info'));
        $cdate->setChecked($settings->isDateFilterEnabled());
        $cdate->setValue(1);
        $this->form->addItem($cdate);
        
        // hide advanced search
        $cb = new ilCheckboxInputGUI($lng->txt("search_hide_adv_search"), "hide_adv_search");
        $cb->setChecked($settings->getHideAdvancedSearch());
        $this->form->addItem($cb);
        

        
        $direct = new ilRadioOption($this->lng->txt('search_direct'), ilSearchSettings::LIKE_SEARCH, $this->lng->txt('search_like_info'));
        $type->addOption($direct);
        
        if ($ilDB->supportsFulltext()) {
            $index = new ilRadioOption($this->lng->txt('search_index'), ilSearchSettings::INDEX_SEARCH, $this->lng->txt('search_full_info'));
            $type->addOption($index);
        }
        
        $lucene = new ilRadioOption($this->lng->txt('search_lucene'), ilSearchSettings::LUCENE_SEARCH, $this->lng->txt('java_server_info'));
        $type->addOption($lucene);

        
        // number of auto complete entries
        $options = array(
            5 => 5,
            10 => 10,
            20 => 20,
            30 => 30
            );
        $si = new ilSelectInputGUI($lng->txt("search_auto_complete_length"), "auto_complete_length");
        $si->setOptions($options);
        $val = ($settings->getAutoCompleteLength() > 0)
            ? $settings->getAutoCompleteLength()
            : 10;
        $si->setValue($val);
        $this->form->addItem($si);

        $inactive_user = new ilCheckboxInputGUI($this->lng->txt('search_show_inactive_user'), 'inactive_user');
        $inactive_user->setInfo($this->lng->txt('search_show_inactive_user_info'));
        $inactive_user->setChecked($settings->isInactiveUserVisible());
        $this->form->addItem($inactive_user);

        $limited_user = new ilCheckboxInputGUI($this->lng->txt('search_show_limited_user'), 'limited_user');
        $limited_user->setInfo($this->lng->txt('search_show_limited_user_info'));
        $limited_user->setChecked($settings->isLimitedUserVisible());
        $this->form->addItem($limited_user);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initSubTabs()

ilObjSearchSettingsGUI::initSubTabs (   $a_section )

protected

Definition at line 623 of file class.ilObjSearchSettingsGUI.php.

Referenced by advancedLuceneSettingsObject(), and luceneSettingsObject().

    {
        switch ($a_section) {
            case 'lucene':
                $this->tabs_gui->addSubTabTarget(
                    'lucene_general_settings',
                    $this->ctrl->getLinkTarget($this, 'luceneSettings')
                );

                break;
        }
    }

Here is the caller graph for this function:

luceneSettingsObject()

ilObjSearchSettingsGUI::luceneSettingsObject ( ilPropertyFormGUI  $form = null )

protected

Lucene settings.

Parameters

Definition at line 395 of file class.ilObjSearchSettingsGUI.php.

References initFormLuceneSettings(), and initSubTabs().

Referenced by saveLuceneSettingsObject().

    {
        $this->initSubTabs('lucene');
        $this->tabs_gui->setTabActive('lucene_settings_tab');
        
        if (!$form instanceof ilPropertyFormGUI) {
            $this->initFormLuceneSettings();
        }
        $this->tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

refreshLuceneSettings()

ilObjSearchSettingsGUI::refreshLuceneSettings ( )

protected

Refresh lucene server settings.

Exceptions

Exception

Definition at line 561 of file class.ilObjSearchSettingsGUI.php.

References $DIC, $ilSetting, ilRpcClientFactory\factory(), ilSearchSettings\getInstance(), and ilLoggerFactory\getLogger().

Referenced by saveLuceneSettingsObject(), and updateSettingsObject().

    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        
        if (!ilSearchSettings::getInstance()->enabledLucene()) {
            return true;
        }
        
        try {
            include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
            ilRpcClientFactory::factory('RPCAdministration')->refreshSettings(CLIENT_ID . '_' . $ilSetting->get('inst_id', 0));
        } catch (Exception $exception) {
            ilLoggerFactory::getLogger('src')->error('Refresh of lucene server settings failed with message: ' . $exception->getMessage());
            throw $exception;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveAdvancedLuceneSettingsObject()

ilObjSearchSettingsGUI::saveAdvancedLuceneSettingsObject ( )

protected

Save advanced settings.

Definition at line 601 of file class.ilObjSearchSettingsGUI.php.

References $_POST, ilObjectGUI\$access, $GLOBALS, ilObjectGUI\$settings, advancedLuceneSettingsObject(), ilLuceneAdvancedSearchFields\getFields(), ilLuceneAdvancedSearchSettings\getInstance(), ilUtil\sendFailure(), and ilUtil\sendInfo().

    {
        $access = $GLOBALS['DIC']->access();
        
        if (!$access->checkAccess('write', '', $this->object->getRefId())) {
            ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
            $GLOBALS['DIC']->ctrl()->redirect($this, 'settings');
        }
        
        
        $settings = ilLuceneAdvancedSearchSettings::getInstance();
        foreach (ilLuceneAdvancedSearchFields::getFields() as $field => $translation) {
            $settings->setActive($field, in_array($field, (array) $_POST['fid']) ? true : false);
        }
        $settings->save();
        ilUtil::sendInfo($this->lng->txt('settings_saved'));
        $this->advancedLuceneSettingsObject();
    }

Here is the call graph for this function:

saveLuceneSettingsObject()

ilObjSearchSettingsGUI::saveLuceneSettingsObject ( )

protected

Save Lucene settings.

Returns

Definition at line 513 of file class.ilObjSearchSettingsGUI.php.

References $_POST, $DIC, $ilBench, $ilLog, $ilSetting, ilObjectGUI\$settings, ilSearchSettings\getInstance(), initFormLuceneSettings(), luceneSettingsObject(), refreshLuceneSettings(), ilUtil\sendFailure(), and ilUtil\sendInfo().

    {
        global $DIC;

        $ilBench = $DIC['ilBench'];
        $ilLog = $DIC['ilLog'];
        $ilSetting = $DIC['ilSetting'];
        
        $this->initFormLuceneSettings();
        
        $settings = ilSearchSettings::getInstance();
        $settings->setFragmentCount((int) $_POST['fragmentCount']);
        $settings->setFragmentSize((int) $_POST['fragmentSize']);
        $settings->setMaxSubitems((int) $_POST['maxSubitems']);
        $settings->showRelevance((int) $_POST['relevance']);
        $settings->enableLuceneOfflineFilter((int) $_POST['offline_filter']);
        $settings->enableLuceneMimeFilter((int) $_POST['mime_enabled']);
        $settings->setLuceneMimeFilter((array) $_POST['mime']);
        $settings->showSubRelevance((int) $_POST['subrelevance']);
        $settings->enablePrefixWildcardQuery((int) $_POST['prefix']);
        
        if ($this->form->checkInput()) {
            $settings->setLastIndexTime($this->form->getItemByPostVar('last_index')->getDate());
            $settings->update();
            
            // refresh lucene server
            try {
                $this->refreshLuceneSettings();
                ilUtil::sendInfo($this->lng->txt('settings_saved'));
                $this->luceneSettingsObject();
                return true;
            } catch (Exception $exception) {
                ilUtil::sendFailure($exception->getMessage());
                $this->luceneSettingsObject();
                return false;
            }
        }
        
        ilUtil::sendInfo($this->lng->txt('err_check_input'));
        $this->form->setValuesByPost();
        $this->luceneSettingsObject($this->form);
        return false;
    }

Here is the call graph for this function:

saveSettingsObject()

ilObjSearchSettingsGUI::saveSettingsObject

(

)

Save settings public.

Definition at line 94 of file class.ilObjSearchSettingsGUI.php.

References $_POST, $DIC, ilObjectGUI\$rbacsystem, ilRPCServerSettings\getInstance(), and ilUtil\sendInfo().

    {
        include_once 'Services/WebServices/RPC/classes/class.ilRPCServerSettings.php';

        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];

        if (!$rbacsystem->checkAccess('write', $this->object->getRefId())) {
            $this->ilias->raiseError($this->lng->txt("permission_denied"), $this->ilias->error_obj->MESSAGE);
        }

        $this->object->initSettingsObject();
        $this->object->settings_obj->setMaxHits((int) $_POST['max_hits']);
        $this->object->settings_obj->enableIndex($_POST['search_index']);
        $this->object->settings_obj->enableLucene($_POST['search_lucene']);
        $this->object->settings_obj->setHideAdvancedSearch($_POST['hide_adv_search']);
        $this->object->settings_obj->setAutoCompleteLength($_POST['auto_complete_length']);
        $this->object->settings_obj->setDefaultOperator((int) $_POST['operator']);
        $this->object->settings_obj->enableLuceneItemFilter((int) $_POST['if']);
        $this->object->settings_obj->setLuceneItemFilter((array) $_POST['filter']);
        

        $rpc_settings = ilRPCServerSettings::getInstance();
        if ($this->object->settings_obj->enabledLucene() and !$rpc_settings->pingServer()) {
            ilUtil::sendInfo($this->lng->txt('search_no_connection_lucene'), true);
            $this->ctrl->redirect($this, 'settings');

            return false;
        }

        $this->object->settings_obj->update();

        ilUtil::sendInfo($this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'settings');

        return true;
    }

Here is the call graph for this function:

settingsObject()

ilObjSearchSettingsGUI::settingsObject

(

)

Show settings public.

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

References initFormSettings().

Referenced by updateSettingsObject().

    {
        if (!$this->dic->rbac()->system()->checkAccess("visible,read", $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
        $this->tabs_gui->setTabActive('settings');
        $this->initFormSettings();
        $this->tpl->setContent($this->form->getHTML());
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateSettingsObject()

ilObjSearchSettingsGUI::updateSettingsObject ( )

protected

Update Settings.

Returns

void

Definition at line 329 of file class.ilObjSearchSettingsGUI.php.

References $_POST, $_SESSION, $DIC, $GLOBALS, ilObjectGUI\$settings, ilSearchSettings\getInstance(), ilSearchSettings\INDEX_SEARCH, initFormSettings(), ilSearchSettings\LIKE_SEARCH, ilSearchSettings\LUCENE_SEARCH, refreshLuceneSettings(), ilUtil\sendFailure(), ilUtil\sendInfo(), and settingsObject().

    {
        global $DIC;

        $ilAccess = $DIC['ilAccess'];
        
        $this->initFormSettings();
        $this->form->checkInput();
        
        if (!$ilAccess->checkAccess('write', '', $this->object->getRefId())) {
            ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
            $GLOBALS['DIC']->ctrl()->redirect($this, 'settings');
        }
        
        include_once './Services/Search/classes/class.ilSearchSettings.php';
        $settings = ilSearchSettings::getInstance();
        $settings->setMaxHits((int) $_POST['max_hits']);
        
        switch ((int) $_POST['search_type']) {
            case ilSearchSettings::LIKE_SEARCH:
                $settings->enableIndex(false);
                $settings->enableLucene(false);
                break;
            case ilSearchSettings::INDEX_SEARCH:
                $settings->enableIndex(true);
                $settings->enableLucene(false);
                break;
            case ilSearchSettings::LUCENE_SEARCH:
                $settings->enableIndex(false);
                $settings->enableLucene(true);
                break;
        }

        $settings->setDefaultOperator((int) $_POST['operator']);
        $settings->enableLuceneItemFilter((int) $_POST['if']);
        $settings->setLuceneItemFilter((array) $_POST['filter']);

        $settings->setHideAdvancedSearch($_POST['hide_adv_search']);
        $settings->setAutoCompleteLength($_POST['auto_complete_length']);
        $settings->showInactiveUser($_POST["inactive_user"]);
        $settings->showLimitedUser($_POST["limited_user"]);
        $settings->enableDateFilter($_POST['cdate']);
        $settings->enableLuceneUserSearch((int) $_POST['user_search_enabled']);
        $settings->update();
        
        
        // refresh lucene server
        try {
            $this->refreshLuceneSettings();
            ilUtil::sendInfo($this->lng->txt('settings_saved'));
            $this->settingsObject();
            return true;
        } catch (Exception $exception) {
            ilUtil::sendFailure($exception->getMessage());
            $this->settingsObject();
            return false;
        }
        
        unset($_SESSION['search_last_class']);
    }

Here is the call graph for this function:

Field Documentation

$dic

ilObjSearchSettingsGUI::$dic

protected

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

$error

ilObjSearchSettingsGUI::$error

protected

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

---

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

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