Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator Class Reference

FileBackendStore helper function to handle listings that span container shards. More...

Inherits FilterIterator.

Inherited by Wikimedia\FileBackend\FileIteration\FileBackendStoreShardDirIterator, and Wikimedia\FileBackend\FileIteration\FileBackendStoreShardFileIterator.

Collaboration diagram for Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator:

Public Member Functions
	__construct (FileBackendStore $backend, $container, $dir, array $suffixes, array $params)
	accept ()
	rewind ()

Protected Member Functions
	listFromShard ( $container)
	Get the list for a given container shard.

Protected Attributes
FileBackendStore	$backend
string	$container
	Full container name.
string	$directory
	Resolved relative path.
array	$multiShardPaths = []
array	$params

Detailed Description

FileBackendStore helper function to handle listings that span container shards.

Do not use this class from places outside of FileBackendStore.

Definition at line 35 of file FileBackendStoreShardListIterator.php.

Constructor & Destructor Documentation

__construct()

Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator::__construct	(	FileBackendStore	$backend,
			$container,
			$dir,
		array	$suffixes,
		array	$params )

Parameters

FileBackendStore	$backend
string	$container	Full storage container name
string	$dir	Storage directory relative to container
array	$suffixes	List of container shard suffixes
array	$params

Definition at line 58 of file FileBackendStoreShardListIterator.php.

References Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator\$backend, Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator\$container, Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator\$params, and Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator\listFromShard().

Member Function Documentation

accept()

Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator::accept

(

)

Definition at line 74 of file FileBackendStoreShardListIterator.php.

listFromShard()

Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator::listFromShard ( $container )

abstractprotected

Get the list for a given container shard.

Parameters

string

$container

Resolved container name

Returns

Iterator

Reimplemented in Wikimedia\FileBackend\FileIteration\FileBackendStoreShardDirIterator, and Wikimedia\FileBackend\FileIteration\FileBackendStoreShardFileIterator.

Referenced by Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator\__construct().

rewind()

Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator::rewind

(

)

Definition at line 91 of file FileBackendStoreShardListIterator.php.

Member Data Documentation

$backend

FileBackendStore Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator::$backend

protected

Definition at line 37 of file FileBackendStoreShardListIterator.php.

Referenced by Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator\__construct().

$container

string Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator::$container

protected

Full container name.

Definition at line 43 of file FileBackendStoreShardListIterator.php.

Referenced by Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator\__construct(), Wikimedia\FileBackend\FileIteration\FileBackendStoreShardDirIterator\listFromShard(), and Wikimedia\FileBackend\FileIteration\FileBackendStoreShardFileIterator\listFromShard().

$directory

string Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator::$directory

protected

Resolved relative path.

Definition at line 46 of file FileBackendStoreShardListIterator.php.

$multiShardPaths

array Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator::$multiShardPaths = []

protected

Definition at line 49 of file FileBackendStoreShardListIterator.php.

$params

array Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator::$params

protected

Definition at line 40 of file FileBackendStoreShardListIterator.php.

Referenced by Wikimedia\FileBackend\FileIteration\FileBackendStoreShardListIterator\__construct().

---

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

• includes/libs/filebackend/fileiteration/FileBackendStoreShardListIterator.php