MediaWiki  REL1_19
Public Member Functions | Protected Member Functions | Protected Attributes
FileBackendStoreShardListIterator Class Reference
File backend

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

List of all members.

Public Member Functions

 __construct (FileBackendStore $backend, $container, $dir, array $suffixes, array $params)
 current ()
 key ()
 next ()
 rewind ()
 valid ()

Protected Member Functions

 nextShardIteratorIfNotValid ()
 If the iterator for this container shard is out of items, then move on to the next container that has items.
 setIteratorFromCurrentShard ()

Protected Attributes

 $backend
 $container
 $curShard = 0
 $directory
 $iter
 $params
 $pos = 0
 $shardSuffixes

Detailed Description

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

Do not use this class from places outside of FileBackendStore.

Definition at line 1647 of file FileBackend.php.

Constructor & Destructor Documentation

FileBackendStoreShardListIterator::__construct ( FileBackendStore $  backend,
$  container,
$  dir,
array $  suffixes,
array $  params 
)
Parameters:
$backendFileBackendStore
$containerstring Full storage container name
$dirstring Storage directory relative to container
$suffixesArray List of container shard suffixes
$paramsArray

Definition at line 1669 of file FileBackend.php.

References $backend, $container, $dir, and $params.

Member Function Documentation

FileBackendStoreShardListIterator::current ( )

Definition at line 1679 of file FileBackend.php.

Referenced by valid().

Here is the caller graph for this function:

FileBackendStoreShardListIterator::key ( )

Definition at line 1687 of file FileBackend.php.

FileBackendStoreShardListIterator::next ( )

Definition at line 1691 of file FileBackend.php.

References nextShardIteratorIfNotValid().

Here is the call graph for this function:

FileBackendStoreShardListIterator::nextShardIteratorIfNotValid ( ) [protected]

If the iterator for this container shard is out of items, then move on to the next container that has items.

If there are none, then it advances to the last container.

Definition at line 1707 of file FileBackend.php.

References setIteratorFromCurrentShard(), and valid().

Referenced by next(), and rewind().

Here is the call graph for this function:

Here is the caller graph for this function:

FileBackendStoreShardListIterator::rewind ( )

Definition at line 1722 of file FileBackend.php.

References nextShardIteratorIfNotValid(), and setIteratorFromCurrentShard().

Here is the call graph for this function:

FileBackendStoreShardListIterator::setIteratorFromCurrentShard ( ) [protected]

Definition at line 1716 of file FileBackend.php.

Referenced by nextShardIteratorIfNotValid(), and rewind().

Here is the caller graph for this function:

FileBackendStoreShardListIterator::valid ( )

Definition at line 1730 of file FileBackend.php.

References current().

Referenced by nextShardIteratorIfNotValid().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

FileBackendStoreShardListIterator::$backend [protected]

Definition at line 1649 of file FileBackend.php.

Referenced by __construct().

FileBackendStoreShardListIterator::$container [protected]

Definition at line 1654 of file FileBackend.php.

Referenced by __construct().

FileBackendStoreShardListIterator::$curShard = 0 [protected]

Definition at line 1659 of file FileBackend.php.

FileBackendStoreShardListIterator::$directory [protected]

Definition at line 1655 of file FileBackend.php.

FileBackendStoreShardListIterator::$iter [protected]

Definition at line 1658 of file FileBackend.php.

FileBackendStoreShardListIterator::$params [protected]

Definition at line 1651 of file FileBackend.php.

Referenced by __construct().

FileBackendStoreShardListIterator::$pos = 0 [protected]

Definition at line 1660 of file FileBackend.php.

FileBackendStoreShardListIterator::$shardSuffixes [protected]

Definition at line 1653 of file FileBackend.php.

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