Collaboration diagram for ilSearchSettings:

Public Member Functions
	__construct ()

	getEnabledLuceneItemFilterDefinitions ()
	Get lucene item filter definitions. More...

	getEnabledLuceneMimeFilterDefinitions ()

	enablePrefixWildcardQuery ($a_stat)

	isPrefixWildcardQueryEnabled ()

	enabledIndex ()

	enableIndex ($a_status)

	enabledLucene ()

	enableLucene ($a_status)

	getMaxHits ()

	setMaxHits ($a_max_hits)

	getDefaultOperator ()

	setDefaultOperator ($a_op)

	setFragmentSize ($a_size)

	getFragmentSize ()

	setFragmentCount ($a_count)

	getHideAdvancedSearch ()

	setHideAdvancedSearch ($a_status)

	getAutoCompleteLength ()

	setAutoCompleteLength ($auto_complete_length)

	getFragmentCount ()

	setMaxSubitems ($a_max)

	getMaxSubitems ()

	isRelevanceVisible ()

	showRelevance ($a_status)

	getLastIndexTime ()

	enableLuceneItemFilter ($a_status)

	isLuceneItemFilterEnabled ()

	getLuceneItemFilter ()

	setLuceneItemFilter ($a_filter)

	enableLuceneOfflineFilter ($a_stat)

	isLuceneOfflineFilterEnabled ()

	showSubRelevance ($a_stat)

	isSubRelevanceVisible ()

	setLuceneMimeFilter ($a_filter)

	getLuceneMimeFilter ()

	isLuceneMimeFilterEnabled ()
	Check if lucene mime filter is enabled. More...

	enableLuceneMimeFilter ($a_stat)
	Enable lucene mime filter. More...

	setLastIndexTime ($time)

	isLuceneUserSearchEnabled ()
	Check if user search is enabled. More...

	enableLuceneUserSearch ($a_status)
	Enable lucene user search. More...

	showInactiveUser ($a_visible)
	show inactive user in user search More...

	isInactiveUserVisible ()
	are inactive user visible in user search More...

	showLimitedUser ($a_visible)
	show user with limited access in user search More...

	isLimitedUserVisible ()
	are user with limited access visible in user search More...

	isDateFilterEnabled ()

	enableDateFilter ($a_filter)

	update ()

	__read ()

Static Public Member Functions
static	getInstance ()

static	getLuceneItemFilterDefinitions ()
	Get lucene item filter definitions. More...

static	getLuceneMimeFilterDefinitions ()

static	_getSearchSettingRefId ()
	Read the ref_id of Search Settings object. More...

Data Fields
const	LIKE_SEARCH = 0

const	INDEX_SEARCH = 1

const	LUCENE_SEARCH = 2

const	OPERATOR_AND = 1

const	OPERATOR_OR = 2

	$ilias = null

	$max_hits = null

	$index = null

Protected Attributes
	$default_operator = self::OPERATOR_AND

	$fragmentSize = 30

	$fragmentCount = 3

	$numSubitems = 5

	$showRelevance = true

	$last_index_date = null

	$lucene_item_filter_enabled = false

	$lucene_item_filter = array()

	$lucene_offline_filter = true

	$auto_complete_length = 10

	$show_inactiv_user = true

	$show_limited_user = true

	$lucene_mime_filter_enabled = false

	$lucene_mime_filter = array()

	$showSubRelevance = false

	$prefix_wildcard = false

	$user_search = false

	$date_filter = false

Static Protected Attributes
static	$instance = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilSearchSettings::__construct ( )

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

    {
        global $ilias;
 
        $this->ilias = $ilias;
        $this->__read();
    }

References $ilias, and __read().

Here is the call graph for this function:

Member Function Documentation

◆ __read()

ilSearchSettings::__read ( )

