Search/Lucene/Search/Query/Wildcard.php

Show:

inherited

Classes
- \Zend_Search_Lucene_Search_Query_Wildcard

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Search_Lucene
Subpackage: Search
Version: $Id$

\Zend_Search_Lucene_Search_Query_Wildcard
jump to top

Package: Zend_Search_Lucene\Search

Parent(s): \Zend_Search_Lucene_Search_Query
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

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

Default valuenullDetails

Type: array

integer $_minPrefixLength = 3

static

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

Default value3Details

Type: integer

\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

Type: \Zend_Search_Lucene_Index_Term

Methods

__construct(\Zend_Search_Lucene_Index_Term $pattern) : void

Zend_Search_Lucene_Search_Query_Wildcard constructor.

Parameters

Name	Type	Description
$pattern	\Zend_Search_Lucene_Index_Term

__toString() : string

Print a query

Returns

Type	Description
string

_getPrefix(string $word) : string

static

Get terms prefix

Parameters

Name	Type	Description
$word	string

Returns

Type	Description
string

_highlightMatches(\Zend_Search_Lucene_Search_Highlighter_Interface $highlighter) : void

Query specific matches highlighting

Parameters

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.

Parameters

Name	Type	Description
$reader	\Zend_Search_Lucene_Interface

Returns

Type	Description
\Zend_Search_Lucene_Search_Weight

Throws

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

Parameters

Name	Type	Description
$reader	\Zend_Search_Lucene_Interface
$docsFilter	\Zend_Search_Lucene_Index_DocsFilter \| null

Throws

Exception	Description
\Zend_Search_Lucene_Exception

getMinPrefixLength() : integer

static

Get minimum prefix length

Returns

Type	Description
integer

getPattern() : \Zend_Search_Lucene_Index_Term

Returns query pattern

Returns

Type	Description
\Zend_Search_Lucene_Index_Term

getQueryTerms() : array

Return query terms

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Search_Lucene_Exception

matchedDocs() : array

Get document ids likely matching the query

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

Returns

Type	Description
array

Throws

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

Parameters

Name	Type	Description
$index	\Zend_Search_Lucene_Interface

Returns

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

Parameters

Name	Type	Description
$index	\Zend_Search_Lucene_Interface

Returns

Type	Description
\Zend_Search_Lucene_Search_Query

Throws

Exception	Description
\Zend_Search_Lucene_Exception

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

Score specified document

Parameters

Name	Type	Description
$docId	integer
$reader	\Zend_Search_Lucene_Interface

Returns

Type	Description
float

Throws

Exception	Description
\Zend_Search_Lucene_Exception

setMinPrefixLength(integer $minPrefixLength) : void

static

Set minimum prefix length

Parameters

Name	Type	Description
$minPrefixLength	integer

Search/Lucene/Search/Query/Wildcard.php

\Zend_Search_Lucene_Search_Query_Wildcardjump to top

Properties

Methods

\Zend_Search_Lucene_Search_Query_Wildcard
jump to top