Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class FinderIndexCommand - list of methods

Console command Purges and rebuilds the index (search filters are preserved)
Package: Joomla\CMS\Console
Copyright: (C) 2011 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Console/FinderIndexCommand.php
Project: Joomla

Method Summary

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

Instantiate the command.
Parameters
  • \Joomla\Database\DatabaseInterface $db Database connector
Since
  • 4.0.0
Show source code of this method: __construct Source Code

protected void
()

Initialise the command.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: configure Source Code

protected int
(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)

Internal function to execute the command.
Parameters
  • \Symfony\Component\Console\Input\InputInterface $input The input to inject into the command.
  • \Symfony\Component\Console\Output\OutputInterface $output The output to inject into the command.
Returns
  • int The command exit code
Since
  • 4.0.0
Show source code of this method: doExecute Source Code

private void
(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)

Configures the IO
Parameters
  • \Symfony\Component\Console\Input\InputInterface $input Console Input
  • \Symfony\Component\Console\Output\OutputInterface $output Console Output
Returns
  • void
Since
  • 4.0.0
Show source code of this method: configureIO Source Code

private void
()

Save static filters.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: getFilters Source Code

private void
()

Purge the index.
Returns
  • void
Since
  • 3.3
Show source code of this method: purge Source Code

private void
()

Run the indexer.
Returns
  • void
Since
  • 2.5
Show source code of this method: index Source Code

private void
()

Restore static filters.
Returns
  • void
Since
  • 3.3
Show source code of this method: putFilters Source Code

Properties Summary

protected static string
$defaultName
The default command name
Since
  • 4.0.0
private \Symfony\Component\Console\Input\InputInterface
$cliInput
Stores the Input Object
Since
  • 4.0.0
private \Symfony\Component\Console\Style\SymfonyStyle
$ioStyle
SymfonyStyle Object
Since
  • 4.0.0
private \Joomla\Database\DatabaseInterface
$db
Database connector
Since
  • 4.0.0
private string
$time
Start time for the index process
Since
  • 2.5
private string
$qtime
Start time for each batch
Since
  • 2.5
private array
$filters
Static filters information.
Since
  • 3.3
private string|int
$pause
Pausing type or defined pause time in seconds.
Since
  • 3.9.12
private int
$divisor
The divisor of the division: batch-processing time / divisor.
Since
  • 3.9.12
private int
$minimumBatchProcessingTime
Minimum processing time in seconds, in order to apply a pause Defaults to 1
Since
  • 3.9.12

Tags Summary

Since
4.0.0