API Documentation

Search/Lucene/Search/Query/Wildcard.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Search_Lucene
subpackage
Search
version
$Id: Wildcard.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Search_Lucene_Search_Query_Wildcard

Description

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.

Zend_Search_Lucene_Search_Query_Wildcard

Extends from
Zend_Search_Lucene_Search_Query
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Search_Lucene
subpackage
Search
Properties
$_pattern
$_matches
$_minPrefixLength
Methods
__construct
getMinPrefixLength
setMinPrefixLength
_getPrefix
rewrite
optimize
getPattern
getQueryTerms
createWeight
execute
matchedDocs
score
_highlightMatches
__toString

Description

Properties

$_matches

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

Details

$_matches
array
visibility
private
default
null
final
false
static
false

$_minPrefixLength

integer $_minPrefixLength = '3'

Minimum term prefix length (number of minimum non-wildcard characters)

Details

$_minPrefixLength
integer
visibility
private
default
3
final
false
static
true

$_pattern

Zend_Search_Lucene_Index_Term $_pattern = ''

Search pattern.

Field has to be fully specified or has to be null Text may contain '*' or '?' symbols

Details

$_pattern
Zend_Search_Lucene_Index_Term
visibility
private
default
final
false
static
false

Methods

__construct

__construct( Zend_Search_Lucene_Index_Term $pattern ) :

Zend_Search_Lucene_Search_Query_Wildcard constructor.

Arguments
$pattern
Zend_Search_Lucene_Index_Term
Details
visibility
public
final
false
static
false

__toString

__toString( ) : string

Print a query

Output
string
Details
visibility
public
final
false
static
false

_getPrefix

_getPrefix( string $word ) : string

Get terms prefix

Arguments
$word
string
Output
string
Details
visibility
private
final
false
static
true

_highlightMatches

_highlightMatches( Zend_Search_Lucene_Search_Highlighter_Interface $highlighter ) :

Query specific matches highlighting

Arguments
$highlighter
Zend_Search_Lucene_Search_Highlighter_Interface
Highlighter object (also contains doc for highlighting)
Details
visibility
protected
final
false
static
false

createWeight

createWeight( Zend_Search_Lucene_Interface $reader ) : Zend_Search_Lucene_Search_Weight

Constructs an appropriate Weight implementation for this query.

Arguments
$reader
Zend_Search_Lucene_Interface
Details
visibility
public
final
false
static
false
throws

execute

execute( Zend_Search_Lucene_Interface $reader, Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null ) :

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

Arguments
$reader
Zend_Search_Lucene_Interface
$docsFilter
Zend_Search_Lucene_Index_DocsFilternull
Details
visibility
public
final
false
static
false
throws

getMinPrefixLength

getMinPrefixLength( ) : integer

Get minimum prefix length

Output
integer
Details
visibility
public
final
false
static
true

getPattern

getPattern( ) : Zend_Search_Lucene_Index_Term

Returns query pattern

Details
visibility
public
final
false
static
false

getQueryTerms

getQueryTerms( ) : array

Return query terms

Output
array
Details
visibility
public
final
false
static
false
throws

matchedDocs

matchedDocs( ) : array

Get document ids likely matching the query

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

Output
array
Details
visibility
public
final
false
static
false
throws

optimize

optimize( Zend_Search_Lucene_Interface $index ) : Zend_Search_Lucene_Search_Query

Optimize query in the context of specified index

Arguments
$index
Zend_Search_Lucene_Interface
Details
visibility
public
final
false
static
false

rewrite

rewrite( Zend_Search_Lucene_Interface $index ) : Zend_Search_Lucene_Search_Query

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

Arguments
$index
Zend_Search_Lucene_Interface
Details
visibility
public
final
false
static
false
throws

score

score( integer $docId, Zend_Search_Lucene_Interface $reader ) : float

Score specified document

Arguments
$docId
integer
$reader
Zend_Search_Lucene_Interface
Output
float
Details
visibility
public
final
false
static
false
throws

setMinPrefixLength

setMinPrefixLength( integer $minPrefixLength ) :

Set minimum prefix length

Arguments
$minPrefixLength
integer
Details
visibility
public
final
false
static
true
Documentation was generated by DocBlox.