MediaWiki  master
NullRepo Class Reference

File repository with no files, for performance testing. More...

Inheritance diagram for NullRepo:
Collaboration diagram for NullRepo:

Public Member Functions

 __construct ($info)
 
- Public Member Functions inherited from FileRepo
 __construct (array $info=null)
 
 backendSupportsUnicodePaths ()
 
 canTransformVia404 ()
 Returns true if the repository can transform files via a 404 handler. More...
 
 checkRedirect (Title $title)
 Checks if there is a redirect named as $title. More...
 
 cleanDir ($dir)
 Deletes a directory if empty. More...
 
 cleanupBatch (array $files, $flags=0)
 Deletes a batch of files. More...
 
 cleanupDeletedBatch (array $storageKeys)
 Delete files in the deleted directory if they are not referenced in the filearchive table. More...
 
 concatenate (array $srcPaths, $dstPath, $flags=0)
 Concatenate a list of temporary files into a target file location. More...
 
 delete ($srcRel, $archiveRel)
 Move a file to the deletion archive. More...
 
 deleteBatch (array $sourceDestPairs)
 Move a group of files to the deletion archive. More...
 
 enumFiles ($callback)
 Call a callback function for every public regular file in the repository. More...
 
 fileExists ($file)
 Checks existence of a a file. More...
 
 fileExistsBatch (array $files)
 Checks existence of an array of files. More...
 
 findBySha1 ($hash)
 Get an array or iterator of file objects for files that have a given SHA-1 content hash. More...
 
 findBySha1s (array $hashes)
 Get an array of arrays or iterators of file objects for files that have the given SHA-1 content hashes. More...
 
 findFile ($title, $options=[])
 Find an instance of the named file created at the specified time Returns false if the file does not exist. More...
 
 findFileFromKey ($sha1, $options=[])
 Find an instance of the file with this key, created at the specified time Returns false if the file does not exist. More...
 
 findFiles (array $items, $flags=0)
 Find many files at once. More...
 
 findFilesByPrefix ($prefix, $limit)
 Return an array of files where the name starts with $prefix. More...
 
 freeTemp ($virtualUrl)
 Remove a temporary file or mark it for garbage collection. More...
 
 getBackend ()
 Get the file backend instance. More...
 
 getDeletedHashPath ($key)
 Get a relative path for a deletion archive key, e.g. More...
 
 getDescriptionRenderUrl ($name, $lang=null)
 Get the URL of the content-only fragment of the description page. More...
 
 getDescriptionStylesheetUrl ()
 Get the URL of the stylesheet to apply to description pages. More...
 
 getDescriptionUrl ($name)
 Get the URL of an image description page. More...
 
 getDisplayName ()
 Get the human-readable name of the repo. More...
 
 getErrorCleanupFunction ()
 Get a callback function to use for cleaning error message parameters. More...
 
 getFileProps ($virtualUrl)
 Get properties of a file with a given virtual URL/storage path. More...
 
 getFileSha1 ($virtualUrl)
 Get the sha1 (base 36) of a file with a given virtual URL/storage path. More...
 
 getFileSize ($virtualUrl)
 Get the size of a file with a given virtual URL/storage path. More...
 
 getFileTimestamp ($virtualUrl)
 Get the timestamp of a file with a given virtual URL/storage path. More...
 
 getHashLevels ()
 Get the number of hash directory levels. More...
 
 getHashPath ($name)
 Get a relative path including trailing slash, e.g. More...
 
 getInfo ()
 Return information about the repository. More...
 
 getLocalCacheKey ()
 Get a key for this repo in the local cache domain. More...
 
 getLocalCopy ($virtualUrl)
 Get a local FS copy of a file with a given virtual URL/storage path. More...
 
 getLocalReference ($virtualUrl)
 Get a local FS file with a given virtual URL/storage path. More...
 
 getName ()
 Get the name of this repository, as specified by $info['name]' to the constructor. More...
 
 getNameFromTitle (Title $title)
 Get the name of a file from its title object. More...
 
 getReadOnlyReason ()
 Get an explanatory message if this repo is read-only. More...
 
 getRootDirectory ()
 Get the public zone root storage directory of the repository. More...
 
 getSharedCacheKey ()
 Get a key on the primary cache for this repository. More...
 
 getTempHashPath ($suffix)
 Get a relative path including trailing slash, e.g. More...
 
 getTempRepo ()
 Get a temporary private FileRepo associated with this repo. More...
 
 getThumbScriptUrl ()
 Get the URL of thumb.php. More...
 
 getUploadStash (User $user=null)
 Get an UploadStash associated with this repo. More...
 
 getVirtualUrl ($suffix=false)
 Get a URL referring to this repository, with the private mwrepo protocol. More...
 
 getZonePath ($zone)
 Get the storage path corresponding to one of the zones. More...
 
 getZoneUrl ($zone, $ext=null)
 Get the URL corresponding to one of the four basic zones. More...
 
 hasSha1Storage ()
 Returns whether or not storage is SHA-1 based. More...
 
 invalidateImageRedirect (Title $title)
 Invalidates image redirect cache related to that image Doesn't do anything for repositories that don't support image redirects. More...
 
 isLocal ()
 Returns true if this the local file repository. More...
 
 makeUrl ($query= '', $entry= 'index')
 Make an url to this repo. More...
 
 nameForThumb ($name)
 Get the portion of the file that contains the origin file name. More...
 
 newFatal ($message)
 Create a new fatal error. More...
 
 newFile ($title, $time=false)
 Create a new File object from the local repository. More...
 
 newGood ($value=null)
 Create a new good result. More...
 
 paranoidClean ($param)
 Path disclosure protection function. More...
 
 passThrough ($param)
 Path disclosure protection function. More...
 
 publish ($src, $dstRel, $archiveRel, $flags=0, array $options=[])
 Copy or move a file either from a storage path, virtual URL, or file system path, into this repository at the specified destination location. More...
 
 publishBatch (array $ntuples, $flags=0)
 Publish a batch of files. More...
 
 quickCleanDir ($dir)
 Deletes a directory if empty. More...
 
 quickImport ($src, $dst, $options=null)
 Import a file from the local file system into the repo. More...
 
 quickImportBatch (array $triples)
 Import a batch of files from the local file system into the repo. More...
 
 quickPurge ($path)
 Purge a file from the repo. More...
 
 quickPurgeBatch (array $paths)
 Purge a batch of files from the repo. More...
 
 resolveVirtualUrl ($url)
 Get the backend storage path corresponding to a virtual URL. More...
 
 store ($srcPath, $dstZone, $dstRel, $flags=0)
 Store a file to a given destination. More...
 
 storeBatch (array $triplets, $flags=0)
 Store a batch of files. More...
 
 storeTemp ($originalName, $srcPath)
 Pick a random name in the temp zone and store a file to it. More...
 
 streamFile ($virtualUrl, $headers=[])
 Attempt to stream a file with the given virtual URL/storage path. More...
 
 streamFileWithStatus ($virtualUrl, $headers=[], $optHeaders=[])
 Attempt to stream a file with the given virtual URL/storage path. More...
 
 supportsSha1URLs ()
 Returns whether or not repo supports having originals SHA-1s in the thumb URLs. More...
 
 validateFilename ($filename)
 Determine if a relative path is valid, i.e. More...
 

Protected Member Functions

 assertWritableRepo ()
 
- Protected Member Functions inherited from FileRepo
 assertWritableRepo ()
 Throw an exception if this repo is read-only by design. More...
 
 enumFilesInStorage ($callback)
 Call a callback function for every public file in the repository. More...
 
 getZoneLocation ($zone)
 The the storage container and base path of a zone. More...
 
 initDirectory ($dir)
 Creates a directory with the appropriate zone permissions. More...
 
 initZones ($doZones=[])
 Check if a single zone or list of zones is defined for usage. More...
 
 resolveToStoragePath ($path)
 If a path is a virtual URL, resolve it to a storage path. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from FileRepo
static isVirtualUrl ($url)
 Determine if a string is an mwrepo:// URL. More...
 
- Public Attributes inherited from FileRepo
int $descriptionCacheExpiry
 
bool $fetchDescription
 Whether to fetch commons image description pages and display them on the local wiki. More...
 
const DELETE_SOURCE = 1
 
const NAME_AND_TIME_ONLY = 1
 
const OVERWRITE = 2
 
const OVERWRITE_SAME = 4
 
const SKIP_LOCKING = 8
 
- Static Protected Member Functions inherited from FileRepo
static getHashPathForLevel ($name, $levels)
 
- Protected Attributes inherited from FileRepo
int $abbrvThreshold
 File names over this size will use the short form of thumbnail names. More...
 
string $articleUrl
 Equivalent to $wgArticlePath, e.g. More...
 
FileBackend $backend
 
int $deletedHashLevels
 The number of directory levels for hash-based division of deleted files. More...
 
string $descBaseUrl
 URL of image description pages, e.g. More...
 
string $favicon
 The URL of the repo's favicon, if any. More...
 
array $fileFactory = [ 'UnregisteredLocalFile', 'newFromTitle' ]
 callable Override these in the base class More...
 
array $fileFactoryKey = false
 callable|bool Override these in the base class More...
 
int $hashLevels
 The number of directory levels for hash-based division of files. More...
 
bool $hasSha1Storage = false
 
bool $initialCapital
 Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE], determines whether filenames implicitly start with a capital letter. More...
 
