Prioritized list of file repositories. More...

Collaboration diagram for RepoGroup:

Public Member Functions
	__construct ($localInfo, $foreignInfo)
	Construct a group of file repositories.
	checkRedirect (Title $title)
	Interface for FileRepo::checkRedirect()
	clearCache (Title $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=array())
	Search repositories for an image.
	findFileFromKey ($hash, $options=array())
	Find an instance of the file with this key, created at the specified time Returns false if the file does not exist.
	findFiles ($inputItems)
	forEachForeignRepo ($callback, $params=array())
	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.
	splitVirtualUrl ($url)
	Split a virtual URL into repo, zone and rel parts.
Static Public Member Functions
static	destroySingleton ()
	Destroy the singleton instance, so that a new one will be created next time singleton() is called.
static	setSingleton ($instance)
	Set the singleton instance to a given object Used by extensions which hook into the Repo chain.
static	singleton ()
	Get a RepoGroup instance.
Public Attributes
	$cache
	$foreignInfo
	$foreignRepos
	$localInfo
LocalRepo	$localRepo
	$reposInitialised = false
const	MAX_CACHE_SIZE = 500
Protected Member Functions
	newRepo ($info)
	Create a repo class based on an info structure.
	pingCache ($key)
	Move a cache entry to the top (such as when accessed)
	trimCache ()
	Limit cache memory.
Static Protected Attributes
static	$instance

Detailed Description

Prioritized list of file repositories.

Definition at line 29 of file RepoGroup.php.

Constructor & Destructor Documentation

RepoGroup::__construct	(	$	localInfo,
		$	foreignInfo
	)

Construct a group of file repositories.

Parameters:

$localInfo	array Associative array for local repo's info
$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.

Definition at line 87 of file RepoGroup.php.

Member Function Documentation

RepoGroup::checkRedirect ( Title $ title )

Interface for FileRepo::checkRedirect()

Parameters:

$title Title

Returns:: bool

Definition at line 205 of file RepoGroup.php.

RepoGroup::clearCache ( Title $ title = null )

Clear RepoGroup process cache used for finding a file.

Parameters:

$title Title|null Title of the file or null to clear all files

Definition at line 444 of file RepoGroup.php.

static RepoGroup::destroySingleton ( ) [static]

Destroy the singleton instance, so that a new one will be created next time singleton() is called.

Definition at line 62 of file RepoGroup.php.

Referenced by UploadFromUrlTestSuite\setUp(), NewParserTest\setupGlobals(), UploadFromUrlTestSuite\tearDown(), NewParserTest\tearDown(), and NewParserTest\teardownGlobals().

RepoGroup::findBySha1 ( $ hash )

Find all instances of files with this key.

Parameters:

$hash String base 36 SHA-1 hash

Returns:: Array of File objects

Definition at line 252 of file RepoGroup.php.

RepoGroup::findBySha1s ( array $ hashes )

Find all instances of files with this keys.

Parameters:

$hashes Array base 36 SHA-1 hashes

Returns:: Array of array of File objects

Definition at line 271 of file RepoGroup.php.

RepoGroup::findFile	(	$	title,
		$	options = `array()`
	)

Search repositories for an image.

You can also use wfFindFile() to do this.

Parameters:

$title	Title\|string Title object or string
$options	array 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 true, return restricted (deleted) files if the current user is allowed to view them. Otherwise, such files will not be found.

bypassCache: If true, do not use the process-local cache of File objects

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

Definition at line 112 of file RepoGroup.php.

RepoGroup::findFileFromKey	(	$	hash,
		$	options = `array()`
	)

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

Parameters:

$hash	String base 36 SHA-1 hash
$options	array Option array, same as findFile()

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

Definition at line 231 of file RepoGroup.php.

RepoGroup::findFiles ( $ inputItems )

Parameters:

$inputItems array

Returns:: array

Definition at line 171 of file RepoGroup.php.

RepoGroup::forEachForeignRepo	(	$	callback,
		$	params = `array()`
	)

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

Parameters:

$callback	Callback: the function to call
$params	Array: optional additional parameters to pass to the function

Returns:: bool

Definition at line 340 of file RepoGroup.php.

RepoGroup::getFileProps ( $ fileName )

