OxidEsales\EshopCommunity\Application\Model\FileCollector Class Reference

Public Member Functions
	setBaseDirectory ($sDir)
	getFiles ()
	addFile ($sFile)
	addDirectoryFiles ($sFolder, $aExtensions=[], $blRecursive=false)

Protected Attributes
	$_sBaseDirectory
	$_aFiles

Detailed Description

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

Member Function Documentation

addDirectoryFiles()

OxidEsales\EshopCommunity\Application\Model\FileCollector::addDirectoryFiles	(		$sFolder,
			$aExtensions = [],
			$blRecursive = false
	)

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

Parameters

string	$sFolder	which is explored
array	$aExtensions	list of extensions to scan - if empty all files are taken
boolean	$blRecursive	should directories be checked in recursive manner

Exceptions

exception

Returns

null

addFile()

OxidEsales\EshopCommunity\Application\Model\FileCollector::addFile

(

$sFile

)

Add one file to collection if it exists

Parameters

string

$sFile

file name to add to collection

Exceptions

Exception

Returns

null

getFiles()

OxidEsales\EshopCommunity\Application\Model\FileCollector::getFiles

(

)

get collection files

Returns

mixed

setBaseDirectory()

OxidEsales\EshopCommunity\Application\Model\FileCollector::setBaseDirectory

(

$sDir

)

Setter for working directory

Parameters

string

$sDir

Directory

Member Data Documentation

$_aFiles

OxidEsales\EshopCommunity\Application\Model\FileCollector::$_aFiles

protected

$_sBaseDirectory

OxidEsales\EshopCommunity\Application\Model\FileCollector::$_sBaseDirectory

protected

---

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

• /oxideshop-ce/source/Application/Model/FileCollector.php