Search/Lucene/Interface.php

Show:

inherited

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 [email protected] 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
Version: $Id$

\Zend_Search_Lucene_Interface
jump to top

Package: Zend_Search_Lucene

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

Methods

addDocument(\Zend_Search_Lucene_Document $document) : void

Adds a document to this index.

Parameters

Name	Type	Description
$document	\Zend_Search_Lucene_Document

commit() : void

Commit changes resulting from delete() or undeleteAll() operations.

count() : integer

Returns the total number of documents in this index (including deleted documents).

Returns

Type	Description
integer

delete(integer | \Zend_Search_Lucene_Search_QueryHit $id) : void

Deletes a document from the index.

$id is an internal document id

Parameters

Name	Type	Description
$id	integer \| \Zend_Search_Lucene_Search_QueryHit

Throws

Exception	Description
\Zend_Search_Lucene_Exception

docFreq(\Zend_Search_Lucene_Index_Term $term) : integer

Returns the number of documents in this index containing the $term.

Parameters

Name	Type	Description
$term	\Zend_Search_Lucene_Index_Term

Returns

Type	Description
integer

find(mixed $query) : array

Performs a query against the index and returns an array of Zend_Search_Lucene_Search_QueryHit objects.

Input is a string or Zend_Search_Lucene_Search_Query.

Parameters

Name	Type	Description
$query	mixed

Returns

Type	Description
array	Zend_Search_Lucene_Search_QueryHit

Throws

Exception	Description
\Zend_Search_Lucene_Exception

getActualGeneration(\Zend_Search_Lucene_Storage_Directory $directory) : integer

static

Get current generation number

Returns generation number 0 means pre-2.1 index format -1 means there are no segments files.

Parameters

Name	Type	Description
$directory	\Zend_Search_Lucene_Storage_Directory

Returns

Type	Description
integer

Throws

Exception	Description
\Zend_Search_Lucene_Exception

getDefaultSearchField() : string

static

Get default search field.

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

Returns

Type	Description
string

getDirectory() : \Zend_Search_Lucene_Storage_Directory

Returns the Zend_Search_Lucene_Storage_Directory instance for this index.

Returns

Type	Description
\Zend_Search_Lucene_Storage_Directory

getDocument(integer | \Zend_Search_Lucene_Search_QueryHit $id) : \Zend_Search_Lucene_Document

Returns a Zend_Search_Lucene_Document object for the document number $id in this index.

Parameters

Name	Type	Description
$id	integer \| \Zend_Search_Lucene_Search_QueryHit

Returns

Type	Description
\Zend_Search_Lucene_Document

getFieldNames(boolean $indexed = false) : array

Returns a list of all unique field names that exist in this index.

Parameters

Name	Type	Description
$indexed	boolean

Returns

Type	Description
array

getFormatVersion() : integer

Get index format version

Returns

Type	Description
integer

getMaxBufferedDocs() : integer

Retrieve index maxBufferedDocs option

maxBufferedDocs is a minimal number of documents required before the buffered in-memory documents are written into a new Segment Default value is 10

Returns

Type	Description
integer

getMaxMergeDocs() : integer

Retrieve index maxMergeDocs option

maxMergeDocs is a largest number of documents ever merged by addDocument(). Small values (e.g., less than 10,000) are best for interactive indexing, as this limits the length of pauses while indexing to a few seconds. Larger values are best for batched indexing and speedier searches. Default value is PHP_INT_MAX

Returns

Type	Description
integer

getMergeFactor() : integer

Retrieve index mergeFactor option

mergeFactor determines how often segment indices are merged by addDocument(). With smaller values, less RAM is used while indexing, and searches on unoptimized indices are faster, but indexing speed is slower. With larger values, more RAM is used during indexing, and while searches on unoptimized indices are slower, indexing is faster. Thus larger values (> 10) are best for batch index creation, and smaller values (< 10) for indices that are interactively maintained. Default value is 10

Returns

Type	Description
integer

getResultSetLimit() : integer

static

Set result set limit.

0 means no limit

Returns

Type	Description
integer

getSegmentFileName(integer $generation) : string

static

Get segments file name

Parameters

Name	Type	Description
$generation	integer

Returns

Type	Description
string

getSimilarity() : \Zend_Search_Lucene_Search_Similarity

