ilAbstractSearch Class Reference

Inheritance diagram for ilAbstractSearch:

Collaboration diagram for ilAbstractSearch:

Public Member Functions
	__construct ($qp_obj)
	Constructor @access public. More...
	setFields ($a_fields)
	Set fields to search. More...
	getFields ()
	Get fields to search. More...
	setFilter ($a_filter)
	set object type to search in More...
	setIdFilter ($a_id_filter)
	Set id filter Filters search by given object id. More...
	getIdFilter ()
	Get Id filter. More...
	appendToFilter ($a_type)
	Append object type to filter. More...
	getFilter ()
	get object type to search in More...
	__createLocateString ()
	build locate string in case of AND search More...
	__prepareFound (&$row)
	performSearch ()

Data Fields
	$db = null
	$query_parser = null
	$search_result = null
	$object_types

Private Attributes
	$id_filter = array()

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilAbstractSearch::__construct

(

$qp_obj

)

Constructor @access public.

Reimplemented in ilLikeAdvancedSearch, ilLikeUserMultiFieldSearch, ilLikeUserOrgUnitSearch, ilLikeWebresourceSearch, ilLikeWikiContentSearch, and ilAdvancedMDSearch.

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $this->query_parser = $qp_obj;
        $this->db = $ilDB;
 
        include_once 'Services/Search/classes/class.ilSearchResult.php';
 
        $this->search_result = new ilSearchResult();
    }

References $DIC, and $ilDB.

Member Function Documentation

__createLocateString()

ilAbstractSearch::__createLocateString

(

)

build locate string in case of AND search

Returns

string @access public

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        if ($this->query_parser->getCombination() == 'or') {
            return '';
        }
        if (count($this->fields) > 1) {
            foreach ($this->fields as $field) {
                $tmp_fields[] = array($field,'text');
            }
            $complete_str = $ilDB->concat($tmp_fields);
            
        /*
        $complete_str = 'CONCAT(';
        $complete_str .= implode(',',$this->fields);
        $complete_str .= ')';
        */
        } else {
            $complete_str = $this->fields[0];
        }
 
        $counter = 0;
        foreach ($this->query_parser->getQuotedWords() as $word) {
            $locate .= ',';
            $locate .= $ilDB->locate($ilDB->quote($word, 'text'), $complete_str);
            $locate .= (' found' . $counter++);
            $locate .= ' ';
            #$locate .= (", LOCATE('".$word."',".$complete_str.") ");
            #$locate .= ("as found".$counter++." ");
        }
        
        return $locate;
    }

References $DIC, $ilDB, and fields.

Referenced by ilMetaDataSearch\__searchContribute(), ilMetaDataSearch\__searchDescriptions(), ilAdvancedSearch\__searchEntity(), ilAdvancedSearch\__searchGeneral(), ilAdvancedSearch\__searchKeyword(), ilMetaDataSearch\__searchKeywords(), ilAdvancedSearch\__searchLifecycle(), ilTestSearch\__searchSurveyIntroduction(), ilTestSearch\__searchSurveyTitle(), ilAdvancedSearch\__searchTaxon(), ilTestSearch\__searchTestIntroduction(), ilTestSearch\__searchTestTitle(), ilAdvancedSearch\__searchTitleDescription(), ilMetaDataSearch\__searchTitles(), ilMediaPoolSearch\performKeywordSearch(), ilAdvancedMDSearch\performSearch(), ilExerciseSearch\performSearch(), ilForumSearch\performSearch(), ilGlossaryDefinitionSearch\performSearch(), ilLMContentSearch\performSearch(), ilMediaCastSearch\performSearch(), ilMediaPoolSearch\performSearch(), ilObjectSearch\performSearch(), ilUserDefinedFieldSearch\performSearch(), ilUserSearch\performSearch(), ilWebresourceSearch\performSearch(), ilWikiContentSearch\performSearch(), ilLikeUserMultiFieldSearch\performSearch(), and ilLikeUserOrgUnitSearch\performSearch().

Here is the caller graph for this function:

__prepareFound()

ilAbstractSearch::__prepareFound

(

&

$row

)

