ilRepositoryObjectDetailSearch Class Reference

Collaboration diagram for ilRepositoryObjectDetailSearch:

Public Member Functions
	__construct ($a_obj_id)
	constructor More...
	getSettings ()
	Get settings. More...
	getObjId ()
	get obj id More...
	getType ()
	setQueryString ($a_query)
	getQueryString ()
	get query string More...
	performSearch ()
	Perform search. More...

Protected Member Functions
	performLuceneSearch ()
	Perform lucene search. More...
	performDBSearch ()
	Perform DB search. More...

Protected Attributes
	$settings = null
	$obj_id
	$type
	$query_string

Detailed Description

Definition at line 17 of file class.ilRepositoryObjectDetailSearch.php.

Constructor & Destructor Documentation

__construct()

ilRepositoryObjectDetailSearch::__construct

(

$a_obj_id

)

constructor

Definition at line 28 of file class.ilRepositoryObjectDetailSearch.php.

References ilObject\_lookupType(), ilSearchSettings\getInstance(), getObjId(), and settings().

    {
        $this->obj_id = $a_obj_id;
        $this->type = ilObject::_lookupType($this->getObjId());
        
        $this->settings = ilSearchSettings::getInstance();
    }

Here is the call graph for this function:

Member Function Documentation

getObjId()

ilRepositoryObjectDetailSearch::getObjId

(

)

get obj id

Returns

type

Definition at line 49 of file class.ilRepositoryObjectDetailSearch.php.

References $obj_id.

Referenced by __construct(), performDBSearch(), and performLuceneSearch().

    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getQueryString()

ilRepositoryObjectDetailSearch::getQueryString

(

)

get query string

Definition at line 69 of file class.ilRepositoryObjectDetailSearch.php.

References $query_string.

Referenced by performDBSearch(), and performLuceneSearch().

    {
        return $this->query_string;
    }

Here is the caller graph for this function:

getSettings()

ilRepositoryObjectDetailSearch::getSettings

(

)

Get settings.

Returns

ilSearchSettings

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

References $settings.

Referenced by performDBSearch(), and performSearch().

    {
        return $this->settings;
    }

Here is the caller graph for this function:

getType()

ilRepositoryObjectDetailSearch::getType

(

)

Definition at line 54 of file class.ilRepositoryObjectDetailSearch.php.

References $type.

Referenced by performDBSearch().

    {
        return $this->type;
    }

Here is the caller graph for this function:

performDBSearch()

ilRepositoryObjectDetailSearch::performDBSearch ( )

protected

Perform DB search.

Returns

ilRepositoryObjectDetailSearchResult

Definition at line 131 of file class.ilRepositoryObjectDetailSearch.php.

References ilObjectSearchFactory\getByTypeSearchInstance(), getObjId(), getQueryString(), getSettings(), getType(), ilSearchSettings\OPERATOR_AND, QP_COMBINATION_AND, and QP_COMBINATION_OR.

Referenced by performSearch().

    {
        // query parser
        include_once 'Services/Search/classes/class.ilQueryParser.php';

        $query_parser = new ilQueryParser($this->getQueryString());
        
        $query_parser->setCombination(
            ($this->getSettings()->getDefaultOperator() == ilSearchSettings::OPERATOR_AND) ?
                QP_COMBINATION_AND :
                QP_COMBINATION_OR
        );
        $query_parser->parse();
        
        if (!$query_parser->validate()) {
            throw new Exception($query_parser->getMessage());
        }
        include_once 'Services/Search/classes/class.ilSearchResult.php';
        $search_result = new ilSearchResult();
        
        include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
        $search = ilObjectSearchFactory::getByTypeSearchInstance($this->getType(), $query_parser);
        
        switch ($this->getType()) {
            case 'wiki':
                $search->setFilter(array('wpg'));
                break;
        }
        
        $search->setIdFilter(array($this->getObjId()));
        
        $search_result->mergeEntries($search->performSearch());
        
        include_once './Services/Search/classes/class.ilRepositoryObjectDetailSearchResult.php';
        $detail_search_result = new ilRepositoryObjectDetailSearchResult();
        
        foreach ($search_result->getEntries() as $entry) {
            foreach ((array) $entry['child'] as $child) {
                $detail_search_result->addResultSet(
                    array(
                            'obj_id' => $entry['obj_id'],
                            'item_id' => $child
                        )
                );
            }
        }
        return $detail_search_result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

performLuceneSearch()

ilRepositoryObjectDetailSearch::performLuceneSearch ( )

protected

Perform lucene search.

Exceptions

ilLuceneQueryParserException

Definition at line 93 of file class.ilRepositoryObjectDetailSearch.php.

References ilLuceneSearcher\getInstance(), ilLoggerFactory\getLogger(), getObjId(), and getQueryString().

Referenced by performSearch().

    {
        include_once './Services/Search/classes/Lucene/class.ilLuceneQueryParser.php';
        try {
            $qp = new ilLuceneQueryParser($this->getQueryString());
            $qp->parse();
        } catch (ilLuceneQueryParserException $e) {
            ilLoggerFactory::getLogger('src')->warning('Invalid query: ' . $e->getMessage());
            throw $e;
        }
        
        include_once './Services/Search/classes/Lucene/class.ilLuceneSearcher.php';
        $searcher = ilLuceneSearcher::getInstance($qp);
        $searcher->highlight(array($this->getObjId()));
        
        include_once './Services/Search/classes/class.ilRepositoryObjectDetailSearchResult.php';
        $detail_search_result = new ilRepositoryObjectDetailSearchResult();
        
        if ($searcher->getHighlighter() instanceof ilLuceneHighlighterResultParser) {
            foreach ($searcher->getHighlighter()->getSubItemIds($this->getObjId()) as $sub_id) {
                $detail_search_result->addResultSet(
                    array(
                        'obj_id' => $this->getObjId(),
                        'item_id' => $sub_id,
                        'relevance' => $searcher->getHighlighter()->getRelevance($this->getObjId(), $sub_id),
                        'content' => $searcher->getHighlighter()->getContent($this->getObjId(), $sub_id)
                    )
                );
            }
        }
        return $detail_search_result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

performSearch()

ilRepositoryObjectDetailSearch::performSearch

(

)

Perform search.

Returns

ilRepositoryObjectDetailSearchResult

Exceptions

ilLuceneQueryParserException

Definition at line 80 of file class.ilRepositoryObjectDetailSearch.php.

References getSettings(), performDBSearch(), and performLuceneSearch().

    {
        if ($this->getSettings()->enabledLucene()) {
            return $this->performLuceneSearch();
        } else {
            return $this->performDBSearch();
        }
    }

Here is the call graph for this function:

setQueryString()

ilRepositoryObjectDetailSearch::setQueryString

(

$a_query

)

Definition at line 60 of file class.ilRepositoryObjectDetailSearch.php.

    {
        $this->query_string = $a_query;
    }

Field Documentation

$obj_id

ilRepositoryObjectDetailSearch::$obj_id

protected

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

Referenced by getObjId().

$query_string

ilRepositoryObjectDetailSearch::$query_string

protected

Definition at line 23 of file class.ilRepositoryObjectDetailSearch.php.

Referenced by getQueryString().

$settings

ilRepositoryObjectDetailSearch::$settings = null

protected

Definition at line 19 of file class.ilRepositoryObjectDetailSearch.php.

Referenced by getSettings().

$type

ilRepositoryObjectDetailSearch::$type

protected

Definition at line 22 of file class.ilRepositoryObjectDetailSearch.php.

Referenced by getType().

---

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

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