Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

integer
$_defaultPrefixLength= '3'
Default non-fuzzy prefix length
3
Details
array
$_matches= 'null'
Matched terms.
Matched terms list. It's filled during the search (rewrite operation) and may be used for search result post-processing
Array of Zend_Search_Lucene_Index_Term objects
null
Details
$_maxDistances= 'array()'
Array of precalculated max distances
keys are integers representing a word size
array()
Details
float
$_minimumSimilarity= ''
A value between 0 and 1 to set the required similarity between the query term and the matching terms. For example, for a _minimumSimilarity of 0.5 a term of the same length as the query term is considered similar to the query term if the edit distance between both terms is less than length(term)*0.5

__construct(
\Zend_Search_Lucene_Index_Term $term, float $minimumSimilarity
=
self::DEFAULT_MIN_SIMILARITY, integer $prefixLength
=
null
)
:
void
Zend_Search_Lucene_Search_Query_Wildcard constructor.
Name | Type | Description |
---|---|---|
$term | \Zend_Search_Lucene_Index_Term | |
$minimumSimilarity | float | |
$prefixLength | integer |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |

_calculateMaxDistance(
integer $prefixLength, integer $termLength, integer $length
)
:
integer
Calculate maximum distance for specified word length
Name | Type | Description |
---|---|---|
$prefixLength | integer | |
$termLength | integer | |
$length | integer |
Type | Description |
---|---|
integer |

_highlightMatches(
\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter
)
:
void
Query specific matches highlighting
Name | Type | Description |
---|---|---|
$highlighter | \Zend_Search_Lucene_Search_Highlighter_Interface | Highlighter object (also contains doc for highlighting) |

createWeight(
\Zend_Search_Lucene_Interface $reader
)
:
\Zend_Search_Lucene_Search_Weight
Constructs an appropriate Weight implementation for this query.
Name | Type | Description |
---|---|---|
$reader | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
\Zend_Search_Lucene_Search_Weight |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |

execute(
\Zend_Search_Lucene_Interface $reader, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter
=
null
)
:
void
Execute query in context of index reader It also initializes necessary internal structures
Name | Type | Description |
---|---|---|
$reader | \Zend_Search_Lucene_Interface | |
$docsFilter | \Zend_Search_Lucene_Index_DocsFilter|null |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |

getDefaultPrefixLength(
)
:
integer
Get default non-fuzzy prefix length
Type | Description |
---|---|
integer |

matchedDocs(
)
:
array
Get document ids likely matching the query
It's an array with document ids as keys (performance considerations)
Type | Description |
---|---|
array |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |

optimize(
\Zend_Search_Lucene_Interface $index
)
:
\Zend_Search_Lucene_Search_Query
Optimize query in the context of specified index
Name | Type | Description |
---|---|---|
$index | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
\Zend_Search_Lucene_Search_Query |

rewrite(
\Zend_Search_Lucene_Interface $index
)
:
\Zend_Search_Lucene_Search_Query
Re-write query into primitive queries in the context of specified index
Name | Type | Description |
---|---|---|
$index | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
\Zend_Search_Lucene_Search_Query |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |

score(
integer $docId, \Zend_Search_Lucene_Interface $reader
)
:
float
Score specified document
Name | Type | Description |
---|---|---|
$docId | integer | |
$reader | \Zend_Search_Lucene_Interface |
Type | Description |
---|---|
float |
Exception | Description |
---|---|
\Zend_Search_Lucene_Exception |