Definition at line 180 of file class.ilAbstractSearch.php.

    {
        if ($this->query_parser->getCombination() == 'or') {
            return array();
        }
        $counter = 0;
        foreach ($this->query_parser->getQuotedWords() as $word) {
            $res_found = "found" . $counter++;
            $found[] = $row->$res_found;
        }
        return $found ? $found : array();
    }

Referenced by ilAdvancedSearch\__searchEntity(), ilAdvancedSearch\__searchGeneral(), ilAdvancedSearch\__searchKeyword(), ilAdvancedSearch\__searchLifecycle(), and ilAdvancedSearch\__searchTaxon().

Here is the caller graph for this function:

appendToFilter()

ilAbstractSearch::appendToFilter

(

$a_type

)

Append object type to filter.

Parameters

string

obj_type e.g. 'role' @access public

Definition at line 115 of file class.ilAbstractSearch.php.

    {
        if (is_array($this->object_types)) {
            if (in_array($a_type, $this->object_types)) {
                return false;
            }
        }
        $this->object_types[] = $a_type;
        
        return true;
    }

getFields()

ilAbstractSearch::getFields

(

)

Get fields to search.

Returns

array array of search fields. E.g. array(title,description) @access public

Definition at line 74 of file class.ilAbstractSearch.php.

    {
        return $this->fields ? $this->fields : array();
    }

References fields.

Referenced by ilLikeTestSearch\__createWhereCondition(), ilLikeUserDefinedFieldSearch\__createWhereCondition(), ilLikeUserMultiFieldSearch\__createWhereCondition(), ilLikeUserSearch\__createWhereCondition(), ilTestSearch\__searchSurveyIntroduction(), ilTestSearch\__searchSurveyTitle(), ilTestSearch\__searchTestIntroduction(), and ilTestSearch\__searchTestTitle().

Here is the caller graph for this function:

getFilter()

ilAbstractSearch::getFilter

(

)

get object type to search in

Parameters

array

Array of object types (e.g array('lm','st','pg','dbk')) @access public

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

    {
        return $this->object_types ? $this->object_types : array();
    }

Referenced by ilLMContentSearch\__createInStatement(), ilMetaDataSearch\__createInStatement(), ilWikiContentSearch\__createInStatement(), ilAdvancedSearch\__searchClassification(), ilAdvancedSearch\__searchContribute(), ilAdvancedSearch\__searchEducational(), ilAdvancedSearch\__searchEntity(), ilAdvancedSearch\__searchFormat(), ilAdvancedSearch\__searchGeneral(), ilAdvancedSearch\__searchKeyword(), ilAdvancedSearch\__searchLanguage(), ilAdvancedSearch\__searchLifecycle(), ilAdvancedSearch\__searchRequirement(), ilAdvancedSearch\__searchRights(), ilAdvancedSearch\__searchTaxon(), ilAdvancedSearch\__searchTitleDescription(), and ilAdvancedMDSearch\performSearch().

Here is the caller graph for this function:

getIdFilter()

ilAbstractSearch::getIdFilter

(

)

Get Id filter.

Returns

Definition at line 105 of file class.ilAbstractSearch.php.

    {
        return (array) $this->id_filter;
    }

References $id_filter.

Referenced by ilLMContentSearch\__createInStatement(), ilObjectSearch\__createInStatement(), and ilWikiContentSearch\__createInStatement().

Here is the caller graph for this function:

performSearch()

ilAbstractSearch::performSearch

(

)

Reimplemented in ilAdvancedMDSearch, ilAdvancedSearch, ilExerciseSearch, ilForumSearch, ilGlossaryDefinitionSearch, ilLMContentSearch, ilMediaCastSearch, ilMediaPoolSearch, ilMetaDataSearch, ilObjectSearch, ilTestSearch, ilUserDefinedFieldSearch, ilUserSearch, ilWebresourceSearch, ilWikiContentSearch, ilLikeUserMultiFieldSearch, and ilLikeUserOrgUnitSearch.

Definition at line 193 of file class.ilAbstractSearch.php.

    {
        echo "Should be overwritten.";
    }

setFields()

ilAbstractSearch::setFields

(

$a_fields

)

Set fields to search.

Parameters

array

Array of table field (e.g array('title','description')) @access public

Reimplemented in ilLikeUserDefinedFieldSearch, and ilLikeUserMultiFieldSearch.

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

    {
        $this->fields = $a_fields;
    }

References fields.

