0ba2242300
* CDB stands for "constant database" file, hence also changes references
to "constant" when likely intended to refer to CDB.
* Remove reference to non-existent docs/Configuration.md.
* Remove unused resetLocalCache() method. This was documented as
internal for testing only, but tests did not use it.
It was left behind in 2016 with I7d7424345d0ce3ce90 (025f15a208).
Bug: T315315
Change-Id: I61d9689160d9bf5715c4ff18009fbd16236d34e6
138 lines
3.5 KiB
PHP
138 lines
3.5 KiB
PHP
<?php
|
|
/**
|
|
* 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
|
|
*/
|
|
|
|
/**
|
|
* An interwiki record value object.
|
|
*
|
|
* By default these represent a row in the `interwiki` database table.
|
|
* See @ref \MediaWiki\Interwiki\ClassicInterwikiLookup for where this is used.
|
|
*/
|
|
class Interwiki {
|
|
|
|
/** @var string The interwiki prefix, (e.g. "Meatball", or the language prefix "de") */
|
|
protected $mPrefix;
|
|
|
|
/** @var string The article path URL of the wiki, with "$1" as a placeholder for an article name. */
|
|
protected $mURL;
|
|
|
|
/** @var string The URL to the api.php entry point of the wiki. */
|
|
protected $mAPI;
|
|
|
|
/** @var string The name of the database (for a connection to be established
|
|
* with LBFactory::getMainLB( 'domainId' ))
|
|
*/
|
|
protected $mWikiID;
|
|
|
|
/** @var bool Whether the wiki is in this project */
|
|
protected $mLocal;
|
|
|
|
/** @var bool Whether interwiki transclusions are allowed */
|
|
protected $mTrans;
|
|
|
|
public function __construct( $prefix = null, $url = '', $api = '', $wikiId = '', $local = 0,
|
|
$trans = 0
|
|
) {
|
|
$this->mPrefix = $prefix;
|
|
$this->mURL = $url;
|
|
$this->mAPI = $api;
|
|
$this->mWikiID = $wikiId;
|
|
$this->mLocal = (bool)$local;
|
|
$this->mTrans = (bool)$trans;
|
|
}
|
|
|
|
/**
|
|
* Get the URL for a particular title (or with $1 if no title given)
|
|
*
|
|
* @param string|null $title What text to put for the article name
|
|
* @return string The URL
|
|
* @note Prior to 1.19 The getURL with an argument was broken.
|
|
* If you if you use this arg in an extension that supports MW earlier
|
|
* than 1.19 please wfUrlencode and substitute $1 on your own.
|
|
*/
|
|
public function getURL( $title = null ) {
|
|
$url = $this->mURL;
|
|
if ( $title !== null ) {
|
|
$url = str_replace( "$1", wfUrlencode( $title ), $url );
|
|
}
|
|
|
|
return $url;
|
|
}
|
|
|
|
/**
|
|
* Get the API URL for this wiki
|
|
*
|
|
* @return string The URL
|
|
*/
|
|
public function getAPI() {
|
|
return $this->mAPI;
|
|
}
|
|
|
|
/**
|
|
* Get the DB name for this wiki
|
|
*
|
|
* @return string The DB name
|
|
*/
|
|
public function getWikiID() {
|
|
return $this->mWikiID;
|
|
}
|
|
|
|
/**
|
|
* Is this a local link from a sister project, or is
|
|
* it something outside, like Google
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isLocal() {
|
|
return $this->mLocal;
|
|
}
|
|
|
|
/**
|
|
* Can pages from this wiki be transcluded?
|
|
* Still requires $wgEnableScaryTransclusion
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isTranscludable() {
|
|
return $this->mTrans;
|
|
}
|
|
|
|
/**
|
|
* Get the name for the interwiki site
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getName() {
|
|
$msg = wfMessage( 'interwiki-name-' . $this->mPrefix )->inContentLanguage();
|
|
|
|
return !$msg->exists() ? '' : $msg->text();
|
|
}
|
|
|
|
/**
|
|
* Get a description for this interwiki
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getDescription() {
|
|
$msg = wfMessage( 'interwiki-desc-' . $this->mPrefix )->inContentLanguage();
|
|
|
|
return !$msg->exists() ? '' : $msg->text();
|
|
}
|
|
|
|
}
|