MediaWiki REL1_33
SwiftFileBackendList Class Reference

SwiftFileBackend helper class to page through listings. More...

Inheritance diagram for SwiftFileBackendList:
Collaboration diagram for SwiftFileBackendList:

Public Member Functions

 __construct (SwiftFileBackend $backend, $fullCont, $dir, array $params)
 
 key ()
 
 next ()
 
 rewind ()
 
 valid ()
 

Public Attributes

const PAGE_SIZE = 9000
 

Protected Member Functions

 pageFromList ( $container, $dir, &$after, $limit, array $params)
 Get the given list portion (page)
 

Protected Attributes

SwiftFileBackend $backend
 
string $bufferAfter = null
 List items after this path.
 
array $bufferIter = []
 List of path or (path,stat array) entries.
 
string $container
 Container name.
 
string $dir
 Storage directory.
 
array $params = []
 
int $pos = 0
 
int $suffixStart
 

Detailed Description

SwiftFileBackend helper class to page through listings.

Swift also has a listing limit of 10,000 objects for sanity. Do not use this class from places outside SwiftFileBackend.

Definition at line 1835 of file SwiftFileBackend.php.

Constructor & Destructor Documentation

◆ __construct()

SwiftFileBackendList::__construct ( SwiftFileBackend  $backend,
  $fullCont,
  $dir,
array  $params 
)
Parameters
SwiftFileBackend$backend
string$fullContResolved container name
string$dirResolved directory relative to container
array$params

Definition at line 1868 of file SwiftFileBackend.php.

References $backend, $dir, and $params.

Member Function Documentation

◆ key()

SwiftFileBackendList::key ( )
See also
Iterator::key()
Returns
int

Definition at line 1887 of file SwiftFileBackend.php.

References $pos.

◆ next()

SwiftFileBackendList::next ( )
See also
Iterator::next()

Definition at line 1894 of file SwiftFileBackend.php.

References $pos, next(), pageFromList(), and valid().

Referenced by next().

◆ pageFromList()

SwiftFileBackendList::pageFromList (   $container,
  $dir,
$after,
  $limit,
array  $params 
)
abstractprotected

Get the given list portion (page)

Parameters
string$containerResolved container name
string$dirResolved path relative to container
string&$after
int$limit
array$params
Returns
Traversable|array

Reimplemented in SwiftFileBackendDirList, and SwiftFileBackendFileList.

Referenced by next(), and rewind().

◆ rewind()

SwiftFileBackendList::rewind ( )
See also
Iterator::rewind()

Definition at line 1910 of file SwiftFileBackend.php.

References pageFromList().

◆ valid()

SwiftFileBackendList::valid ( )
See also
Iterator::valid()
Returns
bool

Definition at line 1922 of file SwiftFileBackend.php.

Referenced by next().

Member Data Documentation

◆ $backend

SwiftFileBackend SwiftFileBackendList::$backend
protected

Definition at line 1849 of file SwiftFileBackend.php.

Referenced by __construct().

◆ $bufferAfter

string SwiftFileBackendList::$bufferAfter = null
protected

List items after this path.

Definition at line 1840 of file SwiftFileBackend.php.

◆ $bufferIter

array SwiftFileBackendList::$bufferIter = []
protected

List of path or (path,stat array) entries.

Definition at line 1837 of file SwiftFileBackend.php.

◆ $container

string SwiftFileBackendList::$container
protected

Container name.

Definition at line 1852 of file SwiftFileBackend.php.

Referenced by SwiftFileBackendDirList\pageFromList(), and SwiftFileBackendFileList\pageFromList().

◆ $dir

string SwiftFileBackendList::$dir
protected

◆ $params

array SwiftFileBackendList::$params = []
protected

◆ $pos

int SwiftFileBackendList::$pos = 0
protected

Definition at line 1843 of file SwiftFileBackend.php.

Referenced by key(), and next().

◆ $suffixStart

int SwiftFileBackendList::$suffixStart
protected

Definition at line 1858 of file SwiftFileBackend.php.

◆ PAGE_SIZE

const SwiftFileBackendList::PAGE_SIZE = 9000

Definition at line 1860 of file SwiftFileBackend.php.


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