Referenced by ilObjectSearch\__construct(), ilMetaDataSearch\__searchContribute(), ilMetaDataSearch\__searchDescriptions(), ilAdvancedSearch\__searchEntity(), ilAdvancedSearch\__searchGeneral(), ilAdvancedSearch\__searchKeyword(), ilMetaDataSearch\__searchKeywords(), ilAdvancedSearch\__searchLifecycle(), ilTestSearch\__searchSurveyIntroduction(), ilTestSearch\__searchSurveyTitle(), ilAdvancedSearch\__searchTaxon(), ilTestSearch\__searchTestIntroduction(), ilTestSearch\__searchTestTitle(), ilAdvancedSearch\__searchTitleDescription(), ilMetaDataSearch\__searchTitles(), ilMediaPoolSearch\performKeywordSearch(), ilAdvancedMDSearch\performSearch(), ilExerciseSearch\performSearch(), ilForumSearch\performSearch(), ilGlossaryDefinitionSearch\performSearch(), ilLMContentSearch\performSearch(), ilMediaCastSearch\performSearch(), ilMediaPoolSearch\performSearch(), ilWebresourceSearch\performSearch(), and ilWikiContentSearch\performSearch().

Here is the caller graph for this function:

setFilter()

ilAbstractSearch::setFilter

(

$a_filter

)

set object type to search in

Parameters

array

Array of object types (e.g array('lm','st','pg','dbk')) @access public

Definition at line 84 of file class.ilAbstractSearch.php.

    {
        if (is_array($a_filter)) {
            $this->object_types = $a_filter;
        }
    }

setIdFilter()

ilAbstractSearch::setIdFilter

(

$a_id_filter

)

Set id filter Filters search by given object id.

Returns

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

    {
        $this->id_filter = $a_id_filter;
    }

Field Documentation

$db

ilAbstractSearch::$db = null

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

$id_filter

ilAbstractSearch::$id_filter = array()

private

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

Referenced by getIdFilter().

$object_types

ilAbstractSearch::$object_types

Initial value:

= array('cat','dbk','crs','fold','frm','grp','lm','sahs','glo','mep','htlm','exc','file','qpl','tst','svy','spl',
                         'chat','webr','mcst','sess','pg','st','wiki','book', 'copa')

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

$query_parser

ilAbstractSearch::$query_parser = null

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

Referenced by ilAdvancedMDSearch\__construct().

$search_result

ilAbstractSearch::$search_result = null

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

Referenced by ilAdvancedSearch\__searchClassification(), ilAdvancedSearch\__searchContribute(), ilMetaDataSearch\__searchContribute(), ilMetaDataSearch\__searchDescriptions(), ilAdvancedSearch\__searchEducational(), ilAdvancedSearch\__searchEntity(), ilAdvancedSearch\__searchFormat(), ilAdvancedSearch\__searchGeneral(), ilAdvancedSearch\__searchKeyword(), ilMetaDataSearch\__searchKeywords(), ilAdvancedSearch\__searchLanguage(), ilAdvancedSearch\__searchLifecycle(), ilAdvancedSearch\__searchRequirement(), ilAdvancedSearch\__searchRights(), ilTestSearch\__searchSurveyIntroduction(), ilTestSearch\__searchSurveyTitle(), ilAdvancedSearch\__searchTaxon(), ilTestSearch\__searchTestIntroduction(), ilTestSearch\__searchTestTitle(), ilAdvancedSearch\__searchTitleDescription(), ilMetaDataSearch\__searchTitles(), ilAdvancedSearch\__searchTypicalAgeRange(), ilMediaPoolSearch\performKeywordSearch(), ilAdvancedMDSearch\performSearch(), ilExerciseSearch\performSearch(), ilForumSearch\performSearch(), ilGlossaryDefinitionSearch\performSearch(), ilLMContentSearch\performSearch(), ilMediaCastSearch\performSearch(), ilMediaPoolSearch\performSearch(), ilObjectSearch\performSearch(), ilTestSearch\performSearch(), ilUserDefinedFieldSearch\performSearch(), ilUserSearch\performSearch(), ilWebresourceSearch\performSearch(), ilWikiContentSearch\performSearch(), ilLikeUserMultiFieldSearch\performSearch(), and ilLikeUserOrgUnitSearch\performSearch().

---

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

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