MediaWiki  REL1_22
SwiftFileBackendList Class Reference

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

Inheritance diagram for SwiftFileBackendList:
Collaboration diagram for SwiftFileBackendList:

List of all members.

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
 *
 $bufferAfter = null
Array $bufferIter = array()
 *
 $container
 $dir
Array $params = array()
 *
 $pos = 0
 $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 1551 of file SwiftFileBackend.php.


Constructor & Destructor Documentation

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 1570 of file SwiftFileBackend.php.

References $backend, and $dir.


Member Function Documentation

See also:
Iterator::key()
Returns:
integer

Definition at line 1589 of file SwiftFileBackend.php.

See also:
Iterator::next()
Returns:
void

Definition at line 1597 of file SwiftFileBackend.php.

SwiftFileBackendList::pageFromList ( container,
dir,
&$  after,
limit,
array params 
) [abstract, protected]

Get the given list portion (page)

Parameters:
string$containerResolved container name
string$dirResolved path relative to container
string$after,|null
integer$limit
array$params
Returns:
Traversable|Array

Reimplemented in SwiftFileBackendFileList, and SwiftFileBackendDirList.

See also:
Iterator::rewind()
Returns:
void

Definition at line 1614 of file SwiftFileBackend.php.

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

Definition at line 1626 of file SwiftFileBackend.php.


Member Data Documentation

SwiftFileBackend SwiftFileBackendList::$backend [protected]

*

Definition at line 1557 of file SwiftFileBackend.php.

Referenced by __construct().

SwiftFileBackendList::$bufferAfter = null [protected]

Definition at line 1553 of file SwiftFileBackend.php.

Array SwiftFileBackendList::$bufferIter = array() [protected]

*

Definition at line 1552 of file SwiftFileBackend.php.

SwiftFileBackendList::$container [protected]

Definition at line 1558 of file SwiftFileBackend.php.

SwiftFileBackendList::$dir [protected]

Definition at line 1559 of file SwiftFileBackend.php.

Referenced by __construct().

Array SwiftFileBackendList::$params = array() [protected]

*

Definition at line 1555 of file SwiftFileBackend.php.

SwiftFileBackendList::$pos = 0 [protected]

Definition at line 1554 of file SwiftFileBackend.php.

SwiftFileBackendList::$suffixStart [protected]

Definition at line 1560 of file SwiftFileBackend.php.

Definition at line 1562 of file SwiftFileBackend.php.


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