Collaboration diagram for ilSearchSettings:

Public Member Functions
	ilSearchSettings ()
	getEnabledLuceneItemFilterDefinitions ()
	Get lucene item filter definitions.
	getEnabledLuceneMimeFilterDefinitions ()
	enablePrefixWildcardQuery ($a_stat)
	isPrefixWildcardQueryEnabled ()
	_getSearchSettingRefId ()
	Read the ref_id of Search Settings object.
	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.
	enableLuceneMimeFilter ($a_stat)
	Enable lucene mime filter.
	setLastIndexTime ($time)
	isLuceneUserSearchEnabled ()
	Check if user search is enabled.
	enableLuceneUserSearch ($a_status)
	Enable lucene user search.
	update ()
	__read ()

Static Public Member Functions
static	getInstance ()
static	getLuceneItemFilterDefinitions ()
	Get lucene item filter definitions.
static	getLuceneMimeFilterDefinitions ()

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
	$lucene_mime_filter_enabled = false
	$lucene_mime_filter = array()
	$showSubRelevance = false
	$prefix_wildcard = false
	$user_search = false

Static Protected Attributes
static	$instance = null

Detailed Description

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

Member Function Documentation

ilSearchSettings::__read ( )

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

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

Referenced by ilSearchSettings().

        {
                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));
                
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilSearchSettings::_getSearchSettingRefId ( )

Read the ref_id of Search Settings object.

normally used for rbacsystem->checkAccess()

Returns: int ref_id public

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

References $query, $res, $row, and DB_FETCHMODE_OBJECT.

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

        {
                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(DB_FETCHMODE_OBJECT);
                
                return $seas_ref_id = $row->ref_id;
        }

Here is the caller graph for this function:

ilSearchSettings::enabledIndex ( )

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

Referenced by update().

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

Here is the caller graph for this function:

ilSearchSettings::enabledLucene ( )

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

Referenced by update().

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

Here is the caller graph for this function:

ilSearchSettings::enableIndex ( $a_status )

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

Referenced by __read().

        {
                $this->index = $a_status;
        }

Here is the caller graph for this function:

ilSearchSettings::enableLucene ( $a_status )

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

Referenced by __read().

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

Here is the caller graph for this function:

ilSearchSettings::enableLuceneItemFilter ( $a_status )

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

Referenced by __read().

        {
                $this->lucene_item_filter_enabled = $a_status;
        }

Here is the caller graph for this function:

ilSearchSettings::enableLuceneMimeFilter ( $a_stat )

Enable lucene mime filter.

Parameters

type $a_stat

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

Referenced by __read().

        {
                $this->lucene_mime_filter_enabled = $a_stat;
        }

Here is the caller graph for this function:

ilSearchSettings::enableLuceneOfflineFilter ( $a_stat )

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

Referenced by __read().

        {
                $this->lucene_offline_filter = $a_stat;
        }

Here is the caller graph for this function:

ilSearchSettings::enableLuceneUserSearch ( $a_status )

Enable lucene user search.

Parameters

type $a_status

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

Referenced by __read().

        {
                $this->user_search = $a_status;
        }

Here is the caller graph for this function:

ilSearchSettings::enablePrefixWildcardQuery ( $a_stat )

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

Referenced by __read().

        {
                $this->prefix_wildcard = $a_stat;
        }

Here is the caller graph for this function:

ilSearchSettings::getAutoCompleteLength ( )

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

References $auto_complete_length.

Referenced by update().

        {
                return $this->auto_complete_length;
        }

Here is the caller graph for this function:

ilSearchSettings::getDefaultOperator ( )

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

References $default_operator.

Referenced by update().

        {
                return $this->default_operator;
        }

Here is the caller graph for this function:

ilSearchSettings::getEnabledLuceneItemFilterDefinitions ( )

Get lucene item filter definitions.

Returns

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

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

References getLuceneItemFilter(), and isLuceneItemFilterEnabled().

        {
                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;
        }

Here is the call graph for this function:

ilSearchSettings::getEnabledLuceneMimeFilterDefinitions ( )

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

References getLuceneMimeFilter(), and isLuceneItemFilterEnabled().

        {
                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;
        }

Here is the call graph for this function:

ilSearchSettings::getFragmentCount ( )

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

References $fragmentCount.

Referenced by update().

        {
                return $this->fragmentCount;
        }

Here is the caller graph for this function:

ilSearchSettings::getFragmentSize ( )

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

References $fragmentSize.

Referenced by update().

        {
                return $this->fragmentSize;
        }

Here is the caller graph for this function:

ilSearchSettings::getHideAdvancedSearch ( )

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

Referenced by update().

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

Here is the caller graph for this function:

static ilSearchSettings::getInstance ( )

static

Returns: ilSearchSettings

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

References $instance, and ilSearchSettings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilSearchSettings::getLastIndexTime ( )

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

References IL_CAL_DATETIME.

Referenced by update().

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

Here is the caller graph for this function:

ilSearchSettings::getLuceneItemFilter ( )

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

References $lucene_item_filter.

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

        {
                return $this->lucene_item_filter;
        }

