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

Constructor & Destructor Documentation

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

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

Member Function Documentation

FileBackendStoreShardListIterator::accept ( )

Definition at line 1919 of file FileBackendStore.php.

References $path.

FileBackendStoreShardListIterator::listFromShard (   $container)
abstractprotected

Get the list for a given container shard.

Parameters
string$containerResolved container name
Returns
Iterator

Referenced by __construct().

FileBackendStoreShardListIterator::rewind ( )

Definition at line 1934 of file FileBackendStore.php.

Member Data Documentation

FileBackendStore FileBackendStoreShardListIterator::$backend
protected

Definition at line 1882 of file FileBackendStore.php.

Referenced by __construct().

string FileBackendStoreShardListIterator::$container
protected
string FileBackendStoreShardListIterator::$directory
protected

Resolved relative path.

Definition at line 1891 of file FileBackendStore.php.

array FileBackendStoreShardListIterator::$multiShardPaths = []
protected

Definition at line 1894 of file FileBackendStore.php.

array FileBackendStoreShardListIterator::$params
protected

Definition at line 1885 of file FileBackendStore.php.

Referenced by __construct().


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