FinderIndexCommand
Extends AbstractCommand Implements LanguageAwareInterfaceConsole command Purges and rebuilds the index (search filters are preserved)
| since |
4.0.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Instantiate the command.
__construct(\Joomla\Database\DatabaseInterface db) :
| since |
4.0.0 |
|---|
Arguments
- db
DatabaseInterfaceDatabase connector
Response
mixed
configure
Initialise the command.
configure() :
| since |
4.0.0 |
|---|
Response
void
configureIO
Configures the IO
configureIO(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| since |
4.0.0 |
|---|
Arguments
- input
InputInterfaceConsole Input- output
OutputInterfaceConsole Output
Response
void
doExecute
Internal function to execute the command.
doExecute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
| since |
4.0.0 |
|---|
Arguments
- input
InputInterfaceThe input to inject into the command.- output
OutputInterfaceThe output to inject into the command.
Response
intThe command exit code
getFilters
Save static filters.
getFilters() :
Since a purge/index cycle will cause all the taxonomy ids to change, the static filters need to be updated with the new taxonomy ids. The static filter information is saved prior to the purge/index so that it can later be used to update the filters with new ids.
| since |
4.0.0 |
|---|
Response
void
getLanguage
Get the Language.
getLanguage() : \Joomla\CMS\Language\Language
| since |
4.4.0 |
|---|---|
| throws |
|
Response
index
Run the indexer.
index() :
| since |
2.5 |
|---|
Response
void
purge
Purge the index.
purge() :
| since |
3.3 |
|---|
Response
void
putFilters
Restore static filters.
putFilters() :
Using the saved filter information, update the filter records with the new taxonomy ids.
| since |
3.3 |
|---|
Response
void
setLanguage
Set the language to use.
setLanguage(\Joomla\CMS\Language\Language language) :
Properties
defaultName
The default command name
| since |
4.0.0 |
|---|
Type(s)
string
cliInput
Stores the Input Object
| since |
4.0.0 |
|---|
Type(s)
InputInterface
ioStyle
SymfonyStyle Object
| since |
4.0.0 |
|---|
Type(s)
SymfonyStyle
db
Database connector
| since |
4.0.0 |
|---|
Type(s)
DatabaseInterface
time
Start time for the index process
| since |
2.5 |
|---|
Type(s)
string
qtime
Start time for each batch
| since |
2.5 |
|---|
Type(s)
string
filters
Static filters information.
| since |
3.3 |
|---|
Type(s)
array<string|int, mixed>
pause
Pausing type or defined pause time in seconds.
One pausing type is implemented: 'division' for dynamic calculation of pauses
Defaults to 'division'
| since |
3.9.12 |
|---|
Type(s)
string|int
divisor
The divisor of the division: batch-processing time / divisor.
This is used together with --pause=division in order to pause dynamically in relation to the processing time Defaults to 5
| since |
3.9.12 |
|---|
Type(s)
int
minimumBatchProcessingTime
Minimum processing time in seconds, in order to apply a pause Defaults to 1
| since |
3.9.12 |
|---|
Type(s)
int