class.imageLib.md

Class imageLib

• Class name: imageLib
• Source: admin-dev/filemanager/include/php_image_magician.php line 163

Contents

Properties

• $aggresiveSharpening
• $captionBoxPositionArray
• $cropFromTopPercent
• $debug
• $errorArray
• $fileExtension
• $fileName
• $fillColorArray
• $filterOverlayPath
• $fontDir
• $forceStretch
• $height
• $heightOriginal
• $image
• $imageResized
• $imageSize
• $isInterlace
• $keepTransparency
• $psdReaderPath
• $sharpenArray
• $transparentArray
• $width
• $widthOriginal

Methods

• GD2BMPstring
• GetPixelColor
• ImageCreateFromBMP
• LittleEndian2String
• __construct
• __destruct
• addBorder
• addCaptionBox
• addReflection
• addShadow
• addText
• addTextToCaptionBox
• addWatermark
• blackAndWhite
• borderPreset
• calculateCaptionBoxPosition
• calculatePosition
• checkInterlaceImage
• checkStringStartsWith
• createImageColor
• crop
• cropImage
• displayImage
• filterOpacity
• findSharp
• findUnusedBlue
• findUnusedGreen
• formatColor
• gd_apply_overlay
• gd_filter_monopin
• gd_filter_vintage
• getCropPlacing
• getDimensions
• getErrors
• getExif
• getFileName
• getHeight
• getOptimalCrop
• getOriginalHeight
• getOriginalWidth
• getSizeByAuto
• getSizeByFixedHeight
• getSizeByFixedWidth
• getTextFont
• getTextSize
• getWidth
• greyScale
• greyScaleDramatic
• greyScaleEnhanced
• hex2dec
• image_colorize
• imagecreatefrompsd
• initialise
• invertTransparency
• iptc_maketag
• keepTransparancy
• negative
• openImage
• prepOption
• reset
• resizeImage
• resolveExposureProgram
• resolveFlash
• resolveMeteringMode
• rotate
• roundCorners
• saveImage
• sepia
• sepia2
• setCropFromTop
• setFile
• setFillColor
• setForceStretch
• setTransparency
• sharpen
• sharpen2
• testColorExists
• testEXIFInstalled
• testFunct
• testGDInstalled
• testIsImage
• transparentImage
• vintage
• writeIPTC
• writeIPTCcaption
• writeIPTCwriter

Properties

$aggresiveSharpening

private mixed $aggresiveSharpening = false

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 179.

$captionBoxPositionArray

private mixed $captionBoxPositionArray = array()

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 192.

$cropFromTopPercent

private mixed $cropFromTopPercent = 10

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 196.

$debug

private mixed $debug = true

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 175.

$errorArray

private mixed $errorArray = array()

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 176.

$fileExtension

private mixed $fileExtension

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 173.

$fileName

private mixed $fileName

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 165.

$fillColorArray

private mixed $fillColorArray = array('r' => 255, 'g' => 255, 'b' => 255)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 183.

$filterOverlayPath

private mixed $filterOverlayPath

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 188.

$fontDir

private mixed $fontDir = 'fonts'

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 194.

$forceStretch

private mixed $forceStretch = true

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 178.

$height

private mixed $height

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 171.

$heightOriginal

private mixed $heightOriginal

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 169.

$image

private mixed $image

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 166.

$imageResized

protected mixed $imageResized

• Visibility: protected
• Source: admin-dev/filemanager/include/php_image_magician.php line 167.

$imageSize

private mixed $imageSize

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 172.

$isInterlace

private mixed $isInterlace

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 190.

$keepTransparency

private mixed $keepTransparency = true

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 182.

$psdReaderPath

private mixed $psdReaderPath

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 187.

$sharpenArray

private mixed $sharpenArray = array('jpg')

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 185.

$transparentArray

private mixed $transparentArray = array('.png', '.gif')

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 181.

$width

private mixed $width

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 170.

$widthOriginal

private mixed $widthOriginal

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 168.

Methods

GD2BMPstring

mixed imageLib::GD2BMPstring($gd_image)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 3060

Arguments

• $gd_image mixed

GetPixelColor

mixed imageLib::GetPixelColor($img, $x, $y)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 3113

Arguments

• $img mixed
• $x mixed
• $y mixed

ImageCreateFromBMP

mixed imageLib::ImageCreateFromBMP($filename)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 3152

Arguments

• $filename mixed

LittleEndian2String

mixed imageLib::LittleEndian2String($number, $minbytes)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 3130

Arguments

• $number mixed
• $minbytes mixed

__construct

mixed imageLib::__construct($fileName)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 201

Arguments

• $fileName mixed

__destruct

mixed imageLib::__destruct()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 3320

addBorder

mixed imageLib::addBorder($thickness, $rgbArray)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 919

Arguments

• $thickness mixed
• $rgbArray mixed

addCaptionBox

mixed imageLib::addCaptionBox($side, $thickness, $padding, $bgColor, $transparencyAmount)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1585

Arguments

• $side mixed
• $thickness mixed
• $padding mixed
• $bgColor mixed
• $transparencyAmount mixed

