FinderIndexCommand

Extends \Joomla\Console\Command\AbstractCommand

Console command Purges and rebuilds the index (search filters are preserved)

since

4.0.0

Methods

__construct

Instantiate the command.

__construct(\Joomla\Database\DatabaseInterface $db) 
since

4.0.0

Arguments

$db

\Joomla\Database\DatabaseInterfaceDatabase connector

configure

Initialise the command.

configure() : void
since

4.0.0

configureIO

Configures the IO

configureIO(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : void
since

4.0.0

Arguments

$input

\Symfony\Component\Console\Input\InputInterfaceConsole Input

$output

\Symfony\Component\Console\Output\OutputInterfaceConsole Output

doExecute

Internal function to execute the command.

doExecute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output) : integer
since

4.0.0

Arguments

$input

\Symfony\Component\Console\Input\InputInterfaceThe input to inject into the command.

$output

\Symfony\Component\Console\Output\OutputInterfaceThe output to inject into the command.

Response

integerThe command exit code

getFilters

Save static filters.

getFilters() : void

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

index

Run the indexer.

index() : void
since

2.5

purge

Purge the index.

purge() : void
since

3.3

putFilters

Restore static filters.

putFilters() : void

Using the saved filter information, update the filter records with the new taxonomy ids.

since

3.3

Properties

defaultName

The default command name

static
since

4.0.0

Type(s)

string

cliInput

Stores the Input Object

since

4.0.0

Type(s)

\Symfony\Component\Console\Input\InputInterface

ioStyle

SymfonyStyle Object

since

4.0.0

Type(s)

\Symfony\Component\Console\Style\SymfonyStyle

db

Database connector

since

4.0.0

Type(s)

\Joomla\Database\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

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|integer

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)

integer

minimumBatchProcessingTime

Minimum processing time in seconds, in order to apply a pause Defaults to 1

since

3.9.12

Type(s)

integer