vBulletin 5.6.5 API

vB_Image_GD extends vB_Image

in package

• vBulletin

Image class for GD Image Library

Tags

version

$Revision: 102901 $

date

$Date: 2019-09-23 19:29:15 -0700 (Mon, 23 Sep 2019) $

Table of Contents

ALLOW_RANDOM_COLOR  = 8

ALLOW_RANDOM_FONT  = 1

These make up the bit field to enable specific parts of image verification

ALLOW_RANDOM_SHAPE  = 16

ALLOW_RANDOM_SIZE  = 2

ALLOW_RANDOM_SLANT  = 4

GIF  = 1

Global image type defines used by serveral functions

JPG  = 2

PNG  = 3

$extension_map  : array<string|int, mixed>

$imageinfo  : mixed

$imagetype_constants  : array<string|int, mixed>

Used to translate from imagetype constants to extension name.

$info_extensions  : array<string|int, mixed>

$invalid  : mixed

$must_convert_types  : array<string|int, mixed>

$options  : array<string|int, mixed>

Options from datastore

$regimageoption  : array<string|int, mixed>

$resize_types  : array<string|int, mixed>

$thumb_extensions  : array<string|int, mixed>

$type_to_canonical_extension  : mixed

It's not very clear if $extension_map was supposed to be mimetype => extension, or extension => "type".

$imagefilelocation  : mixed

$preserveExif  : mixed

$thumbcolor  : string

__construct()  : void

Constructor. Sets up resizable types, extensions, etc.

__destruct()  : mixed

__serialize()  : mixed

__sleep()  : mixed

__unserialize()  : mixed

__wakeup()  : mixed

bestResize()  : mixed

Attempt to resize file if the filesize is too large after an initial resize to max dimensions or the file is already within max dimensions but the filesize is too large

canThumbnailPdf()  : bool

Returns true if it can detect that the required libraries for supporting jpg thumbnails for PDFs are installed and available.

compareExtensionToFilesignature()  : mixed

cropImg()  : mixed

Crop the profile image

fetchImageExtensions()  : mixed

fetchImageInfo()  : array<string|int, mixed>

See function definition in vB_Image

fetchImageInfoForThumbnails()  : mixed

fetchImagetypeFromExtension()  : bool

Checks if supplied extension can be used by fetchThumbnail

fetchMustConvert()  : bool

fetchThumbnail()  : array<string|int, mixed>

Returns an array containing a thumbnail, creation time, thumbnail size and any errors

fileContentIsAnimatedGif()  : mixed

fileIsAnimatedGif()  : mixed

fileLocationIsImage()  : bool

Determine if the given location holds a whitelisted image file. Return false if not an image or not whitelisted.

getConvertTypes()  : mixed

standard getter

getExtensionFromFileheaders()  : mixed

getExtensionMap()  : mixed

standard getter

getImageFromString()  : array<string|int, mixed>

See function definition in vB_Image

getInfoExtensions()  : mixed

standard getter

getOrientation()  : mixed

getResizeTypes()  : mixed

standard getter

getThumbExtensions()  : mixed

standard getter

imageThumbnailSupported()  : bool

Determine if the given extension can have an image thumbnail. Basically an alias for isValidThumbnailExtension().

instance()  : object

Select image library

isImageExtension()  : bool

Determine if the given extension should be treated as an image for size $type as far as HTML is concerned. These types also align with the cangetimgattachment permission.

isValidInfoExtension()  : bool

Checks if supplied extension can be used by fetchImageInfo

isValidResizeType()  : bool

Checks if supplied extension can be resized into a smaller permanent image, not to be used for PSD, PDF, etc as it will lose the original format

isValidThumbnailExtension()  : bool

Checks if supplied extension can be used by fetchThumbnail

loadFileData()  : mixed

loadImage()  : mixed

CALLER MUST CLEAN UP/REMOVE OLD FILE. This is to prevent the image class from removing unknown files that it didn't create.

unloadImage()  : mixed

verifyFileHeadersAndExif()  : bool

Checks for HTML tags that can be exploited via IE, & scripts in exif tags

verifyImageFile()  : bool

Checks for HTML tags that can be exploited via IE, scripts in exif tags, and checks file signature against a whitelist of image signatures (currently only support gif, jpg, bmp, tif, psd)

annotategd()  : string

Return a letter position command

annotatettf()  : string

Return a letter position command

blur()  : image

Apply a blur filter to an image

checkExif()  : mixed

fetchImageResource()  : resource

Create blank image

fetchRegimageBackgrounds()  : array<string|int, mixed>

Fetches image files from the backgrounds directory

fetchRegimageFonts()  : array<string|int, mixed>

Fetches True Type fonts from the fonts directory

flipimage()  : object

mirror an image horizontally. Can be extended to other flips but this is all we need for now

forceRewriteImage()  : mixed

is_animated_gif()  : mixed

magicWhiteList()  : mixed

orientationToAnglesCW()  : mixed

orientationToFlipFlop()  : mixed

orientImageInternalGD()  : mixed

Rotate/flip/flop image from $fileContents as specified by 'orientation' exif tag. Caller must perform file-write using the image resource.

printImage()  : void

Output an image

skipWriteImage()  : mixed

swirl()  : object

Apply a swirl/twirl filter to an image

unsharpmask()  : void

Sharpen an image

wave()  : image

Apply a wave filter to an image

fetchResizedImageFromFiledata()  : mixed

Fetch a resize image from an existing filedata

getImage()  : mixed

getUnsafeImageInfo()  : mixed

@param 	array $imgInfo contains all the required information