OxidEsales\EshopCommunity\Core\PictureHandler Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Core\PictureHandler:

Collaboration diagram for OxidEsales\EshopCommunity\Core\PictureHandler:

Public Member Functions
	deleteArticleMasterPicture ($oObject, $iIndex, $blDeleteMasterPicture=true)
	deleteMainIcon ($oObject)
	deleteThumbnail ($oObject)
	deleteZoomPicture ($oObject, $iIndex)
	getIconName ($sFilename)
	getMainIconName ($sMasterImageFile)
	getThumbName ($sMasterImageFile)
	getZoomName ($sMasterImageFile, $iIndex)
	getImageSize ($aImgSizes, $sIndex=null)
	getAltImageUrl ($sFilePath, $sFile, $blSSL=null)
	getPicUrl ($sPath, $sFile, $sSize, $sIndex=null, $sAltPath=false, $bSsl=null)
	getProductPicUrl ($sPath, $sFile, $sSize, $sIndex=null, $bSsl=null)

Protected Member Functions
	_getBaseMasterImageFileName ($sMasterImageFile)
	_getPictureInfo ($sFilePath, $sFile, $blAdmin=false, $blSSL=null, $iLang=null, $iShopId=null)

Detailed Description

class for pictures processing

Member Function Documentation

_getBaseMasterImageFileName()

OxidEsales\EshopCommunity\Core\PictureHandler::_getBaseMasterImageFileName (   $sMasterImageFile )

protected

Gets master image file name and removes suffics (e.g. _p1) from file end.

Parameters

string

$sMasterImageFile

master image file name

Returns

null

Deprecated:

underscore prefix violates PSR12, will be renamed to "getBaseMasterImageFileName" in next major

_getPictureInfo()

OxidEsales\EshopCommunity\Core\PictureHandler::_getPictureInfo (   $sFilePath,   $sFile,   $blAdmin = false,   $blSSL = null,   $iLang = null,   $iShopId = null  )

protected

Returns dir/url info for given image file

Parameters

string	$sFilePath	path to file
string	$sFile	filename in pictures dir
bool	$blAdmin	is admin mode ?
bool	$blSSL	is ssl ?
int	$iLang	language id
int	$iShopId	shop id

Returns

array

Deprecated:

underscore prefix violates PSR12, will be renamed to "getPictureInfo" in next major

deleteArticleMasterPicture()

OxidEsales\EshopCommunity\Core\PictureHandler::deleteArticleMasterPicture	(		$oObject,
			$iIndex,
			$blDeleteMasterPicture = true
	)

Deletes master picture and all images generated from it. If third parameter is false, skips master image delete, only all generated images will be deleted.

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oObject	article object
int	$iIndex	master picture index
bool	$blDeleteMasterPicture	delete master picture, default is true

Returns

null

deleteMainIcon()

OxidEsales\EshopCommunity\Core\PictureHandler::deleteMainIcon

(

$oObject

)

Deletes custom main icon, which name is specified in oxicon field.

Parameters

\OxidEsales\Eshop\Application\Model\Article

$oObject

article object

deleteThumbnail()

OxidEsales\EshopCommunity\Core\PictureHandler::deleteThumbnail

(

$oObject

)

Deletes custom thumbnail, which name is specified in oxthumb field.

Parameters

\OxidEsales\Eshop\Application\Model\Article

$oObject

article object

deleteZoomPicture()

OxidEsales\EshopCommunity\Core\PictureHandler::deleteZoomPicture	(		$oObject,
			$iIndex
	)

Deletes custom zoom picture, which name is specified in oxzoom field.

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oObject	article object
int	$iIndex	zoom picture index

Returns

null

getAltImageUrl()

OxidEsales\EshopCommunity\Core\PictureHandler::getAltImageUrl	(		$sFilePath,
			$sFile,
			$blSSL = null
	)

Returns alternative image url

Parameters

string	$sFilePath	path to file
string	$sFile	filename in pictures dir
bool	$blSSL	is ssl ?

Returns

string

getIconName()

OxidEsales\EshopCommunity\Core\PictureHandler::getIconName

(

$sFilename

)

Returns article picture icon name for selected article picture

Parameters

string

$sFilename

file name

Returns

string

getImageSize()

OxidEsales\EshopCommunity\Core\PictureHandler::getImageSize	(		$aImgSizes,
			$sIndex = null
	)

Returns image sizes from provided config array

Parameters

mixed	$aImgSizes	array or string of sizes in format x*y
string	$sIndex	index in array

Returns

array

getMainIconName()

OxidEsales\EshopCommunity\Core\PictureHandler::getMainIconName

(

$sMasterImageFile

)

Returns article main icon name generated from master picture

Parameters

string

$sMasterImageFile

master image file name

Returns

string

getPicUrl()

OxidEsales\EshopCommunity\Core\PictureHandler::getPicUrl	(		$sPath,
			$sFile,
			$sSize,
			$sIndex = null,
			$sAltPath = false,
			$bSsl = null
	)

Returns requested picture url. If image is not available - returns false

Parameters

string	$sPath	path from pictures/master/
string	$sFile	picture file name
string	$sSize	picture sizes (x, y)
string	$sIndex	picture index [optional]
string	$sAltPath	alternative picture path [optional]
bool	$bSsl	Whether to force SSL

Returns

string | bool

getProductPicUrl()

OxidEsales\EshopCommunity\Core\PictureHandler::getProductPicUrl	(		$sPath,
			$sFile,
			$sSize,
			$sIndex = null,
			$bSsl = null
	)

Returns requested product picture url. If image is not available - returns url to nopic.jpg

Parameters

string	$sPath	path from pictures/master/
string	$sFile	picture file name
string	$sSize	picture sizes (x, y)
string	$sIndex	picture index [optional]
bool	$bSsl	Whether to force SSL

Returns

string | bool

getThumbName()

OxidEsales\EshopCommunity\Core\PictureHandler::getThumbName

(

$sMasterImageFile

)

Returns thumb image name generated from master picture

Parameters

string

$sMasterImageFile

master image file name

Returns

string

getZoomName()

OxidEsales\EshopCommunity\Core\PictureHandler::getZoomName	(		$sMasterImageFile,
			$iIndex
	)

Returns zoom image name generated from master picture

Parameters

string	$sMasterImageFile	master image file name
string	$iIndex	master image index

Returns

string

---

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

• /oxideshop-ce/source/Core/PictureHandler.php