filebackend: throw exceptions during file iteration.

* This lets calling code be far more robust rather than just
  silently ignoring entries due to some temporary problem.

Change-Id: I3ce2ae34f6cff5e40a80b8da5688503a387ce2a6

1 files changed, 14 insertions, 0 deletions

diff --git a/includes/filebackend/FileBackend.php b/includes/filebackend/FileBackend.php
index 29af88db64f7..9b4760af4335 100644
--- a/includes/filebackend/FileBackend.php
+++ b/includes/filebackend/FileBackend.php
@@ -1061,6 +1061,8 @@ abstract class FileBackend {
 	 *
 	 * Storage backends with eventual consistency might return stale data.
 	 *
+	 * Failures during iteration can result in FileBackendError exceptions (since 1.22).
+	 *
 	 * @param array $params
 	 * $params include:
 	 *   - dir     : storage directory
@@ -1076,6 +1078,8 @@ abstract class FileBackend {
 	 *
 	 * Storage backends with eventual consistency might return stale data.
 	 *
+	 * Failures during iteration can result in FileBackendError exceptions (since 1.22).
+	 *
 	 * @param array $params
 	 * $params include:
 	 *   - dir : storage directory
@@ -1096,6 +1100,8 @@ abstract class FileBackend {
 	 *
 	 * Storage backends with eventual consistency might return stale data.
 	 *
+	 * Failures during iteration can result in FileBackendError exceptions (since 1.22).
+	 *
 	 * @param array $params
 	 * $params include:
 	 *   - dir        : storage directory
@@ -1111,6 +1117,8 @@ abstract class FileBackend {
 	 *
 	 * Storage backends with eventual consistency might return stale data.
 	 *
+	 * Failures during iteration can result in FileBackendError exceptions (since 1.22).
+	 *
 	 * @param array $params
 	 * $params include:
 	 *   - dir        : storage directory
@@ -1379,3 +1387,9 @@ abstract class FileBackend {
 		return $path;
 	}
 }
+
+/**
+ * @ingroup FileBackend
+ * @since 1.22
+ */
+class FileBackendError extends MWException {}