MediaWiki master
MediaWiki\Page\File\BadFileLookup Class Reference

Public Member Functions

 __construct (callable $listCallback, BagOStuff $cache, RepoGroup $repoGroup, TitleParser $titleParser, HookContainer $hookContainer)
 Do not call directly.
 
 isBadFile ( $name, LinkTarget $contextTitle=null)
 Determine if a file exists on the 'bad image list'.
 

Detailed Description

Definition at line 13 of file BadFileLookup.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Page\File\BadFileLookup::__construct ( callable  $listCallback,
BagOStuff  $cache,
RepoGroup  $repoGroup,
TitleParser  $titleParser,
HookContainer  $hookContainer 
)

Do not call directly.

Use MediaWikiServices.

Parameters
callable$listCallbackCallback that returns wikitext of a bad file list
BagOStuff$cacheFor caching parsed versions of the bad file list
RepoGroup$repoGroup
TitleParser$titleParser
HookContainer$hookContainer

Definition at line 41 of file BadFileLookup.php.

Member Function Documentation

◆ isBadFile()

MediaWiki\Page\File\BadFileLookup::isBadFile (   $name,
LinkTarget  $contextTitle = null 
)

Determine if a file exists on the 'bad image list'.

The format of MediaWiki:Bad_image_list is as follows:

  • Only list items (lines starting with "*") are considered
  • The first link on a line must be a link to a bad file
  • Any subsequent links on the same line are considered to be exceptions, i.e. articles where the file may occur inline.
Parameters
string$nameThe file name to check
LinkTarget | null$contextTitleThe page on which the file occurs, if known
Returns
bool

Definition at line 68 of file BadFileLookup.php.


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