CWIS Developer Documentation
|
Public Member Functions | |
__construct ($SourceFileName, $DebugLevel=0) | |
SaveAs ($FileName, $NewImageType=NULL) | |
XSize () | |
YSize () | |
ScaleTo ($ScaledXSize, $ScaledYSize, $MaintainAspectRatio=FALSE) | |
CropTo ($CroppedXSize, $CroppedYSize, $CroppedXOrigin=0, $CroppedYOrigin=0) | |
Type ($FileName=NULL) | |
Get the image type. More... | |
Mimetype () | |
Get the MIME type for the image. More... | |
Extension () | |
JpegQuality ($NewSetting=NULL) | |
Status () | |
FailedExternalCommand () | |
ReadSize () | |
ImageFormatSupportedByPhp ($Format=NULL) | |
Static Public Member Functions | |
static | ExtensionForType ($Type) |
return the file name extension for the image, given a type. More... | |
static | SupportedFormats () |
static | SupportedFormatNames () |
Public Attributes | |
const | IMGTYPE_UNKNOWN = 0 |
const | IMGTYPE_JPEG = 1 |
const | IMGTYPE_GIF = 2 |
const | IMGTYPE_BMP = 4 |
const | IMGTYPE_PNG = 8 |
$GDVersion | |
$ImageObj | |
$SourceFileName | |
$ImageXSize | |
$ImageYSize | |
$ScaledXSize | |
$ScaledYSize | |
$MaintainAspectRatio | |
$CroppedXSize | |
$CroppedYSize | |
$CroppedXOrigin | |
$CroppedYOrigin | |
$JpegSaveQuality | |
$DecodeCommand | |
$ErrorStatus | |
$FailedCommand | |
$DebugLevel | |
Image::__construct | ( | $SourceFileName, | |
$DebugLevel = 0 |
|||
) |
Definition at line 27 of file Image.php.
References $DebugLevel, $SourceFileName, AI_FILEUNREADABLE, AI_IMGOBJCREATEFAILED, AI_INTERNALERROR, AI_OKAY, AI_UNSUPPORTEDFORMAT, ImageFormatSupportedByPhp(), and Type().
Image::CropTo | ( | $CroppedXSize, | |
$CroppedYSize, | |||
$CroppedXOrigin = 0 , |
|||
$CroppedYOrigin = 0 |
|||
) |
Definition at line 285 of file Image.php.
References $CroppedXOrigin, $CroppedXSize, $CroppedYOrigin, and $CroppedYSize.
|
static |
return the file name extension for the image, given a type.
int | $Type | type of file extension |
Definition at line 379 of file Image.php.
Referenced by SPTImage\FieldId(), SPTImage\GetImageUrlForResource(), and Image_Test\testAll().
Image::FailedExternalCommand | ( | ) |
Definition at line 467 of file Image.php.
References $FailedCommand.
Image::ImageFormatSupportedByPhp | ( | $Format = NULL | ) |
Definition at line 512 of file Image.php.
References Type().
Referenced by __construct(), and SaveAs().
Image::JpegQuality | ( | $NewSetting = NULL | ) |
Definition at line 392 of file Image.php.
References $JpegSaveQuality.
Image::Mimetype | ( | ) |
Get the MIME type for the image.
Definition at line 330 of file Image.php.
References $SourceFileName, and Type().
Image::ReadSize | ( | ) |
Image::SaveAs | ( | $FileName, | |
$NewImageType = NULL |
|||
) |
Definition at line 112 of file Image.php.
References $CroppedXSize, $CroppedYSize, $ErrorStatus, $ImageObj, $ScaledXSize, $ScaledYSize, AI_DESTINATIONUNWRITABLE, AI_INTERNALERROR, AI_OKAY, AI_UNSUPPORTEDFORMAT, ImageFormatSupportedByPhp(), Type(), XSize(), and YSize().
Image::ScaleTo | ( | $ScaledXSize, | |
$ScaledYSize, | |||
$MaintainAspectRatio = FALSE |
|||
) |
Definition at line 276 of file Image.php.
References $MaintainAspectRatio, $ScaledXSize, and $ScaledYSize.
Image::Status | ( | ) |
Definition at line 461 of file Image.php.
References $ErrorStatus.
Referenced by SPTImage\FieldId().
|
static |
Definition at line 437 of file Image.php.
References SupportedFormats().
Referenced by Image_Test\testAll().
|
static |
Definition at line 399 of file Image.php.
Referenced by SupportedFormatNames(), and Image_Test\testAll().
Image::Type | ( | $FileName = NULL | ) |
Get the image type.
If image file does not exist, the file name is examined to try to determine the image type.
string | $FileName | Full name (with path) of image file. (OPTIONAL, defaults to previously-stored file name for this object) |
Definition at line 301 of file Image.php.
References $SourceFileName.
Referenced by __construct(), Extension(), ImageFormatSupportedByPhp(), Mimetype(), and SaveAs().
Image::XSize | ( | ) |
Definition at line 262 of file Image.php.
References $ImageXSize, and ReadSize().
Referenced by SaveAs().
Image::YSize | ( | ) |
Definition at line 269 of file Image.php.
References $ImageYSize, and ReadSize().
Referenced by SaveAs().
Image::$CroppedXSize |
Image::$CroppedYSize |
Image::$DebugLevel |
Definition at line 491 of file Image.php.
Referenced by __construct().
Image::$FailedCommand |
Definition at line 490 of file Image.php.
Referenced by FailedExternalCommand().
Image::$JpegSaveQuality |
Definition at line 487 of file Image.php.
Referenced by JpegQuality().
Image::$ScaledXSize |
Image::$ScaledYSize |
Image::$SourceFileName |
Definition at line 477 of file Image.php.
Referenced by __construct(), Mimetype(), and Type().
const Image::IMGTYPE_BMP = 4 |
Definition at line 24 of file Image.php.
Referenced by Image_Test\testAll().
const Image::IMGTYPE_GIF = 2 |
Definition at line 23 of file Image.php.
Referenced by Image_Test\testAll().
const Image::IMGTYPE_JPEG = 1 |
Definition at line 22 of file Image.php.
Referenced by Image_Test\testAll().
const Image::IMGTYPE_PNG = 8 |
Definition at line 25 of file Image.php.
Referenced by Image_Test\testAll().
const Image::IMGTYPE_UNKNOWN = 0 |
Definition at line 21 of file Image.php.
Referenced by Image_Test\testAll().