aboutsummaryrefslogtreecommitdiffstats
path: root/includes/libs/filebackend
diff options
context:
space:
mode:
authorEbrahim Byagowi <ebrahim@gnu.org>2024-05-19 17:10:05 +0330
committerEbrahim Byagowi <ebrahim@gnu.org>2024-05-19 22:35:58 +0330
commitd21cc67450c72455e9e2ea9a67e455598660235c (patch)
tree3162887fd733737019755a145b9ced63b4db03f3 /includes/libs/filebackend
parent5f55c28f44a2661df7aaa09e24d2ea4bc0a040c1 (diff)
downloadmediawikicore-d21cc67450c72455e9e2ea9a67e455598660235c.tar.gz
mediawikicore-d21cc67450c72455e9e2ea9a67e455598660235c.zip
Add namespace and deprecation alias to FileBackend
This patch introduces a namespace declaration for the Wikimedia\FileBackend to FileBackend and establishes a class alias marked as deprecated since version 1.43. Bug: T353458 Change-Id: Id897687b1d679fd7d179e3a32e617aae10ebff33
Diffstat (limited to 'includes/libs/filebackend')
-rw-r--r--includes/libs/filebackend/FSFileBackend.php1
-rw-r--r--includes/libs/filebackend/FileBackend.php24
-rw-r--r--includes/libs/filebackend/FileBackendMultiWrite.php1
-rw-r--r--includes/libs/filebackend/FileBackendStore.php1
-rw-r--r--includes/libs/filebackend/MemoryFileBackend.php1
-rw-r--r--includes/libs/filebackend/SwiftFileBackend.php1
-rw-r--r--includes/libs/filebackend/fileop/CopyFileOp.php2
-rw-r--r--includes/libs/filebackend/fileop/DeleteFileOp.php2
-rw-r--r--includes/libs/filebackend/fileop/DescribeFileOp.php2
-rw-r--r--includes/libs/filebackend/fileop/FileOp.php1
-rw-r--r--includes/libs/filebackend/fileop/MoveFileOp.php2
11 files changed, 32 insertions, 6 deletions
diff --git a/includes/libs/filebackend/FSFileBackend.php b/includes/libs/filebackend/FSFileBackend.php
index 78c698a29d15..392d4a59cc7a 100644
--- a/includes/libs/filebackend/FSFileBackend.php
+++ b/includes/libs/filebackend/FSFileBackend.php
@@ -43,6 +43,7 @@
use Shellbox\Shellbox;
use Wikimedia\AtEase\AtEase;
+use Wikimedia\FileBackend\FileBackend;
use Wikimedia\Timestamp\ConvertibleTimestamp;
/**
diff --git a/includes/libs/filebackend/FileBackend.php b/includes/libs/filebackend/FileBackend.php
index 24c2c70519ee..981012c86e27 100644
--- a/includes/libs/filebackend/FileBackend.php
+++ b/includes/libs/filebackend/FileBackend.php
@@ -28,10 +28,20 @@
* @file
* @ingroup FileBackend
*/
+
+namespace Wikimedia\FileBackend;
+
+use FSFile;
+use InvalidArgumentException;
+use LockManager;
use MediaWiki\FileBackend\FSFile\TempFSFileFactory;
+use NullLockManager;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
+use ScopedLock;
+use StatusValue;
+use TempFSFile;
use Wikimedia\ScopedCallback;
/**
@@ -191,7 +201,7 @@ abstract class FileBackend implements LoggerAwareInterface {
* - profiler : Optional callback that takes a section name argument and returns
* a ScopedCallback instance that ends the profile section in its destructor.
* - statusWrapper : Optional callback that is used to wrap returned StatusValues
- * @throws InvalidArgumentException
+ * @throws \InvalidArgumentException
*/
public function __construct( array $config ) {
if ( !array_key_exists( 'name', $config ) ) {
@@ -1293,7 +1303,7 @@ abstract class FileBackend implements LoggerAwareInterface {
* @param array $params Parameters include:
* - dir : storage directory
* - topOnly : only return direct child dirs of the directory
- * @return Traversable|array|null Directory list enumerator or null (initial I/O error)
+ * @return \Traversable|array|null Directory list enumerator or null (initial I/O error)
* @since 1.20
*/
abstract public function getDirectoryList( array $params );
@@ -1311,7 +1321,7 @@ abstract class FileBackend implements LoggerAwareInterface {
*
* @param array $params Parameters include:
* - dir : storage directory
- * @return Traversable|array|null Directory list enumerator or null (initial I/O error)
+ * @return \Traversable|array|null Directory list enumerator or null (initial I/O error)
* @since 1.20
*/
final public function getTopDirectoryList( array $params ) {
@@ -1337,7 +1347,7 @@ abstract class FileBackend implements LoggerAwareInterface {
* - topOnly : only return direct child files of the directory (since 1.20)
* - adviseStat : set to true if stat requests will be made on the files (since 1.22)
* - forWrite : true if the list will inform a write operations (since 1.41)
- * @return Traversable|array|null File list enumerator or null (initial I/O error)
+ * @return \Traversable|array|null File list enumerator or null (initial I/O error)
*/
abstract public function getFileList( array $params );
@@ -1354,7 +1364,7 @@ abstract class FileBackend implements LoggerAwareInterface {
* @param array $params Parameters include:
* - dir : storage directory
* - adviseStat : set to true if stat requests will be made on the files (since 1.22)
- * @return Traversable|array|null File list enumerator or null on failure
+ * @return \Traversable|array|null File list enumerator or null on failure
* @since 1.20
*/
final public function getTopFileList( array $params ) {
@@ -1631,7 +1641,7 @@ abstract class FileBackend implements LoggerAwareInterface {
*
* @param string $type One of (attachment, inline)
* @param string $filename Suggested file name (should not contain slashes)
- * @throws InvalidArgumentException
+ * @throws \InvalidArgumentException
* @return string
* @since 1.20
*/
@@ -1745,3 +1755,5 @@ abstract class FileBackend implements LoggerAwareInterface {
return $this->streamerOptions;
}
}
+/** @deprecated class alias since 1.43 */
+class_alias( FileBackend::class, 'FileBackend' );
diff --git a/includes/libs/filebackend/FileBackendMultiWrite.php b/includes/libs/filebackend/FileBackendMultiWrite.php
index 955c802b3f32..38eb4652cd25 100644
--- a/includes/libs/filebackend/FileBackendMultiWrite.php
+++ b/includes/libs/filebackend/FileBackendMultiWrite.php
@@ -23,6 +23,7 @@
use MediaWiki\Deferred\DeferredUpdates;
use MediaWiki\Json\FormatJson;
+use Wikimedia\FileBackend\FileBackend;
use Wikimedia\Timestamp\ConvertibleTimestamp;
/**
diff --git a/includes/libs/filebackend/FileBackendStore.php b/includes/libs/filebackend/FileBackendStore.php
index d625d5554b66..7b93d71fe74d 100644
--- a/includes/libs/filebackend/FileBackendStore.php
+++ b/includes/libs/filebackend/FileBackendStore.php
@@ -23,6 +23,7 @@
use MediaWiki\Json\FormatJson;
use Wikimedia\AtEase\AtEase;
+use Wikimedia\FileBackend\FileBackend;
use Wikimedia\Timestamp\ConvertibleTimestamp;
/**
diff --git a/includes/libs/filebackend/MemoryFileBackend.php b/includes/libs/filebackend/MemoryFileBackend.php
index 4481d918ea04..aea68d79211f 100644
--- a/includes/libs/filebackend/MemoryFileBackend.php
+++ b/includes/libs/filebackend/MemoryFileBackend.php
@@ -22,6 +22,7 @@
*/
use Wikimedia\AtEase\AtEase;
+use Wikimedia\FileBackend\FileBackend;
use Wikimedia\Timestamp\ConvertibleTimestamp;
/**
diff --git a/includes/libs/filebackend/SwiftFileBackend.php b/includes/libs/filebackend/SwiftFileBackend.php
index 4b54345f2b48..72afc7568cbb 100644
--- a/includes/libs/filebackend/SwiftFileBackend.php
+++ b/includes/libs/filebackend/SwiftFileBackend.php
@@ -26,6 +26,7 @@ use MediaWiki\Json\FormatJson;
use MediaWiki\Utils\MWTimestamp;
use Psr\Log\LoggerInterface;
use Wikimedia\AtEase\AtEase;
+use Wikimedia\FileBackend\FileBackend;
use Wikimedia\RequestTimeout\TimeoutException;
/**
diff --git a/includes/libs/filebackend/fileop/CopyFileOp.php b/includes/libs/filebackend/fileop/CopyFileOp.php
index a60e391ee68a..256aad6b2394 100644
--- a/includes/libs/filebackend/fileop/CopyFileOp.php
+++ b/includes/libs/filebackend/fileop/CopyFileOp.php
@@ -21,6 +21,8 @@
* @ingroup FileBackend
*/
+use Wikimedia\FileBackend\FileBackend;
+
/**
* Copy a file from one storage path to another in the backend.
* Parameters for this operation are outlined in FileBackend::doOperations().
diff --git a/includes/libs/filebackend/fileop/DeleteFileOp.php b/includes/libs/filebackend/fileop/DeleteFileOp.php
index 1c467bbe8f31..bc37ad7c03ae 100644
--- a/includes/libs/filebackend/fileop/DeleteFileOp.php
+++ b/includes/libs/filebackend/fileop/DeleteFileOp.php
@@ -21,6 +21,8 @@
* @ingroup FileBackend
*/
+use Wikimedia\FileBackend\FileBackend;
+
/**
* Delete a file at the given storage path from the backend.
* Parameters for this operation are outlined in FileBackend::doOperations().
diff --git a/includes/libs/filebackend/fileop/DescribeFileOp.php b/includes/libs/filebackend/fileop/DescribeFileOp.php
index 70411963e416..a563d811c95c 100644
--- a/includes/libs/filebackend/fileop/DescribeFileOp.php
+++ b/includes/libs/filebackend/fileop/DescribeFileOp.php
@@ -21,6 +21,8 @@
* @ingroup FileBackend
*/
+use Wikimedia\FileBackend\FileBackend;
+
/**
* Change metadata for a file at the given storage path in the backend.
* Parameters for this operation are outlined in FileBackend::doOperations().
diff --git a/includes/libs/filebackend/fileop/FileOp.php b/includes/libs/filebackend/fileop/FileOp.php
index 781ac06caa24..53f5f0882dfd 100644
--- a/includes/libs/filebackend/fileop/FileOp.php
+++ b/includes/libs/filebackend/fileop/FileOp.php
@@ -23,6 +23,7 @@
use MediaWiki\Json\FormatJson;
use Psr\Log\LoggerInterface;
+use Wikimedia\FileBackend\FileBackend;
use Wikimedia\RequestTimeout\TimeoutException;
/**
diff --git a/includes/libs/filebackend/fileop/MoveFileOp.php b/includes/libs/filebackend/fileop/MoveFileOp.php
index 8540cfacc9c5..ce4a91ac1ff4 100644
--- a/includes/libs/filebackend/fileop/MoveFileOp.php
+++ b/includes/libs/filebackend/fileop/MoveFileOp.php
@@ -21,6 +21,8 @@
* @ingroup FileBackend
*/
+use Wikimedia\FileBackend\FileBackend;
+
/**
* Move a file from one storage path to another in the backend.
* Parameters for this operation are outlined in FileBackend::doOperations().