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.

__construct(
\Zend_Search_Lucene_Storage_Directory $directory, string $name
)
:
void
Object constructor.
Name | Type | Description |
---|---|---|
$directory | \Zend_Search_Lucene_Storage_Directory | |
$name | string |

_dumpFNM(
)
:
void
Dump Field Info (.fnm) segment file
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::_dumpFNM()
_dumpTermDictEntry(
\Zend_Search_Lucene_Storage_File $dicFile, \Zend_Search_Lucene_Index_Term $prevTerm, \Zend_Search_Lucene_Index_Term $term, \Zend_Search_Lucene_Index_TermInfo $prevTermInfo, \Zend_Search_Lucene_Index_TermInfo $termInfo
)
:
void
Dump Term Dictionary segment file entry.
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::_dumpTermDictEntry()Used to write entry to .tis or .tii files
Name | Type | Description |
---|---|---|
$dicFile | \Zend_Search_Lucene_Storage_File | |
$prevTerm | \Zend_Search_Lucene_Index_Term | |
$term | \Zend_Search_Lucene_Index_Term | |
$prevTermInfo | \Zend_Search_Lucene_Index_TermInfo | |
$termInfo | \Zend_Search_Lucene_Index_TermInfo |

_generateCFS(
)
:
void
Generate compound index file
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::_generateCFS()
addField(
\Zend_Search_Lucene_Field $field
)
:
integer
Add field to the segment
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::addField()Returns actual field number
Name | Type | Description |
---|---|---|
$field | \Zend_Search_Lucene_Field |
Type | Description |
---|---|
integer |

addFieldInfo(
\Zend_Search_Lucene_Index_FieldInfo $fieldInfo
)
:
integer
Add fieldInfo to the segment
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::addFieldInfo()Returns actual field number
Name | Type | Description |
---|---|---|
$fieldInfo | \Zend_Search_Lucene_Index_FieldInfo |
Type | Description |
---|---|
integer |

addStoredFields(
array $storedFields
)
:
void
Add stored fields information
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::addStoredFields()Name | Type | Description |
---|---|---|
$storedFields | array | array of Zend_Search_Lucene_Field objects |

addTerm(
\Zend_Search_Lucene_Index_Term $termEntry, array $termDocs
)
:
void
Add term
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::addTerm()Term positions is an array( docId => array(pos1, pos2, pos3, ...), ... )
Name | Type | Description |
---|---|---|
$termEntry | \Zend_Search_Lucene_Index_Term | |
$termDocs | array |

close(
)
:
\Zend_Search_Lucene_Index_SegmentInfo
Close segment, write it to disk and return segment info
Type | Description |
---|---|
\Zend_Search_Lucene_Index_SegmentInfo |

closeDictionaryFiles(
)
:
void
Close dictionary
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::closeDictionaryFiles()
count(
)
:
integer
Returns the total number of documents in this segment.
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::count()Type | Description |
---|---|
integer |

getFieldInfos(
)
:
array
Returns array of FieldInfo objects.
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::getFieldInfos()Type | Description |
---|---|
array |

getName(
)
:
string
Return segment name
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::getName()Type | Description |
---|---|
string |

initializeDictionaryFiles(
)
:
void
Create dicrionary, frequency and positions files and write necessary headers
Inherited from: \Zend_Search_Lucene_Index_SegmentWriter::initializeDictionaryFiles()