MediaWiki REL1_34
InterwikiLookupAdapter.php
Go to the documentation of this file.
1<?php
2
3namespace MediaWiki\Interwiki;
4
31use Interwiki;
32use Site;
33use SiteLookup;
35
37
41 private $siteLookup;
42
47
48 function __construct(
50 array $interwikiMap = null
51 ) {
52 $this->siteLookup = $siteLookup;
53 $this->interwikiMap = $interwikiMap;
54 }
55
63 public function isValidInterwiki( $prefix ) {
64 return array_key_exists( $prefix, $this->getInterwikiMap() );
65 }
66
74 public function fetch( $prefix ) {
75 if ( $prefix == '' ) {
76 return null;
77 }
78
79 if ( !$this->isValidInterwiki( $prefix ) ) {
80 return false;
81 }
82
83 return $this->interwikiMap[$prefix];
84 }
85
92 public function getAllPrefixes( $local = null ) {
93 $res = [];
94 foreach ( $this->getInterwikiMap() as $interwikiId => $interwiki ) {
95 if ( $local === null || $interwiki->isLocal() === $local ) {
96 $res[] = [
97 'iw_prefix' => $interwikiId,
98 'iw_url' => $interwiki->getURL(),
99 'iw_api' => $interwiki->getAPI(),
100 'iw_wikiid' => $interwiki->getWikiID(),
101 'iw_local' => $interwiki->isLocal(),
102 'iw_trans' => $interwiki->isTranscludable(),
103 ];
104 }
105 }
106 return $res;
107 }
108
114 public function invalidateCache( $prefix ) {
115 if ( !isset( $this->interwikiMap[$prefix] ) ) {
116 return;
117 }
118 $globalId = $this->interwikiMap[$prefix]->getWikiID();
119 unset( $this->interwikiMap[$prefix] );
120
121 // Reload the interwiki
122 $site = $this->siteLookup->getSites()->getSite( $globalId );
123 $interwikis = $this->getSiteInterwikis( $site );
124 $this->interwikiMap = array_merge( $this->interwikiMap, [ $interwikis[$prefix] ] );
125 }
126
130 private function loadInterwikiMap() {
131 $interwikiMap = [];
132 $siteList = $this->siteLookup->getSites();
133 foreach ( $siteList as $site ) {
134 $interwikis = $this->getSiteInterwikis( $site );
135 $interwikiMap = array_merge( $interwikiMap, $interwikis );
136 }
137 $this->interwikiMap = $interwikiMap;
138 }
139
145 private function getInterwikiMap() {
146 if ( $this->interwikiMap === null ) {
147 $this->loadInterwikiMap();
148 }
149 return $this->interwikiMap;
150 }
151
158 private function getSiteInterwikis( Site $site ) {
159 $interwikis = [];
160 foreach ( $site->getInterwikiIds() as $interwiki ) {
161 $url = $site->getPageUrl();
162 if ( $site instanceof MediaWikiSite ) {
163 $path = $site->getFileUrl( 'api.php' );
164 } else {
165 $path = '';
166 }
167 $local = $site->getSource() === 'local';
168 // TODO: How to adapt trans?
169 $interwikis[$interwiki] = new Interwiki(
170 $interwiki,
171 $url,
172 $path,
173 $site->getGlobalId(),
174 $local
175 );
176 }
177 return $interwikis;
178 }
179}
Value object for representing interwiki records.
Definition Interwiki.php:27
Class representing a MediaWiki site.
Interwiki[] null $interwikiMap
associative array mapping interwiki prefixes to Interwiki objects
getSiteInterwikis(Site $site)
Load interwikis for the given site.
fetch( $prefix)
See InterwikiLookup::fetch It loads the whole interwiki map.
getAllPrefixes( $local=null)
See InterwikiLookup::getAllPrefixes.
__construct(SiteLookup $siteLookup, array $interwikiMap=null)
loadInterwikiMap()
Load interwiki map to use as cache.
isValidInterwiki( $prefix)
See InterwikiLookup::isValidInterwiki It loads the whole interwiki map.
invalidateCache( $prefix)
See InterwikiLookup::invalidateCache.
getInterwikiMap()
Get interwikiMap attribute, load if needed.
Definition Site.php:29
getSource()
Returns the source of the site data (ie 'local', 'wikidata', 'my-magical-repo').
Definition Site.php:207
getGlobalId()
Returns the global site identifier (ie enwiktionary).
Definition Site.php:140
getPageUrl( $pageName=false)
Returns the full URL for the given page on the site.
Definition Site.php:370
getInterwikiIds()
Returns the interwiki link identifiers that can be used for this site.
Definition Site.php:546
Service interface for looking up Interwiki records.
Copyright (C) 2018 Kunal Mehta legoktm@member.fsf.org