TermsStreamInterface
in
Tags
Table of Contents
Methods
- closeTermsStream() : mixed
- Close terms stream
- currentTerm() : Term|null
- Returns term in current position
- nextTerm() : Term|null
- Scans terms dictionary and returns next term
- resetTermsStream() : mixed
- Reset terms stream.
- skipTo() : mixed
- Skip terms stream up to specified term preffix.
Methods
closeTermsStream()
Close terms stream
public
closeTermsStream() : mixed
Should be used for resources clean up if stream is not read up to the end
currentTerm()
Returns term in current position
public
currentTerm() : Term|null
Return values
Term|nullnextTerm()
Scans terms dictionary and returns next term
public
nextTerm() : Term|null
Return values
Term|nullresetTermsStream()
Reset terms stream.
public
resetTermsStream() : mixed
skipTo()
Skip terms stream up to specified term preffix.
public
skipTo(Term $prefix) : mixed
Prefix contains fully specified field info and portion of searched term
Parameters
- $prefix : Term