BlueSpice MediaWiki REL1_27
 All Classes Namespaces Files Functions Variables Groups Pages
FSFileBackendList Class Reference
Inheritance diagram for FSFileBackendList:
Collaboration diagram for FSFileBackendList:

Public Member Functions

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

Protected Member Functions

 initIterator ($dir)
 
 filterViaNext ()
 
 getRelPath ($dir)
 

Protected Attributes

 $iter
 
 $suffixStart
 
 $pos = 0
 
 $params = []
 

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.

Constructor & Destructor Documentation

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

Member Function Documentation

FSFileBackendList::current ( )
See Also
Iterator::current()
Returns
string|bool String or false
FSFileBackendList::filterViaNext ( )
protected

Filter out items by advancing to the next ones

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
FSFileBackendList::initIterator (   $dir)
protected

Return an appropriate iterator object to wrap

Parameters
string$dirFile system directory
Returns
Iterator
FSFileBackendList::key ( )
See Also
Iterator::key()
Returns
int
FSFileBackendList::next ( )
See Also
Iterator::next()
Exceptions
FileBackendError
FSFileBackendList::rewind ( )
See Also
Iterator::rewind()
Exceptions
FileBackendError
FSFileBackendList::valid ( )
See Also
Iterator::valid()
Returns
bool

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