addReflection

mixed imageLib::addReflection($reflectionHeight, $startingTransparency, $inside, $bgColor, $stretch, $divider)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1187

Arguments

• $reflectionHeight mixed
• $startingTransparency mixed
• $inside mixed
• $bgColor mixed
• $stretch mixed
• $divider mixed

addShadow

mixed imageLib::addShadow($shadowAngle, $blur, $bgColor)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1438

Arguments

• $shadowAngle mixed
• $blur mixed
• $bgColor mixed

addText

mixed imageLib::addText($text, $pos, $padding, $fontColor, $fontSize, $angle, $font)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2131

Arguments

• $text mixed
• $pos mixed
• $padding mixed
• $fontColor mixed
• $fontSize mixed
• $angle mixed
• $font mixed

addTextToCaptionBox

mixed imageLib::addTextToCaptionBox($text, $fontColor, $fontSize, $angle, $font)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1620

Arguments

• $text mixed
• $fontColor mixed
• $fontSize mixed
• $angle mixed
• $font mixed

addWatermark

mixed imageLib::addWatermark($watermarkImage, $pos, $padding, $opacity)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2221

Arguments

• $watermarkImage mixed
• $pos mixed
• $padding mixed
• $opacity mixed

blackAndWhite

mixed imageLib::blackAndWhite()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1003

borderPreset

mixed imageLib::borderPreset($preset)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 899

Arguments

• $preset mixed

calculateCaptionBoxPosition

mixed imageLib::calculateCaptionBoxPosition($side, $thickness, $padding)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 1670

Arguments

• $side mixed
• $thickness mixed
• $padding mixed

calculatePosition

mixed imageLib::calculatePosition($pos, $padding, $assetWidth, $assetHeight, $upperLeft)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2273

Arguments

• $pos mixed
• $padding mixed
• $assetWidth mixed
• $assetHeight mixed
• $upperLeft mixed

checkInterlaceImage

mixed imageLib::checkInterlaceImage($isEnabled)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2854

Arguments

• $isEnabled mixed

checkStringStartsWith

mixed imageLib::checkStringStartsWith($needle, $haystack)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 3049

Arguments

• $needle mixed
• $haystack mixed

createImageColor

mixed imageLib::createImageColor($colorArray)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2924

Arguments

• $colorArray mixed

crop

mixed imageLib::crop($optimalWidth, $optimalHeight, $newWidth, $newHeight, $cropPos)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 438

Arguments

• $optimalWidth mixed
• $optimalHeight mixed
• $newWidth mixed
• $newHeight mixed
• $cropPos mixed

cropImage

mixed imageLib::cropImage($newWidth, $newHeight, $cropPos)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 383

Arguments

• $newWidth mixed
• $newHeight mixed
• $cropPos mixed

displayImage

mixed imageLib::displayImage($fileType, $imageQuality)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2598

Arguments

• $fileType mixed
• $imageQuality mixed

filterOpacity

mixed imageLib::filterOpacity($img, $opacity)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2366

Arguments

• $img mixed
• $opacity mixed

findSharp

mixed imageLib::findSharp($orig, $final)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 840

Arguments

• $orig mixed
• $final mixed

findUnusedBlue

mixed imageLib::findUnusedBlue()

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2973

findUnusedGreen

mixed imageLib::findUnusedGreen()

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2950

formatColor

mixed imageLib::formatColor($value)

• Visibility: protected
• Source: admin-dev/filemanager/include/php_image_magician.php line 2864

Arguments

• $value mixed

gd_apply_overlay

mixed imageLib::gd_apply_overlay($im, $type, $amount)

Apply a PNG overlay

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 1122

Arguments

• $im mixed
• $type mixed
• $amount mixed

gd_filter_monopin

mixed imageLib::gd_filter_monopin()

Apply 'Monopin' preset

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1095

gd_filter_vintage

mixed imageLib::gd_filter_vintage()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1107

getCropPlacing

mixed imageLib::getCropPlacing($optimalWidth, $optimalHeight, $newWidth, $newHeight, $pos)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 469

Arguments

• $optimalWidth mixed
• $optimalHeight mixed
• $newWidth mixed
• $newHeight mixed
• $pos mixed

getDimensions

mixed imageLib::getDimensions($newWidth, $newHeight, $option)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 562

Arguments

• $newWidth mixed
• $newHeight mixed
• $option mixed

getErrors

mixed imageLib::getErrors()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2839

getExif

mixed imageLib::getExif($debug)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1711

Arguments

• $debug mixed

getFileName

mixed imageLib::getFileName()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2796

getHeight

mixed imageLib::getHeight()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2811

getOptimalCrop

mixed imageLib::getOptimalCrop($newWidth, $newHeight)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 726

Arguments

• $newWidth mixed
• $newHeight mixed

getOriginalHeight

mixed imageLib::getOriginalHeight()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2825

getOriginalWidth

mixed imageLib::getOriginalWidth()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2832

getSizeByAuto

mixed imageLib::getSizeByAuto($newWidth, $newHeight)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 663

