Prioritized list of file repositories. More...

Collaboration diagram for RepoGroup:

[legend]

Public Member Functions
	__construct ( $localInfo, $foreignInfo, WANObjectCache $wanCache, MimeAnalyzer $mimeAnalyzer)
	Construct a group of file repositories.

	checkRedirect ( $title)
	Interface for FileRepo::checkRedirect()

	clearCache ( $title=null)
	Clear RepoGroup process cache used for finding a file.

	findBySha1 ( $hash)
	Find all instances of files with this key.

	findBySha1s (array $hashes)
	Find all instances of files with this keys.

	findFile ( $title, $options=[])
	Search repositories for an image.

	findFileFromKey ( $hash, $options=[])
	Find an instance of the file with this key, created at the specified time Returns false if the file does not exist.

	findFiles (array $inputItems, $flags=0)
	Search repositories for many files at once.

	forEachForeignRepo ( $callback, $params=[])
	Call a function for each foreign repo, with the repo object as the first parameter.

	getFileProps ( $fileName)

	getLocalRepo ()
	Get the local repository, i.e.

	getRepo ( $index)
	Get the repo instance with a given key.

	getRepoByName ( $name)
	Get the repo instance by its name.

	hasForeignRepos ()
	Does the installation have any foreign repos set up?

	initialiseRepos ()
	Initialise the $repos array.

	newCustomLocalRepo ( $info=[])
	Create a local repo with the specified option overrides.

Protected Member Functions
	newRepo ( $info)
	Create a repo class based on an info structure.

Protected Attributes
MapCacheLRU	$cache

array	$foreignInfo

FileRepo[]	$foreignRepos

array	$localInfo

LocalRepo	$localRepo

bool	$reposInitialised = false

WANObjectCache	$wanCache

Detailed Description

Prioritized list of file repositories.

Definition at line 30 of file RepoGroup.php.

Constructor & Destructor Documentation

◆ __construct()

RepoGroup::__construct	(		$localInfo,
			$foreignInfo,
		WANObjectCache	$wanCache,
		MimeAnalyzer	$mimeAnalyzer )

Construct a group of file repositories.

Do not call this – use MediaWikiServices::getRepoGroup.

Parameters

array	$localInfo	Associative array for local repo's info
array	$foreignInfo	Array of repository info arrays. Each info array is an associative array with the 'class' member giving the class name. The entire array is passed to the repository constructor as the first parameter.
WANObjectCache	$wanCache
MimeAnalyzer	$mimeAnalyzer

Definition at line 70 of file RepoGroup.php.

Member Function Documentation

◆ checkRedirect()

RepoGroup::checkRedirect ( $title )

Interface for FileRepo::checkRedirect()

Parameters

PageIdentity | LinkTarget | string $title

Returns: Title|false

Definition at line 213 of file RepoGroup.php.

References initialiseRepos().

◆ clearCache()

RepoGroup::clearCache ( $title = null )

Clear RepoGroup process cache used for finding a file.

Parameters

PageIdentity | string | null $title File page or file name, or null to clear all files

Definition at line 463 of file RepoGroup.php.

◆ findBySha1()

RepoGroup::findBySha1 ( $hash )

Find all instances of files with this key.

Parameters

string $hash Base 36 SHA-1 hash

Returns: File[]

Definition at line 267 of file RepoGroup.php.

References initialiseRepos().

◆ findBySha1s()

RepoGroup::findBySha1s ( array $hashes )

Find all instances of files with this keys.

Parameters

string[] $hashes Base 36 SHA-1 hashes

Returns: File[][]

Definition at line 287 of file RepoGroup.php.

References initialiseRepos().

◆ findFile()

RepoGroup::findFile	(		$title,
			$options = [] )

Search repositories for an image.

Parameters

PageIdentity \| LinkTarget \| string	$title	The file to find
array	$options	Associative array of options: time: requested time for an archived image, or false for the current version. An image object will be returned which was created at the specified time. ignoreRedirect: If true, do not follow file redirects private: If Authority object, return restricted (deleted) files if the performer is allowed to view them. Otherwise, such files will not be found. Authority is only accepted since 1.37, User was required before. latest: If true, load from the latest available data into File objects @phpcs:ignore Generic.Files.LineLength

Returns: File|false False if title is not found

Definition at line 101 of file RepoGroup.php.

References initialiseRepos(), and wfTimestamp().

◆ findFileFromKey()

RepoGroup::findFileFromKey	(		$hash,
			$options = [] )

Find an instance of the file with this key, created at the specified time Returns false if the file does not exist.

Parameters

string	$hash	Base 36 SHA-1 hash
array	$options	Option array, same as findFile()

Returns: File|false File object or false if it is not found

Definition at line 243 of file RepoGroup.php.

References $file, and initialiseRepos().

◆ findFiles()

RepoGroup::findFiles	(	array	$inputItems,
			$flags = 0 )

Search repositories for many files at once.

Parameters

array $inputItems An array of titles, or an array of findFile() options with the "title" option giving the title. Example:

