oxPictureHandler Class Reference
Public Member Functions | |
| generateArticlePictures ($oObject, $iIndex) | |
| deleteArticleMasterPicture ($oObject, $iIndex, $blDeleteMasterPicture=true) | |
| deleteMainIcon ($oObject) | |
| deleteThumbnail ($oObject) | |
| deleteZoomPicture ($oObject, $iIndex) | |
| getIconName ($sFilename) | |
| getMainIconName ($sMasterImageFile) | |
| getThumbName ($sMasterImageFile) | |
| getZoomName ($sMasterImageFile, $iIndex) | |
Static Public Member Functions | |
| static | getInstance () |
Protected Member Functions | |
| _getArticleMasterPictureName ($oObject, $iIndex) | |
| _getBaseMasterImageFileName ($sMasterImageFile) | |
Static Private Attributes | |
| static | $_instance = null |
Detailed Description
class for pictures processing
Definition at line 6 of file oxpicturehandler.php.
Member Function Documentation
| oxPictureHandler._getArticleMasterPictureName | ( | $ | oObject, | |
| $ | iIndex | |||
| ) | [protected] |
Get article master picture file name.
- Parameters:
-
oxArticle $oObject article object int $iIndex master picture index
- Returns:
- string
Definition at line 124 of file oxpicturehandler.php.
| 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 388 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 148 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 222 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 255 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 288 of file oxpicturehandler.php.
| oxPictureHandler.generateArticlePictures | ( | $ | oObject, | |
| $ | iIndex | |||
| ) |
Generates article pictures (icon, thumbnail, zoom picture) from master picture.
- Parameters:
-
oxArticle $oObject article object int $iIndex master picture index
- Returns:
- null
Definition at line 47 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 328 of file oxpicturehandler.php.
| static oxPictureHandler.getInstance | ( | ) | [static] |
Returns object instance
- Returns:
- oxPictureHandler
Definition at line 21 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 342 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 357 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 373 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
