MediaWiki  master
Interwiki.php
Go to the documentation of this file.
1 <?php
23 
27 class Interwiki {
28 
30  protected $mPrefix;
31 
33  protected $mURL;
34 
36  protected $mAPI;
37 
41  protected $mWikiID;
42 
44  protected $mLocal;
45 
47  protected $mTrans;
48 
49  public function __construct( $prefix = null, $url = '', $api = '', $wikiId = '', $local = 0,
50  $trans = 0
51  ) {
52  $this->mPrefix = $prefix;
53  $this->mURL = $url;
54  $this->mAPI = $api;
55  $this->mWikiID = $wikiId;
56  $this->mLocal = (bool)$local;
57  $this->mTrans = (bool)$trans;
58  }
59 
68  public static function isValidInterwiki( $prefix ) {
69  wfDeprecated( __METHOD__, '1.28' );
70  return MediaWikiServices::getInstance()->getInterwikiLookup()->isValidInterwiki( $prefix );
71  }
72 
81  public static function fetch( $prefix ) {
82  wfDeprecated( __METHOD__, '1.28' );
83  return MediaWikiServices::getInstance()->getInterwikiLookup()->fetch( $prefix );
84  }
85 
92  public static function invalidateCache( $prefix ) {
93  wfDeprecated( __METHOD__, '1.28' );
94  MediaWikiServices::getInstance()->getInterwikiLookup()->invalidateCache( $prefix );
95  }
96 
106  public static function getAllPrefixes( $local = null ) {
107  wfDeprecated( __METHOD__, '1.28' );
108  return MediaWikiServices::getInstance()->getInterwikiLookup()->getAllPrefixes( $local );
109  }
110 
120  public function getURL( $title = null ) {
121  $url = $this->mURL;
122  if ( $title !== null ) {
123  $url = str_replace( "$1", wfUrlencode( $title ), $url );
124  }
125 
126  return $url;
127  }
128 
134  public function getAPI() {
135  return $this->mAPI;
136  }
137 
143  public function getWikiID() {
144  return $this->mWikiID;
145  }
146 
153  public function isLocal() {
154  return $this->mLocal;
155  }
156 
163  public function isTranscludable() {
164  return $this->mTrans;
165  }
166 
172  public function getName() {
173  $msg = wfMessage( 'interwiki-name-' . $this->mPrefix )->inContentLanguage();
174 
175  return !$msg->exists() ? '' : $msg->text();
176  }
177 
183  public function getDescription() {
184  $msg = wfMessage( 'interwiki-desc-' . $this->mPrefix )->inContentLanguage();
185 
186  return !$msg->exists() ? '' : $msg->text();
187  }
188 
189 }
getName()
Get the name for the interwiki site.
Definition: Interwiki.php:172
isLocal()
Is this a local link from a sister project, or is it something outside, like Google.
Definition: Interwiki.php:153
string $mAPI
The URL of the file api.php.
Definition: Interwiki.php:36
string $mURL
The URL of the wiki, with "$1" as a placeholder for an article name.
Definition: Interwiki.php:33
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getWikiID()
Get the DB name for this wiki.
Definition: Interwiki.php:143
isTranscludable()
Can pages from this wiki be transcluded? Still requires $wgEnableScaryTransclusion.
Definition: Interwiki.php:163
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
static invalidateCache( $prefix)
Purge the cache (local and persistent) for an interwiki prefix.
Definition: Interwiki.php:92
getDescription()
Get a description for this interwiki.
Definition: Interwiki.php:183
getAPI()
Get the API URL for this wiki.
Definition: Interwiki.php:134
__construct( $prefix=null, $url='', $api='', $wikiId='', $local=0, $trans=0)
Definition: Interwiki.php:49
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness, which urlencode encodes by default.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
static getAllPrefixes( $local=null)
Returns all interwiki prefix definitions.
Definition: Interwiki.php:106
static fetch( $prefix)
Fetch an Interwiki object.
Definition: Interwiki.php:81
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
string $mPrefix
The interwiki prefix, (e.g.
Definition: Interwiki.php:30
Value object for representing interwiki records.
Definition: Interwiki.php:27
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
bool $mTrans
Whether interwiki transclusions are allowed.
Definition: Interwiki.php:47
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
getURL( $title=null)
Get the URL for a particular title (or with $1 if no title given)
Definition: Interwiki.php:120
static isValidInterwiki( $prefix)
Check whether an interwiki prefix exists.
Definition: Interwiki.php:68
string $mWikiID
The name of the database (for a connection to be established with LBFactory::getMainLB( &#39;domainId&#39; ))...
Definition: Interwiki.php:41
bool $mLocal
Whether the wiki is in this project.
Definition: Interwiki.php:44