$findItem = [ 'title' => $title, 'private' => true ]; $findBatch = [ $findItem ]; $repo->findFiles( $findBatch );

No title should appear in $items twice, as the result use titles as keys

Parameters

int

$flags

Supports:

FileRepo::NAME_AND_TIME_ONLY : return a (search title => (title,timestamp)) map. The search title uses the input titles; the other is the final post-redirect title. All titles are returned as string DB keys and the inner array is associative.

Returns: array Map of (file name => File objects) for matches or (search title => (title,timestamp))

Definition at line 178 of file RepoGroup.php.

References initialiseRepos().

◆ forEachForeignRepo()

RepoGroup::forEachForeignRepo	(		$callback,
			$params = [] )

Call a function for each foreign repo, with the repo object as the first parameter.

Parameters

callable	$callback	The function to call
array	$params	Optional additional parameters to pass to the function

Returns: bool

Definition at line 356 of file RepoGroup.php.

References initialiseRepos().

◆ getFileProps()

RepoGroup::getFileProps ( $fileName )

Parameters

string $fileName

Returns: array

Definition at line 443 of file RepoGroup.php.

References getRepo(), and FileRepo\isVirtualUrl().

◆ getLocalRepo()

RepoGroup::getLocalRepo ( )

Get the local repository, i.e.

the one corresponding to the local image table. Files are typically uploaded to the local repository.

Returns: LocalRepo

Definition at line 343 of file RepoGroup.php.

References getRepo().

Referenced by ApiQueryAllImages\__construct(), MediaWiki\Pager\ImageListPager\__construct(), MediaWiki\Specials\SpecialUndelete\__construct(), and MediaWiki\Specials\SpecialUploadStash\__construct().

◆ getRepo()

RepoGroup::getRepo ( $index )

Get the repo instance with a given key.

Parameters

string | int $index

Returns: FileRepo|false

Definition at line 309 of file RepoGroup.php.

References initialiseRepos().

Referenced by getFileProps(), and getLocalRepo().

◆ getRepoByName()

RepoGroup::getRepoByName ( $name )

Get the repo instance by its name.

Parameters

string $name

Returns: FileRepo|false

Definition at line 324 of file RepoGroup.php.

References initialiseRepos().

◆ hasForeignRepos()

RepoGroup::hasForeignRepos ( )

Does the installation have any foreign repos set up?

Returns: bool

Definition at line 373 of file RepoGroup.php.

References initialiseRepos().

◆ initialiseRepos()

RepoGroup::initialiseRepos ( )

Initialise the $repos array.

Definition at line 383 of file RepoGroup.php.

References newRepo().

Referenced by checkRedirect(), findBySha1(), findBySha1s(), findFile(), findFileFromKey(), findFiles(), forEachForeignRepo(), getRepo(), getRepoByName(), and hasForeignRepos().

◆ newCustomLocalRepo()

RepoGroup::newCustomLocalRepo ( $info = [] )

Create a local repo with the specified option overrides.

Parameters

array $info

Returns: LocalRepo

Definition at line 402 of file RepoGroup.php.

References newRepo().

◆ newRepo()

RepoGroup::newRepo ( $info )

protected

Create a repo class based on an info structure.

Parameters

array $info

Returns: FileRepo

Definition at line 412 of file RepoGroup.php.

Referenced by initialiseRepos(), and newCustomLocalRepo().

Member Data Documentation

◆ $cache

MapCacheLRU RepoGroup::$cache

protected

Definition at line 50 of file RepoGroup.php.

◆ $foreignInfo

array RepoGroup::$foreignInfo

protected

Definition at line 47 of file RepoGroup.php.

◆ $foreignRepos

FileRepo [] RepoGroup::$foreignRepos

protected

Definition at line 35 of file RepoGroup.php.

◆ $localInfo

array RepoGroup::$localInfo

protected

Definition at line 44 of file RepoGroup.php.

◆ $localRepo

LocalRepo RepoGroup::$localRepo

protected

Definition at line 32 of file RepoGroup.php.

◆ $reposInitialised

bool RepoGroup::$reposInitialised = false

protected

Definition at line 41 of file RepoGroup.php.

◆ $wanCache

WANObjectCache RepoGroup::$wanCache

protected

Definition at line 38 of file RepoGroup.php.

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

includes/filerepo/RepoGroup.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkRedirect()

◆ clearCache()

◆ findBySha1()

◆ findBySha1s()

◆ findFile()

◆ findFileFromKey()

◆ findFiles()

◆ forEachForeignRepo()

◆ getFileProps()

◆ getLocalRepo()

◆ getRepo()

◆ getRepoByName()

◆ hasForeignRepos()

◆ initialiseRepos()

◆ newCustomLocalRepo()

◆ newRepo()

Member Data Documentation

◆ $cache

◆ $foreignInfo

◆ $foreignRepos

◆ $localInfo

◆ $localRepo

◆ $reposInitialised

◆ $wanCache