PhraseIndexCollection extends EO_PhraseIndex_Collection
Tags
Table of Contents
Properties
- $verbose : bool
Methods
- collect() : int
- Collect index phrases.
- countItemsToProcess() : int
- Counts items to process.
- getPhraseByCode() : PhraseIndex|null
- Returns phrase object by its code.
- purge() : self
- Drop index.
Properties
$verbose
public
static bool
$verbose
= false
Methods
collect()
Collect index phrases.
public
collect([Filter|null $filter = null ][, ITimeLimit|null $timer = null ][, Filter|null $seek = null ]) : int
Parameters
- $filter : Filter|null = null
-
Params to filter file list.
- $timer : ITimeLimit|null = null
-
Time counter.
- $seek : Filter|null = null
-
Params to seek position.
Return values
intcountItemsToProcess()
Counts items to process.
public
countItemsToProcess([Filter|null $filter = null ]) : int
Parameters
- $filter : Filter|null = null
-
Params to filter file list.
Return values
intgetPhraseByCode()
Returns phrase object by its code.
public
getPhraseByCode(string $code) : PhraseIndex|null
Parameters
- $code : string
-
Phrase code to search.
Return values
PhraseIndex|nullpurge()
Drop index.
public
purge([Filter|null $filter = null ]) : self
Parameters
- $filter : Filter|null = null
-
Params to filter file list.