HumHub Documentation (unofficial)

Lucene
in package

Tags
category

Zend

Table of Contents

Properties

$_defaultSearchField  : string
Default field name for search
$_resultSetLimit  : int
Result set limit
$_termsPerQueryLimit  : int
Terms per query limit

Methods

__construct()  : mixed
create()  : SearchIndexInterface
Create index
getDefaultSearchField()  : string
Get default search field.
getResultSetLimit()  : int
Get result set limit.
getTermsPerQueryLimit()  : int
Get result set limit.
open()  : SearchIndexInterface
Open index
setDefaultSearchField()  : void
Set default search field.
setResultSetLimit()  : void
Set result set limit.
setTermsPerQueryLimit()  : void
Set terms per query limit.

Properties

$_defaultSearchField

Default field name for search

private static string $_defaultSearchField = null

Null means search through all fields

$_resultSetLimit

Result set limit

private static int $_resultSetLimit = 0

0 means no limit

$_termsPerQueryLimit

Terms per query limit

private static int $_termsPerQueryLimit = 1024

0 means no limit

Methods

getDefaultSearchField()

Get default search field.

public static getDefaultSearchField() : string

Null means, that search is performed through all fields by default

Return values
string

getResultSetLimit()

Get result set limit.

public static getResultSetLimit() : int

0 means no limit

Return values
int

getTermsPerQueryLimit()

Get result set limit.

public static getTermsPerQueryLimit() : int

0 (default) means no limit

Return values
int

setDefaultSearchField()

Set default search field.

public static setDefaultSearchField(string $fieldName) : void

Null means, that search is performed through all fields by default

Default value is null

Parameters
$fieldName : string

setResultSetLimit()

Set result set limit.

public static setResultSetLimit(int $limit) : void

0 (default) means no limit

Parameters
$limit : int

setTermsPerQueryLimit()

Set terms per query limit.

public static setTermsPerQueryLimit(int $limit) : void

0 means no limit

Parameters
$limit : int

        
On this page

Search results