MediaWiki  master
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:

Public Member Functions

 __construct ( $dir, array $params)
 
 current ()
 
 getLastError ()
 
 key ()
 
 next ()
 
 rewind ()
 
 valid ()
 

Protected Member Functions

 filterViaNext ()
 Filter out items by advancing to the next ones. More...
 
 getRelPath ( $dir)
 Return only the relative path and normalize slashes to FileBackend-style. More...
 
 initIterator ( $dir)
 Return an appropriate iterator object to wrap. More...
 

Protected Attributes

Iterator $iter
 
string $lastError
 
array $params = []
 
int $pos = 0
 
int $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 29 of file FSFileBackendList.php.

Constructor & Destructor Documentation

◆ __construct()

FSFileBackendList::__construct (   $dir,
array  $params 
)
Parameters
string$dirFile system directory
array$params

Definition at line 48 of file FSFileBackendList.php.

References $params, $path, and initIterator().

Member Function Documentation

◆ current()

FSFileBackendList::current ( )
See also
Iterator::current()
Returns
string|bool String or false

Definition at line 100 of file FSFileBackendList.php.

References getRelPath().

◆ filterViaNext()

FSFileBackendList::filterViaNext ( )
protected

Filter out items by advancing to the next ones.

Reimplemented in FSFileBackendDirList, and FSFileBackendFileList.

Definition at line 154 of file FSFileBackendList.php.

Referenced by next(), and rewind().

◆ getLastError()

FSFileBackendList::getLastError ( )
Returns
string|null The last caught exception message

Definition at line 147 of file FSFileBackendList.php.

References $lastError.

◆ getRelPath()

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$dir
Returns
string

Definition at line 164 of file FSFileBackendList.php.

References $path.

Referenced by current().

◆ initIterator()

FSFileBackendList::initIterator (   $dir)
protected

Return an appropriate iterator object to wrap.

Parameters
string$dirFile system directory
Returns
Iterator
Exceptions
UnexpectedValueException

Definition at line 71 of file FSFileBackendList.php.

Referenced by __construct().

◆ key()

FSFileBackendList::key ( )
See also
Iterator::key()
Returns
int

Definition at line 92 of file FSFileBackendList.php.

References $pos.

◆ next()

FSFileBackendList::next ( )
See also
Iterator::next()
Exceptions
FileBackendError

Definition at line 108 of file FSFileBackendList.php.

References $pos, and filterViaNext().

◆ rewind()

FSFileBackendList::rewind ( )
See also
Iterator::rewind()
Exceptions
FileBackendError

Definition at line 124 of file FSFileBackendList.php.

References filterViaNext().

◆ valid()

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

Definition at line 140 of file FSFileBackendList.php.

Member Data Documentation

◆ $iter

Iterator FSFileBackendList::$iter
protected

Definition at line 31 of file FSFileBackendList.php.

◆ $lastError

string FSFileBackendList::$lastError
protected

Definition at line 33 of file FSFileBackendList.php.

Referenced by getLastError().

◆ $params

array FSFileBackendList::$params = []
protected

Definition at line 42 of file FSFileBackendList.php.

Referenced by __construct().

◆ $pos

int FSFileBackendList::$pos = 0
protected

Definition at line 39 of file FSFileBackendList.php.

Referenced by key(), and next().

◆ $suffixStart

int FSFileBackendList::$suffixStart
protected

Definition at line 36 of file FSFileBackendList.php.


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