oxPictureHandler Class Reference

Inheritance diagram for oxPictureHandler:

Collaboration diagram for oxPictureHandler:

List of all members.

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)
Static Public Member Functions
static	getInstance ()
Protected Member Functions
	_getBaseMasterImageFileName ($sMasterImageFile)
	_getPictureInfo ($sFilePath, $sFile, $blAdmin=false, $blSSL=null, $iLang=null, $iShopId=null)
Static Private Attributes
static	$_instance = null

---

Detailed Description

class for pictures processing

Definition at line 6 of file oxpicturehandler.php.

---

Member Function Documentation

oxPictureHandler._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

Definition at line 212 of file oxpicturehandler.php.

oxPictureHandler._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

Definition at line 254 of file oxpicturehandler.php.

oxPictureHandler.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:

	oxArticle	$oObject article object
	int	$iIndex master picture index
	bool	$blDeleteMasterPicture delete master picture, default is true

Returns:

null

Definition at line 38 of file oxpicturehandler.php.

oxPictureHandler.deleteMainIcon

(

$

oObject

)

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

Parameters:

oxArticle

$oObject article object

Returns:

null

Definition at line 100 of file oxpicturehandler.php.

oxPictureHandler.deleteThumbnail

(

$

oObject

)

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

Parameters:

oxArticle

$oObject article object

Returns:

null

Definition at line 115 of file oxpicturehandler.php.

oxPictureHandler.deleteZoomPicture	(	$	oObject,
		$	iIndex
	)

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

Parameters:

	oxArticle	$oObject article object
	int	$iIndex zoom picture index

Returns:

null

Definition at line 132 of file oxpicturehandler.php.

oxPictureHandler.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

Definition at line 282 of file oxpicturehandler.php.

oxPictureHandler.getIconName

(

$

sFilename

)

Returns article picture icon name for selected article picture

Parameters:

string

$sFilename file name

Returns:

string

Definition at line 163 of file oxpicturehandler.php.

oxPictureHandler.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

Definition at line 225 of file oxpicturehandler.php.

static oxPictureHandler.getInstance

(

)

[static]

Returns object instance

Deprecated:

since v5.0 (2012-08-10); Use Registry getter instead - oxRegistry.get("oxPictureHandler");

Returns:

oxPictureHandler

Definition at line 22 of file oxpicturehandler.php.

oxPictureHandler.getMainIconName

(

$

sMasterImageFile

)

Returns article main icon name generated from master picture

Parameters:

string

$sMasterImageFile master image file name

Returns:

string

Definition at line 175 of file oxpicturehandler.php.

oxPictureHandler.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

Definition at line 324 of file oxpicturehandler.php.

oxPictureHandler.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

Definition at line 349 of file oxpicturehandler.php.

oxPictureHandler.getThumbName

(

$

sMasterImageFile

)

Returns thumb image name generated from master picture

Parameters:

string

$sMasterImageFile master image file name

Returns:

string

Definition at line 187 of file oxpicturehandler.php.

oxPictureHandler.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

Definition at line 200 of file oxpicturehandler.php.

---

Member Data Documentation

oxPictureHandler.$_instance = null [static, private]

Definition at line 13 of file oxpicturehandler.php.

---

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

• core/oxpicturehandler.php