e0c3e75414
Use bool instead of string, most caller provided int instead. The InterwikiLookupAdapter class is strict comparing Interwiki::isLocal (a bool) with the given $local value, which evaluates always to false and the expected filter option is not working. The unit tests is using bool, not the documented string. The ClassicInterwikiLookup is not affected. Found by phan strict checks Change-Id: I63ed9772429c6f5bfe38a9fad190491812866f3f
75 lines
2.3 KiB
PHP
75 lines
2.3 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Interwiki;
|
|
|
|
/**
|
|
* Service interface for looking up Interwiki records.
|
|
*
|
|
* 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
|
|
*
|
|
* @file
|
|
*/
|
|
use Interwiki;
|
|
|
|
/**
|
|
* Service interface for looking up Interwiki records.
|
|
*
|
|
* @since 1.28
|
|
*/
|
|
interface InterwikiLookup {
|
|
|
|
/**
|
|
* Check whether an interwiki prefix exists
|
|
*
|
|
* @param string $prefix Interwiki prefix to use
|
|
* @return bool Whether it exists
|
|
*/
|
|
public function isValidInterwiki( $prefix );
|
|
|
|
/**
|
|
* Fetch an Interwiki object
|
|
*
|
|
* @param string $prefix Interwiki prefix to use
|
|
* @return Interwiki|null|bool
|
|
*/
|
|
public function fetch( $prefix );
|
|
|
|
/**
|
|
* Returns information about all interwiki prefixes, in the form of rows
|
|
* of the interwiki table. Each row may have the following keys:
|
|
*
|
|
* - iw_prefix: the prefix. Always present.
|
|
* - iw_url: the URL to use for linking, with $1 as a placeholder for the target page.
|
|
* Always present.
|
|
* - iw_api: the URL of the API. Optional.
|
|
* - iw_wikiid: the wiki ID (usually the database name for local wikis). Optional.
|
|
* - iw_local: whether the wiki is local, and the "magic redirect" mechanism should apply.
|
|
* Defaults to false.
|
|
* - iw_trans: whether "scary transclusion" is allowed for this site.
|
|
* Defaults to false.
|
|
*
|
|
* @param bool|null $local If set, limits output to local/non-local interwikis
|
|
* @return array[] interwiki rows.
|
|
*/
|
|
public function getAllPrefixes( $local = null );
|
|
|
|
/**
|
|
* Purge the in-process and persistent object cache for an interwiki prefix
|
|
* @param string $prefix
|
|
*/
|
|
public function invalidateCache( $prefix );
|
|
|
|
}
|