Wikimedia\FileBackend\FileIteration\SwiftFileBackendDirList Class Reference

Iterator for listing directories. More...

Inherits Wikimedia\FileBackend\FileIteration\SwiftFileBackendList.

Collaboration diagram for Wikimedia\FileBackend\FileIteration\SwiftFileBackendDirList:

Public Member Functions
	current ()
Public Member Functions inherited from Wikimedia\FileBackend\FileIteration\SwiftFileBackendList
	__construct (SwiftFileBackend $backend, $fullCont, $dir, array $params)
	key ()
	next ()
	rewind ()
	valid ()

Protected Member Functions
	pageFromList ( $container, $dir, &$after, $limit, array $params)
	Get the next page of entries. Parameters string $container Resolved container name string $dir Resolved path relative to container string &$after int $limit array $params Returns Traversable|array

Additional Inherited Members
Protected Attributes inherited from Wikimedia\FileBackend\FileIteration\SwiftFileBackendList
SwiftFileBackend	$backend
string	$container
	Container name.
string null	$continueAfter = null
	Continuation marker; the next page starts after this path.
string	$dir
	Storage directory.
string[] array[]	$iterableBuffer = []
	Current page of entries; path list or (path,stat map) list.
array	$params = []
int	$pos = 0
int	$suffixStart

Detailed Description

Iterator for listing directories.

Definition at line 16 of file SwiftFileBackendDirList.php.

Member Function Documentation

current()

Wikimedia\FileBackend\FileIteration\SwiftFileBackendDirList::current

(

)

See also

Iterator::current()

Returns

string|bool String (relative path) or false

Definition at line 22 of file SwiftFileBackendDirList.php.

References Wikimedia\FileBackend\FileIteration\SwiftFileBackendDirList\current().

Referenced by Wikimedia\FileBackend\FileIteration\SwiftFileBackendDirList\current().

pageFromList()

Wikimedia\FileBackend\FileIteration\SwiftFileBackendDirList::pageFromList ( $container, $dir, & $after, $limit, array $params )

protected

Get the next page of entries.

Parameters

string	$container	Resolved container name
string	$dir	Resolved path relative to container
string	&$after
int	$limit
array	$params

Returns

Traversable|array

Reimplemented from Wikimedia\FileBackend\FileIteration\SwiftFileBackendList.

Definition at line 27 of file SwiftFileBackendDirList.php.

References Wikimedia\FileBackend\FileIteration\SwiftFileBackendList\$container, Wikimedia\FileBackend\FileIteration\SwiftFileBackendList\$dir, and Wikimedia\FileBackend\FileIteration\SwiftFileBackendList\$params.

---

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

• includes/libs/FileBackend/FileIteration/SwiftFileBackendDirList.php