| category |
Zend |
| package |
Zend_Search_Lucene |
| copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
| license |
New BSD License |
| inherited_from |
\Zend_Search_Lucene_MultiSearcher |
Methods
Object constructor.
__construct(array $indices = array())
Inherited
Parameters
$indices
arrayArrays of indices for search
Exceptions
\Zend_Search_Lucene_Exception |
|
Adds a document to this index.
addDocument(\Zend_Search_Lucene_Document $document)
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::addDocument() |
Parameters
$document
\Zend_Search_Lucene_Document
Exceptions
\Zend_Search_Lucene_Exception |
|
Add index for searching.
addIndex(\Zend_Search_Lucene_Interface $index)
Inherited
Parameters
$index
\Zend_Search_Lucene_Interface
Close terms stream
closeTermsStream()
Inherited
Should be used for resources clean up if stream is not read up to the end
Commit changes resulting from delete() or undeleteAll() operations.
commit()
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::commit() |
Returns the total number of documents in this index (including deleted documents).
count() : integer
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::count() |
Returns
integer
Returns term in current position
currentTerm() : \Zend_Search_Lucene_Index_Term | null
Inherited
Returns
\Zend_Search_Lucene_Index_Termnull
Deletes a document from the index.
delete(integer|\Zend_Search_Lucene_Search_QueryHit $id)
Inherited
$id is an internal document id
| inherited_from |
\Zend_Search_Lucene_Interface::delete() |
Parameters
$id
integer\Zend_Search_Lucene_Search_QueryHit
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns the number of documents in this index containing the $term.
docFreq(\Zend_Search_Lucene_Index_Term $term) : integer
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::docFreq() |
Parameters
$term
\Zend_Search_Lucene_Index_Term
Returns
integer
Performs a query against the index and returns an array
of Zend_Search_Lucene_Search_QueryHit objects.
find(mixed $query) : array
Inherited
Input is a string or Zend_Search_Lucene_Search_Query.
| inherited_from |
\Zend_Search_Lucene_Interface::find() |
Parameters
$query
mixed
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
arrayZend_Search_Lucene_Search_QueryHit
Get current generation number
getActualGeneration(\Zend_Search_Lucene_Storage_Directory $directory) : integer
InheritedStatic
Returns generation number
0 means pre-2.1 index format
-1 means there are no segments files.
| inherited_from |
\Zend_Search_Lucene_Interface::getActualGeneration() |
Parameters
$directory
\Zend_Search_Lucene_Storage_Directory
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
integer
Get default search field.
getDefaultSearchField() : string
InheritedStatic
Null means, that search is performed through all fields by default
| inherited_from |
\Zend_Search_Lucene_Interface::getDefaultSearchField() |
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
string
Returns the Zend_Search_Lucene_Storage_Directory instance for this index.
getDirectory() : \Zend_Search_Lucene_Storage_Directory
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::getDirectory() |
Returns
\Zend_Search_Lucene_Storage_Directory
Returns a Zend_Search_Lucene_Document object for the document
number $id in this index.
getDocument(integer|\Zend_Search_Lucene_Search_QueryHit $id) : \Zend_Search_Lucene_Document
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::getDocument() |
Parameters
$id
integer\Zend_Search_Lucene_Search_QueryHit
Exceptions
\Zend_Search_Lucene_Exception |
Exception is thrown if $id is out of the range |
Returns
\Zend_Search_Lucene_Document
Get callback for choosing target index.
getDocumentDistributorCallback() : callback
Inherited
Returns a list of all unique field names that exist in this index.
getFieldNames(boolean $indexed = false) : array
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::getFieldNames() |
Parameters
$indexed
boolean
Returns
array
Retrieve index maxBufferedDocs option
getMaxBufferedDocs() : integer
Inherited
maxBufferedDocs is a minimal number of documents required before
the buffered in-memory documents are written into a new Segment
Default value is 10
| inherited_from |
\Zend_Search_Lucene_Interface::getMaxBufferedDocs() |
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
integer
Retrieve index maxMergeDocs option
getMaxMergeDocs() : integer
Inherited
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
| inherited_from |
\Zend_Search_Lucene_Interface::getMaxMergeDocs() |
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
integer
Retrieve index mergeFactor option
getMergeFactor() : integer
Inherited
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
| inherited_from |
\Zend_Search_Lucene_Interface::getMergeFactor() |
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
integer
Set result set limit.
getResultSetLimit() : integer
InheritedStatic
| inherited_from |
\Zend_Search_Lucene_Interface::getResultSetLimit() |
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
integer
Get segments file name
getSegmentFileName(integer $generation) : string
InheritedStatic
| inherited_from |
\Zend_Search_Lucene_Interface::getSegmentFileName() |
Parameters
$generation
integer
Returns
string
Retrive similarity used by index reader
getSimilarity() : \Zend_Search_Lucene_Search_Similarity
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::getSimilarity() |
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
\Zend_Search_Lucene_Search_Similarity
Returns true if any documents have been deleted from this index.
hasDeletions() : boolean
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::hasDeletions() |
Returns
boolean
Returns true if index contain documents with specified term.
hasTerm(\Zend_Search_Lucene_Index_Term $term) : boolean
Inherited
Is used for query optimization.
| inherited_from |
\Zend_Search_Lucene_Interface::hasTerm() |
Parameters
$term
\Zend_Search_Lucene_Index_Term
Returns
boolean
Checks, that document is deleted
isDeleted(integer $id) : boolean
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::isDeleted() |
Parameters
$id
integer
Exceptions
\Zend_Search_Lucene_Exception |
Exception is thrown if $id is out of the range |
Returns
boolean
Returns one greater than the largest possible document number.
maxDoc() : integer
Inherited
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.
| inherited_from |
\Zend_Search_Lucene_Interface::maxDoc() |
Returns
integer
Scans terms dictionary and returns next term
nextTerm() : \Zend_Search_Lucene_Index_Term | null
Inherited
Returns
\Zend_Search_Lucene_Index_Termnull
Returns a normalization factor for "field, document" pair.
norm(integer $id, string $fieldName) : float
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::norm() |
Parameters
$id
integer
$fieldName
string
Returns
float
Returns the total number of non-deleted documents in this index.
numDocs() : integer
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::numDocs() |
Returns
integer
Optimize index.
optimize()
Inherited
Merges all segments into one
| inherited_from |
\Zend_Search_Lucene_Interface::optimize() |
Reset terms stream.
resetTermsStream()
Inherited
Set default search field.
setDefaultSearchField(string $fieldName)
InheritedStatic
Null means, that search is performed through all fields by default
Default value is null
| inherited_from |
\Zend_Search_Lucene_Interface::setDefaultSearchField() |
Parameters
$fieldName
string
Set callback for choosing target index.
setDocumentDistributorCallback(callback $callback)
Inherited
Parameters
$callback
callback
Exceptions
\Zend_Search_Lucene_Exception |
|
Set index maxBufferedDocs option
setMaxBufferedDocs(integer $maxBufferedDocs)
Inherited
maxBufferedDocs is a minimal number of documents required before
the buffered in-memory documents are written into a new Segment
Default value is 10
| inherited_from |
\Zend_Search_Lucene_Interface::setMaxBufferedDocs() |
Parameters
$maxBufferedDocs
integer
Set index maxMergeDocs option
setMaxMergeDocs(integer $maxMergeDocs)
Inherited
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
| inherited_from |
\Zend_Search_Lucene_Interface::setMaxMergeDocs() |
Parameters
$maxMergeDocs
integer
Set index mergeFactor option
setMergeFactor($mergeFactor)
Inherited
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
| inherited_from |
\Zend_Search_Lucene_Interface::setMergeFactor() |
Parameters
$mergeFactor
Set result set limit.
setResultSetLimit(integer $limit)
InheritedStatic
0 (default) means no limit
| inherited_from |
\Zend_Search_Lucene_Interface::setResultSetLimit() |
Parameters
$limit
integer
Skip terms stream up to specified term preffix.
skipTo(\Zend_Search_Lucene_Index_Term $prefix)
Inherited
Prefix contains fully specified field info and portion of searched term
Parameters
$prefix
\Zend_Search_Lucene_Index_Term
Returns IDs of all the documents containing term.
termDocs(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null) : array
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::termDocs() |
Parameters
$term
\Zend_Search_Lucene_Index_Term
$docsFilter
\Zend_Search_Lucene_Index_DocsFilternull
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
array
Returns documents filter for all documents containing term.
termDocsFilter(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null) : \Zend_Search_Lucene_Index_DocsFilter
Inherited
It performs the same operation as termDocs, but return result as
Zend_Search_Lucene_Index_DocsFilter object
| inherited_from |
\Zend_Search_Lucene_Interface::termDocsFilter() |
Parameters
$term
\Zend_Search_Lucene_Index_Term
$docsFilter
\Zend_Search_Lucene_Index_DocsFilternull
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
\Zend_Search_Lucene_Index_DocsFilter
Returns an array of all term freqs.
termFreqs(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null) : integer
Inherited
Return array structure: array( docId => freq, ...)
| inherited_from |
\Zend_Search_Lucene_Interface::termFreqs() |
Parameters
$term
\Zend_Search_Lucene_Index_Term
$docsFilter
\Zend_Search_Lucene_Index_DocsFilternull
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
integer
Returns an array of all term positions in the documents.
termPositions(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null) : array
Inherited
Return array structure: array( docId => array( pos1, pos2, ...), ...)
| inherited_from |
\Zend_Search_Lucene_Interface::termPositions() |
Parameters
$term
\Zend_Search_Lucene_Index_Term
$docsFilter
\Zend_Search_Lucene_Index_DocsFilternull
Exceptions
\Zend_Search_Lucene_Exception |
|
Returns
array
Returns an array of all terms in this index.
terms() : array
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::terms() |
Returns
array
Undeletes all documents currently marked as deleted in this index.
undeleteAll()
Inherited
| inherited_from |
\Zend_Search_Lucene_Interface::undeleteAll() |
Properties
Callback used to choose target index for new documents
$_documentDistributorCallBack : callback
Function/method signature:
Zend_Search_Lucene_Interface callbackFunction(Zend_Search_Lucene_Document $document, array $indices);
null means "default documents distributing algorithm"
List of indices for searching.
$_indices : array
Array of Zend_Search_Lucene_Interface objects
Terms stream priority queue object
$_termsStream : \Zend_Search_Lucene_TermStreamsPriorityQueue