Public Member Functions
	getBoost ()
	Gets the boost for this clause.

	setBoost ($boost)
	Sets the boost for this query clause to $boost.

	score ($docId, Zend_Search_Lucene_Interface $reader)
	Score specified document.

	matchedDocs ()
	Get document ids likely matching the query.

	execute (Zend_Search_Lucene_Interface $reader, $docsFilter=null)
	Execute query in context of index reader It also initializes necessary internal structures.

	createWeight (Zend_Search_Lucene_Interface $reader)
	Constructs an appropriate Weight implementation for this query.

	rewrite (Zend_Search_Lucene_Interface $index)
	Re-write query into primitive queries in the context of specified index.

	optimize (Zend_Search_Lucene_Interface $index)
	Optimize query in the context of specified index.

	reset ()
	Reset query, so it can be reused within other queries or with other indeces.

	__toString ()
	Print a query.

	getQueryTerms ()
	Return query terms.

	highlightMatches ($inputHTML, $defaultEncoding= '', $highlighter=null)
	Highlight matches in $inputHTML.

	htmlFragmentHighlightMatches ($inputHtmlFragment, $encoding= 'UTF-8', $highlighter=null)
	Highlight matches in $inputHtmlFragment and return it (without HTML header and body tag)

Protected Member Functions
	_initWeight (Zend_Search_Lucene_Interface $reader)
	Constructs an initializes a Weight for a _top-level_query_.

	_highlightMatches (Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
	Query specific matches highlighting.

Protected Attributes
	$_weight = null

Member Function Documentation

__toString ( )

abstract

Print a query.

Returns: string

_highlightMatches ( Zend_Search_Lucene_Search_Highlighter_Interface $highlighter )

abstractprotected

Query specific matches highlighting.

Parameters

Zend_Search_Lucene_Search_Highlighter_Interface $highlighter Highlighter object (also contains doc for highlighting)

_initWeight ( Zend_Search_Lucene_Interface $reader )

protected

Constructs an initializes a Weight for a _top-level_query_.

Parameters

Zend_Search_Lucene_Interface $reader

createWeight ( Zend_Search_Lucene_Interface $reader )

abstract

Constructs an appropriate Weight implementation for this query.

Parameters

Zend_Search_Lucene_Interface $reader

Returns: Zend_Search_Lucene_Search_Weight

execute	(	Zend_Search_Lucene_Interface	$reader,
			$docsFilter = `null`
	)

abstract

Execute query in context of index reader It also initializes necessary internal structures.

Query specific implementation

Parameters

Zend_Search_Lucene_Interface	$reader
Zend_Search_Lucene_Index_DocsFilter \| null	$docsFilter

getBoost ( )

Gets the boost for this clause.

Documents matching this clause will (in addition to the normal weightings) have their score multiplied by boost. The boost is 1.0 by default.

Returns: float

getQueryTerms ( )

abstract

Return query terms.

Returns: array

highlightMatches	(	$inputHTML,
		$defaultEncoding = `''`,
		$highlighter = `null`
	)

Highlight matches in $inputHTML.

Parameters

string	$inputHTML
string	$defaultEncoding	HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag.
Zend_Search_Lucene_Search_Highlighter_Interface \| null	$highlighter

Returns: string

Zend_Search_Lucene_Document_Html

htmlFragmentHighlightMatches	(	$inputHtmlFragment,
		$encoding = `'UTF-8'`,
		$highlighter = `null`
	)

Highlight matches in $inputHtmlFragment and return it (without HTML header and body tag)

Parameters

string	$inputHtmlFragment
string	$encoding	Input HTML string encoding
Zend_Search_Lucene_Search_Highlighter_Interface \| null	$highlighter

Returns: string

Zend_Search_Lucene_Document_Html

matchedDocs ( )

abstract

Get document ids likely matching the query.

It's an array with document ids as keys (performance considerations)

Returns: array

optimize ( Zend_Search_Lucene_Interface $index )

abstract

Optimize query in the context of specified index.

Parameters

Zend_Search_Lucene_Interface $index

Returns: Zend_Search_Lucene_Search_Query

reset ( )

Reset query, so it can be reused within other queries or with other indeces.

rewrite ( Zend_Search_Lucene_Interface $index )

abstract

Re-write query into primitive queries in the context of specified index.

Parameters

Zend_Search_Lucene_Interface $index

Returns: Zend_Search_Lucene_Search_Query

score	(		$docId,
		Zend_Search_Lucene_Interface	$reader
	)

abstract

Score specified document.

Parameters

integer	$docId
Zend_Search_Lucene_Interface	$reader

Returns: float

setBoost ( $boost )

Sets the boost for this query clause to $boost.

Parameters

float $boost

Member Data Documentation

$_weight = null

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

Member Data Documentation