ilSearchSettings Class Reference

Public Member Functions
	ilSearchSettings ()
	_getSearchSettingRefId ()
	Read the ref_id of Search Settings object.
	enabledIndex ()
	enableIndex ($a_status)
	enabledLucene ()
	enableLucene ($a_status)
	getMaxHits ()
	setMaxHits ($a_max_hits)
	update ()
	__read ()
Data Fields
	$ilias = null
	$max_hits = null
	$index = null

---

Detailed Description

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

---

Member Function Documentation

ilSearchSettings::__read

(

)

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

References enableIndex(), enableLucene(), and setMaxHits().

Referenced by ilSearchSettings().

        {
                $this->setMaxHits($this->ilias->getSetting('search_max_hits',50));
                $this->enableIndex($this->ilias->getSetting('search_index',0));
                $this->enableLucene($this->ilias->getSetting('search_lucene',0));
        }

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 53 of file class.ilSearchSettings.php.

References $query, $res, and $row.

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

        {
                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 = '".SYSTEM_FOLDER_ID."' ".
                        "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 75 of file class.ilSearchSettings.php.

Referenced by update().

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

Here is the caller graph for this function:

ilSearchSettings::enabledLucene

(

)

Definition at line 83 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 79 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 87 of file class.ilSearchSettings.php.

Referenced by __read().

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

Here is the caller graph for this function:

ilSearchSettings::getMaxHits

(

)

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

Referenced by update().

        {
                return $this->max_hits;
        }

Here is the caller graph for this function:

ilSearchSettings::ilSearchSettings

(

)

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

References $ilias, and __read().

        {
                global $ilias;

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

Here is the call graph for this function:

ilSearchSettings::setMaxHits

(

$

a_max_hits

)

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

Referenced by __read().

        {
                $this->max_hits = $a_max_hits;
        }

Here is the caller graph for this function:

ilSearchSettings::update

(

)

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

References enabledIndex(), enabledLucene(), and getMaxHits().

        {
                // setSetting writes to db
                $this->ilias->setSetting('search_max_hits',$this->getMaxHits());
                $this->ilias->setSetting('search_index',$this->enabledIndex());
                $this->ilias->setSetting('search_lucene',(int) $this->enabledLucene());

                return true;
        }

Here is the call graph for this function:

---

Field Documentation

ilSearchSettings::$ilias = null

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

Referenced by ilSearchSettings().

ilSearchSettings::$index = null

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

ilSearchSettings::$max_hits = null

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

---

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

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