FSFileBackendList Class Reference

Wrapper around RecursiveDirectoryIterator/DirectoryIterator that catches exception or does any custom behavoir that we may want. More...

Inheritance diagram for FSFileBackendList:

Collaboration diagram for FSFileBackendList:

List of all members.

Public Member Functions
	__construct ($dir, array $params)
	current ()
	key ()
	next ()
	rewind ()
	valid ()
Protected Member Functions
	filterViaNext ()
	Filter out items by advancing to the next ones.
	getRelPath ($dir)
	Return only the relative path and normalize slashes to FileBackend-style.
	initIterator ($dir)
	Return an appropriate iterator object to wrap.
Protected Attributes
Iterator	$iter
	*
Array	$params = array()
	*
	$pos = 0
	$suffixStart

---

Detailed Description

Wrapper around RecursiveDirectoryIterator/DirectoryIterator that catches exception or does any custom behavoir that we may want.

Do not use this class from places outside FSFileBackend.

Definition at line 782 of file FSFileBackend.php.

---

Constructor & Destructor Documentation

FSFileBackendList::__construct	(	$	dir,
		array $	params
	)

Parameters:

string	$dir	file system directory
array	$params

Definition at line 792 of file FSFileBackend.php.

---

Member Function Documentation

FSFileBackendList::current

(

)

See also:

Iterator::current()

Returns:

string|bool String or false

Definition at line 841 of file FSFileBackend.php.

FSFileBackendList::filterViaNext

(

)

[protected]

Filter out items by advancing to the next ones.

Reimplemented in FSFileBackendFileList, and FSFileBackendDirList.

Definition at line 884 of file FSFileBackend.php.

FSFileBackendList::getRelPath

(

$

dir

)

[protected]

Return only the relative path and normalize slashes to FileBackend-style.

Uses the "real path" since the suffix is based upon that.

Parameters:

string

$path

Returns:

string

Definition at line 893 of file FSFileBackend.php.

FSFileBackendList::initIterator

(

$

dir

)

[protected]

Return an appropriate iterator object to wrap.

Parameters:

string

$dir

file system directory

Returns:

Iterator

Definition at line 813 of file FSFileBackend.php.

FSFileBackendList::key

(

)

See also:

Iterator::key()

Returns:

integer

Definition at line 833 of file FSFileBackend.php.

FSFileBackendList::next

(

)

See also:

Iterator::next()

Returns:

void

Definition at line 849 of file FSFileBackend.php.

FSFileBackendList::rewind

(

)

See also:

Iterator::rewind()

Returns:

void

Definition at line 863 of file FSFileBackend.php.

FSFileBackendList::valid

(

)

See also:

Iterator::valid()

Returns:

bool

Definition at line 877 of file FSFileBackend.php.

---

Member Data Documentation

Iterator FSFileBackendList::$iter [protected]

*

Definition at line 783 of file FSFileBackend.php.

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

*

Definition at line 786 of file FSFileBackend.php.

FSFileBackendList::$pos = 0 [protected]

Definition at line 785 of file FSFileBackend.php.

FSFileBackendList::$suffixStart [protected]

Definition at line 784 of file FSFileBackend.php.

---

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

• includes/filebackend/FSFileBackend.php