From 9d49164df1c190c95aec9f7627f27d6e0f11ace1 Mon Sep 17 00:00:00 2001
From: Aaron Schulz <aaron@users.mediawiki.org>
Date: Sat, 14 Jan 2012 01:52:19 +0000
Subject: [PATCH] * Renamed ContainerShardListIterator ->
 FileBackendShardListIterator * Renamed FSFileIterator ->
 FSFileBackendFileList * Renamed SwiftFileIterator -> SwiftFileBackendFileList
 and added it to autoloader * A few minor doc fixes

---
 includes/AutoLoader.php                        |  5 +++--
 includes/filerepo/backend/FSFileBackend.php    |  8 +++-----
 includes/filerepo/backend/FileBackend.php      |  4 ++--
 includes/filerepo/backend/SwiftFileBackend.php | 10 ++++------
 4 files changed, 12 insertions(+), 15 deletions(-)

diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php
index d1304178f2..92dde48dee 100644
--- a/includes/AutoLoader.php
+++ b/includes/AutoLoader.php
@@ -485,14 +485,15 @@ $wgAutoloadLocalClasses = array(
 	'TempFSFile' => 'includes/filerepo/file/TempFSFile.php',
 
 	# includes/filerepo/backend
-	'ContainerShardListIterator' => 'includes/filerepo/backend/FileBackend.php',
 	'FileBackendGroup' => 'includes/filerepo/backend/FileBackendGroup.php',
 	'FileBackendBase' => 'includes/filerepo/backend/FileBackend.php',
 	'FileBackend' => 'includes/filerepo/backend/FileBackend.php',
 	'FileBackendMultiWrite' => 'includes/filerepo/backend/FileBackendMultiWrite.php',
+	'FileBackendShardListIterator' => 'includes/filerepo/backend/FileBackend.php',
 	'FSFileBackend' => 'includes/filerepo/backend/FSFileBackend.php',
+	'FSFileBackendFileList' => 'includes/filerepo/backend/FSFileBackend.php',
 	'SwiftFileBackend' => 'includes/filerepo/backend/SwiftFileBackend.php',
-	'FSFileIterator' => 'includes/filerepo/backend/FSFileBackend.php',
+	'SwiftFileBackendFileList' => 'includes/filerepo/backend/SwiftFileBackend.php',
 	'LockManagerGroup' => 'includes/filerepo/backend/lockmanager/LockManagerGroup.php',
 	'LockManager' => 'includes/filerepo/backend/lockmanager/LockManager.php',
 	'ScopedLock' => 'includes/filerepo/backend/lockmanager/LockManager.php',
diff --git a/includes/filerepo/backend/FSFileBackend.php b/includes/filerepo/backend/FSFileBackend.php
index 007d15542e..a01f846e34 100644
--- a/includes/filerepo/backend/FSFileBackend.php
+++ b/includes/filerepo/backend/FSFileBackend.php
@@ -417,7 +417,7 @@ class FSFileBackend extends FileBackend {
 		if ( !$readable ) {
 			return null; // bad permissions?
 		}
-		return new FSFileIterator( $dir );
+		return new FSFileBackendFileList( $dir );
 	}
 
 	/**
@@ -508,15 +508,13 @@ class FSFileBackend extends FileBackend {
  *
  * @ingroup FileBackend
  */
-class FSFileIterator implements Iterator {
+class FSFileBackendFileList implements Iterator {
 	/** @var RecursiveIteratorIterator */
 	protected $iter;
 	protected $suffixStart; // integer
 
 	/**
-	 * Get an FSFileIterator from a file system directory
-	 * 
-	 * @param $dir string
+	 * @param $dir string file system directory
 	 */
 	public function __construct( $dir ) {
 		$dir = realpath( $dir ); // normalize
diff --git a/includes/filerepo/backend/FileBackend.php b/includes/filerepo/backend/FileBackend.php
index 267bc5ebf7..7cd6f6471d 100644
--- a/includes/filerepo/backend/FileBackend.php
+++ b/includes/filerepo/backend/FileBackend.php
@@ -1052,7 +1052,7 @@ abstract class FileBackend extends FileBackendBase {
 			wfDebug( __METHOD__ . ": iterating over all container shards.\n" );
 			// File listing spans multiple containers/shards
 			list( $b, $shortCont, $r ) = self::splitStoragePath( $params['dir'] );
-			return new ContainerShardListIterator( $this,
+			return new FileBackendShardListIterator( $this,
 				$fullCont, $this->getContainerSuffixes( $shortCont ), $params );
 		}
 	}
@@ -1431,7 +1431,7 @@ abstract class FileBackend extends FileBackendBase {
  *
  * @ingroup FileBackend
  */
-class ContainerShardListIterator implements Iterator {
+class FileBackendShardListIterator implements Iterator {
 	/* @var FileBackend */
 	protected $backend;
 	/* @var Array */
diff --git a/includes/filerepo/backend/SwiftFileBackend.php b/includes/filerepo/backend/SwiftFileBackend.php
index c630011701..a067d5f035 100644
--- a/includes/filerepo/backend/SwiftFileBackend.php
+++ b/includes/filerepo/backend/SwiftFileBackend.php
@@ -454,11 +454,11 @@ class SwiftFileBackend extends FileBackend {
 	 * @see FileBackend::getFileListInternal()
 	 */
 	public function getFileListInternal( $fullCont, $dir, array $params ) {
-		return new SwiftFileIterator( $this, $fullCont, $dir );
+		return new SwiftFileBackendFileList( $this, $fullCont, $dir );
 	}
 
 	/**
-	 * Do not call this function outside of SwiftFileIterator
+	 * Do not call this function outside of SwiftFileBackendFileList
 	 * 
 	 * @param $fullCont string Resolved container name
 	 * @param $dir string Resolved storage directory with no trailing slash
@@ -653,7 +653,7 @@ class SwiftFileBackend extends FileBackend {
  *
  * @ingroup FileBackend
  */
-class SwiftFileIterator implements Iterator {
+class SwiftFileBackendFileList implements Iterator {
 	/** @var Array */
 	protected $bufferIter = array();
 	protected $bufferAfter = null; // string; list items *after* this path
@@ -668,11 +668,9 @@ class SwiftFileIterator implements Iterator {
 	const PAGE_SIZE = 5000; // file listing buffer size
 
 	/**
-	 * Get an FSFileIterator from a file system directory
-	 * 
 	 * @param $backend SwiftFileBackend
 	 * @param $fullCont string Resolved container name
-	 * @param $dir string Resolved relative directory
+	 * @param $dir string Resolved directory relative to container
 	 */
 	public function __construct( SwiftFileBackend $backend, $fullCont, $dir ) {
 		$this->backend = $backend;
-- 
2.20.1