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

---

Constructor & Destructor Documentation

SwiftFileBackendList::__construct	(	SwiftFileBackend $	backend,
		$	fullCont,
		$	dir,
		array $	params
	)

Parameters:

$backend	SwiftFileBackend
$fullCont	string Resolved container name
$dir	string Resolved directory relative to container
$params	Array

Definition at line 1417 of file SwiftFileBackend.php.

References $backend, and $dir.

---

Member Function Documentation

SwiftFileBackendList::key

(

)

See also:

Iterator::key()

Returns:

integer

Definition at line 1436 of file SwiftFileBackend.php.

SwiftFileBackendList::next

(

)

See also:

Iterator::next()

Returns:

void

Definition at line 1444 of file SwiftFileBackend.php.

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

Get the given list portion (page)

Parameters:

$container	string Resolved container name
$dir	string Resolved path relative to container
$after	string|null
$limit	integer
$params	Array

Returns:

Traversable|Array|null Returns null on failure

Reimplemented in SwiftFileBackendFileList, and SwiftFileBackendDirList.

SwiftFileBackendList::rewind

(

)

See also:

Iterator::rewind()

Returns:

void

Definition at line 1461 of file SwiftFileBackend.php.

SwiftFileBackendList::valid

(

)

See also:

Iterator::valid()

Returns:

bool

Definition at line 1473 of file SwiftFileBackend.php.

---

Member Data Documentation

SwiftFileBackend SwiftFileBackendList::$backend [protected]

*

Definition at line 1404 of file SwiftFileBackend.php.

Referenced by __construct().

SwiftFileBackendList::$bufferAfter = null [protected]

Definition at line 1400 of file SwiftFileBackend.php.

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

*

Definition at line 1399 of file SwiftFileBackend.php.

SwiftFileBackendList::$container [protected]

Definition at line 1405 of file SwiftFileBackend.php.

SwiftFileBackendList::$dir [protected]

Definition at line 1406 of file SwiftFileBackend.php.

Referenced by __construct().

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

*

Definition at line 1402 of file SwiftFileBackend.php.

SwiftFileBackendList::$pos = 0 [protected]

Definition at line 1401 of file SwiftFileBackend.php.

SwiftFileBackendList::$suffixStart [protected]

Definition at line 1407 of file SwiftFileBackend.php.

const SwiftFileBackendList::PAGE_SIZE = 9000

Definition at line 1409 of file SwiftFileBackend.php.

---

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

• includes/filebackend/SwiftFileBackend.php