SwiftFileBackend helper class to page through listings.
More...
Inherits Iterator.
Inherited by SwiftFileBackendDirList, and SwiftFileBackendFileList.
|
| pageFromList ( $container, $dir, &$after, $limit, array $params) |
| Get the next page of entries.
|
|
SwiftFileBackend helper class to page through listings.
Swift also has a listing limit of 10,000 objects for performance. Do not use this class from places outside SwiftFileBackend.
Definition at line 32 of file SwiftFileBackendList.php.
◆ __construct()
SwiftFileBackendList::__construct |
( |
SwiftFileBackend | $backend, |
|
|
| $fullCont, |
|
|
| $dir, |
|
|
array | $params ) |
- Parameters
-
SwiftFileBackend | $backend | |
string | $fullCont | Resolved container name |
string | $dir | Resolved directory relative to container |
array | $params | |
- Note
- This defers I/O by not buffering the first page (useful for AppendIterator use)
-
Do not call current()/valid() without calling rewind() first
Definition at line 67 of file SwiftFileBackendList.php.
References $backend, $dir, and $params.
◆ key()
SwiftFileBackendList::key |
( |
| ) |
|
◆ next()
SwiftFileBackendList::next |
( |
| ) |
|
◆ pageFromList()
SwiftFileBackendList::pageFromList |
( |
| $container, |
|
|
| $dir, |
|
|
& | $after, |
|
|
| $limit, |
|
|
array | $params ) |
|
abstractprotected |
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 in SwiftFileBackendDirList, and SwiftFileBackendFileList.
◆ rewind()
SwiftFileBackendList::rewind |
( |
| ) |
|
◆ valid()
SwiftFileBackendList::valid |
( |
| ) |
|
◆ $backend
◆ $container
string SwiftFileBackendList::$container |
|
protected |
◆ $continueAfter
string null SwiftFileBackendList::$continueAfter = null |
|
protected |
◆ $dir
string SwiftFileBackendList::$dir |
|
protected |
◆ $iterableBuffer
string [] array [] SwiftFileBackendList::$iterableBuffer = [] |
|
protected |
◆ $params
array SwiftFileBackendList::$params = [] |
|
protected |
◆ $pos
int SwiftFileBackendList::$pos = 0 |
|
protected |
◆ $suffixStart
int SwiftFileBackendList::$suffixStart |
|
protected |
The documentation for this class was generated from the following file: