MediaWiki REL1_31
Interwiki.php
Go to the documentation of this file.
1<?php
23
27class 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 return MediaWikiServices::getInstance()->getInterwikiLookup()->isValidInterwiki( $prefix );
70 }
71
80 public static function fetch( $prefix ) {
81 return MediaWikiServices::getInstance()->getInterwikiLookup()->fetch( $prefix );
82 }
83
90 public static function invalidateCache( $prefix ) {
91 MediaWikiServices::getInstance()->getInterwikiLookup()->invalidateCache( $prefix );
92 }
93
103 public static function getAllPrefixes( $local = null ) {
104 return MediaWikiServices::getInstance()->getInterwikiLookup()->getAllPrefixes( $local );
105 }
106
116 public function getURL( $title = null ) {
117 $url = $this->mURL;
118 if ( $title !== null ) {
119 $url = str_replace( "$1", wfUrlencode( $title ), $url );
120 }
121
122 return $url;
123 }
124
130 public function getAPI() {
131 return $this->mAPI;
132 }
133
139 public function getWikiID() {
140 return $this->mWikiID;
141 }
142
149 public function isLocal() {
150 return $this->mLocal;
151 }
152
159 public function isTranscludable() {
160 return $this->mTrans;
161 }
162
168 public function getName() {
169 $msg = wfMessage( 'interwiki-name-' . $this->mPrefix )->inContentLanguage();
170
171 return !$msg->exists() ? '' : $msg->text();
172 }
173
179 public function getDescription() {
180 $msg = wfMessage( 'interwiki-desc-' . $this->mPrefix )->inContentLanguage();
181
182 return !$msg->exists() ? '' : $msg->text();
183 }
184
185}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness,...
Value object for representing interwiki records.
Definition Interwiki.php:27
string $mURL
The URL of the wiki, with "$1" as a placeholder for an article name.
Definition Interwiki.php:33
string $mWikiID
The name of the database (for a connection to be established with wfGetLB( 'wikiid' ))
Definition Interwiki.php:41
__construct( $prefix=null, $url='', $api='', $wikiId='', $local=0, $trans=0)
Definition Interwiki.php:49
string $mPrefix
The interwiki prefix, (e.g.
Definition Interwiki.php:30
getDescription()
Get a description for this interwiki.
isLocal()
Is this a local link from a sister project, or is it something outside, like Google.
static isValidInterwiki( $prefix)
Check whether an interwiki prefix exists.
Definition Interwiki.php:68
getName()
Get the name for the interwiki site.
getWikiID()
Get the DB name for this wiki.
bool $mTrans
Whether interwiki transclusions are allowed.
Definition Interwiki.php:47
static fetch( $prefix)
Fetch an Interwiki object.
Definition Interwiki.php:80
string $mAPI
The URL of the file api.php.
Definition Interwiki.php:36
static getAllPrefixes( $local=null)
Returns all interwiki prefix definitions.
getURL( $title=null)
Get the URL for a particular title (or with $1 if no title given)
static invalidateCache( $prefix)
Purge the cache (local and persistent) for an interwiki prefix.
Definition Interwiki.php:90
isTranscludable()
Can pages from this wiki be transcluded? Still requires $wgEnableScaryTransclusion.
getAPI()
Get the API URL for this wiki.
bool $mLocal
Whether the wiki is in this project.
Definition Interwiki.php:44
MediaWikiServices is the service locator for the application scope of MediaWiki.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:964
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 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;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
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:37