ilAbstractSearch Class Reference

Inheritance diagram for ilAbstractSearch:

Collaboration diagram for ilAbstractSearch:

Public Member Functions
	__construct (ilQueryParser $qp_obj)
	setFields (array $a_fields)
	getFields ()
	setFilter (array $a_filter)
	setIdFilter (array $a_id_filter)
	getIdFilter ()
	appendToFilter (string $a_type)
	getFilter ()
	__createLocateString ()
	__prepareFound (object $row)
	performSearch ()

Protected Member Functions
	getValidObjectTypes (ilObjectDefinition $object_definition)

Protected Attributes
ilDBInterface	$db
ilQueryParser	$query_parser
ilSearchResult	$search_result
array	$object_types = []

Private Attributes
array	$id_filter = []
array	$fields = []

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilAbstractSearch::__construct

(

ilQueryParser

$qp_obj

)

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

References $DIC, and getValidObjectTypes().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->query_parser = $qp_obj;
        $this->search_result = new ilSearchResult();

        $this->object_types = $this->getValidObjectTypes($DIC['objDefinition']);
    }

Here is the call graph for this function:

Member Function Documentation

__createLocateString()

ilAbstractSearch::__createLocateString

(

)

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

References ilQueryParser\QP_COMBINATION_OR.

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(), ilMetaDataSearch\__searchTitles(), ilMediaPoolSearch\performKeywordSearch(), ilUserDefinedFieldSearch\performSearch(), ilWikiContentSearch\performSearch(), ilGlossaryDefinitionSearch\performSearch(), ilMediaCastSearch\performSearch(), ilForumSearch\performSearch(), ilLMContentSearch\performSearch(), ilLikeUserMultiFieldSearch\performSearch(), ilWebresourceSearch\performSearch(), ilMediaPoolSearch\performSearch(), ilExerciseSearch\performSearch(), ilUserSearch\performSearch(), ilLikeUserOrgUnitSearch\performSearch(), ilAdvancedMDSearch\performSearch(), ilObjectSearch\performSearch(), and ilAdvancedSearch\searchObjectProperties().

                                          : string
    {
        if ($this->query_parser->getCombination() == ilQueryParser::QP_COMBINATION_OR) {
            return '';
        }
        if (count($this->fields) > 1) {
            $tmp_fields = [];
            foreach ($this->fields as $field) {
                $tmp_fields[] = array($field,'text');
            }
            $complete_str = $this->db->concat($tmp_fields);
        } else {
            $complete_str = $this->fields[0];
        }

        $counter = 0;
        $locate = '';
        foreach ($this->query_parser->getQuotedWords() as $word) {
            $word = str_replace('\%', '%', $word);
            $word = str_replace('\_', '_', $word);

            $locate .= ',';
            $locate .= $this->db->locate($this->db->quote($word, 'text'), $complete_str);
            $locate .= (' found' . $counter++);
            $locate .= ' ';
        }

        return $locate;
    }

Here is the caller graph for this function:

__prepareFound()

ilAbstractSearch::__prepareFound

(

object

$row

)

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

References ILIAS\Repository\int(), and performSearch().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

appendToFilter()

ilAbstractSearch::appendToFilter

(

string

$a_type

)

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

                                                  : void
    {
        if (!in_array($a_type, $this->object_types)) {
            $this->object_types[] = $a_type;
        }
    }

getFields()

ilAbstractSearch::getFields

(

)

Returns

string[] array of search fields. E.g. array(title,description)

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

References $fields.

Referenced by ilLikeTestSearch\__createWhereCondition(), ilLikeUserSearch\__createWhereCondition(), ilLikeUserDefinedFieldSearch\__createWhereCondition(), and ilLikeUserMultiFieldSearch\__createWhereCondition().

                               : array
    {
        return $this->fields;
    }

Here is the caller graph for this function:

getFilter()

ilAbstractSearch::getFilter

(

)

Parameters

string[]

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

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

References $object_types.

Referenced by ilWikiContentSearch\__createInStatement(), ilLMContentSearch\__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(), ilAdvancedMDSearch\performSearch(), and ilAdvancedSearch\searchObjectProperties().

                               : array
    {
        return $this->object_types;
    }

Here is the caller graph for this function:

getIdFilter()

ilAbstractSearch::getIdFilter

(

)

Returns

int[]

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

References $id_filter.

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

                                 : array
    {
        return $this->id_filter;
    }

