Class to handle file backend registration. More...
Public Member Functions | |
| backendFromPath ($storagePath) | |
| Get an appropriate backend object from a storage path. | |
| config ($name) | |
| Get the config array for a backend object with a given name. | |
| get ($name) | |
| Get the backend object with a given name. | |
Static Public Member Functions | |
| static | destroySingleton () |
| Destroy the singleton instance. | |
| static | singleton () |
Protected Member Functions | |
| __construct () | |
| initFromGlobals () | |
| Register file backends from the global variables. | |
| register (array $configs) | |
| Register an array of file backend configurations. | |
Protected Attributes | |
| Array | $backends = array() |
| (name => ('class' => string, 'config' => array, 'instance' => object)) * | |
Static Protected Attributes | |
| static | $instance = null |
Detailed Description
Class to handle file backend registration.
- Since:
- 1.19
Definition at line 31 of file FileBackendGroup.php.
Constructor & Destructor Documentation
| FileBackendGroup::__construct | ( | ) | [protected] |
Definition at line 39 of file FileBackendGroup.php.
Member Function Documentation
| 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 185 of file FileBackendGroup.php.
| FileBackendGroup::config | ( | $ | name | ) |
Get the config array for a backend object with a given name.
- Parameters:
-
string $name
- Returns:
- Array
- Exceptions:
-
MWException
Definition at line 171 of file FileBackendGroup.php.
| static FileBackendGroup::destroySingleton | ( | ) | [static] |
Destroy the singleton instance.
- Returns:
- void
Definition at line 57 of file FileBackendGroup.php.
Referenced by ForkController\prepareEnvironment(), UploadFromUrlTestSuite\setUp(), NewParserTest\setupGlobals(), UploadFromUrlTestSuite\tearDown(), and NewParserTest\tearDown().
| FileBackendGroup::get | ( | $ | name | ) |
Get the backend object with a given name.
- Parameters:
-
string $name
- Returns:
- FileBackend
- Exceptions:
-
MWException
Definition at line 151 of file FileBackendGroup.php.
Referenced by ExternalStoreMwstore\batchFetchFromURLs().
| FileBackendGroup::initFromGlobals | ( | ) | [protected] |
Register file backends from the global variables.
- Returns:
- void
Definition at line 66 of file FileBackendGroup.php.
| FileBackendGroup::register | ( | array $ | configs | ) | [protected] |
Register an array of file backend configurations.
- Parameters:
-
Array $configs
- Returns:
- void
- Exceptions:
-
MWException
Definition at line 122 of file FileBackendGroup.php.
| static FileBackendGroup::singleton | ( | ) | [static] |
- Returns:
- FileBackendGroup
Definition at line 44 of file FileBackendGroup.php.
Referenced by ExternalStoreMwstore\batchFetchFromURLs(), TestFileOpPerformance\execute(), SyncFileBackend\execute(), CopyFileBackend\execute(), ExternalStoreMwstore\fetchFromURL(), and ExternalStoreMwstore\store().
Member Data Documentation
Array FileBackendGroup::$backends = array() [protected] |
(name => ('class' => string, 'config' => array, 'instance' => object)) *
Definition at line 37 of file FileBackendGroup.php.
FileBackendGroup::$instance = null [static, protected] |
Definition at line 35 of file FileBackendGroup.php.
The documentation for this class was generated from the following file:
- includes/filebackend/FileBackendGroup.php
