Inheritance diagram for OxidEsales\EshopCommunity\Core\UtilsFile:

Collaboration diagram for OxidEsales\EshopCommunity\Core\UtilsFile:

Public Member Functions
	__construct ()

	getNewFilesCounter ()

	normalizeDir ($sDir)

	copyDir ($sSourceDir, $sTargetDir)

	deleteDir ($sSourceDir)

	readRemoteFileAsString ($sPath)

	processFiles ($oObject=null, $aFiles=[], $blUseMasterImage=false, $blUnique=true)

	checkFile ($sFile)

	urlValidate ($sLink)

	processFile ($sFileName, $sUploadPath)

	getImageDirByType ($sType, $blGenerated=false)

	translateError ($iError)

Public Attributes
const	PROMO_PICTURE_DIR = 'promo'

Protected Member Functions
	_setNewFilesCounter ($iNewFilesCounter)

	_prepareImageName ($sValue, $sType, $blDemo, $sImagePath, $blUnique=true)

	_getImagePath ($sType)

	_getImageSize ($sImgType, $iImgNum, $sImgConf)

	_copyFile ($sSource, $sTarget)

	_moveImage ($sSource, $sTarget)

	_getUniqueFileName ($sFilePath, $sFileName, $sFileExt, $sSufix="", $blUnique=true)

Protected Attributes
	$_iMaxPicImgCount = 12

	$_iMaxZoomImgCount = 12

	$_aTypeToPath

	$_aBadFiles = ['php', 'php3', 'php4', 'php5', 'phps', 'php6', 'jsp', 'cgi', 'cmf', 'exe', 'phtml', 'pht', 'phar']

	$_aAllowedFiles = ['gif', 'jpg', 'jpeg', 'png', 'pdf']

	$_iNewFilesCounter = 0

Detailed Description

File manipulation utility class

Constructor & Destructor Documentation

◆ __construct()

OxidEsales\EshopCommunity\Core\UtilsFile::__construct ( )

Class constructor, initailizes pictures count info (_iMaxPicImgCount/_iMaxZoomImgCount)

Returns: null

Member Function Documentation

◆ _copyFile()

OxidEsales\EshopCommunity\Core\UtilsFile::_copyFile	(	$sSource,
		$sTarget
	)

protected

Copy file from source to target location

Parameters

string	$sSource	file location
string	$sTarget	file location

Returns: bool

◆ _getImagePath()

OxidEsales\EshopCommunity\Core\UtilsFile::_getImagePath ( $sType )

protected

Returns image storage path

Parameters

string $sType image type

Returns: string

◆ _getImageSize()

OxidEsales\EshopCommunity\Core\UtilsFile::_getImageSize	(	$sImgType,
		$iImgNum,
		$sImgConf
	)

protected

Returns array of sizes which are used to resize images. If size is not defined - NULL will be returned

Parameters

string	$sImgType	image type (TH, TC, ICO etc), can be useful for modules
int	$iImgNum	number of image (e.g. numper of ZOOM1 is 1)
string	$sImgConf	config parameter name, which keeps size info

Returns: array | null

◆ _getUniqueFileName()

OxidEsales\EshopCommunity\Core\UtilsFile::_getUniqueFileName	(	$sFilePath,
		$sFileName,
		$sFileExt,
		$sSufix = `""`,
		$blUnique = `true`
	)

protected

Checks if file with same name does not exist, if exists - addes number prefix to file name Returns unique file name.

Parameters

string	$sFilePath	file storage path/folder (e.g. /htdocs/out/img/)
string	$sFileName	name of file (e.g. picture1)
string	$sFileExt	file extension (e.g. gif)
string	$sSufix	file name sufix (e.g. _ico)
bool	$blUnique	TRUE - generates unique file name, FALSE - just glues given parts of file name

Returns: string

◆ _moveImage()

OxidEsales\EshopCommunity\Core\UtilsFile::_moveImage	(	$sSource,
		$sTarget
	)

protected

Moves image from source to target location

Parameters

string	$sSource	image location
string	$sTarget	image copy location

Returns: bool

◆ _prepareImageName()

OxidEsales\EshopCommunity\Core\UtilsFile::_prepareImageName	(	$sValue,
		$sType,
		$blDemo,
		$sImagePath,
		$blUnique = `true`
	)

protected

Prepares image file name

Parameters

object	$sValue	uploadable file name
string	$sType	image type
object	$blDemo	if true = whecks if file type is defined in \OxidEsales\Eshop\Core\UtilsFile::_aAllowedFiles
string	$sImagePath	final image file location
bool	$blUnique	if TRUE - generates unique file name

Returns: string

◆ _setNewFilesCounter()

OxidEsales\EshopCommunity\Core\UtilsFile::_setNewFilesCounter ( $iNewFilesCounter )

protected

Setter for param _iNewFilesCounter which counts how many new files added.

Parameters

integer $iNewFilesCounter New files count.

◆ checkFile()

OxidEsales\EshopCommunity\Core\UtilsFile::checkFile ( $sFile )