Here is the caller graph for this function:

getValidObjectTypes()

ilAbstractSearch::getValidObjectTypes ( ilObjectDefinition  $object_definition )

protected

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

References ilObjectDefinition\getAllObjects(), ilObjectDefinition\getGroupOfObj(), ilObjectDefinition\isAdministrationObject(), ilObjectDefinition\isAllowedInRepository(), ilObjectDefinition\isRBACObject(), ilObjectDefinition\isSideBlock(), and ilObjectDefinition\isSystemObject().

Referenced by __construct().

                                                                                 : array
    {
        $valid_types = [];
        foreach ($object_definition->getAllObjects() as $type) {
            if (
                !$object_definition->isSystemObject($type) &&
                !$object_definition->isAdministrationObject($type) &&
                !$object_definition->isSideBlock($type) &&
                $object_definition->isRBACObject($type) &&
                $object_definition->isAllowedInRepository($type)
            ) {
                $valid_types[] = $type;
            }
        }

        $grouped_types = [];
        foreach ($object_definition->getAllObjects() as $type) {
            if (in_array($object_definition->getGroupOfObj($type), $valid_types)) {
                $grouped_types[] = $type;
            }
        }

        return array_unique(array_merge($valid_types, $grouped_types));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

performSearch()

ilAbstractSearch::performSearch ( )

abstract

Referenced by __prepareFound().

Here is the caller graph for this function:

setFields()

ilAbstractSearch::setFields

(

array

$a_fields

)

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

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(), ilMetaDataSearch\__searchTitles(), ilMediaPoolSearch\performKeywordSearch(), ilWikiContentSearch\performSearch(), ilWebresourceSearch\performSearch(), ilExerciseSearch\performSearch(), ilLMContentSearch\performSearch(), ilForumSearch\performSearch(), ilMediaCastSearch\performSearch(), ilMediaPoolSearch\performSearch(), ilGlossaryDefinitionSearch\performSearch(), ilAdvancedMDSearch\performSearch(), and ilAdvancedSearch\searchObjectProperties().

                                              : void
    {
        $this->fields = $a_fields;
    }

Here is the caller graph for this function:

setFilter()

ilAbstractSearch::setFilter

(

array

$a_filter

)

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

                                              : void
    {
        $this->object_types = $a_filter;
    }

setIdFilter()

ilAbstractSearch::setIdFilter

(

array

$a_id_filter

)

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

                                                   : void
    {
        $this->id_filter = $a_id_filter;
    }

Field Documentation

$db

ilDBInterface ilAbstractSearch::$db

protected

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

$fields

array ilAbstractSearch::$fields = []

private

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

Referenced by ilAdvancedSearch\__createEducationalWhere(), ilLikeUserSearch\__createWhereCondition(), ilLikeUserDefinedFieldSearch\__createWhereCondition(), ilLikeUserMultiFieldSearch\__createWhereCondition(), ilAdvancedSearch\__getDifference(), getFields(), ilLikeUserDefinedFieldSearch\setFields(), and ilLikeUserMultiFieldSearch\setFields().

$id_filter

array ilAbstractSearch::$id_filter = []

private

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

Referenced by getIdFilter().

$object_types

array ilAbstractSearch::$object_types = []

protected

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

Referenced by getFilter().

$query_parser

ilQueryParser ilAbstractSearch::$query_parser

protected

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

Referenced by ilAdvancedMDSearch\__construct().

$search_result

ilSearchResult ilAbstractSearch::$search_result

protected

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

Referenced by ilAdvancedSearch\__searchClassification(), ilMetaDataSearch\__searchContribute(), ilAdvancedSearch\__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(), ilUserDefinedFieldSearch\performSearch(), ilWikiContentSearch\performSearch(), ilMediaPoolSearch\performSearch(), ilLMContentSearch\performSearch(), ilForumSearch\performSearch(), ilMediaCastSearch\performSearch(), ilGlossaryDefinitionSearch\performSearch(), ilExerciseSearch\performSearch(), ilWebresourceSearch\performSearch(), ilLikeUserMultiFieldSearch\performSearch(), ilLikeUserOrgUnitSearch\performSearch(), ilUserSearch\performSearch(), ilAdvancedMDSearch\performSearch(), ilObjectSearch\performSearch(), ilTestSearch\performSearch(), and ilAdvancedSearch\searchObjectProperties().

---

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

• components/ILIAS/Search/classes/Like/class.ilAbstractSearch.php