ApiQueryLangBacklinks.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use MediaWiki\Title\Title;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef\IntegerDef;
 
class ApiQueryLangBacklinks extends ApiQueryGeneratorBase {
 
    public function __construct( ApiQuery $query, string $moduleName ) {
        parent::__construct( $query, $moduleName, 'lbl' );
    }
 
    public function execute() {
        $this->run();
    }
 
    public function executeGenerator( $resultPageSet ) {
        $this->run( $resultPageSet );
    }
 
    public function run( $resultPageSet = null ) {
        $params = $this->extractRequestParams();
 
        if ( isset( $params['title'] ) && !isset( $params['lang'] ) ) {
            $this->dieWithError(
                [
                    'apierror-invalidparammix-mustusewith',
                    $this->encodeParamName( 'title' ),
                    $this->encodeParamName( 'lang' )
                ],
                'nolang'
            );
        }
 
        if ( $params['continue'] !== null ) {
            $cont = $this->parseContinueParamOrDie( $params['continue'], [ 'string', 'string', 'int' ] );
            $db = $this->getDB();
            $op = $params['dir'] == 'descending' ? '<=' : '>=';
            $this->addWhere( $db->buildComparison( $op, [
                'll_lang' => $cont[0],
                'll_title' => $cont[1],
                'll_from' => $cont[2],
            ] ) );
        }
 
        $prop = array_fill_keys( $params['prop'], true );
        $lllang = isset( $prop['lllang'] );
        $lltitle = isset( $prop['lltitle'] );
 
        $this->addTables( [ 'langlinks', 'page' ] );
        $this->addWhere( 'll_from = page_id' );
 
        $this->addFields( [ 'page_id', 'page_title', 'page_namespace', 'page_is_redirect',
            'll_from', 'll_lang', 'll_title' ] );
 
        $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
        if ( isset( $params['lang'] ) ) {
            $this->addWhereFld( 'll_lang', $params['lang'] );
            if ( isset( $params['title'] ) ) {
                $this->addWhereFld( 'll_title', $params['title'] );
                $this->addOption( 'ORDER BY', 'll_from' . $sort );
            } else {
                $this->addOption( 'ORDER BY', [
                    'll_title' . $sort,
                    'll_from' . $sort
                ] );
            }
        } else {
            $this->addOption( 'ORDER BY', [
                'll_lang' . $sort,
                'll_title' . $sort,
                'll_from' . $sort
            ] );
        }
 
        $this->addOption( 'LIMIT', $params['limit'] + 1 );
 
        $res = $this->select( __METHOD__ );
 
        $pages = [];
 
        $count = 0;
        $result = $this->getResult();
 
        if ( $resultPageSet === null ) {
            $this->executeGenderCacheFromResultWrapper( $res, __METHOD__ );
        }
 
        foreach ( $res as $row ) {
            if ( ++$count > $params['limit'] ) {
                // We've reached the one extra which shows that there are
                // additional pages to be had. Stop here... Continue string
                // preserved in case the redirect query doesn't pass the limit.
                $this->setContinueEnumParameter(
                    'continue',
                    "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}"
                );
                break;
            }
 
            if ( $resultPageSet !== null ) {
                $pages[] = Title::newFromRow( $row );
            } else {
                $entry = [ 'pageid' => (int)$row->page_id ];
 
                $title = Title::makeTitle( $row->page_namespace, $row->page_title );
                ApiQueryBase::addTitleInfo( $entry, $title );
 
                if ( $row->page_is_redirect ) {
                    $entry['redirect'] = true;
                }
 
                if ( $lllang ) {
                    $entry['lllang'] = $row->ll_lang;
                }
 
                if ( $lltitle ) {
                    $entry['lltitle'] = $row->ll_title;
                }
 
                $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $entry );
                if ( !$fit ) {
                    $this->setContinueEnumParameter(
                        'continue',
                        "{$row->ll_lang}|{$row->ll_title}|{$row->ll_from}"
                    );
                    break;
                }
            }
        }
 
        if ( $resultPageSet === null ) {
            $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'll' );
        } else {
            $resultPageSet->populateFromTitles( $pages );
        }
    }
 
    public function getCacheMode( $params ) {
        return 'public';
    }
 
    public function getAllowedParams() {
        return [
            'lang' => null,
            'title' => null,
            'continue' => [
                ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
            ],
            'limit' => [
                ParamValidator::PARAM_DEFAULT => 10,
                ParamValidator::PARAM_TYPE => 'limit',
                IntegerDef::PARAM_MIN => 1,
                IntegerDef::PARAM_MAX => ApiBase::LIMIT_BIG1,
                IntegerDef::PARAM_MAX2 => ApiBase::LIMIT_BIG2
            ],
            'prop' => [
                ParamValidator::PARAM_ISMULTI => true,
                ParamValidator::PARAM_DEFAULT => '',
                ParamValidator::PARAM_TYPE => [
                    'lllang',
                    'lltitle',
                ],
                ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
            ],
            'dir' => [
                ParamValidator::PARAM_DEFAULT => 'ascending',
                ParamValidator::PARAM_TYPE => [
                    'ascending',
                    'descending'
                ]
            ],
        ];
    }
 
    protected function getExamplesMessages() {
        return [
            'action=query&list=langbacklinks&lbltitle=Test&lbllang=fr'
                => 'apihelp-query+langbacklinks-example-simple',
            'action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info'
                => 'apihelp-query+langbacklinks-example-generator',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Langbacklinks';
    }
}
 
class_alias( ApiQueryLangBacklinks::class, 'ApiQueryLangBacklinks' );