ilAbstractSearch Class Reference

Inheritance diagram for ilAbstractSearch:

Collaboration diagram for ilAbstractSearch:

Public Member Functions
	ilAbstractSearch (&$qp_obj)
	Constructor 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.

Member Function Documentation

__createLocateString()

ilAbstractSearch::__createLocateString

(

)

build locate string in case of AND search

Returns

string public

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

References $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(), ilUserDefinedFieldSearch\performSearch(), ilMediaPoolSearch\performSearch(), ilLikeUserMultiFieldSearch\performSearch(), ilWebresourceSearch\performSearch(), ilForumSearch\performSearch(), ilGlossaryDefinitionSearch\performSearch(), ilMediaCastSearch\performSearch(), ilExerciseSearch\performSearch(), ilWikiContentSearch\performSearch(), ilLMContentSearch\performSearch(), ilObjectSearch\performSearch(), ilUserSearch\performSearch(), and ilAdvancedMDSearch\performSearch().

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

Here is the caller graph for this function:

__prepareFound()

ilAbstractSearch::__prepareFound

(

&

$row

)

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

References $row.

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

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

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' public

Definition at line 114 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) public

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

References fields.

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

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

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')) public

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

Referenced by ilWikiContentSearch\__createInStatement(), ilLMContentSearch\__createInStatement(), ilShopMetaDataSearch\__createInStatement(), ilMetaDataSearch\__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().

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

Here is the caller graph for this function:

getIdFilter()

ilAbstractSearch::getIdFilter

(

)

Get Id filter.

Returns

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

References $id_filter.

Referenced by ilObjectSearch\__createInStatement().

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

Here is the caller graph for this function:

ilAbstractSearch()

ilAbstractSearch::ilAbstractSearch

(

&

$qp_obj

)

Constructor public.

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

References $ilDB.

        {
                global $ilDB;

                $this->query_parser =& $qp_obj;
                $this->db =& $ilDB;

                include_once 'Services/Search/classes/class.ilSearchResult.php';

                $this->search_result = new ilSearchResult();
        }

performSearch()

& ilAbstractSearch::performSearch

(

)

Definition at line 200 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')) public

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

References fields.

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

        {
                $this->fields = $a_fields;
        }

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')) public

Definition at line 82 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 95 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','icrs','icla','webr','mcst','sess','pg','st','wiki','book')

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(), ilExerciseSearch\ilExerciseSearch(), ilForumSearch\ilForumSearch(), ilGlossaryDefinitionSearch\ilGlossaryDefinitionSearch(), ilLMContentSearch\ilLMContentSearch(), ilMediaCastSearch\ilMediaCastSearch(), ilMediaPoolSearch\ilMediaPoolSearch(), ilTestSearch\ilTestSearch(), ilUserDefinedFieldSearch\ilUserDefinedFieldSearch(), ilUserSearch\ilUserSearch(), ilWebresourceSearch\ilWebresourceSearch(), and ilWikiContentSearch\ilWikiContentSearch().

$search_result

ilAbstractSearch::$search_result = null

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

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

---

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

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