wikimedia/mediawiki-extensions-CirrusSearch

<?php

namespace CirrusSearch\Sanity;

use MediaWiki\Title\Title;
use WikiPage;

/**
 * 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
 */

interface Remediator {
    /**
     * There is a redirect in the index.
     * @param string $docId elasticsearch document id of the redirected page
     * @param WikiPage $page the page in the index
     * @param string $indexSuffix The index suffix it was found in
     */
    public function redirectInIndex( string $docId, WikiPage $page, string $indexSuffix );

    /**
     * A page isn't in the index.
     * @param WikiPage $page not in the index
     */
    public function pageNotInIndex( WikiPage $page );

    /**
     * A non-existent page is in the index.  Odds are good it was deleted.
     *
     * @param string $docId elasticsearch document id of the deleted page
     * @param Title $title title of the page read from the ghost
     */
    public function ghostPageInIndex( $docId, Title $title );

    /**
     * An existent page is in more then one index.
     *
     * @param string $docId elasticsearch document id
     * @param WikiPage $page page in too many indexes
     * @param string $indexSuffix index suffix that the page is in but shouldn't be in
     */
    public function pageInWrongIndex( $docId, WikiPage $page, $indexSuffix );

    /**
     * @param string $docId elasticsearch document id
     * @param WikiPage $page page with outdated document in index
     * @param string $indexSuffix index contgaining outdated document
     */
    public function oldVersionInIndex( $docId, WikiPage $page, $indexSuffix );

    /**
     * @param WikiPage $page Page considered too old in index
     */
    public function oldDocument( WikiPage $page );
}