MediaWiki  master
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. More...
 

Protected Attributes

FileBackendStore $backend
 
string $container
 Full container name. More...
 
string $directory
 Resolved relative path. More...
 
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 28 of file FileBackendStoreShardListIterator.php.

Constructor & Destructor Documentation

◆ __construct()

FileBackendStoreShardListIterator::__construct ( FileBackendStore  $backend,
  $container,
  $dir,
array  $suffixes,
array  $params 
)
Parameters
FileBackendStore$backend
string$containerFull storage container name
string$dirStorage directory relative to container
array$suffixesList of container shard suffixes
array$params

Definition at line 51 of file FileBackendStoreShardListIterator.php.

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

Member Function Documentation

◆ accept()

FileBackendStoreShardListIterator::accept ( )

Definition at line 67 of file FileBackendStoreShardListIterator.php.

References $path.

◆ listFromShard()

FileBackendStoreShardListIterator::listFromShard (   $container)
abstractprotected

Get the list for a given container shard.

Parameters
string$containerResolved container name
Returns
Iterator

Reimplemented in FileBackendStoreShardFileIterator, and FileBackendStoreShardDirIterator.

Referenced by __construct().

◆ rewind()

FileBackendStoreShardListIterator::rewind ( )

Definition at line 82 of file FileBackendStoreShardListIterator.php.

Member Data Documentation

◆ $backend

FileBackendStore FileBackendStoreShardListIterator::$backend
protected

Definition at line 30 of file FileBackendStoreShardListIterator.php.

Referenced by __construct().

◆ $container

string FileBackendStoreShardListIterator::$container
protected

◆ $directory

string FileBackendStoreShardListIterator::$directory
protected

Resolved relative path.

Definition at line 39 of file FileBackendStoreShardListIterator.php.

◆ $multiShardPaths

array FileBackendStoreShardListIterator::$multiShardPaths = []
protected

Definition at line 42 of file FileBackendStoreShardListIterator.php.

◆ $params

array FileBackendStoreShardListIterator::$params
protected

Definition at line 33 of file FileBackendStoreShardListIterator.php.

Referenced by __construct().


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