Search/Lucene/Proxy.php
inherited
Classes
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-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Search_Lucene
- Version
- $Id: Proxy.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Search_Lucene_Proxy
Proxy class intended to be used in userland.
It tracks, when index object goes out of scope and forces ndex closing
- Implements
- \Zend_Search_Lucene_Interface
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
Methods
__construct(\Zend_Search_Lucene_Interface $index) : voidObject constructor
| Name | Type | Description |
|---|---|---|
| $index | \Zend_Search_Lucene_Interface |
__destruct() : voidObject destructor
addDocument(\Zend_Search_Lucene_Document $document) : voidAdds a document to this index.
| Name | Type | Description |
|---|---|---|
| $document | \Zend_Search_Lucene_Document |
closeTermsStream() : voidClose terms stream
Should be used for resources clean up if stream is not read up to the end
commit() : voidCommit changes resulting from delete() or undeleteAll() operations.
count() : integerReturns the total number of documents in this index (including deleted documents).
| Type | Description |
|---|---|
| integer |
currentTerm() : \Zend_Search_Lucene_Index_Term | nullReturns term in current position
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Index_Term | null |
delete(integer | \Zend_Search_Lucene_Search_QueryHit $id) : voidDeletes a document from the index.
$id is an internal document id
| Name | Type | Description |
|---|---|---|
| $id | integer | \Zend_Search_Lucene_Search_QueryHit |
| Exception | Description |
|---|---|
| \Zend_Search_Lucene_Exception |
docFreq(\Zend_Search_Lucene_Index_Term $term) : integerReturns the number of documents in this index containing the $term.
| Name | Type | Description |
|---|---|---|
| $term | \Zend_Search_Lucene_Index_Term |
| Type | Description |
|---|---|
| integer |
find(mixed $query) : arrayPerforms 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.
| Name | Type | Description |
|---|---|---|
| $query | mixed |
| Type | Description |
|---|---|
| array | Zend_Search_Lucene_Search_QueryHit |
| Exception | Description |
|---|---|
| \Zend_Search_Lucene_Exception |
getActualGeneration(\Zend_Search_Lucene_Storage_Directory $directory) : integerGet current generation number
Returns generation number 0 means pre-2.1 index format -1 means there are no segments files.
| Name | Type | Description |
|---|---|---|
| $directory | \Zend_Search_Lucene_Storage_Directory |
| Type | Description |
|---|---|
| integer |
| Exception | Description |
|---|---|
| \Zend_Search_Lucene_Exception |
getDefaultSearchField() : stringGet default search field.
Null means, that search is performed through all fields by default
| Type | Description |
|---|---|
| string |
getDirectory() : \Zend_Search_Lucene_Storage_DirectoryReturns the Zend_Search_Lucene_Storage_Directory instance for this index.
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Storage_Directory |
getDocument(integer | \Zend_Search_Lucene_Search_QueryHit $id) : \Zend_Search_Lucene_DocumentReturns a Zend_Search_Lucene_Document object for the document number $id in this index.
| Name | Type | Description |
|---|---|---|
| $id | integer | \Zend_Search_Lucene_Search_QueryHit |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Document |
getFieldNames(boolean $indexed = false) : arrayReturns a list of all unique field names that exist in this index.
| Name | Type | Description |
|---|---|---|
| $indexed | boolean |
| Type | Description |
|---|---|
| array |
getFormatVersion() : integerGet index format version
| Type | Description |
|---|---|
| integer |
getMaxBufferedDocs() : integerRetrieve 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
| Type | Description |
|---|---|
| integer |
getMaxMergeDocs() : integerRetrieve 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
| Type | Description |
|---|---|
| integer |
getMergeFactor() : integerRetrieve 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
| Type | Description |
|---|---|
| integer |
getResultSetLimit() : integerSet result set limit.
0 means no limit
| Type | Description |
|---|---|
| integer |
getSegmentFileName(integer $generation) : stringGet segments file name
| Name | Type | Description |
|---|---|---|
| $generation | integer |
| Type | Description |
|---|---|
| string |
getSimilarity() : \Zend_Search_Lucene_Search_SimilarityRetrive similarity used by index reader
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Search_Similarity |
hasDeletions() : booleanReturns true if any documents have been deleted from this index.
| Type | Description |
|---|---|
| boolean |
hasTerm(\Zend_Search_Lucene_Index_Term $term) : booleanReturns true if index contain documents with specified term.
Is used for query optimization.
| Name | Type | Description |
|---|---|---|
| $term | \Zend_Search_Lucene_Index_Term |
| Type | Description |
|---|---|
| boolean |
isDeleted(integer $id) : booleanChecks, that document is deleted
| Name | Type | Description |
|---|---|---|
| $id | integer |
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Search_Lucene_Exception | Exception is thrown if $id is out of the range |
maxDoc() : integerReturns 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.
| Type | Description |
|---|---|
| integer |
nextTerm() : \Zend_Search_Lucene_Index_Term | nullScans terms dictionary and returns next term
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Index_Term | null |
norm(integer $id, string $fieldName) : floatReturns a normalization factor for "field, document" pair.
| Name | Type | Description |
|---|---|---|
| $id | integer | |
| $fieldName | string |
| Type | Description |
|---|---|
| float |
numDocs() : integerReturns the total number of non-deleted documents in this index.
| Type | Description |
|---|---|
| integer |
optimize() : voidOptimize index.
Merges all segments into one
resetTermsStream() : voidReset terms stream.
setDefaultSearchField(string $fieldName) : voidSet default search field.
Null means, that search is performed through all fields by default
Default value is null
| Name | Type | Description |
|---|---|---|
| $fieldName | string |
setFormatVersion(int $formatVersion) : voidSet index format version.
Index is converted to this format at the nearest upfdate time
| Name | Type | Description |
|---|---|---|
| $formatVersion | int |
| Exception | Description |
|---|---|
| \Zend_Search_Lucene_Exception |
setMaxBufferedDocs(integer $maxBufferedDocs) : voidSet 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
| Name | Type | Description |
|---|---|---|
| $maxBufferedDocs | integer |
setMaxMergeDocs(integer $maxMergeDocs) : voidSet 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
| Name | Type | Description |
|---|---|---|
| $maxMergeDocs | integer |
setMergeFactor( $mergeFactor) : voidSet 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
| Name | Type | Description |
|---|---|---|
| $mergeFactor |
setResultSetLimit(integer $limit) : voidSet result set limit.
0 (default) means no limit
| Name | Type | Description |
|---|---|---|
| $limit | integer |
skipTo(\Zend_Search_Lucene_Index_Term $prefix) : voidSkip terms stream up to specified term preffix.
Prefix contains fully specified field info and portion of searched term
| Name | Type | Description |
|---|---|---|
| $prefix | \Zend_Search_Lucene_Index_Term |
termDocs(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter | null $docsFilter = null) : arrayReturns IDs of all the documents containing term.
| Name | Type | Description |
|---|---|---|
| $term | \Zend_Search_Lucene_Index_Term | |
| $docsFilter | \Zend_Search_Lucene_Index_DocsFilter | null |
| Type | Description |
|---|---|
| array |
termDocsFilter(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter | null $docsFilter = null) : \Zend_Search_Lucene_Index_DocsFilterReturns documents filter for all documents containing term.
It performs the same operation as termDocs, but return result as Zend_Search_Lucene_Index_DocsFilter object
| Name | Type | Description |
|---|---|---|
| $term | \Zend_Search_Lucene_Index_Term | |
| $docsFilter | \Zend_Search_Lucene_Index_DocsFilter | null |
| Type | Description |
|---|---|
| \Zend_Search_Lucene_Index_DocsFilter |
termFreqs(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter | null $docsFilter = null) : integerReturns an array of all term freqs.
Return array structure: array( docId => freq, ...)
| Name | Type | Description |
|---|---|---|
| $term | \Zend_Search_Lucene_Index_Term | |
| $docsFilter | \Zend_Search_Lucene_Index_DocsFilter | null |
| Type | Description |
|---|---|
| integer |
termPositions(\Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_DocsFilter | null $docsFilter = null) : arrayReturns an array of all term positions in the documents.
Return array structure: array( docId => array( pos1, pos2, ...), ...)
| Name | Type | Description |
|---|---|---|
| $term | \Zend_Search_Lucene_Index_Term | |
| $docsFilter | \Zend_Search_Lucene_Index_DocsFilter | null |
| Type | Description |
|---|---|
| array |
terms() : arrayReturns an array of all terms in this index.
| Type | Description |
|---|---|
| array |
undeleteAll() : voidUndeletes all documents currently marked as deleted in this index.