bool $isPrivate
 Whether all zones should be private (e.g. More...
 
array $oldFileFactory = false
 callable|bool Override these in the base class More...
 
array $oldFileFactoryKey = false
 callable|bool Override these in the base class More...
 
string $pathDisclosureProtection = 'simple'
 May be 'paranoid' to remove all parameters from error messages, 'none' to leave the paths in unchanged, or 'simple' to replace paths with placeholders. More...
 
string $scriptDirUrl
 URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g. More...
 
string $scriptExtension
 Script extension of the MediaWiki installation, equivalent to the old $wgScriptExtension, e.g. More...
 
bool $supportsSha1URLs = false
 
string $thumbScriptUrl
 URL of thumb.php. More...
 
string $thumbUrl
 The base thumbnail URL. More...
 
bool $transformVia404
 Whether to skip media file transformation on parse and rely on a 404 handler instead. More...
 
string false $url
 Public zone URL. More...
 
array $zones = []
 Map of zones to config. More...
 

Detailed Description

File repository with no files, for performance testing.

Definition at line 28 of file NullRepo.php.

Constructor & Destructor Documentation

NullRepo::__construct (   $info)
Parameters
array | null$info

Definition at line 32 of file NullRepo.php.

Member Function Documentation

NullRepo::assertWritableRepo ( )
protected

Definition at line 35 of file NullRepo.php.


The documentation for this class was generated from the following file: