MediaWiki REL1_28
ForeignDBFile.php
Go to the documentation of this file.
1<?php
29class ForeignDBFile extends LocalFile {
36 static function newFromTitle( $title, $repo, $unused = null ) {
37 return new self( $title, $repo );
38 }
39
48 static function newFromRow( $row, $repo ) {
49 $title = Title::makeTitle( NS_FILE, $row->img_name );
50 $file = new self( $title, $repo );
51 $file->loadFromRow( $row );
52
53 return $file;
54 }
55
63 function publish( $srcPath, $flags = 0, array $options = [] ) {
64 $this->readOnlyError();
65 }
66
79 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
80 $watch = false, $timestamp = false, User $user = null ) {
81 $this->readOnlyError();
82 }
83
90 function restore( $versions = [], $unsuppress = false ) {
91 $this->readOnlyError();
92 }
93
101 function delete( $reason, $suppress = false, $user = null ) {
102 $this->readOnlyError();
103 }
104
110 function move( $target ) {
111 $this->readOnlyError();
112 }
113
117 function getDescriptionUrl() {
118 // Restore remote behavior
120 }
121
126 function getDescriptionText( $lang = false ) {
128
129 if ( !$this->repo->fetchDescription ) {
130 return false;
131 }
132
133 $lang = $lang ?: $wgLang;
134 $renderUrl = $this->repo->getDescriptionRenderUrl( $this->getName(), $lang->getCode() );
135 if ( !$renderUrl ) {
136 return false;
137 }
138
139 $touched = $this->repo->getSlaveDB()->selectField(
140 'page',
141 'page_touched',
142 [
143 'page_namespace' => NS_FILE,
144 'page_title' => $this->title->getDBkey()
145 ]
146 );
147 if ( $touched === false ) {
148 return false; // no description page
149 }
150
151 $cache = ObjectCache::getMainWANInstance();
152
153 return $cache->getWithSetCallback(
154 $this->repo->getLocalCacheKey(
155 'RemoteFileDescription',
156 'url',
157 $lang->getCode(),
158 $this->getName(),
159 $touched
160 ),
161 $this->repo->descriptionCacheExpiry ?: $cache::TTL_UNCACHEABLE,
162 function ( $oldValue, &$ttl, array &$setOpts ) use ( $renderUrl ) {
163 wfDebug( "Fetching shared description from $renderUrl\n" );
164 $res = Http::get( $renderUrl, [], __METHOD__ );
165 if ( !$res ) {
166 $ttl = WANObjectCache::TTL_UNCACHEABLE;
167 }
168
169 return $res;
170 }
171 );
172 }
173
181 public function getDescriptionShortUrl() {
182 $dbr = $this->repo->getSlaveDB();
183 $pageId = $dbr->selectField(
184 'page',
185 'page_id',
186 [
187 'page_namespace' => NS_FILE,
188 'page_title' => $this->title->getDBkey()
189 ]
190 );
191
192 if ( $pageId !== false ) {
193 $url = $this->repo->makeUrl( [ 'curid' => $pageId ] );
194 if ( $url !== false ) {
195 return $url;
196 }
197 }
198 return null;
199 }
200
201}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
string $url
The URL corresponding to one of the four basic zones.
Definition File.php:116
getName()
Return the name of this file.
Definition File.php:296
readOnlyError()
Definition File.php:1768
FileRepo LocalRepo ForeignAPIRepo bool $repo
Some member variables can be lazy-initialised using __get().
Definition File.php:95
Title string bool $title
Definition File.php:98
getDescriptionUrl()
Get the URL of the image description page.
Definition File.php:2022
Foreign file with an accessible MediaWiki database.
publish( $srcPath, $flags=0, array $options=[])
static newFromRow( $row, $repo)
Create a ForeignDBFile from a title Do not call this except from inside a repo class.
getDescriptionText( $lang=false)
getDescriptionShortUrl()
Get short description URL for a file based on the page ID.
restore( $versions=[], $unsuppress=false)
recordUpload( $oldver, $desc, $license='', $copyStatus='', $source='', $watch=false, $timestamp=false, User $user=null)
static newFromTitle( $title, $repo, $unused=null)
Class to represent a local file in the wiki's own database.
Definition LocalFile.php:43
int $user
User ID of uploader.
string $timestamp
Upload timestamp.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:48
$res
Definition database.txt:21
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as $wgLang
Definition design.txt:56
const NS_FILE
Definition Defines.php:62
the array() calling protocol came about after MediaWiki 1.4rc1.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition hooks.txt:1096
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition hooks.txt:2710
$license
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
$cache
Definition mcc.php:33
$source
title
if(!isset( $args[0])) $lang