Retrive similarity used by index reader

Returns

Type	Description
\Zend_Search_Lucene_Search_Similarity

hasDeletions() : boolean

Returns true if any documents have been deleted from this index.

Returns

Type	Description
boolean

hasTerm(\Zend_Search_Lucene_Index_Term $term) : boolean

Returns true if index contain documents with specified term.

Is used for query optimization.

Parameters

Name	Type	Description
$term	\Zend_Search_Lucene_Index_Term

Returns

Type	Description
boolean

isDeleted(integer $id) : boolean

Checks, that document is deleted

Parameters

Name	Type	Description
$id	integer

Returns

Type	Description
boolean

Throws

Exception	Description
\Zend_Search_Lucene_Exception	Exception is thrown if $id is out of the range

maxDoc() : integer

Returns one greater than the largest possible document number.

This may be used to, e.g., determine how big to allocate a structure which will have an element for every document number in an index.

Returns

Type	Description
integer

norm(integer $id, string $fieldName) : float

Returns a normalization factor for "field, document" pair.

Parameters

Name	Type	Description
$id	integer
$fieldName	string

Returns

Type	Description
float

numDocs() : integer

Returns the total number of non-deleted documents in this index.

Returns

Type	Description
integer

optimize() : void

Optimize index.

Merges all segments into one

setDefaultSearchField(string $fieldName) : void

static

Set default search field.

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

Parameters

Name	Type	Description
$fieldName	string

setFormatVersion(int $formatVersion) : void

Set index format version.

Index is converted to this format at the nearest upfdate time

Parameters

Name	Type	Description
$formatVersion	int

Throws

Exception	Description
\Zend_Search_Lucene_Exception

setMaxBufferedDocs(integer $maxBufferedDocs) : void

Set index maxBufferedDocs option

maxBufferedDocs is a minimal number of documents required before the buffered in-memory documents are written into a new Segment Default value is 10

Parameters

Name	Type	Description
$maxBufferedDocs	integer

setMaxMergeDocs(integer $maxMergeDocs) : void

Set index maxMergeDocs option

Parameters

Name	Type	Description
$maxMergeDocs	integer

setMergeFactor( $mergeFactor) : void

Set index mergeFactor option

Parameters

Name	Type	Description
$mergeFactor

setResultSetLimit(integer $limit) : void

static

Set result set limit.

0 (default) means no limit

Parameters

Name	Type	Description
$limit	integer

termDocs(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter | null $docsFilter = null) : array

Returns IDs of all the documents containing term.

Parameters

Name	Type	Description
$term	\Zend_Search_Lucene_Index_Term
$docsFilter	\Zend_Search_Lucene_Index_DocsFilter \| null

Returns

Type	Description
array

termDocsFilter(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter | null $docsFilter = null) : \Zend_Search_Lucene_Index_DocsFilter

Returns documents filter for all documents containing term.

It performs the same operation as termDocs, but return result as Zend_Search_Lucene_Index_DocsFilter object

Parameters

Name	Type	Description
$term	\Zend_Search_Lucene_Index_Term
$docsFilter	\Zend_Search_Lucene_Index_DocsFilter \| null

Returns

Type	Description
\Zend_Search_Lucene_Index_DocsFilter

termFreqs(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter | null $docsFilter = null) : integer

Returns an array of all term freqs.

Return array structure: array( docId => freq, ...)

Parameters

Name	Type	Description
$term	\Zend_Search_Lucene_Index_Term
$docsFilter	\Zend_Search_Lucene_Index_DocsFilter \| null

Returns

Type	Description
integer

termPositions(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter | null $docsFilter = null) : array

Returns an array of all term positions in the documents.

Return array structure: array( docId => array( pos1, pos2, ...), ...)

Parameters

Name	Type	Description
$term	\Zend_Search_Lucene_Index_Term
$docsFilter	\Zend_Search_Lucene_Index_DocsFilter \| null

Returns

Type	Description
array

terms() : array

Returns an array of all terms in this index.

Returns

Type	Description
array

undeleteAll() : void

Undeletes all documents currently marked as deleted in this index.

Search/Lucene/Interface.php

\Zend_Search_Lucene_Interfacejump to top

Methods

\Zend_Search_Lucene_Interface
jump to top