CirrusSearch
Elasticsearch-powered search for MediaWiki
Loading...
Searching...
No Matches
CirrusSearch\Sanity\Remediator Interface Reference

Remediation actions for insanity in the search index. More...

+ Inheritance diagram for CirrusSearch\Sanity\Remediator:

Public Member Functions

 redirectInIndex (WikiPage $page)
 There is a redirect in the index.
 
 pageNotInIndex (WikiPage $page)
 A page isn't in the index.
 
 ghostPageInIndex ( $docId, Title $title)
 A non-existent page is in the index.
 
 pageInWrongIndex ( $docId, WikiPage $page, $indexSuffix)
 An existent page is in more then one index.
 
 oldVersionInIndex ( $docId, WikiPage $page, $indexSuffix)
 
 oldDocument (WikiPage $page)
 

Detailed Description

Remediation actions for insanity in the search index.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Member Function Documentation

◆ ghostPageInIndex()

CirrusSearch\Sanity\Remediator::ghostPageInIndex ( $docId,
Title $title )

A non-existent page is in the index.

Odds are good it was deleted.

Parameters
string$docIdelsaticsearch document id of the deleted page
Title$titletitle of the page read from the ghost

Implemented in CirrusSearch\Sanity\AllClustersQueueingRemediator, CirrusSearch\Sanity\BufferedRemediator, CirrusSearch\Sanity\NoopRemediator, CirrusSearch\Sanity\PrintingRemediator, and CirrusSearch\Sanity\QueueingRemediator.

◆ oldDocument()

CirrusSearch\Sanity\Remediator::oldDocument ( WikiPage $page)

◆ oldVersionInIndex()

CirrusSearch\Sanity\Remediator::oldVersionInIndex ( $docId,
WikiPage $page,
$indexSuffix )
Parameters
string$docIdelasticsearch document id
WikiPage$pagepage with outdated document in index
string$indexSuffixindex contgaining outdated document

Implemented in CirrusSearch\Sanity\QueueingRemediator, CirrusSearch\Sanity\AllClustersQueueingRemediator, CirrusSearch\Sanity\BufferedRemediator, CirrusSearch\Sanity\NoopRemediator, and CirrusSearch\Sanity\PrintingRemediator.

◆ pageInWrongIndex()

CirrusSearch\Sanity\Remediator::pageInWrongIndex ( $docId,
WikiPage $page,
$indexSuffix )

An existent page is in more then one index.

Parameters
string$docIdelasticsearch document id
WikiPage$pagepage in too many indexes
string$indexSuffixindex suffix that the page is in but shouldn't be in

Implemented in CirrusSearch\Sanity\AllClustersQueueingRemediator, CirrusSearch\Sanity\BufferedRemediator, CirrusSearch\Sanity\NoopRemediator, CirrusSearch\Sanity\PrintingRemediator, and CirrusSearch\Sanity\QueueingRemediator.

◆ pageNotInIndex()

CirrusSearch\Sanity\Remediator::pageNotInIndex ( WikiPage $page)

◆ redirectInIndex()

CirrusSearch\Sanity\Remediator::redirectInIndex ( WikiPage $page)

The documentation for this interface was generated from the following file: