Go to the documentation of this file.
187 # Normalize NS_MEDIA -> NS_FILE
190 # Sanity check the title namespace
195 # Convert strings to Title objects
198 if ( !
$ret && $exception !==
false ) {
199 throw new MWException(
"`$title` is not a valid file title." );
206 $function = [ $this,
'get' . ucfirst(
$name ) ];
207 if ( !is_callable( $function ) ) {
210 $this->
$name = call_user_func( $function );
232 if ( isset( $squish[$lower] ) ) {
233 return $squish[$lower];
234 } elseif ( preg_match(
'/^[0-9a-z]+$/', $lower ) ) {
251 $n = strrpos( $new,
'.' );
255 return $mimeMagic->isMatchingExtension( $newExt, $oldMime );
274 if ( strpos(
$mime,
'/' ) !==
false ) {
275 return explode(
'/',
$mime, 2 );
277 return [
$mime,
'unknown' ];
298 if ( !isset( $this->
name ) ) {
300 $this->
name = $this->repo->getNameFromTitle( $this->
title );
312 if ( !isset( $this->extension ) ) {
313 $n = strrpos( $this->
getName(),
'.' );
315 $n ? substr( $this->
getName(), $n + 1 ) :
'' );
336 if ( $this->redirected ) {
349 if ( !isset( $this->url ) ) {
352 $this->url = $this->repo->getZoneUrl(
'public',
$ext ) .
'/' . $this->
getUrlRel();
394 wfDebug( __METHOD__ .
': supposed to render ' . $this->
getName() .
397 return $this->
getUrl(); # hm...
return NULL?
418 if ( !isset( $this->path ) ) {
420 $this->path = $this->repo->getZonePath(
'public' ) .
'/' . $this->
getRel();
435 if ( !isset( $this->fsFile ) ) {
437 $this->fsFile = $this->repo->getLocalReference( $this->
getPath() );
440 MediaWikiServices::getInstance()->getStatsdDataFactory()->timing(
441 'media.thumbnail.generate.fetchoriginal', 1000 * $statTiming );
443 if ( !$this->fsFile ) {
444 $this->fsFile =
false;
448 return ( $this->fsFile )
449 ? $this->fsFile->getPath()
495 if ( $imageWidth ===
false ) {
499 if ( $desiredWidth > $imageWidth ) {
509 sort( $sortedBuckets );
511 foreach ( $sortedBuckets
as $bucket ) {
512 if ( $bucket >= $imageWidth ) {
669 if ( !is_array( $metadata ) ) {
708 return 'unknown/unknown';
820 # wfDebug( "LocalFile::isSafeFile: type= $type, mime= $mime\n" );
823 return false; # unknown
type,
not trusted
829 if (
$mime ===
"unknown/unknown" ) {
830 return false; # unknown
type,
not trusted
853 # this could be implemented to check a flag in the database,
854 # look for signatures, etc
878 return $this->
getPath() && $this->repo->fileExists( $this->path );
895 if ( !isset( $this->transformScript ) ) {
896 $this->transformScript =
false;
898 $script = $this->repo->getThumbScriptUrl();
917 $page = isset( $hp[
'page'] ) ? $hp[
'page'] :
false;
922 $hp[
'width'] = $width;
924 unset( $hp[
'height'] );
940 ? $this->repo->nameForThumb( $this->
getName() )
962 if ( $this->repo->supportsSha1URLs() ) {
963 $thumbName .=
'-' . $this->
getSha1() .
'.' . $thumbExt;
965 $thumbName .=
'-' .
$name;
968 $thumbName .=
".$thumbExt";
993 $params = [
'width' => $width ];
994 if ( $height != -1 ) {
998 if ( !$thumb || $thumb->isError() ) {
1002 return $thumb->getUrl();
1018 if (
$handler && $wgIgnoreImageErrors && !(
$flags & self::RENDER_NOW ) ) {
1045 if ( $descriptionUrl ) {
1051 if ( $script && !(
$flags & self::RENDER_NOW ) ) {
1062 $thumbName = $this->
thumbName( $normalisedParams );
1066 if ( $this->repo ) {
1076 wfDebug( __METHOD__ .
": Doing stat for $thumbPath\n" );
1077 if ( !(
$flags & self::RENDER_FORCE ) && $this->repo->fileExists( $thumbPath ) ) {
1078 $timestamp = $this->repo->getFileTimestamp( $thumbPath );
1084 $thumb->setStoragePath( $thumbPath );
1087 } elseif (
$flags & self::RENDER_FORCE ) {
1088 wfDebug( __METHOD__ .
" forcing rendering per flag File::RENDER_FORCE\n" );
1093 if ( $this->repo->getReadOnlyReason() !==
false ) {
1108 return is_object( $thumb ) ? $thumb :
false;
1121 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
1125 $normalisedParams = $transformParams;
1128 $thumbName = $this->
thumbName( $normalisedParams );
1132 $tmpThumbPath = $tmpFile->getPath();
1142 $tmpFile->bind( $thumb );
1144 $statTiming = microtime(
true ) -
$starttime;
1145 $stats->timing(
'media.thumbnail.generate.transform', 1000 * $statTiming );
1149 } elseif ( $thumb->isError() ) {
1151 $this->lastError = $thumb->toText();
1156 } elseif ( $this->repo && $thumb->hasFile() && !$thumb->fileIsSource() ) {
1162 $status = $this->repo->quickImport( $tmpThumbPath, $thumbPath, $disposition );
1164 $thumb->setStoragePath( $thumbPath );
1169 $statTiming = microtime(
true ) -
$starttime;
1170 $stats->timing(
'media.thumbnail.generate.store', 1000 * $statTiming );
1173 Hooks::run(
'FileTransformed', [ $this, $thumb, $tmpThumbPath, $thumbPath ] );
1187 || !isset(
$params[
'physicalWidth'] )
1188 || !isset(
$params[
'physicalHeight'] )
1195 if ( !$bucket || $bucket ==
$params[
'physicalWidth'] ) {
1201 if ( $this->repo->fileExists( $bucketPath ) ) {
1207 $params[
'physicalWidth'] = $bucket;
1220 $buckettime = microtime(
true ) -
$starttime;
1222 if ( !$thumb || $thumb->isError() ) {
1226 $this->tmpBucketedThumbCache[$bucket] = $tmpFile->getPath();
1229 $tmpFile->bind( $this );
1231 MediaWikiServices::getInstance()->getStatsdDataFactory()->timing(
1232 'media.thumbnail.generate.bucket', 1000 * $buckettime );
1245 && isset(
$params[
'physicalWidth'] )
1255 if ( isset( $this->tmpBucketedThumbCache[$bucket] ) ) {
1256 $tmpPath = $this->tmpBucketedThumbCache[$bucket];
1258 if ( file_exists( $tmpPath ) ) {
1262 'height' => $bucketHeight
1269 if ( $this->repo->fileExists( $bucketPath ) ) {
1270 $fsFile = $this->repo->getLocalReference( $bucketPath );
1276 'height' => $bucketHeight
1284 if ( $this->
getSize() >= 1e7 ) {
1288 'doWork' =>
function ()
use ( $that ) {
1289 return $that->getLocalRefPath();
1322 return $this->
thumbName( [
'physicalWidth' => $bucket ] );
1343 if ( $thumbExt !=
'' && $thumbExt !== $this->
getExtension() ) {
1344 $fileName .=
".$thumbExt";
1366 if ( !isset( $this->
handler ) ) {
1380 $assetsPath =
"$wgResourceBasePath/resources/assets/file-type-icons/";
1381 $assetsDirectory =
"$IP/resources/assets/file-type-icons/";
1383 $try = [
'fileicon-' . $this->
getExtension() .
'.png',
'fileicon.png' ];
1384 foreach ( $try
as $icon ) {
1385 if ( file_exists( $assetsDirectory . $icon ) ) {
1386 $params = [
'width' => 120,
'height' => 120 ];
1498 if ( !isset( $this->hashPath ) ) {
1500 $this->hashPath = $this->repo->getHashPath( $this->
getName() );
1525 if ( $suffix ===
false ) {
1543 if ( $suffix !==
false ) {
1544 $path .=
'/' . $suffix;
1570 if ( $suffix ===
false ) {
1588 return $this->repo->getZonePath(
'public' ) .
'/' . $this->
getArchiveRel( $suffix );
1601 return $this->repo->getZonePath(
'thumb' ) .
'/' .
1614 return $this->repo->getZonePath(
'thumb' ) .
'/' . $this->
getThumbRel( $suffix );
1626 return $this->repo->getZonePath(
'transcoded' ) .
'/' . $this->
getThumbRel( $suffix );
1639 if ( $suffix ===
false ) {
1642 $path .= rawurlencode( $suffix );
1658 $path = $this->repo->getZoneUrl(
'thumb',
$ext ) .
'/archive/' .
1659 $this->
getHashPath() . rawurlencode( $archiveName ) .
"/";
1660 if ( $suffix ===
false ) {
1663 $path .= rawurlencode( $suffix );
1680 if ( $suffix !==
false ) {
1681 $path .=
'/' . rawurlencode( $suffix );
1694 return $this->
getZoneUrl(
'thumb', $suffix );
1704 return $this->
getZoneUrl(
'transcoded', $suffix );
1715 $path = $this->repo->getVirtualUrl() .
'/public/' . $this->
getUrlRel();
1716 if ( $suffix !==
false ) {
1717 $path .=
'/' . rawurlencode( $suffix );
1731 $path = $this->repo->getVirtualUrl() .
'/public/archive/' . $this->
getHashPath();
1732 if ( $suffix ===
false ) {
1735 $path .= rawurlencode( $suffix );
1749 $path = $this->repo->getVirtualUrl() .
'/thumb/' . $this->
getUrlRel();
1750 if ( $suffix !==
false ) {
1751 $path .=
'/' . rawurlencode( $suffix );
1763 return (
bool)$this->repo->getHashLevels();
1789 $watch =
false, $timestamp =
false,
User $user =
null
1837 return $this->repo && $this->repo->isLocal();
1846 return $this->repo ? $this->repo->getName() :
'unknown';
1930 function delete( $reason, $suppress =
false,
$user = null ) {
1948 function restore( $versions = [], $unsuppress =
false ) {
1992 if ( $srcWidth == 0 ) {
1995 return (
int)round( $srcHeight * $dstWidth / $srcWidth );
2014 return $this->
getHandler()->getImageSize( $this, $filePath );
2024 if ( $this->repo ) {
2025 return $this->repo->getDescriptionUrl( $this->
getName() );
2040 if ( !$this->repo || !$this->repo->fetchDescription ) {
2046 $renderUrl = $this->repo->getDescriptionRenderUrl( $this->
getName(),
$lang->getCode() );
2049 $key = $this->repo->getLocalCacheKey(
2050 'RemoteFileDescription',
2056 return $cache->getWithSetCallback(
2058 $this->repo->descriptionCacheExpiry ?: $cache::TTL_UNCACHEABLE,
2060 wfDebug(
"Fetching shared description from $renderUrl\n" );
2098 return $this->repo->getFileTimestamp( $this->
getPath() );
2120 return $this->repo->getFileSha1( $this->
getPath() );
2134 $dotExt =
$ext ===
'' ?
'' :
".$ext";
2136 return $hash . $dotExt;
2210 if ( $this->redirected ) {
2211 if ( !$this->redirectTitle ) {
2226 $this->redirected = $from;
2249 if ( !( $this->repo instanceof $this->repoClass ) ) {
2250 throw new MWException(
"A {$this->repoClass} object is not set for this File.\n" );
2260 throw new MWException(
"A Title object is not set for this File.\n" );
getExtension()
Get the file extension, e.g.
when a variable name is used in a function
wasDeleted()
Was this file ever deleted from the wiki?
getDescriptionTouched()
Returns the timestamp (in TS_MW format) of the last change of the description page.
getPath()
Return the storage path to the file.
Media transform output for images.
static checkExtensionCompatibility(File $old, $new)
Checks if file extensions are compatible.
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
FileRepo LocalRepo ForeignAPIRepo bool $repo
Some member variables can be lazy-initialised using __get().
canAnimateThumbIfAppropriate()
Will the thumbnail be animated if one would expect it to be.
getArchiveThumbPath( $archiveName, $suffix=false)
Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified.
const TTL_UNCACHEABLE
Idiom for getWithSetCallback() callbacks to avoid calling set()
processing should stop and the error should be shown to the user * false
getHeight( $page=1)
Return the height of the image.
array $tmpBucketedThumbCache
Cache of tmp filepaths pointing to generated bucket thumbnails, keyed by width.
getBitDepth()
Return the bit depth of the file Overridden by LocalFile STUB.
getUrlRel()
Get urlencoded path of the file relative to the public zone root.
migrateThumbFile( $thumbName)
Hook into transform() to allow migration of thumbnail files STUB Overridden by LocalFile.
isMultipage()
Returns 'true' if this file is a type which supports multiple pages, e.g.
getFullUrl()
Return a fully-qualified URL to the file.
getZoneUrl( $zone, $suffix=false)
Get the URL of the zone directory, or a particular file if $suffix is specified.
getMetadata()
Get handler-specific metadata Overridden by LocalFile, UnregisteredLocalFile STUB.
if(!isset( $args[0])) $lang
getIsSafeFileUncached()
Uncached accessor.
string $transformScript
URL of transformscript (for example thumb.php)
getRel()
Get the path of the file relative to the public zone root.
isExpensiveToThumbnail()
True if creating thumbnails from the file is large or otherwise resource-intensive.
getOriginalTitle()
Return the title used to find this file.
getLastError()
Get last thumbnailing error.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 $status
getTimestamp()
Get the 14-character timestamp of the file upload.
getSha1()
Get the SHA-1 base 36 hash of the file.
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
convertMetadataVersion( $metadata, $version)
get versioned metadata
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
getUser( $type='text')
Returns ID or name of user who uploaded the file STUB.
static addUpdate(DeferrableUpdate $update, $stage=self::POSTSEND)
Add an update to the deferred list to be run later by execute()
static extensionFromPath( $path, $case='lowercase')
Get the final extension from a storage or FS path.
unserialize( $serialized)
const RENDER_FORCE
Force rendering even if thumbnail already exist and using RENDER_NOW I.e.
getUrl()
Return the URL of the file.
static compare(File $a, File $b)
Callback for usort() to do file sorts by name.
getTranscodedUrl( $suffix=false)
Get the URL of the transcoded directory, or a particular file if $suffix is specified.
getThumbnailSource( $params)
Returns the most appropriate source image for the thumbnail, given a target thumbnail size.
getWidth( $page=1)
Return the width of the image.
recordUpload( $oldver, $desc, $license='', $copyStatus='', $source='', $watch=false, $timestamp=false, User $user=null)
Record a file upload in the upload log and the image table STUB Overridden by LocalFile.
getMediaType()
Return the type of the media in the file.
restore( $versions=[], $unsuppress=false)
Restore all or specified deleted revisions to the given file.
static splitMime( $mime)
Split an internet media type into its two components; if not a two-part name, set the minor type to '...
isVisible()
Returns true if file exists in the repository and can be included in a page.
Convenience class for dealing with PoolCounters using callbacks.
$wgThumbnailBuckets
When defined, is an array of image widths used as buckets for thumbnail generation.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Interface for database access objects.
string $repoClass
Required Repository class type.
getArchiveRel( $suffix=false)
Get the path of an archived file relative to the public zone root.
isDeleted( $field)
Is this file a "deleted" file in a private archive? STUB.
getVisibility()
Return the deletion bitfield STUB.
getDescriptionText( $lang=false)
Get the HTML text of the description page, if available.
$wgThumbnailMinimumBucketDistance
When using thumbnail buckets as defined above, this sets the minimum distance to the bucket above the...
static normalizeTitle( $title, $exception=false)
Given a string or Title object return either a valid Title object with namespace NS_FILE or null.
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
exists()
Returns true if file exists in the repository.
getThumbVirtualUrl( $suffix=false)
Get the virtual URL for a thumbnail file or directory.
$wgThumbnailEpoch
If rendered thumbnail files are older than this timestamp, they will be rerendered on demand as if th...
upgradeRow()
Upgrade the database row if there is one Called by ImagePage STUB.
Base class for file repositories.
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
string $path
The storage path corresponding to one of the zones.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves set to a MediaTransformOutput the error message to be returned in an array you should do so by altering $wgNamespaceProtection and $wgNamespaceContentModels outside the handler
isCacheable()
Check if this file object is small and can be cached.
bool $canRender
Whether the output of transform() for this file is likely to be valid.
getBucketThumbName( $bucket)
Returns the name of the thumb for a given bucket.
Implements some public methods and some protected utility functions which are required by multiple ch...
getMimeType()
Returns the MIME type of the file.
getDefaultRenderLanguage()
In files that support multiple language, what is the default language to use if none specified.
string $url
The URL corresponding to one of the four basic zones.
getLocalRefPath()
Get an FS copy or original of this file and return the path.
transformErrorOutput( $thumbPath, $thumbUrl, $params, $flags)
Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors)
getIsSafeFile()
Accessor for __get()
getThumbPath( $suffix=false)
Get the path of the thumbnail directory, or a particular file if $suffix is specified.
pageCount()
Returns the number of pages of a multipage document, or false for documents which aren't multipage do...
nextHistoryLine()
Return the history of this file, line by line.
static normalizeExtension( $extension)
Normalize a file extension to the common form, making it lowercase and checking some synonyms,...
execute( $skipcache=false)
Get the result of the work (whatever it is), or the result of the error() function.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
getArchiveVirtualUrl( $suffix=false)
Get the public zone virtual URL for an archived version source file.
purgeCache( $options=[])
Purge shared caches such as thumbnails and DB data caching STUB Overridden by LocalFile.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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 the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers please use GetContentModels hook to make them known to core if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
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
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
getArchiveThumbRel( $archiveName, $suffix=false)
Get the path, relative to the thumbnail zone root, for an archived file's thumbs directory or a speci...
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array change it to the message you want to define you are encouraged to submit patches to MediaWiki s core to add new MIME types to mime types $mimeMagic
when a variable name is used in a it is silently declared as a new masking the global
static singleton()
Get an instance of this class.
getStorageKey()
Get the deletion archive key, "<sha1>.<ext>".
__construct( $title, $repo)
Call this constructor from child classes.
generateAndSaveThumb( $tmpFile, $transformParams, $flags)
Generates a thumbnail according to the given parameters and saves it to storage.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
getCommonMetaArray()
Like getMetadata but returns a handler independent array of common values.
getThumbRel( $suffix=false)
Get the path, relative to the thumbnail zone root, of the thumbnail directory or a particular file if...
static factory( $prefix, $extension='', $tmpDirectory=null)
Make a new temporary file on the file system.
isTransformedLocally()
Whether the thumbnails created on the same server as this code is running.
static get( $url, $options=[], $caller=__METHOD__)
Simple wrapper for Http::request( 'GET' )
canRender()
Checks if the output of transform() for this file is likely to be valid.
FSFile bool $fsFile
False if undefined.
if( $ext=='php'|| $ext=='php5') $mime
string false $pageCount
Number of pages of a multipage document, or false for documents which aren't multipage documents.
Class to invalidate the HTML cache of all the pages linking to a given title.
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
getAvailableLanguages()
Gives a (possibly empty) list of languages to render the file in.
iconThumb()
Get a ThumbnailImage representing a file type icon.
purgeDescription()
Purge the file description page, but don't go after pages using the file.
isOld()
Returns true if the image is an old version STUB.
assertTitleDefined()
Assert that $this->title is set to a Title.
$wgIgnoreImageErrors
If set, inline scaled images will still produce "<img>" tags ready for output instead of showing an e...
getHistory( $limit=null, $start=null, $end=null, $inc=true)
Return a fragment of the history of file.
generateThumbName( $name, $params)
Generate a thumbnail file name from a name and specified parameters.
formatMetadata( $context=false)
createThumb( $width, $height=-1)
Create a thumbnail of the image having the specified width/height.
getDescriptionUrl()
Get the URL of the image description page.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
getArchiveThumbUrl( $archiveName, $suffix=false)
Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified.
getName()
Return the name of this file.
getArchiveUrl( $suffix=false)
Get the URL of the archive directory, or a particular file if $suffix is specified.
getThumbDisposition( $thumbName, $dispositionType='inline')
Class representing a non-directory file on the file system.
isSafeFile()
Determines if this media file is in a format that is unlikely to contain viruses or malicious content...
getRepoName()
Returns the name of the repository.
publish( $src, $flags=0, array $options=[])
Move or copy a file to its public location.
string $extension
File extension.
getBucketThumbPath( $bucket)
Returns the repo path of the thumb for a given bucket.
string $hashPath
Relative path including trailing slash.
static scaleHeight( $srcWidth, $srcHeight, $dstWidth)
Calculate the height of a thumbnail using the source and destination width.
see documentation in includes Linker php for Linker::makeImageLink & $handlerParams
const RENDER_NOW
Force rendering in the current process.
transform( $params, $flags=0)
Transform a media file.
getTitle()
Return the associated title object.
Represents a title within MediaWiki.
A foreign repository with a remote MediaWiki with an API thingy.
wfTempDir()
Tries to get the system directory for temporary files.
bool $isSafeFile
Whether this media file is in a format that is unlikely to contain viruses or malicious content.
getThumbnailBucket( $desiredWidth, $page=1)
Return the smallest bucket from $wgThumbnailBuckets which is at least $wgThumbnailMinimumBucketDistan...
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
move( $target)
Move file to the new title.
assertRepoDefined()
Assert that $this->repo is set to a valid FileRepo instance.
static getMainWANInstance()
Get the main WAN cache object.
getDescription( $audience=self::FOR_PUBLIC, User $user=null)
Get description of file revision STUB.
getLength()
Get the duration of a media file in seconds.
isLocal()
Returns true if the file comes from the local file repository.
purgeSquid()
Purge all applicable CDN URLs.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
getCanRender()
Accessor for __get()
mustRender()
Return true if the file is of a type that can't be directly rendered by typical browsers and needs to...
load( $flags=0)
Load any lazy-loaded file object fields from source.
isDeletedQuick()
Is there a version of this page in the deletion archive?
resetHistory()
Reset the history pointer to the first element of the history.
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 "<
string $name
The name of a file from its title object.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
getRepo()
Returns the repository.
allowInlineDisplay()
Alias for canRender()
invalidateCache( $purgeTime=null)
Updates page_touched for this page; called from LinksUpdate.php.
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
getThumbUrl( $suffix=false)
Get the URL of the thumbnail directory, or a particular file if $suffix is specified.
isVectorized()
Return true if the file is vectorized.
getHandler()
Get a MediaHandler instance for this file.
$wgTrustedMediaFormats
list of trusted media-types and MIME types.
userCan( $field, User $user=null)
Determine if the current user is allowed to view a particular field of this file, if it's marked as d...
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
generateBucketsIfNeeded( $params, $flags=0)
Generates chained bucketed thumbnails if needed.
thumbName( $params, $flags=0)
Return the file name of a thumbnail with the specified parameters.
string $lastError
Text of last error.
string $redirected
Main part of the title, with underscores (Title::getDBkey)
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
getImageSize( $filePath)
Get an image size array like that returned by getImageSize(), or false if it can't be determined.
getPath()
Returns the file system path.
makeTransformTmpFile( $thumbPath)
Creates a temp FS file with the same extension and the thumbnail.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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
getArchivePath( $suffix=false)
Get the path of the archived file.
purgeEverything()
Purge metadata and all affected pages when the file is created, deleted, or majorly updated.
getUnscaledThumb( $handlerParams=[])
Get a ThumbnailImage which is the same size as the source.
getHashPath()
Get the filename hash component of the directory including trailing slash, e.g.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
isTrustedFile()
Returns true if the file is flagged as trusted.
A repository that stores files in the local filesystem and registers them in the wiki's own database.
getSize()
Return the size of the image file, in bytes Overridden by LocalFile, UnregisteredLocalFile STUB.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
the array() calling protocol came about after MediaWiki 1.4rc1.
getThumbnails()
Get all thumbnail names previously generated for this file STUB Overridden by LocalFile.
getTranscodedPath( $suffix=false)
Get the path of the transcoded directory, or a particular file if $suffix is specified.
getVirtualUrl( $suffix=false)
Get the public zone virtual URL for a current version source file.
static makeContentDisposition( $type, $filename='')
Build a Content-Disposition header value per RFC 6266.