Definition at line 466 of file class.ilSearchSettings.php.

    {
        global $ilSetting;
        
        $this->setMaxHits($this->ilias->getSetting('search_max_hits', 10));
        $this->enableIndex($this->ilias->getSetting('search_index', 0));
        $this->enableLucene($this->ilias->getSetting('search_lucene', 0));
        
        $this->setDefaultOperator($this->ilias->getSetting('lucene_default_operator', self::OPERATOR_AND));
        $this->setFragmentSize($this->ilias->getSetting('lucene_fragment_size', 50));
        $this->setFragmentCount($this->ilias->getSetting('lucene_fragment_count', 3));
        $this->setMaxSubitems($this->ilias->getSetting('lucene_max_subitems', 5));
        $this->showRelevance($this->ilias->getSetting('lucene_show_relevance', true));
 
        if ($time = $this->ilias->getSetting('lucene_last_index_time', false)) {
            $this->setLastIndexTime(new ilDateTime($time, IL_CAL_UNIX));
        } else {
            $this->setLastIndexTime(null);
        }
        
        $this->setHideAdvancedSearch($this->ilias->getSetting('hide_adv_search', 0));
        $this->setAutoCompleteLength($this->ilias->getSetting('auto_complete_length', $this->getAutoCompleteLength()));
        
        $this->enableLuceneItemFilter($this->ilias->getSetting('lucene_item_filter_enabled', (int) $this->isLuceneItemFilterEnabled()));
        
        $filter = $this->ilias->getSetting('lucene_item_filter', serialize($this->getLuceneItemFilter()));
        $this->setLuceneItemFilter(unserialize($filter));
        $this->enableLuceneOfflineFilter($this->ilias->getSetting('lucene_offline_filter'), $this->isLuceneOfflineFilterEnabled());
        
        $this->enableLuceneMimeFilter($ilSetting->get('lucene_mime_filter_enabled', $this->lucene_item_filter_enabled));
        $filter = $this->ilias->getSetting('lucene_mime_filter', serialize($this->getLuceneMimeFilter()));
        $this->setLuceneMimeFilter(unserialize($filter));
        $this->showSubRelevance($this->ilias->getSetting('lucene_sub_relevance', $this->showSubRelevance));
        $this->enablePrefixWildcardQuery($this->ilias->getSetting('lucene_prefix_wildcard', $this->prefix_wildcard));
        $this->enableLuceneUserSearch($ilSetting->get('lucene_user_search', $this->user_search));
 
        $this->showInactiveUser($ilSetting->get('search_show_inactiv_user', $this->show_inactiv_user));
        $this->showLimitedUser($ilSetting->get('search_show_limited_user', $this->show_limited_user));
        
        $this->enableDateFilter($ilSetting->get('search_date_filter', $this->date_filter));
    }

References $ilSetting, $time, enableDateFilter(), enableIndex(), enableLucene(), enableLuceneItemFilter(), enableLuceneMimeFilter(), enableLuceneOfflineFilter(), enableLuceneUserSearch(), enablePrefixWildcardQuery(), getLuceneItemFilter(), getLuceneMimeFilter(), IL_CAL_UNIX, setAutoCompleteLength(), setDefaultOperator(), setFragmentCount(), setFragmentSize(), setHideAdvancedSearch(), setLastIndexTime(), setLuceneItemFilter(), setLuceneMimeFilter(), setMaxHits(), setMaxSubitems(), showInactiveUser(), showLimitedUser(), showRelevance(), and showSubRelevance().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getSearchSettingRefId()

static ilSearchSettings::_getSearchSettingRefId ( )

static

Read the ref_id of Search Settings object.

normally used for rbacsystem->checkAccess()

Returns: int ref_id @access public

Definition at line 161 of file class.ilSearchSettings.php.

    {
        global $ilDB;
 
        static $seas_ref_id = 0;
 
        if ($seas_ref_id) {
            return $seas_ref_id;
        }
        $query = "SELECT object_reference.ref_id as ref_id FROM object_reference,tree,object_data " .
            "WHERE tree.parent = " . $ilDB->quote(SYSTEM_FOLDER_ID, 'integer') . " " .
            "AND object_data.type = 'seas' " .
            "AND object_reference.ref_id = tree.child " .
            "AND object_reference.obj_id = object_data.obj_id";
            
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        
        return $seas_ref_id = $row->ref_id;
    }

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilSearchController\executeCommand(), and ilMainMenuGUI\setTemplateVars().

Here is the caller graph for this function:

◆ enableDateFilter()

ilSearchSettings::enableDateFilter ( $a_filter )

