FileBackendStoreShardListIterator Class Reference

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

Inheritance diagram for FileBackendStoreShardListIterator:

Collaboration diagram for 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 1886 of file FileBackendStore.php.

Constructor & Destructor Documentation

__construct()

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 1909 of file FileBackendStore.php.

References $backend, $container, $params, directory, and listFromShard().

Member Function Documentation

accept()

FileBackendStoreShardListIterator::accept

(

)

Definition at line 1925 of file FileBackendStore.php.

listFromShard()

FileBackendStoreShardListIterator::listFromShard ( $container )

abstractprotected

Get the list for a given container shard.

Parameters

string

$container

Resolved container name

Returns

Iterator

Reimplemented in FileBackendStoreShardDirIterator, and FileBackendStoreShardFileIterator.

Referenced by __construct().

rewind()

FileBackendStoreShardListIterator::rewind

(

)

Definition at line 1940 of file FileBackendStore.php.

Member Data Documentation

$backend

FileBackendStore FileBackendStoreShardListIterator::$backend

protected

Definition at line 1888 of file FileBackendStore.php.

Referenced by __construct().

$container

string FileBackendStoreShardListIterator::$container

protected

Full container name.

Definition at line 1894 of file FileBackendStore.php.

Referenced by __construct(), FileBackendStoreShardDirIterator\listFromShard(), and FileBackendStoreShardFileIterator\listFromShard().

$directory

string FileBackendStoreShardListIterator::$directory

protected

Resolved relative path.

Definition at line 1897 of file FileBackendStore.php.

$multiShardPaths

array FileBackendStoreShardListIterator::$multiShardPaths = []

protected

Definition at line 1900 of file FileBackendStore.php.

$params

array FileBackendStoreShardListIterator::$params

protected

Definition at line 1891 of file FileBackendStore.php.

Referenced by __construct().

---

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

• includes/libs/filebackend/FileBackendStore.php