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
	*
string	$bufferAfter = null
	List items *after* this path *.
array	$bufferIter = array()
	List of path or (path,stat array) entries *.
string	$container
	Container name *.
string	$dir
	Storage directory *.
array	$params = array()
	*
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 1678 of file SwiftFileBackend.php.

---

Constructor & Destructor Documentation

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

Definition at line 1703 of file SwiftFileBackend.php.

---

Member Function Documentation

SwiftFileBackendList::key

(

)

See also:

Iterator::key()

Returns:

int

Definition at line 1722 of file SwiftFileBackend.php.

SwiftFileBackendList::next

(

)

See also:

Iterator::next()

Definition at line 1729 of file SwiftFileBackend.php.

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

Get the given list portion (page)

Parameters:

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

Returns:

Traversable|array

Reimplemented in SwiftFileBackendFileList, and SwiftFileBackendDirList.

Referenced by valid().

SwiftFileBackendList::rewind

(

)

See also:

Iterator::rewind()

Definition at line 1745 of file SwiftFileBackend.php.

SwiftFileBackendList::valid

(

)

See also:

Iterator::valid()

Returns:

bool

Definition at line 1757 of file SwiftFileBackend.php.

References pageFromList().

---

Member Data Documentation

SwiftFileBackend SwiftFileBackendList::$backend [protected]

*

Definition at line 1687 of file SwiftFileBackend.php.

string SwiftFileBackendList::$bufferAfter = null [protected]

List items *after* this path *.

Definition at line 1681 of file SwiftFileBackend.php.

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

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

Definition at line 1679 of file SwiftFileBackend.php.

string SwiftFileBackendList::$container [protected]

Container name *.

Definition at line 1689 of file SwiftFileBackend.php.

Referenced by SwiftFileBackendFileList\pageFromList().

string SwiftFileBackendList::$dir [protected]

Storage directory *.

Definition at line 1691 of file SwiftFileBackend.php.

Referenced by SwiftFileBackendFileList\pageFromList().

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

*

Definition at line 1685 of file SwiftFileBackend.php.

int SwiftFileBackendList::$pos = 0 [protected]

*

Definition at line 1683 of file SwiftFileBackend.php.

int SwiftFileBackendList::$suffixStart [protected]

*

Definition at line 1693 of file SwiftFileBackend.php.

const SwiftFileBackendList::PAGE_SIZE = 9000

Definition at line 1695 of file SwiftFileBackend.php.

---

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

• includes/filebackend/SwiftFileBackend.php