Arguments

• $newWidth mixed
• $newHeight mixed

getSizeByFixedHeight

mixed imageLib::getSizeByFixedHeight($newWidth, $newHeight)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 621

Arguments

• $newWidth mixed
• $newHeight mixed

getSizeByFixedWidth

mixed imageLib::getSizeByFixedWidth($newWidth, $newHeight)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 642

Arguments

• $newWidth mixed
• $newHeight mixed

getTextFont

mixed imageLib::getTextFont($font)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2169

Arguments

• $font mixed

getTextSize

mixed imageLib::getTextSize($fontSize, $angle, $font, $text)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2201

Arguments

• $fontSize mixed
• $angle mixed
• $font mixed
• $text mixed

getWidth

mixed imageLib::getWidth()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2818

greyScale

mixed imageLib::greyScale()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 955

greyScaleDramatic

mixed imageLib::greyScaleDramatic()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 992

greyScaleEnhanced

mixed imageLib::greyScaleEnhanced()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 972

hex2dec

mixed imageLib::hex2dec($hex)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2904

Arguments

• $hex mixed

image_colorize

mixed imageLib::image_colorize($rgb)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1161

Arguments

• $rgb mixed

imagecreatefrompsd

mixed imageLib::imagecreatefrompsd($fileName)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 3293

Arguments

• $fileName mixed

initialise

mixed imageLib::initialise()

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 258

invertTransparency

mixed imageLib::invertTransparency($value, $originalMax, $invert)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2996

Arguments

• $value mixed
• $originalMax mixed
• $invert mixed

iptc_maketag

mixed imageLib::iptc_maketag($rec, $dat, $val)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2088

Arguments

• $rec mixed
• $dat mixed
• $val mixed

keepTransparancy

mixed imageLib::keepTransparancy($width, $height, $im)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 414

Arguments

• $width mixed
• $height mixed
• $im mixed

negative

mixed imageLib::negative()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1024

openImage

mixed imageLib::openImage($file)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2433

Arguments

• $file mixed

prepOption

mixed imageLib::prepOption($option)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 861

Arguments

• $option mixed

reset

mixed imageLib::reset()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2485

resizeImage

mixed imageLib::resizeImage($newWidth, $newHeight, $option, $sharpen, $autoRotate)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 274

Arguments

• $newWidth mixed
• $newHeight mixed
• $option mixed
• $sharpen mixed
• $autoRotate mixed

resolveExposureProgram

mixed imageLib::resolveExposureProgram($ep)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 1897

Arguments

• $ep mixed

resolveFlash

mixed imageLib::resolveFlash($flash)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 1974

Arguments

• $flash mixed

resolveMeteringMode

mixed imageLib::resolveMeteringMode($mm)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 1937

Arguments

• $mm mixed

rotate

mixed imageLib::rotate($value, $bgColor)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1274

Arguments

• $value mixed
• $bgColor mixed

roundCorners

mixed imageLib::roundCorners($radius, $bgColor)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1342

Arguments

• $radius mixed
• $bgColor mixed

saveImage

mixed imageLib::saveImage($savePath, $imageQuality)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2500

Arguments

• $savePath mixed
• $imageQuality mixed

sepia

mixed imageLib::sepia()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1044

sepia2

mixed imageLib::sepia2()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1064

setCropFromTop

mixed imageLib::setCropFromTop($value)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2680

Arguments

• $value mixed

setFile

mixed imageLib::setFile($fileName)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2781

Arguments

• $fileName mixed

setFillColor

mixed imageLib::setFillColor($value)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2662

Arguments

• $value mixed

setForceStretch

mixed imageLib::setForceStretch($value)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2766

Arguments

• $value mixed

setTransparency

mixed imageLib::setTransparency($bool)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2654

Arguments

• $bool mixed

sharpen

mixed imageLib::sharpen()

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 784

sharpen2

mixed imageLib::sharpen2($level)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 829

Arguments

• $level mixed

testColorExists

mixed imageLib::testColorExists($colorArray)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2935

Arguments

• $colorArray mixed

testEXIFInstalled

mixed imageLib::testEXIFInstalled()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2709

testFunct

mixed imageLib::testFunct()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2751

testGDInstalled

mixed imageLib::testGDInstalled()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2688

testIsImage

mixed imageLib::testIsImage($image)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2730

Arguments

• $image mixed

transparentImage

mixed imageLib::transparentImage($src)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 3021

Arguments

• $src mixed

vintage

mixed imageLib::vintage()

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 1083

writeIPTC

mixed imageLib::writeIPTC($dat, $value)

• Visibility: private
• Source: admin-dev/filemanager/include/php_image_magician.php line 2076

Arguments

• $dat mixed
• $value mixed

writeIPTCcaption

mixed imageLib::writeIPTCcaption($value)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2061

Arguments

• $value mixed

writeIPTCwriter

mixed imageLib::writeIPTCwriter($value)

• Visibility: public
• Source: admin-dev/filemanager/include/php_image_magician.php line 2069

Arguments

• $value mixed