Definition at line 428 of file class.ilSearchSettings.php.

    {
        $this->date_filter = $a_filter;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ enabledIndex()

ilSearchSettings::enabledIndex ( )

Definition at line 182 of file class.ilSearchSettings.php.

    {
        global $ilDB;
        
        if ($ilDB->getDBType() == 'oracle') {
            return false;
        }
        return $this->index ? true : false;
    }

References $ilDB.

Referenced by update().

Here is the caller graph for this function:

◆ enabledLucene()

ilSearchSettings::enabledLucene ( )

Definition at line 195 of file class.ilSearchSettings.php.

    {
        return $this->lucene ? true : false;
    }

Referenced by update().

Here is the caller graph for this function:

◆ enableIndex()

ilSearchSettings::enableIndex ( $a_status )

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

    {
        $this->index = $a_status;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ enableLucene()

ilSearchSettings::enableLucene ( $a_status )

Definition at line 199 of file class.ilSearchSettings.php.

    {
        $this->lucene = $a_status ? true : false;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ enableLuceneItemFilter()

ilSearchSettings::enableLuceneItemFilter ( $a_status )

Definition at line 287 of file class.ilSearchSettings.php.

    {
        $this->lucene_item_filter_enabled = $a_status;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ enableLuceneMimeFilter()

ilSearchSettings::enableLuceneMimeFilter ( $a_stat )

Enable lucene mime filter.

Parameters

type $a_stat

Definition at line 351 of file class.ilSearchSettings.php.

    {
        $this->lucene_mime_filter_enabled = $a_stat;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ enableLuceneOfflineFilter()

ilSearchSettings::enableLuceneOfflineFilter ( $a_stat )

Definition at line 308 of file class.ilSearchSettings.php.

    {
        $this->lucene_offline_filter = $a_stat;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ enableLuceneUserSearch()

ilSearchSettings::enableLuceneUserSearch ( $a_status )

Enable lucene user search.

Parameters

type $a_status

Definition at line 378 of file class.ilSearchSettings.php.

    {
        $this->user_search = $a_status;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ enablePrefixWildcardQuery()

ilSearchSettings::enablePrefixWildcardQuery ( $a_stat )

Definition at line 144 of file class.ilSearchSettings.php.

    {
        $this->prefix_wildcard = $a_stat;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ getAutoCompleteLength()

ilSearchSettings::getAutoCompleteLength ( )

Definition at line 246 of file class.ilSearchSettings.php.

    {
        return $this->auto_complete_length;
    }

References $auto_complete_length.

Referenced by update().

Here is the caller graph for this function:

◆ getDefaultOperator()

ilSearchSettings::getDefaultOperator ( )

Definition at line 213 of file class.ilSearchSettings.php.

    {
        return $this->default_operator;
    }

References $default_operator.

Referenced by update().

Here is the caller graph for this function:

◆ getEnabledLuceneItemFilterDefinitions()

ilSearchSettings::getEnabledLuceneItemFilterDefinitions ( )

Get lucene item filter definitions.

Returns

Todo:: This has to be defined in module.xml

Definition at line 111 of file class.ilSearchSettings.php.

    {
        if (!$this->isLuceneItemFilterEnabled()) {
            return array();
        }
        
        $filter = $this->getLuceneItemFilter();
        $enabled = array();
        foreach (self::getLuceneItemFilterDefinitions() as $obj => $def) {
            if (isset($filter[$obj]) and $filter[$obj]) {
                $enabled[$obj] = $def;
            }
        }
        return $enabled;
    }

References $def, getLuceneItemFilter(), and isLuceneItemFilterEnabled().

Here is the call graph for this function:

◆ getEnabledLuceneMimeFilterDefinitions()

ilSearchSettings::getEnabledLuceneMimeFilterDefinitions ( )

Definition at line 128 of file class.ilSearchSettings.php.

    {
        if (!$this->isLuceneItemFilterEnabled()) {
            return array();
        }
        
        $filter = $this->getLuceneMimeFilter();
        $enabled = array();
        foreach (self::getLuceneMimeFilterDefinitions() as $mime => $def) {
            if (isset($filter[$mime]) and $filter[$mime]) {
                $enabled[$mime] = $def;
            }
        }
        return $enabled;
    }

References $def, getLuceneMimeFilter(), and isLuceneItemFilterEnabled().

Here is the call graph for this function:

◆ getFragmentCount()

ilSearchSettings::getFragmentCount ( )

Definition at line 255 of file class.ilSearchSettings.php.

    {
        return $this->fragmentCount;
    }

References $fragmentCount.

Referenced by update().

Here is the caller graph for this function:

◆ getFragmentSize()

ilSearchSettings::getFragmentSize ( )

Definition at line 228 of file class.ilSearchSettings.php.

    {
        return $this->fragmentSize;
    }

References $fragmentSize.

Referenced by update().

Here is the caller graph for this function:

◆ getHideAdvancedSearch()

ilSearchSettings::getHideAdvancedSearch ( )

Definition at line 238 of file class.ilSearchSettings.php.

    {
        return $this->hide_adv_search ? true : false;
    }

Referenced by update().

Here is the caller graph for this function:

◆ getInstance()

static ilSearchSettings::getInstance ( )

static

Returns: ilSearchSettings

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

    {
        if (self::$instance == null) {
            return self::$instance = new ilSearchSettings();
        }
        return self::$instance;
    }

References $instance.

Here is the caller graph for this function:

◆ getLastIndexTime()

ilSearchSettings::getLastIndexTime ( )

Definition at line 280 of file class.ilSearchSettings.php.

    {
        return $this->last_index_date instanceof ilDateTime  ?
            $this->last_index_date :
            new ilDateTime('2009-01-01 12:00:00', IL_CAL_DATETIME);
    }

References IL_CAL_DATETIME.

Referenced by update().

Here is the caller graph for this function:

◆ getLuceneItemFilter()

ilSearchSettings::getLuceneItemFilter ( )

Definition at line 297 of file class.ilSearchSettings.php.

    {
        return $this->lucene_item_filter;
    }

References $lucene_item_filter.

Referenced by __read(), getEnabledLuceneItemFilterDefinitions(), and update().

Here is the caller graph for this function:

◆ getLuceneItemFilterDefinitions()

static ilSearchSettings::getLuceneItemFilterDefinitions ( )

static

Get lucene item filter definitions.

Returns

Todo:: This has to be defined in module.xml

Definition at line 78 of file class.ilSearchSettings.php.

    {
        return array(
            'crs' => array('filter' => 'type:crs','trans' => 'objs_crs'),
            'grp' => array('filter' => 'type:grp', 'trans' => 'objs_grp'),
            'lms' => array('filter' => 'type:lm OR type:htlm OR type:sahs OR type:dbk','trans' => 'learning_resource'),
            'glo' => array('filter' => 'type:glo','trans' => 'objs_glo'),
            'mep' => array('filter' => 'type:mep', 'trans' => 'objs_mep'),
            'tst' => array('filter' => 'type:tst OR type:svy OR type:qpl OR type:spl','trans' => 'search_tst_svy'),
            'frm' => array('filter' => 'type:frm','trans' => 'objs_frm'),
            'exc' => array('filter' => 'type:exc','trans' => 'objs_exc'),
            'file' => array('filter' => 'type:file','trans' => 'objs_file'),
            'mcst' => array('filter' => 'type:mcst','trans' => 'objs_mcst'),
            'wiki' => array('filter' => 'type:wiki','trans' => 'objs_wiki')
        );
    }

Referenced by ilObjSearchSettingsGUI\initFormSettings().

Here is the caller graph for this function:

◆ getLuceneMimeFilter()

ilSearchSettings::getLuceneMimeFilter ( )

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

    {
        return $this->lucene_mime_filter;
    }

References $lucene_mime_filter.

Referenced by __read(), getEnabledLuceneMimeFilterDefinitions(), and update().

Here is the caller graph for this function:

◆ getLuceneMimeFilterDefinitions()

static ilSearchSettings::getLuceneMimeFilterDefinitions ( )

static

Definition at line 95 of file class.ilSearchSettings.php.

    {
        return array(
            'pdf' => array('filter' => 'mimeType:pdf','trans' => 'search_mime_pdf'),
            'word' => array('filter' => 'mimeType:word','trans' => 'search_mime_word'),
            'excel' => array('filter' => 'mimeType:excel','trans' => 'search_mime_excel'),
            'powerpoint' => array('filter' => 'mimeType:powerpoint','trans' => 'search_mime_powerpoint'),
            'image' => array('filter' => 'mimeType:image','trans' => 'search_mime_image')
        );
    }

Referenced by ilObjSearchSettingsGUI\initFormLuceneSettings().

Here is the caller graph for this function:

◆ getMaxHits()

ilSearchSettings::getMaxHits ( )

Definition at line 204 of file class.ilSearchSettings.php.

    {
        return $this->max_hits;
    }

References $max_hits.

Referenced by update().

Here is the caller graph for this function:

◆ getMaxSubitems()

ilSearchSettings::getMaxSubitems ( )

Definition at line 265 of file class.ilSearchSettings.php.

    {
        return $this->numSubitems;
    }

References $numSubitems.

Referenced by update().

Here is the caller graph for this function:

◆ isDateFilterEnabled()

ilSearchSettings::isDateFilterEnabled ( )

Definition at line 423 of file class.ilSearchSettings.php.

    {
        return $this->date_filter;
    }

References $date_filter.

Referenced by update().

Here is the caller graph for this function:

◆ isInactiveUserVisible()

ilSearchSettings::isInactiveUserVisible ( )

are inactive user visible in user search

Returns: bool

Definition at line 398 of file class.ilSearchSettings.php.

    {
        return $this->show_inactiv_user;
    }

References $show_inactiv_user.

Referenced by update().

Here is the caller graph for this function:

◆ isLimitedUserVisible()

ilSearchSettings::isLimitedUserVisible ( )

are user with limited access visible in user search

Returns: bool

Definition at line 418 of file class.ilSearchSettings.php.

    {
        return $this->show_limited_user;
    }

References $show_limited_user.

Referenced by update().

Here is the caller graph for this function:

◆ isLuceneItemFilterEnabled()

ilSearchSettings::isLuceneItemFilterEnabled ( )

Definition at line 292 of file class.ilSearchSettings.php.

    {
        return $this->lucene_item_filter_enabled;
    }

References $lucene_item_filter_enabled.

Referenced by getEnabledLuceneItemFilterDefinitions(), getEnabledLuceneMimeFilterDefinitions(), and update().

Here is the caller graph for this function:

◆ isLuceneMimeFilterEnabled()

ilSearchSettings::isLuceneMimeFilterEnabled ( )

Check if lucene mime filter is enabled.

Definition at line 342 of file class.ilSearchSettings.php.

    {
        return $this->lucene_mime_filter_enabled;
    }

References $lucene_mime_filter_enabled.

Referenced by update().

Here is the caller graph for this function:

◆ isLuceneOfflineFilterEnabled()

ilSearchSettings::isLuceneOfflineFilterEnabled ( )

Definition at line 313 of file class.ilSearchSettings.php.

    {
        return $this->lucene_offline_filter;
    }

References $lucene_offline_filter.

Referenced by update().

Here is the caller graph for this function:

◆ isLuceneUserSearchEnabled()

ilSearchSettings::isLuceneUserSearchEnabled ( )

Check if user search is enabled.

Returns: type

Definition at line 369 of file class.ilSearchSettings.php.

    {
        return $this->user_search;
    }

References $user_search.

Referenced by update().

Here is the caller graph for this function:

◆ isPrefixWildcardQueryEnabled()

ilSearchSettings::isPrefixWildcardQueryEnabled ( )

Definition at line 149 of file class.ilSearchSettings.php.

    {
        return $this->prefix_wildcard;
    }

References $prefix_wildcard.

Referenced by update().

Here is the caller graph for this function:

◆ isRelevanceVisible()

ilSearchSettings::isRelevanceVisible ( )

Definition at line 270 of file class.ilSearchSettings.php.

    {
        return $this->showRelevance;
    }

References $showRelevance.

Referenced by update().

Here is the caller graph for this function:

◆ isSubRelevanceVisible()

ilSearchSettings::isSubRelevanceVisible ( )

Definition at line 323 of file class.ilSearchSettings.php.

    {
        return $this->showSubRelevance;
    }

References $showSubRelevance.

Referenced by update().

Here is the caller graph for this function:

◆ setAutoCompleteLength()

ilSearchSettings::setAutoCompleteLength ( $auto_complete_length )

Definition at line 250 of file class.ilSearchSettings.php.

    {
        $this->auto_complete_length = $auto_complete_length;
    }

References $auto_complete_length.

Referenced by __read().

Here is the caller graph for this function:

◆ setDefaultOperator()

ilSearchSettings::setDefaultOperator ( $a_op )

Definition at line 218 of file class.ilSearchSettings.php.

    {
        $this->default_operator = $a_op;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ setFragmentCount()

ilSearchSettings::setFragmentCount ( $a_count )

Definition at line 233 of file class.ilSearchSettings.php.

    {
        $this->fragmentCount = $a_count;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ setFragmentSize()

ilSearchSettings::setFragmentSize ( $a_size )

Definition at line 223 of file class.ilSearchSettings.php.

    {
        $this->fragmentSize = $a_size;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ setHideAdvancedSearch()

ilSearchSettings::setHideAdvancedSearch ( $a_status )

Definition at line 242 of file class.ilSearchSettings.php.

    {
        $this->hide_adv_search = $a_status;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ setLastIndexTime()

ilSearchSettings::setLastIndexTime ( $time )

Parameters

object instance of ilDateTime

Definition at line 360 of file class.ilSearchSettings.php.

    {
        $this->last_index_date = $time;
    }

References $time.

Referenced by __read().

Here is the caller graph for this function:

◆ setLuceneItemFilter()

ilSearchSettings::setLuceneItemFilter ( $a_filter )

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

    {
        $this->lucene_item_filter = $a_filter;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ setLuceneMimeFilter()

ilSearchSettings::setLuceneMimeFilter ( $a_filter )

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

    {
        $this->lucene_mime_filter = $a_filter;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ setMaxHits()

ilSearchSettings::setMaxHits ( $a_max_hits )

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

    {
        $this->max_hits = $a_max_hits;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ setMaxSubitems()

ilSearchSettings::setMaxSubitems ( $a_max )

Definition at line 260 of file class.ilSearchSettings.php.

    {
        $this->numSubitems = $a_max;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ showInactiveUser()

ilSearchSettings::showInactiveUser ( $a_visible )

show inactive user in user search

Parameters

bool $a_visible

Definition at line 388 of file class.ilSearchSettings.php.

    {
        $this->show_inactiv_user = (bool) $a_visible;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ showLimitedUser()

ilSearchSettings::showLimitedUser ( $a_visible )

show user with limited access in user search

Parameters

bool $a_visible

Definition at line 408 of file class.ilSearchSettings.php.

    {
        $this->show_limited_user = (bool) $a_visible;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ showRelevance()

ilSearchSettings::showRelevance ( $a_status )

Definition at line 275 of file class.ilSearchSettings.php.

    {
        $this->showRelevance = (bool) $a_status;
    }

References showRelevance().

Referenced by __read(), and showRelevance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSubRelevance()

ilSearchSettings::showSubRelevance ( $a_stat )

Definition at line 318 of file class.ilSearchSettings.php.

    {
        $this->showSubRelevance = $a_stat;
    }

References showSubRelevance().

Referenced by __read(), and showSubRelevance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilSearchSettings::update ( )

Definition at line 433 of file class.ilSearchSettings.php.

    {
        global $ilSetting;
 
        $this->ilias->setSetting('search_max_hits', $this->getMaxHits());
        $this->ilias->setSetting('search_index', (int) $this->enabledIndex());
        $this->ilias->setSetting('search_lucene', (int) $this->enabledLucene());
        
        $this->ilias->setSetting('lucene_default_operator', $this->getDefaultOperator());
        $this->ilias->setSetting('lucene_fragment_size', $this->getFragmentSize());
        $this->ilias->setSetting('lucene_fragment_count', $this->getFragmentCount());
        $this->ilias->setSetting('lucene_max_subitems', $this->getMaxSubitems());
        $this->ilias->setSetting('lucene_show_relevance', $this->isRelevanceVisible());
        $this->ilias->setSetting('lucene_last_index_time', $this->getLastIndexTime()->get(IL_CAL_UNIX));
        $this->ilias->setSetting('hide_adv_search', (int) $this->getHideAdvancedSearch());
        $this->ilias->setSetting('auto_complete_length', (int) $this->getAutoCompleteLength());
        $this->ilias->setSetting('lucene_item_filter_enabled', (int) $this->isLuceneItemFilterEnabled());
        $this->ilias->setSetting('lucene_item_filter', serialize($this->getLuceneItemFilter()));
        $this->ilias->setSetting('lucene_offline_filter', (int) $this->isLuceneOfflineFilterEnabled());
        $this->ilias->setSetting('lucene_mime_filter', serialize($this->getLuceneMimeFilter()));
        $this->ilias->setSetting('lucene_sub_relevance', $this->isSubRelevanceVisible());
        $ilSetting->set('lucene_mime_filter_enabled', $this->isLuceneMimeFilterEnabled());
        $this->ilias->setSetting('lucene_prefix_wildcard', $this->isPrefixWildcardQueryEnabled());
        $ilSetting->set('lucene_user_search', $this->isLuceneUserSearchEnabled());
        $ilSetting->set('search_show_inactiv_user', $this->isInactiveUserVisible());
        $ilSetting->set('search_show_limited_user', $this->isLimitedUserVisible());
        
        $ilSetting->set('search_date_filter', $this->isDateFilterEnabled());
 
        return true;
    }

References $ilSetting, enabledIndex(), enabledLucene(), getAutoCompleteLength(), getDefaultOperator(), getFragmentCount(), getFragmentSize(), getHideAdvancedSearch(), getLastIndexTime(), getLuceneItemFilter(), getLuceneMimeFilter(), getMaxHits(), getMaxSubitems(), IL_CAL_UNIX, isDateFilterEnabled(), isInactiveUserVisible(), isLimitedUserVisible(), isLuceneItemFilterEnabled(), isLuceneMimeFilterEnabled(), isLuceneOfflineFilterEnabled(), isLuceneUserSearchEnabled(), isPrefixWildcardQueryEnabled(), isRelevanceVisible(), and isSubRelevanceVisible().

Here is the call graph for this function:

Field Documentation

◆ $auto_complete_length

ilSearchSettings::$auto_complete_length = 10

protected

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

Referenced by getAutoCompleteLength(), and setAutoCompleteLength().

◆ $date_filter

ilSearchSettings::$date_filter = false

protected

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

Referenced by isDateFilterEnabled().

◆ $default_operator

ilSearchSettings::$default_operator = self::OPERATOR_AND

protected

Definition at line 25 of file class.ilSearchSettings.php.

Referenced by getDefaultOperator().

◆ $fragmentCount

ilSearchSettings::$fragmentCount = 3

protected

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

Referenced by getFragmentCount().

◆ $fragmentSize

ilSearchSettings::$fragmentSize = 30

protected

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

Referenced by getFragmentSize().

◆ $ilias

ilSearchSettings::$ilias = null

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

Referenced by __construct().

◆ $index

ilSearchSettings::$index = null

Definition at line 49 of file class.ilSearchSettings.php.

◆ $instance

ilSearchSettings::$instance = null

staticprotected

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

Referenced by getInstance().

◆ $last_index_date

ilSearchSettings::$last_index_date = null

protected

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

◆ $lucene_item_filter

ilSearchSettings::$lucene_item_filter = array()

protected

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

Referenced by getLuceneItemFilter().

◆ $lucene_item_filter_enabled

ilSearchSettings::$lucene_item_filter_enabled = false

protected

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

Referenced by isLuceneItemFilterEnabled().

◆ $lucene_mime_filter

ilSearchSettings::$lucene_mime_filter = array()

protected

Definition at line 39 of file class.ilSearchSettings.php.

Referenced by getLuceneMimeFilter().

◆ $lucene_mime_filter_enabled

ilSearchSettings::$lucene_mime_filter_enabled = false

protected

Definition at line 38 of file class.ilSearchSettings.php.

Referenced by isLuceneMimeFilterEnabled().

◆ $lucene_offline_filter

ilSearchSettings::$lucene_offline_filter = true

protected

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

Referenced by isLuceneOfflineFilterEnabled().

◆ $max_hits

ilSearchSettings::$max_hits = null

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

Referenced by getMaxHits().

◆ $numSubitems

ilSearchSettings::$numSubitems = 5

protected

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

Referenced by getMaxSubitems().

◆ $prefix_wildcard

ilSearchSettings::$prefix_wildcard = false

protected

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

Referenced by isPrefixWildcardQueryEnabled().

◆ $show_inactiv_user

ilSearchSettings::$show_inactiv_user = true

protected

Definition at line 35 of file class.ilSearchSettings.php.

Referenced by isInactiveUserVisible().

◆ $show_limited_user

ilSearchSettings::$show_limited_user = true

protected

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

Referenced by isLimitedUserVisible().

◆ $showRelevance

ilSearchSettings::$showRelevance = true

protected

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

Referenced by isRelevanceVisible().

◆ $showSubRelevance

ilSearchSettings::$showSubRelevance = false

protected

Definition at line 40 of file class.ilSearchSettings.php.

Referenced by isSubRelevanceVisible().

◆ $user_search

ilSearchSettings::$user_search = false

protected

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

Referenced by isLuceneUserSearchEnabled().

◆ INDEX_SEARCH

const ilSearchSettings::INDEX_SEARCH = 1

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

Referenced by ilObjSearchSettingsGUI\initFormSettings(), and ilObjSearchSettingsGUI\updateSettingsObject().

◆ LIKE_SEARCH

const ilSearchSettings::LIKE_SEARCH = 0

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

Referenced by ilObjSearchSettingsGUI\initFormSettings(), and ilObjSearchSettingsGUI\updateSettingsObject().

◆ LUCENE_SEARCH

const ilSearchSettings::LUCENE_SEARCH = 2

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

Referenced by ilObjSearchSettingsGUI\initFormSettings(), and ilObjSearchSettingsGUI\updateSettingsObject().

◆ OPERATOR_AND

const ilSearchSettings::OPERATOR_AND = 1

Definition at line 20 of file class.ilSearchSettings.php.

Referenced by ilObjSearchSettingsGUI\initFormSettings(), ilRepositoryObjectDetailSearch\performDBSearch(), ilAdvancedSearchGUI\performSearch(), ilSearchGUI\showSearch(), and ilLuceneSearchGUI\showSearchForm().

◆ OPERATOR_OR

const ilSearchSettings::OPERATOR_OR = 2

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

Referenced by ilObjSearchSettingsGUI\initFormSettings().

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

Services/Search/classes/class.ilSearchSettings.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __read()

◆ _getSearchSettingRefId()

◆ enableDateFilter()

◆ enabledIndex()

◆ enabledLucene()

◆ enableIndex()

◆ enableLucene()

◆ enableLuceneItemFilter()

◆ enableLuceneMimeFilter()

◆ enableLuceneOfflineFilter()

◆ enableLuceneUserSearch()

◆ enablePrefixWildcardQuery()

◆ getAutoCompleteLength()

◆ getDefaultOperator()

◆ getEnabledLuceneItemFilterDefinitions()

◆ getEnabledLuceneMimeFilterDefinitions()

◆ getFragmentCount()

◆ getFragmentSize()

◆ getHideAdvancedSearch()

◆ getInstance()

◆ getLastIndexTime()

◆ getLuceneItemFilter()

◆ getLuceneItemFilterDefinitions()

◆ getLuceneMimeFilter()

◆ getLuceneMimeFilterDefinitions()

◆ getMaxHits()

◆ getMaxSubitems()

◆ isDateFilterEnabled()

◆ isInactiveUserVisible()

◆ isLimitedUserVisible()

◆ isLuceneItemFilterEnabled()

◆ isLuceneMimeFilterEnabled()

◆ isLuceneOfflineFilterEnabled()

◆ isLuceneUserSearchEnabled()

◆ isPrefixWildcardQueryEnabled()

◆ isRelevanceVisible()

◆ isSubRelevanceVisible()

◆ setAutoCompleteLength()

◆ setDefaultOperator()

◆ setFragmentCount()

◆ setFragmentSize()

◆ setHideAdvancedSearch()

◆ setLastIndexTime()

◆ setLuceneItemFilter()

◆ setLuceneMimeFilter()

◆ setMaxHits()

◆ setMaxSubitems()

◆ showInactiveUser()

◆ showLimitedUser()

◆ showRelevance()

◆ showSubRelevance()

◆ update()

Field Documentation

◆ $auto_complete_length

◆ $date_filter

◆ $default_operator

◆ $fragmentCount

◆ $fragmentSize

◆ $ilias

◆ $index

◆ $instance

◆ $last_index_date

◆ $lucene_item_filter

◆ $lucene_item_filter_enabled

◆ $lucene_mime_filter

◆ $lucene_mime_filter_enabled

◆ $lucene_offline_filter

◆ $max_hits

◆ $numSubitems

◆ $prefix_wildcard

◆ $show_inactiv_user