Checks if passed file exists and may be opened for reading. Returns true on success.

Parameters

string $sFile Name of file to check

Returns: bool

◆ copyDir()

OxidEsales\EshopCommunity\Core\UtilsFile::copyDir	(	$sSourceDir,
		$sTargetDir
	)

Copies directory tree for creating a new shop.

Parameters

string	$sSourceDir	Source directory
string	$sTargetDir	Target directory

◆ deleteDir()

OxidEsales\EshopCommunity\Core\UtilsFile::deleteDir ( $sSourceDir )

Deletes directory tree.

Parameters

string $sSourceDir Path to directory

Returns: null

◆ getImageDirByType()

OxidEsales\EshopCommunity\Core\UtilsFile::getImageDirByType	(	$sType,
		$blGenerated = `false`
	)

Returns image storage path

Parameters

string	$sType	image type
bool	$blGenerated	generated image dir.

Returns: string

◆ getNewFilesCounter()

OxidEsales\EshopCommunity\Core\UtilsFile::getNewFilesCounter ( )

Getter for param _iNewFilesCounter which counts how many new files added.

Returns: integer

◆ normalizeDir()

OxidEsales\EshopCommunity\Core\UtilsFile::normalizeDir ( $sDir )

Normalizes dir by adding missing trailing slash

Parameters

string $sDir Directory

Returns: string

◆ processFile()

OxidEsales\EshopCommunity\Core\UtilsFile::processFile	(	$sFileName,
		$sUploadPath
	)

Process uploaded files. Returns unique file name, on fail false

Parameters

string	$sFileName	form file item name
string	$sUploadPath	RELATIVE (to config sShopDir parameter) path for uploaded file to be copied

Exceptions

oxException if file is not valid

Returns: string

◆ processFiles()

OxidEsales\EshopCommunity\Core\UtilsFile::processFiles	(	$oObject = `null`,
		$aFiles = `[]`,
		$blUseMasterImage = `false`,
		$blUnique = `true`
	)

Uploaded file processor (filters, etc), sets configuration parameters to passed object and returns it.

Parameters

object	$oObject	object, that parameters are modified according to passed files
array	$aFiles	name of files to process
bool	$blUseMasterImage	use master image as source for processing
bool	$blUnique	TRUE - forces new file creation with unique name

Returns: object

◆ readRemoteFileAsString()

OxidEsales\EshopCommunity\Core\UtilsFile::readRemoteFileAsString ( $sPath )

Reads remote stored file. Returns contents of file.

Parameters

string $sPath Remote file path & name

Returns: string

◆ translateError()

OxidEsales\EshopCommunity\Core\UtilsFile::translateError ( $iError )

Translate php file upload errors to user readable format.

Parameters

integer $iError php file upload error number

Returns: string

◆ urlValidate()

OxidEsales\EshopCommunity\Core\UtilsFile::urlValidate ( $sLink )

Checks if given URL is accessible (HTTP-Code: 200)

Parameters

string $sLink given link

Returns: boolean

Member Data Documentation

◆ $_aAllowedFiles

OxidEsales\EshopCommunity\Core\UtilsFile::$_aAllowedFiles = ['gif', 'jpg', 'jpeg', 'png', 'pdf']

protected

◆ $_aBadFiles

OxidEsales\EshopCommunity\Core\UtilsFile::$_aBadFiles = ['php', 'php3', 'php4', 'php5', 'phps', 'php6', 'jsp', 'cgi', 'cmf', 'exe', 'phtml', 'pht', 'phar']

protected

◆ $_aTypeToPath

OxidEsales\EshopCommunity\Core\UtilsFile::$_aTypeToPath

protected

◆ $_iMaxPicImgCount

OxidEsales\EshopCommunity\Core\UtilsFile::$_iMaxPicImgCount = 12

protected

◆ $_iMaxZoomImgCount

OxidEsales\EshopCommunity\Core\UtilsFile::$_iMaxZoomImgCount = 12

protected

◆ $_iNewFilesCounter

OxidEsales\EshopCommunity\Core\UtilsFile::$_iNewFilesCounter = 0

protected

◆ PROMO_PICTURE_DIR

const OxidEsales\EshopCommunity\Core\UtilsFile::PROMO_PICTURE_DIR = 'promo'

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

/oxideshop-ce/source/Core/UtilsFile.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _copyFile()

◆ _getImagePath()

◆ _getImageSize()

◆ _getUniqueFileName()

◆ _moveImage()

◆ _prepareImageName()

◆ _setNewFilesCounter()

◆ checkFile()

◆ copyDir()

◆ deleteDir()

◆ getImageDirByType()

◆ getNewFilesCounter()

◆ normalizeDir()

◆ processFile()

◆ processFiles()

◆ readRemoteFileAsString()

◆ translateError()

◆ urlValidate()

Member Data Documentation

◆ $_aAllowedFiles

◆ $_aBadFiles

◆ $_aTypeToPath

◆ $_iMaxPicImgCount

◆ $_iMaxZoomImgCount

◆ $_iNewFilesCounter

◆ PROMO_PICTURE_DIR