Reads and parses lucene search results. More...

Collaboration diagram for ilLuceneSearcher:

Public Member Functions
	setType (int $a_type)
	Set search type. More...

	getType ()
	Get type. More...

	search ()
	Search. More...

	highlight (array $a_obj_ids)

	nextResultPage ()
	get next result page More...

	getHighlighter ()
	get highlighter More...

	getResult ()
	Get result. More...

	getPageNumber ()
	get current page number More...

Static Public Member Functions
static	getInstance (ilLuceneQueryParser $qp)
	Get singleton instance. More...

Data Fields
const	TYPE_STANDARD = 1

const	TYPE_USER = 2

Protected Member Functions
	performSearch ()
	search lucene More...

Protected Attributes
ilSetting	$setting

Private Member Functions
	__construct (ilLuceneQueryParser $qp)

Private Attributes
ilLuceneQueryParser	$query_parser

ilLuceneSearchResult	$result

ilLuceneHighlighterResultParser	$highlighter = null

int	$page_number = 1

int	$type = self::TYPE_STANDARD

Static Private Attributes
static ilLuceneSearcher	$instance = null

Detailed Description

Reads and parses lucene search results.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilLuceneSearcher::__construct ( ilLuceneQueryParser $qp )

private

Definition at line 50 of file class.ilLuceneSearcher.php.

    {
        global $DIC;
 
        $this->setting = $DIC->settings();
        $this->result = new ilLuceneSearchResult();
        $this->result->setCallback([$this,'nextResultPage']);
        $this->query_parser = $qp;
    }

References $DIC.

Member Function Documentation

◆ getHighlighter()

ilLuceneSearcher::getHighlighter ( )

get highlighter

Definition at line 137 of file class.ilLuceneSearcher.php.

                                    : ?ilLuceneHighlighterResultParser
    {
        return $this->highlighter;
    }

References $highlighter.

◆ getInstance()

static ilLuceneSearcher::getInstance ( ilLuceneQueryParser $qp )

static

Get singleton instance.

Definition at line 63 of file class.ilLuceneSearcher.php.

                                                               : self
    {
        if (self::$instance instanceof ilLuceneSearcher) {
            return self::$instance;
        }
        return self::$instance = new ilLuceneSearcher($qp);
    }

References $instance.

Referenced by ilSearchAutoComplete\getLuceneList(), ilRepositoryObjectDetailSearch\performLuceneSearch(), ilLuceneAdvancedSearchGUI\performSearch(), ilLuceneSearchGUI\performSearch(), ilLuceneUserSearchGUI\performSearch(), ilSoapObjectAdministration\searchObjects(), ilLuceneAdvancedSearchGUI\showSavedResults(), and ilLuceneSearchGUI\showSavedResults().

Here is the caller graph for this function:

◆ getPageNumber()

ilLuceneSearcher::getPageNumber ( )

get current page number

Definition at line 153 of file class.ilLuceneSearcher.php.

                                   : int
    {
        return $this->page_number;
    }

References $page_number.

◆ getResult()

ilLuceneSearcher::getResult ( )

Get result.

Definition at line 145 of file class.ilLuceneSearcher.php.

                               : ilLuceneSearchResult
    {
        return $this->result;
    }

References $result.

◆ getType()

ilLuceneSearcher::getType ( )

Get type.

Definition at line 82 of file class.ilLuceneSearcher.php.

                             : int
    {
        return $this->type;
    }

References $type.

Referenced by performSearch().

Here is the caller graph for this function:

◆ highlight()

ilLuceneSearcher::highlight ( array $a_obj_ids )

Parameters

int[] $a_obj_ids

Returns: ilLuceneHighlighterResultParser|null

Definition at line 100 of file class.ilLuceneSearcher.php.

                                               : ?ilLuceneHighlighterResultParser
    {
        if (!$this->query_parser->getQuery()) {
            return null;
        }
 
        // Search in combined index
        try {
            $res = ilRpcClientFactory::factory('RPCSearchHandler')->highlight(
                CLIENT_ID . '_' . $this->setting->get('inst_id', '0'),
                $a_obj_ids,
                $this->query_parser->getQuery()
            );
        } catch (Exception $e) {
            ilLoggerFactory::getLogger('src')->error('Highlighting failed with message: ' . $e->getMessage());
            return new ilLuceneHighlighterResultParser();
        }
 
        $this->highlighter = new ilLuceneHighlighterResultParser();
        $this->highlighter->setResultString($res);
        $this->highlighter->parse();
 
        return $this->highlighter;
    }