Parameters:

$fileName string

Returns:: array

Definition at line 404 of file RepoGroup.php.

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 328 of file RepoGroup.php.

RepoGroup::getRepo ( $ index )

Get the repo instance with a given key.

Parameters:

$index string|int

Returns:: bool|LocalRepo

Definition at line 292 of file RepoGroup.php.

RepoGroup::getRepoByName ( $ name )

Get the repo instance by its name.

Parameters:

$name string

Returns:: bool

Definition at line 310 of file RepoGroup.php.

RepoGroup::hasForeignRepos ( )

Does the installation have any foreign repos set up?

Returns:: Boolean

Definition at line 354 of file RepoGroup.php.

RepoGroup::initialiseRepos ( )

Initialise the $repos array.

Definition at line 361 of file RepoGroup.php.

RepoGroup::newRepo ( $ info ) [protected]

Create a repo class based on an info structure.

Definition at line 377 of file RepoGroup.php.

RepoGroup::pingCache ( $ key ) [protected]

Move a cache entry to the top (such as when accessed)

Definition at line 420 of file RepoGroup.php.

static RepoGroup::setSingleton ( $ instance ) [static]

Set the singleton instance to a given object Used by extensions which hook into the Repo chain.

It's not enough to just create a superclass ... you have to get people to call into it even though all they know is RepoGroup::singleton()

Parameters:

$instance RepoGroup

Definition at line 74 of file RepoGroup.php.

static RepoGroup::singleton ( ) [static]

Get a RepoGroup instance.

At present only one instance of RepoGroup is needed in a MediaWiki invocation, this may change in the future.

Returns:: RepoGroup

Definition at line 49 of file RepoGroup.php.

Referenced by ApiQueryAllImages\__construct(), UploadFromChunks\__construct(), UploadFromStash\__construct(), SpecialUploadStash\__construct(), RevDel_FileItem\__construct(), RevertFileAction\checkCanExecute(), UploadBase\checkWarnings(), ApiDelete\deleteFile(), ApiTestCaseUpload\deleteFileByContent(), NewParserTest\deleteFiles(), DeleteArchivedFilesImplementation\doDelete(), RevDel_FileList\doPreCommitUpdates(), MovePageForm\doSubmit(), ApiQueryStashImageInfo\execute(), ApiMove\execute(), CheckImages\execute(), ApiQueryImageInfo\execute(), UploadStashCleanup\execute(), RefreshImageMetadata\execute(), ImageCleanup\filePath(), UploadBase\getRealPath(), Linker\makeBrokenImageLinkObj(), Title\moveTo(), PurgeDeletedFiles\purgeFromLogType(), ApiQueryDuplicateFiles\run(), NewParserTest\setupUploads(), UploadBase\stashFile(), UploadStashTest\testBug29408(), SpecialUploadStash\tryClearStashedUploads(), SpecialRevisionDelete\tryShowFile(), wfExtractThumbParams(), wfFindFile(), wfIsBadImage(), wfLocalFile(), and wfStreamThumb().

RepoGroup::splitVirtualUrl ( $ url )

Split a virtual URL into repo, zone and rel parts.

Parameters:

$url string

Exceptions:

MWException

Returns:: array containing repo, zone and rel

Definition at line 388 of file RepoGroup.php.

RepoGroup::trimCache ( ) [protected]

Limit cache memory.

Definition at line 431 of file RepoGroup.php.

Member Data Documentation

RepoGroup::$cache

Definition at line 36 of file RepoGroup.php.

RepoGroup::$foreignInfo

Definition at line 35 of file RepoGroup.php.

RepoGroup::$foreignRepos

Definition at line 34 of file RepoGroup.php.

RepoGroup::$instance [static, protected]

Definition at line 41 of file RepoGroup.php.

RepoGroup::$localInfo

Definition at line 35 of file RepoGroup.php.

LocalRepo RepoGroup::$localRepo

Definition at line 32 of file RepoGroup.php.

RepoGroup::$reposInitialised = false

Definition at line 34 of file RepoGroup.php.

const RepoGroup::MAX_CACHE_SIZE = 500

Definition at line 42 of file RepoGroup.php.

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

includes/filerepo/RepoGroup.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation