OXID eShop CE  4.9.6
 All Classes Files Functions Variables Pages
oxUtilsPic Class Reference
+ Inheritance diagram for oxUtilsPic:
+ Collaboration diagram for oxUtilsPic:

Public Member Functions

 resizeImage ($sSrc, $sTarget, $iDesiredWidth, $iDesiredHeight)
 safePictureDelete ($sPicName, $sAbsDynImageDir, $sTable, $sField)
 overwritePic ($oObject, $sPicTable, $sPicField, $sPicType, $sPicDir, $aParams, $sAbsDynImageDir)
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 __construct ()
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Protected Member Functions

 _deletePicture ($sPicName, $sAbsDynImageDir)
 _isPicDeletable ($sPicName, $sTable, $sField)
 _resizeGif ($sSrc, $sTarget, $iNewWidth, $iNewHeight, $iOriginalWidth, $iOriginalHeigth, $iGDVer, $blDisableTouch)
 _resize ($aImageInfo, $sSrc, $hDestinationImage, $sTarget, $iNewWidth, $iNewHeight, $iGdVer, $blDisableTouch, $iDefQuality)
 _copyAlteredImage ($sDestinationImage, $sSourceImage, $iNewWidth, $iNewHeight, $aImageInfo, $sTarget, $iGdVer, $blDisableTouch)

Protected Attributes

 $_aImageTypes = array("GIF" => IMAGETYPE_GIF, "JPG" => IMAGETYPE_JPEG, "PNG" => IMAGETYPE_PNG, "JPEG" => IMAGETYPE_JPEG)

Additional Inherited Members

- Static Protected Attributes inherited from oxSuperCfg
static $_oConfig = null
static $_oSession = null
static $_oRights = null
static $_oActUser = null
static $_blIsAdmin = null

Detailed Description

Including pictures generator functions file Image manipulation class

Definition at line 11 of file oxutilspic.php.

Member Function Documentation

oxUtilsPic::_copyAlteredImage (   $sDestinationImage,
  $sSourceImage,
  $iNewWidth,
  $iNewHeight,
  $aImageInfo,
  $sTarget,
  $iGdVer,
  $blDisableTouch 
)
protected

create and copy the resized image

Parameters
string$sDestinationImagefile + path of destination
string$sSourceImagefile + path of source
int$iNewWidthnew width of the image
int$iNewHeightnew height of the image
array$aImageInfoadditional info
string$sTargettarget file path
int$iGdVerused gd version
bool$blDisableTouchwether Touch() should be called or not
Returns
null

Definition at line 236 of file oxutilspic.php.

oxUtilsPic::_deletePicture (   $sPicName,
  $sAbsDynImageDir 
)
protected

Removes picture file from disk.

Parameters
string$sPicNamename of picture
string$sAbsDynImageDirthe absolute image diectory, where to delete the given image ($myConfig->getPictureDir(false))
Returns
null

Definition at line 77 of file oxutilspic.php.

oxUtilsPic::_isPicDeletable (   $sPicName,
  $sTable,
  $sField 
)
protected

Checks if current picture file is used in more than one table entry, returns true if one, false if more than one.

Parameters
string$sPicNameName of picture file
string$sTablein which table
string$sFieldtable field value
Returns
bool

Definition at line 118 of file oxutilspic.php.

oxUtilsPic::_resize (   $aImageInfo,
  $sSrc,
  $hDestinationImage,
  $sTarget,
  $iNewWidth,
  $iNewHeight,
  $iGdVer,
  $blDisableTouch,
  $iDefQuality 
)
protected

type dependant image resizing

Parameters
array$aImageInfoContains information on image's type / width / height
string$sSrcsource image
string$hDestinationImageDestination Image
string$sTargetResized Image target
int$iNewWidthResized Image's width
int$iNewHeightResized Image's height
mixed$iGdVerused GDVersion, if null or false returns false
bool$blDisableTouchfalse if "touch()" should be called for gif resizing
string$iDefQualityquality for "imagejpeg" function
Returns
bool

Definition at line 192 of file oxutilspic.php.

oxUtilsPic::_resizeGif (   $sSrc,
  $sTarget,
  $iNewWidth,
  $iNewHeight,
  $iOriginalWidth,
  $iOriginalHeigth,
  $iGDVer,
  $blDisableTouch 
)
protected

Resizes and saves GIF image. This method was separated due to GIF transparency problems.

Parameters
string$sSrcimage file
string$sTargetdestination file
int$iNewWidthnew width
int$iNewHeightnew height
int$iOriginalWidthoriginal width
int$iOriginalHeigthoriginal height
int$iGDVerGD packet version
bool$blDisableTouchfalse if "touch()" should be called
Returns
bool

Definition at line 172 of file oxutilspic.php.

oxUtilsPic::overwritePic (   $oObject,
  $sPicTable,
  $sPicField,
  $sPicType,
  $sPicDir,
  $aParams,
  $sAbsDynImageDir 
)

Deletes picture if new is uploaded or changed

Parameters
object$oObjectin whitch obejct search for old values
string$sPicTablepictures table
string$sPicFieldwhere picture are stored
string$sPicTypehow does it call in $_FILE array
string$sPicDirdirectory of pic
array$aParamsnew input text array
string$sAbsDynImageDirthe absolute image diectory, where to delete the given image ($myConfig->getPictureDir(false))
Returns
null

Definition at line 143 of file oxutilspic.php.

oxUtilsPic::resizeImage (   $sSrc,
  $sTarget,
  $iDesiredWidth,
  $iDesiredHeight 
)

Resizes image to desired width and height, returns true on success.

Parameters
string$sSrcSource of image file
string$sTargetTarget to write resized image file
mixed$iDesiredWidthWidth of resized image
mixed$iDesiredHeightHeight of resized image
Returns
bool

Definition at line 31 of file oxutilspic.php.

oxUtilsPic::safePictureDelete (   $sPicName,
  $sAbsDynImageDir,
  $sTable,
  $sField 
)

deletes the given picutre and checks before if the picture is deletable

Parameters
string$sPicNameName of picture file
string$sAbsDynImageDirthe absolute image diectory, where to delete the given image ($myConfig->getPictureDir(false))
string$sTablein which table
string$sFieldtable field value
Returns
bool

Definition at line 59 of file oxutilspic.php.

Member Data Documentation

oxUtilsPic::$_aImageTypes = array("GIF" => IMAGETYPE_GIF, "JPG" => IMAGETYPE_JPEG, "PNG" => IMAGETYPE_PNG, "JPEG" => IMAGETYPE_JPEG)
protected

Definition at line 19 of file oxutilspic.php.


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