References Vendor\Package\$e, $highlighter, $res, CLIENT_ID, ilRpcClientFactory\factory(), and ilLoggerFactory\getLogger().

Here is the call graph for this function:

◆ nextResultPage()

ilLuceneSearcher::nextResultPage ( )

get next result page

Definition at line 128 of file class.ilLuceneSearcher.php.

                                    : void
    {
        $this->page_number++;
        $this->performSearch();
    }

References performSearch().

Here is the call graph for this function:

◆ performSearch()

ilLuceneSearcher::performSearch ( )

protected

search lucene

@noinspection PhpUndefinedMethodInspection

Definition at line 161 of file class.ilLuceneSearcher.php.

                                      : void
    {
        if (!$this->query_parser->getQuery()) {
            return;
        }
        try {
            switch ($this->getType()) {
 
                case self::TYPE_USER:
                    $res = ilRpcClientFactory::factory('RPCSearchHandler')->searchUsers(
                        CLIENT_ID . '_' . $this->setting->get('inst_id', '0'),
                        $this->query_parser->getQuery()
                    );
                    break;
 
                case self::TYPE_STANDARD:
                default:
                    $res = ilRpcClientFactory::factory('RPCSearchHandler')->search(
                        CLIENT_ID . '_' . $this->setting->get('inst_id', '0'),
                        $this->query_parser->getQuery(),
                        $this->getPageNumber()
                    );
                    break;
 
            }
            ilLoggerFactory::getLogger('src')->debug('Searching for: ' . $this->query_parser->getQuery());
        } catch (Exception $e) {
            ilLoggerFactory::getLogger('src')->error('Searching failed with message: ' . $e->getMessage());
            return;
        }
 
        ilLoggerFactory::getLogger('src')->dump($res);
 
        // Parse results
        $parser = new ilLuceneSearchResultParser($res);
        $parser->parse($this->result);
    }

References Vendor\Package\$e, $res, CLIENT_ID, ilRpcClientFactory\factory(), ilLoggerFactory\getLogger(), getType(), TYPE_STANDARD, and TYPE_USER.

Referenced by nextResultPage(), and search().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ search()

ilLuceneSearcher::search ( )

Search.

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

                            : void
    {
        $this->performSearch();
    }

References performSearch().

Here is the call graph for this function:

◆ setType()

ilLuceneSearcher::setType ( int $a_type )

Set search type.

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

                                        : void
    {
        $this->type = $a_type;
    }

Field Documentation

◆ $highlighter

ilLuceneHighlighterResultParser ilLuceneSearcher::$highlighter = null

private

Definition at line 44 of file class.ilLuceneSearcher.php.

Referenced by getHighlighter(), and highlight().

◆ $instance

ilLuceneSearcher ilLuceneSearcher::$instance = null

staticprivate

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

Referenced by getInstance().

◆ $page_number

int ilLuceneSearcher::$page_number = 1

private

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

Referenced by getPageNumber().

◆ $query_parser

ilLuceneQueryParser ilLuceneSearcher::$query_parser

private

Definition at line 42 of file class.ilLuceneSearcher.php.

◆ $result

ilLuceneSearchResult ilLuceneSearcher::$result

private

Definition at line 43 of file class.ilLuceneSearcher.php.

Referenced by getResult().

◆ $setting

ilSetting ilLuceneSearcher::$setting

protected

Definition at line 48 of file class.ilLuceneSearcher.php.

◆ $type

int ilLuceneSearcher::$type = self::TYPE_STANDARD

private

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

Referenced by getType().

◆ TYPE_STANDARD

const ilLuceneSearcher::TYPE_STANDARD = 1

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

Referenced by ilSearchAutoComplete\getLuceneList(), and performSearch().

◆ TYPE_USER

const ilLuceneSearcher::TYPE_USER = 2

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

Referenced by performSearch(), and ilLuceneUserSearchGUI\performSearch().

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

Services/Search/classes/Lucene/class.ilLuceneSearcher.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getHighlighter()

◆ getInstance()

◆ getPageNumber()

◆ getResult()

◆ getType()

◆ highlight()

◆ nextResultPage()

◆ performSearch()

◆ search()

◆ setType()

Field Documentation

◆ $highlighter

◆ $instance

◆ $page_number

◆ $query_parser

◆ $result

◆ $setting

◆ $type

◆ TYPE_STANDARD

◆ TYPE_USER