FileBackendGroup Class Reference

Class to handle file backend registration. More...

Public Member Functions
	__construct (ServiceOptions $options, ConfiguredReadOnlyMode $configuredReadOnlyMode, BagOStuff $srvCache, WANObjectCache $wanCache, MimeAnalyzer $mimeAnalyzer, LockManagerGroupFactory $lmgFactory, TempFSFileFactory $tmpFileFactory, ObjectFactory $objectFactory)
	backendFromPath ( $storagePath)
	Get an appropriate backend object from a storage path. More...
	config ( $name)
	Get the config array for a backend object with a given name. More...
	get ( $name)
	Get the backend object with a given name. More...
	guessMimeInternal ( $storagePath, $content, $fsPath)

Public Attributes
const	CONSTRUCTOR_OPTIONS

Protected Member Functions
	register (array $configs, $readOnlyReason=null)
	Register an array of file backend configurations. More...

Protected Attributes
array[]	$backends = []
	(name => ('class' => string, 'config' => array, 'instance' => object)) More...

Detailed Description

Class to handle file backend registration.

Since

1.19

Definition at line 38 of file FileBackendGroup.php.

Constructor & Destructor Documentation

__construct()

FileBackendGroup::__construct	(	ServiceOptions	$options,
		ConfiguredReadOnlyMode	$configuredReadOnlyMode,
		BagOStuff	$srvCache,
		WANObjectCache	$wanCache,
		MimeAnalyzer	$mimeAnalyzer,
		LockManagerGroupFactory	$lmgFactory,
		TempFSFileFactory	$tmpFileFactory,
		ObjectFactory	$objectFactory
	)

Parameters

ServiceOptions	$options
ConfiguredReadOnlyMode	$configuredReadOnlyMode
BagOStuff	$srvCache
WANObjectCache	$wanCache
MimeAnalyzer	$mimeAnalyzer
LockManagerGroupFactory	$lmgFactory
TempFSFileFactory	$tmpFileFactory
ObjectFactory	$objectFactory

Definition at line 87 of file FileBackendGroup.php.

References MediaWiki\Config\ServiceOptions\get(), and Wikimedia\Rdbms\ConfiguredReadOnlyMode\getReason().

Member Function Documentation

backendFromPath()

FileBackendGroup::backendFromPath

(

$storagePath

)

Get an appropriate backend object from a storage path.

Parameters

string

$storagePath

Returns

FileBackend|null Backend or null on failure

Definition at line 254 of file FileBackendGroup.php.

References FileBackend\splitStoragePath().

config()

FileBackendGroup::config

(

$name

)

Get the config array for a backend object with a given name.

Parameters

string

$name

Returns

array Parameters to FileBackend::__construct()

Exceptions

InvalidArgumentException

Definition at line 214 of file FileBackendGroup.php.

References Profiler\instance().

Referenced by get().

get()

FileBackendGroup::get

(

$name

)

Get the backend object with a given name.

Parameters

string

$name

Returns

FileBackend

Exceptions

InvalidArgumentException

Definition at line 184 of file FileBackendGroup.php.

References config().

guessMimeInternal()

FileBackendGroup::guessMimeInternal	(		$storagePath,
			$content,
			$fsPath
	)

Parameters

string	$storagePath
string | null	$content
string | null	$fsPath

Returns

string

Since

1.27

Definition at line 270 of file FileBackendGroup.php.

References $content, $ext, $type, and FileBackend\extensionFromPath().

register()

FileBackendGroup::register ( array  $configs,   $readOnlyReason = null  )

protected

Register an array of file backend configurations.

Parameters

array[]	$configs
string | null	$readOnlyReason

Exceptions

InvalidArgumentException

Definition at line 152 of file FileBackendGroup.php.

Member Data Documentation

$backends

array [] FileBackendGroup::$backends = []

protected

(name => ('class' => string, 'config' => array, 'instance' => object))

Definition at line 43 of file FileBackendGroup.php.

CONSTRUCTOR_OPTIONS

const FileBackendGroup::CONSTRUCTOR_OPTIONS

Initial value:

= [
        MainConfigNames::DirectoryMode,
        MainConfigNames::FileBackends,
        MainConfigNames::ForeignFileRepos,
        MainConfigNames::LocalFileRepo,
        'fallbackWikiId',
    ]

Access: internal

For use by ServiceWiring

Definition at line 69 of file FileBackendGroup.php.

---

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

• includes/filebackend/FileBackendGroup.php