Here is the caller graph for this function:

static ilSearchSettings::getLuceneItemFilterDefinitions ( )

static

Get lucene item filter definitions.

Returns

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

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

Referenced by ilObjSearchSettingsGUI\initFormSettings().

        {
                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')
                );
        }

Here is the caller graph for this function:

ilSearchSettings::getLuceneMimeFilter ( )

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

References $lucene_mime_filter.

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

        {
                return $this->lucene_mime_filter;
        }

Here is the caller graph for this function:

static ilSearchSettings::getLuceneMimeFilterDefinitions ( )

static

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

Referenced by ilObjSearchSettingsGUI\initFormLuceneSettings().

        {
                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')
                );
        }

Here is the caller graph for this function:

ilSearchSettings::getMaxHits ( )

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

References $max_hits.

Referenced by update().

        {
                return $this->max_hits;
        }

Here is the caller graph for this function:

ilSearchSettings::getMaxSubitems ( )

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

References $numSubitems.

Referenced by update().

        {
                return $this->numSubitems;
        }

Here is the caller graph for this function:

ilSearchSettings::ilSearchSettings ( )

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

References $ilias, and __read().

Referenced by getInstance().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilSearchSettings::isLuceneItemFilterEnabled ( )

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

References $lucene_item_filter_enabled.

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

        {
                return $this->lucene_item_filter_enabled;
        }

Here is the caller graph for this function:

ilSearchSettings::isLuceneMimeFilterEnabled ( )

Check if lucene mime filter is enabled.

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

References $lucene_mime_filter_enabled.

Referenced by update().

        {
                return $this->lucene_mime_filter_enabled;
        }

Here is the caller graph for this function:

ilSearchSettings::isLuceneOfflineFilterEnabled ( )

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

References $lucene_offline_filter.

Referenced by __read(), and update().

        {
                return $this->lucene_offline_filter;
        }

Here is the caller graph for this function:

ilSearchSettings::isLuceneUserSearchEnabled ( )

Check if user search is enabled.

Returns: type

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

References $user_search.

Referenced by update().

        {
                return $this->user_search;
        }

Here is the caller graph for this function:

ilSearchSettings::isPrefixWildcardQueryEnabled ( )

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

References $prefix_wildcard.

Referenced by update().

        {
                return $this->prefix_wildcard;
        }

Here is the caller graph for this function:

ilSearchSettings::isRelevanceVisible ( )

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

References $showRelevance.

Referenced by update().

        {
                return $this->showRelevance;
        }

Here is the caller graph for this function:

ilSearchSettings::isSubRelevanceVisible ( )

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

References $showSubRelevance.

Referenced by update().

        {
                return $this->showSubRelevance;
        }

Here is the caller graph for this function:

ilSearchSettings::setAutoCompleteLength ( $auto_complete_length )

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

References $auto_complete_length.

Referenced by __read().

        {
                $this->auto_complete_length = $auto_complete_length;
        }

Here is the caller graph for this function:

ilSearchSettings::setDefaultOperator ( $a_op )

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

Referenced by __read().

        {
                $this->default_operator = $a_op;
        }

Here is the caller graph for this function:

ilSearchSettings::setFragmentCount ( $a_count )

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

Referenced by __read().

        {
                $this->fragmentCount = $a_count;
        }

Here is the caller graph for this function:

ilSearchSettings::setFragmentSize ( $a_size )

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

Referenced by __read().

        {
                $this->fragmentSize = $a_size;
        }

Here is the caller graph for this function:

ilSearchSettings::setHideAdvancedSearch ( $a_status )

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

Referenced by __read().

        {
                $this->hide_adv_search = $a_status;
        }

Here is the caller graph for this function:

ilSearchSettings::setLastIndexTime ( $time )

Parameters

object instance of ilDateTime

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

Referenced by __read().

        {
                $this->last_index_date = $time;
        }

Here is the caller graph for this function:

ilSearchSettings::setLuceneItemFilter ( $a_filter )

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

Referenced by __read().

        {
                $this->lucene_item_filter = $a_filter;
        }

Here is the caller graph for this function:

ilSearchSettings::setLuceneMimeFilter ( $a_filter )

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

Referenced by __read().

        {
                $this->lucene_mime_filter = $a_filter;
        }

Here is the caller graph for this function:

ilSearchSettings::setMaxHits ( $a_max_hits )

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

Referenced by __read().

        {
                $this->max_hits = $a_max_hits;
        }

Here is the caller graph for this function:

ilSearchSettings::setMaxSubitems ( $a_max )

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

Referenced by __read().

        {
                $this->numSubitems = $a_max;
        }

Here is the caller graph for this function:

ilSearchSettings::showRelevance ( $a_status )

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

Referenced by __read().

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

Here is the caller graph for this function:

ilSearchSettings::showSubRelevance ( $a_stat )

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

Referenced by __read().

        {
                $this->showSubRelevance = $a_stat;
        }

Here is the caller graph for this function:

ilSearchSettings::update ( )

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

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

        {
                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());
                return true;
        }