wikimedia/mediawiki-extensions-CirrusSearch

<?php

namespace CirrusSearch\Api;

use CirrusSearch\Connection;
use CirrusSearch\SearchConfig;
use MediaWiki\Api\ApiBase;

/**
 * Dumps CirrusSearch mappings for easy viewing.
 *
 * 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
 */
class MappingDump extends ApiBase {
    use ApiTrait;

    public function execute() {
        $conn = $this->getCirrusConnection();
        $indexPrefix = $this->getSearchConfig()->get( SearchConfig::INDEX_BASE_NAME );
        foreach ( $conn->getAllIndexSuffixes( null ) as $index ) {
            $mapping = $conn->getIndex( $indexPrefix, $index )->getMapping();
            $this->getResult()->addValue( null, $index, $mapping );
        }
        if ( $this->getSearchConfig()->isCompletionSuggesterEnabled() ) {
            $index = $conn->getIndex( $indexPrefix, Connection::TITLE_SUGGEST_INDEX_SUFFIX );
            if ( $index->exists() ) {
                $mapping = $index->getMapping();
                $this->getResult()->addValue( null, Connection::TITLE_SUGGEST_INDEX_SUFFIX, $mapping );
            }
        }
    }

    public function getAllowedParams() {
        return [];
    }

    /**
     * @see ApiBase::getExamplesMessages
     * @return array
     */
    protected function getExamplesMessages() {
        return [
            'action=cirrus-mapping-dump' =>
                'apihelp-cirrus-mapping-dump-example'
        ];
    }

}