OXID eShop CE  4.9.5
 All Classes Files Functions Variables Pages
oxFileCollector Class Reference

Public Member Functions

 setBaseDirectory ($sDir)
 getFiles ()
 addFile ($sFile)
 addDirectoryFiles ($sFolder, $aExtensions=array(), $blRecursive=false)

Protected Attributes

 $_sBaseDirectory
 $_aFiles

Detailed Description

Directory reader. Performs reading of file list of one shop directory

Definition at line 9 of file oxfilecollector.php.

Member Function Documentation

oxFileCollector::addDirectoryFiles (   $sFolder,
  $aExtensions = array(),
  $blRecursive = false 
)

browse all folders and sub-folders after files which have given extensions

Parameters
string$sFolderwhich is explored
array$aExtensionslist of extensions to scan - if empty all files are taken
boolean$blRecursiveshould directories be checked in recursive manner
Exceptions
exception
Returns
null

Definition at line 87 of file oxfilecollector.php.

oxFileCollector::addFile (   $sFile)

Add one file to collection if it exists

Parameters
string$sFilefile name to add to collection
Exceptions
Exception
Returns
null

Definition at line 56 of file oxfilecollector.php.

oxFileCollector::getFiles ( )

get collection files

Returns
mixed

Definition at line 43 of file oxfilecollector.php.

oxFileCollector::setBaseDirectory (   $sDir)

Setter for working directory

Parameters
string$sDirDirectory

Definition at line 31 of file oxfilecollector.php.

Member Data Documentation

oxFileCollector::$_aFiles
protected

Definition at line 24 of file oxfilecollector.php.

oxFileCollector::$_sBaseDirectory
protected

Definition at line 17 of file oxfilecollector.php.


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