Inheritance diagram for t3lib_stdGraphic:

Public Member Functions
	init ()
	maskImageOntoImage (&$im, $conf, $workArea)
	copyImageOntoImage (&$im, $conf, $workArea)
	copyGifOntoGif (&$im, $cpImg, $conf, $workArea)
	imagecopyresized (&$im, $cpImg, $Xstart, $Ystart, $cpImgCutX, $cpImgCutY, $w, $h, $w, $h)
	makeText (&$im, $conf, $workArea)
	txtPosition ($conf, $workArea, $BB)
	calcBBox ($conf)
	addToMap ($cords, $conf)
	calcTextCordsForMap ($cords, $offset, $conf)
	SpacedImageTTFText (&$im, $fontSize, $angle, $x, $y, $Fcolor, $fontFile, $text, $spacing, $wordSpacing, $splitRenderingConf, $sF=1)
	fontResize ($conf)
	ImageTTFBBoxWrapper ($fontSize, $angle, $fontFile, $string, $splitRendering, $sF=1)
	ImageTTFTextWrapper ($im, $fontSize, $angle, $x, $y, $color, $fontFile, $string, $splitRendering, $sF=1)
	splitString ($string, $splitRendering, $fontSize, $fontFile)
	calcWordSpacing ($conf, $scaleFactor=1)
	getTextScalFactor ($conf)
	makeOutline (&$im, $conf, $workArea, $txtConf)
	circleOffset ($distance, $iterations)
	makeEmboss (&$im, $conf, $workArea, $txtConf)
	makeShadow (&$im, $conf, $workArea, $txtConf)
	makeBox (&$im, $conf, $workArea)
	makeEllipse (&$im, array $conf, array $workArea)
	makeEffect (&$im, $conf)
	IMparams ($setup)
	adjust (&$im, $conf)
	crop (&$im, $conf)
	scale (&$im, $conf)
	setWorkArea ($workArea)
	autolevels (&$im)
	outputLevels (&$im, $low, $high, $swap= '')
	inputLevels (&$im, $low, $high, $swap= '')
	IMreduceColors ($file, $cols)
	prependAbsolutePath ($fontFile)
	v5_sharpen ($factor)
	v5_blur ($factor)
	randomName ()
	applyOffset ($cords, $OFFSET)
	convertColor ($string)
	recodeString ($string)
	singleChars ($theText, $returnUnicodeNumber=FALSE)
	objPosition ($conf, $workArea, $BB)
	imageMagickConvert ($imagefile, $newExt= '', $w= '', $h= '', $params= '', $frame= '', $options= '', $mustCreate=0)
	getImageDimensions ($imageFile)
	cacheImageDimensions ($identifyResult)
	getCachedImageDimensions ($imageFile)
	getImageScale ($info, $w, $h, $options)
	file_exists_typo3temp_file ($output, $orig= '')
	imageMagickIdentify ($imagefile)
	imageMagickExec ($input, $output, $params, $frame=0)
	combineExec ($input, $overlay, $mask, $output, $handleNegation=FALSE)
	checkFile ($file)
	createTempSubDir ($dirName)
	applyImageMagickToPHPGif (&$im, $command)
	gif_or_jpg ($type, $w, $h)
	output ($file)
	destroy ()
	imgTag ($imgInfo)
	ImageWrite ($destImg, $theImage, $quality=0)
	imageCreateFromFile ($sourceImg)
	hexColor ($col)
	unifyColors (&$img, $colArr, $closest=FALSE)
Public Attributes
	$combineScript = 'combine'
	$noFramePrepended = 0
	$GD2 = 1
	$imagecopyresized_fix = 0
	$gifExtension = 'gif'
	$gdlibExtensions = ''
	$png_truecolor = FALSE
	$truecolorColors = 0xffffff
	$enable_typo3temp_db_tracking = 0
	$imageFileExt = 'gif,jpg,jpeg,png,tif,bmp,tga,pcx,ai,pdf'
	$webImageExt = 'gif,jpg,jpeg,png'
	$maskNegate = ''
	$NO_IM_EFFECTS = ''
	$cmds
	$NO_IMAGE_MAGICK = ''
	$V5_EFFECTS = 0
	$im_version_4 = 0
	$mayScaleUp = 1
	$filenamePrefix = ''
	$imageMagickConvert_forceFileNameBody = ''
	$dontCheckForExistingTempFile = 0
	$dontCompress = 0
	$dontUnlinkTempFiles = 0
	$alternativeOutputKey = ''
	$IM_commands = array()
	$workArea = array()
	$tempPath = 'typo3temp/'
	$absPrefix = ''
	$scalecmd = '-geometry'
	$im5fx_blurSteps = '1x2,2x2,3x2,4x3,5x3,5x4,6x4,7x5,8x5,9x5'
	$im5fx_sharpenSteps = '1x2,2x2,3x2,2x3,3x3,4x3,3x4,4x4,4x5,5x5'
	$pixelLimitGif = 10000
	$colMap
	$csConvObj
	$nativeCharset = ''
Protected Member Functions
	renderTTFText (&$im, $fontSize, $angle, $x, $y, $color, $fontFile, $string, $splitRendering, $conf, $sF=1)
	getWordPairsForLineBreak ($string)
	getRenderedTextWidth ($text, $conf)
	getBreakSpace ($conf, array $boundingBox=NULL)
	wrapFileName ($inputName)

Detailed Description

Definition at line 144 of file class.t3lib_stdgraphic.php.

Member Function Documentation

t3lib_stdGraphic::addToMap	(	$	cords,
		$	conf
	)

Adds an <area> tag to the internal variable $this->map which is used to accumulate the content for an ImageMap

Parameters:

array	Coordinates for a polygon image map as created by ->calcTextCordsForMap()
array	Configuration for "imgMap." property of a TEXT GIFBUILDER object.

Returns:: void private

See also:: makeText(), calcTextCordsForMap()

Definition at line 786 of file class.t3lib_stdgraphic.php.

Referenced by makeText().

t3lib_stdGraphic::adjust	(	&$	im,
		$	conf
	)

Implements the "ADJUST" GIFBUILDER object

Parameters:

pointer	GDlib image pointer
array	TypoScript array with configuration for the GIFBUILDER object.

Returns:: void

See also:: tslib_gifBuilder::make(), autoLevels(), outputLevels(), inputLevels()

Definition at line 1685 of file class.t3lib_stdgraphic.php.

References $value, inputLevels(), t3lib_div\intExplode(), and outputLevels().

Referenced by tslib_gifBuilder\make().

t3lib_stdGraphic::applyImageMagickToPHPGif	(	&$	im,
		$	command
	)

Applies an ImageMagick parameter to a GDlib image pointer resource by writing the resource to file, performing an IM operation upon it and reading back the result into the ImagePointer.

Parameters:

pointer	The image pointer (reference)
string	The ImageMagick parameters. Like effects, scaling etc.

Returns:: void

Definition at line 2726 of file class.t3lib_stdgraphic.php.

References imageCreateFromFile(), imageMagickExec(), ImageWrite(), and randomName().

Referenced by makeEffect().

t3lib_stdGraphic::applyOffset	(	$	cords,
		$	OFFSET
	)

Applies offset value to coordinated in $cords. Basically the value of key 0/1 of $OFFSET is added to keys 0/1 of $cords

Parameters:

array	Integer coordinates in key 0/1
array	Offset values in key 0/1

Returns:: array Modified $cords array

Definition at line 2008 of file class.t3lib_stdgraphic.php.

Referenced by makeOutline(), makeShadow(), objPosition(), setWorkArea(), and txtPosition().

t3lib_stdGraphic::autolevels ( &$ im )

Apply auto-levels to input image pointer

Parameters:

integer GDlib Image Pointer

Returns:: void

Definition at line 1814 of file class.t3lib_stdgraphic.php.

t3lib_stdGraphic::cacheImageDimensions ( $ identifyResult )

Cache the result of the getImageDimensions function into the database. Does not check if the file exists!

Parameters:

array $identifyResult,: Result of the getImageDimensions function

Returns:: boolean True if operation was successful

Author:: Michael Stucki <michael@typo3.org> / Robert Lemke <rl@robertlemke.de>

Definition at line 2315 of file class.t3lib_stdgraphic.php.

References $GLOBALS.

Referenced by getImageDimensions().

t3lib_stdGraphic::calcBBox ( $ conf )

Calculates bounding box information for the TEXT GIFBUILDER object.

Parameters:

array TypoScript array for the TEXT GIFBUILDER object

Returns:: array Array with three keys [0]/[1] being x/y and [2] being the bounding box array private

See also:: txtPosition(), tslib_gifBuilder::start()

Definition at line 705 of file class.t3lib_stdgraphic.php.

References $value, calcWordSpacing(), getBreakSpace(), getRenderedTextWidth(), getTextScalFactor(), getWordPairsForLineBreak(), ImageTTFBBoxWrapper(), recodeString(), and singleChars().

Referenced by getBreakSpace(), tslib_gifBuilder\start(), and txtPosition().

t3lib_stdGraphic::calcTextCordsForMap	(	$	cords,
		$	offset,
		$	conf
	)

Calculating the coordinates for a TEXT string on an image map. Used in an <area> tag

Parameters:

array	Coordinates (from BBOX array)
array	Offset array
array	Configuration for "imgMap." property of a TEXT GIFBUILDER object.

Returns:: array private

See also:: makeText(), calcTextCordsForMap()

Definition at line 809 of file class.t3lib_stdgraphic.php.

References t3lib_div\intExplode().

Referenced by makeText().

t3lib_stdGraphic::calcWordSpacing	(	$	conf,
		$	scaleFactor = `1`
	)

Calculates the spacing and wordSpacing values

Parameters:

array	TypoScript array for the TEXT GIFBUILDER object
integer	TypoScript value from eg $conf['niceText.']['scaleFactor']

Returns:: array Array with two keys [0]/[1] being array($spacing,$wordSpacing) private

See also:: calcBBox()

Definition at line 1177 of file class.t3lib_stdgraphic.php.

Referenced by calcBBox(), fontResize(), and makeText().

t3lib_stdGraphic::checkFile ( $ file )

Returns true if the input file existed

Parameters:

string Input file to check

Returns:: string Returns the filename if the file existed, otherwise empty.

Reimplemented in tslib_gifBuilder.

Definition at line 2690 of file class.t3lib_stdgraphic.php.

t3lib_stdGraphic::circleOffset	(	$	distance,
		$	iterations
	)

Creates some offset values in an array used to simulate a circularly applied outline around TEXT

access private

Parameters:

integer	Distance
integer	Iterations.

Returns:: array

See also:: makeOutline()

Definition at line 1360 of file class.t3lib_stdgraphic.php.

References $res.

Referenced by makeOutline().

t3lib_stdGraphic::combineExec	(	$	input,
		$	overlay,
		$	mask,
		$	output,
		$	handleNegation = `FALSE`
	)

Executes a ImageMagick "combine" (or composite in newer times) on four filenames - $input, $overlay and $mask as input files and $output as the output filename (written to) Can be used for many things, mostly scaling and effects.

Parameters:

string	The relative (to PATH_site) image filepath, bottom file
string	The relative (to PATH_site) image filepath, overlay file (top)
string	The relative (to PATH_site) image filepath, the mask file (grayscale)
string	The relative (to PATH_site) image filepath, output filename (written to)
[type]	$handleNegation: ...

Returns:: void

Definition at line 2634 of file class.t3lib_stdgraphic.php.

References t3lib_utility_Command\exec(), t3lib_div\fixPermissions(), t3lib_div\imageMagickCommand(), imageMagickExec(), randomName(), and wrapFileName().

Referenced by makeShadow(), makeText(), and maskImageOntoImage().

t3lib_stdGraphic::convertColor ( $ string )

Converts a "HTML-color" TypoScript datatype to RGB-values. Default is 0,0,0

Parameters:

string "HTML-color" data type string, eg. 'red', '#ffeedd' or '255,0,255'. You can also add a modifying operator afterwards. There are two options: "255,0,255 : 20" - will add 20 to values, result is "255,20,255". Or "255,0,255 : *1.23" which will multiply all RGB values with 1.23

Returns:: array RGB values in key 0/1/2 of the array

Definition at line 2021 of file class.t3lib_stdgraphic.php.

References t3lib_div\intInRange().

Referenced by crop(), ImageTTFTextWrapper(), tslib_gifBuilder\make(), makeBox(), makeEllipse(), makeShadow(), makeText(), and unifyColors().

t3lib_stdGraphic::copyGifOntoGif	(	&$	im,
		$	cpImg,
		$	conf,
		$	workArea
	)

Copies two GDlib image pointers onto each other, using TypoScript configuration from $conf and the input $workArea definition.

Parameters:

pointer	GDlib image pointer, destination (bottom image)
pointer	GDlib image pointer, source (top image)
array	TypoScript array with the properties for the IMAGE GIFBUILDER object. Only used for the "tile" property value.
array	Work area

Returns:: void Works on the $im image pointer private

Definition at line 430 of file class.t3lib_stdgraphic.php.

References $workArea, imagecopyresized(), t3lib_div\intExplode(), t3lib_div\intInRange(), and objPosition().

Referenced by copyImageOntoImage(), crop(), and maskImageOntoImage().

t3lib_stdGraphic::copyImageOntoImage	(	&$	im,
		$	conf,
		$	workArea
	)

Implements the "IMAGE" GIFBUILDER object, when the "mask" property is false (using only $conf['file'])

Parameters:

pointer	GDlib image pointer
array	TypoScript array with configuration for the GIFBUILDER object.
array	The current working area coordinates.

Returns:: void

See also:: tslib_gifBuilder::make(), maskImageOntoImage()

Definition at line 408 of file class.t3lib_stdgraphic.php.

References $workArea, copyGifOntoGif(), imageCreateFromFile(), imageMagickConvert(), and t3lib_div\inList().

Referenced by tslib_gifBuilder\make().

t3lib_stdGraphic::createTempSubDir ( $ dirName )

Creates subdirectory in typo3temp/ if not already found.

Parameters:

string Name of sub directory

Returns:: boolean Result of t3lib_div::mkdir(), true if it went well.

Definition at line 2704 of file class.t3lib_stdgraphic.php.

References t3lib_div\isFirstPartOfStr(), and t3lib_div\mkdir().

Referenced by tslib_gifBuilder\gifBuild(), imageMagickConvert(), and randomName().

t3lib_stdGraphic::crop	(	&$	im,
		$	conf
	)

Implements the "CROP" GIFBUILDER object

Parameters:

pointer	GDlib image pointer
array	TypoScript array with configuration for the GIFBUILDER object.

Returns:: void

See also:: tslib_gifBuilder::make()

Definition at line 1719 of file class.t3lib_stdgraphic.php.

References $workArea, convertColor(), copyGifOntoGif(), t3lib_div\intExplode(), objPosition(), and setWorkArea().

Referenced by tslib_gifBuilder\make().

t3lib_stdGraphic::destroy ( )

Destroy internal image pointer, $this->im

Returns:: void

See also:: tslib_gifBuilder::gifBuild()

Definition at line 2811 of file class.t3lib_stdgraphic.php.

Referenced by tslib_gifBuilder\gifBuild().

t3lib_stdGraphic::file_exists_typo3temp_file	(	$	output,
		$	orig = `''`
	)

Used to check if a certain process of scaling an image is already being carried out (can be logged in the SQL database)

Parameters:

string	Output imagefile
string	Original basis file

Returns:: boolean Returns true if the file is already being made; thus "true" means "Don't render the image again" private

Definition at line 2508 of file class.t3lib_stdgraphic.php.

References $GLOBALS, $res, and $row.

Referenced by imageMagickConvert().

t3lib_stdGraphic::fontResize ( $ conf )

Function that finds the right fontsize that will render the textstring within a certain width

Parameters:

array The TypoScript properties of the TEXT GIFBUILDER object

Returns:: integer The new fontSize private

Author:: René Fritz <r.fritz@colorcube.de>

See also:: tslib_gifBuilder::start()

Definition at line 879 of file class.t3lib_stdgraphic.php.

References calcWordSpacing(), ImageTTFBBoxWrapper(), and recodeString().

Referenced by tslib_gifBuilder\start().

t3lib_stdGraphic::getBreakSpace	(	$	conf,
		array $	boundingBox = `NULL`
	)		`[protected]`

Gets the break space for each new line.

Parameters:

array	$conf,:	TypoScript configuration for the currently rendered object
array	$boundingBox,:	The bounding box the the currently rendered object

Returns:: integer The break space

Definition at line 1299 of file class.t3lib_stdgraphic.php.

References calcBBox().

Referenced by calcBBox(), and renderTTFText().

t3lib_stdGraphic::getCachedImageDimensions ( $ imageFile )

Fetch the cached imageDimensions from the MySQL database. Does not check if the image file exists!

Parameters:

string The image filepath

Returns:: array Returns an array where [0]/[1] is w/h, [2] is extension and [3] is the filename.

Author:: Michael Stucki <michael@typo3.org>; Robert Lemke <rl@robertlemke.de>

Definition at line 2351 of file class.t3lib_stdgraphic.php.

References $GLOBALS.

Referenced by getImageDimensions().

t3lib_stdGraphic::getImageDimensions ( $ imageFile )

Gets the input image dimensions.

Parameters:

string The image filepath

Returns:: array Returns an array where [0]/[1] is w/h, [2] is extension and [3] is the filename.

See also:: imageMagickConvert(), tslib_cObj::getImgResource()

Definition at line 2287 of file class.t3lib_stdgraphic.php.

References cacheImageDimensions(), getCachedImageDimensions(), imageMagickIdentify(), and t3lib_div\inList().

Referenced by imageMagickConvert(), and maskImageOntoImage().

t3lib_stdGraphic::getImageScale	(	$	info,
		$	w,
		$	h,
		$	options
	)

Get numbers for scaling the image based on input

Parameters:

array	Current image information: Width, Height etc.
integer	"required" width
integer	"required" height
array	Options: Keys are like "maxW", "maxH", "minW", "minH"

Returns:: array private

See also:: imageMagickConvert()

Definition at line 2394 of file class.t3lib_stdgraphic.php.

Referenced by imageMagickConvert().

t3lib_stdGraphic::getRenderedTextWidth	(	$	text,
		$	conf
	)		`[protected]`

Gets the rendered text width.

Parameters:

string	$text
array	$conf
	integer

Definition at line 1280 of file class.t3lib_stdgraphic.php.

References ImageTTFBBoxWrapper(), and recodeString().

Referenced by calcBBox(), and renderTTFText().

t3lib_stdGraphic::getTextScalFactor ( $ conf )

Calculates and returns the niceText.scaleFactor

Parameters:

array TypoScript array for the TEXT GIFBUILDER object

Returns:: integer TypoScript value from eg $conf['niceText.']['scaleFactor'] private

Definition at line 1196 of file class.t3lib_stdgraphic.php.

References t3lib_div\intInRange().

Referenced by calcBBox().

t3lib_stdGraphic::getWordPairsForLineBreak ( $ string ) [protected]

Gets the word pairs used for automatic line breaks.

Parameters:

string $string

Returns:: array

Definition at line 1261 of file class.t3lib_stdgraphic.php.

Referenced by calcBBox(), and renderTTFText().

t3lib_stdGraphic::gif_or_jpg	(	$	type,
		$	w,
		$	h
	)

Returns an image extension for an output image based on the number of pixels of the output and the file extension of the original file. For example: If the number of pixels exceeds $this->pixelLimitGif (normally 10000) then it will be a "jpg" string in return.

Parameters:

string	The file extension, lowercase.
integer	The width of the output image.
integer	The height of the output image.

Returns:: string The filename, either "jpg" or "gif"/"png" (whatever $this->gifExtension is set to.)

Definition at line 2752 of file class.t3lib_stdgraphic.php.

Referenced by imageMagickConvert().

t3lib_stdGraphic::hexColor ( $ col )

Returns the HEX color value for an RGB color array

Parameters:

array RGB color array

Returns:: string HEX color value

Definition at line 2910 of file class.t3lib_stdgraphic.php.

Referenced by unifyColors().

t3lib_stdGraphic::imagecopyresized	(	&$	im,
		$	cpImg,
		$	Xstart,
		$	Ystart,
		$	cpImgCutX,
		$	cpImgCutY,
		$	w,
		$	h,
		$	w,
		$	h
	)

Alternative function for using the similar PHP function imagecopyresized(). Used for GD2 only.

OK, the reason for this stupid fix is the following story: GD1.x was capable of copying two images together and combining their palettes! GD2 is apparently not. With GD2 only the palette of the dest-image is used which mostly results in totally black images when trying to copy a color-ful image onto the destination. The GD2-fix is to 1) Create a blank TRUE-COLOR image 2) Copy the destination image onto that one 3) Then do the actual operation; Copying the source (top image) onto that 4) ... and return the result pointer. 5) Reduce colors (if we do not, the result may become strange!) It works, but the resulting images is now a true-color PNG which may be very large. So, why not use 'imagetruecolortopalette ($im, TRUE, 256)' - well because it does NOT WORK! So simple is that.

For parameters, see PHP function "imagecopyresized()"

Parameters:

pointer	see PHP function "imagecopyresized()"
pointer	see PHP function "imagecopyresized()"
integer	see PHP function "imagecopyresized()"
integer	see PHP function "imagecopyresized()"
integer	see PHP function "imagecopyresized()"
integer	see PHP function "imagecopyresized()"
integer	see PHP function "imagecopyresized()"
integer	see PHP function "imagecopyresized()"
integer	see PHP function "imagecopyresized()"
integer	see PHP function "imagecopyresized()"

Returns:: void private

See also:: t3lib_iconWorks::imagecopyresized()

Definition at line 509 of file class.t3lib_stdgraphic.php.

Referenced by copyGifOntoGif(), and makeShadow().

t3lib_stdGraphic::imageCreateFromFile ( $ sourceImg )

Creates a new GDlib image resource based on the input image filename. If it fails creating a image from the input file a blank gray image with the dimensions of the input image will be created instead.

Parameters:

string Image filename

Returns:: pointer Image Resource pointer

Definition at line 2873 of file class.t3lib_stdgraphic.php.

Referenced by applyImageMagickToPHPGif(), copyImageOntoImage(), makeShadow(), makeText(), maskImageOntoImage(), scale(), and unifyColors().

t3lib_stdGraphic::imageMagickConvert	(	$	imagefile,
		$	newExt = `''`,
		$	w = `''`,
		$	h = `''`,
		$	params = `''`,
		$	frame = `''`,
		$	options = `''`,
		$	mustCreate = `0`
	)

Converts $imagefile to another file in temp-dir of type $newExt (extension).

Parameters:

string	The image filepath
string	New extension, eg. "gif", "png", "jpg", "tif". If $newExt is NOT set, the new imagefile will be of the original format. If newExt = 'WEB' then one of the web-formats is applied.
string	Width. $w / $h is optional. If only one is given the image is scaled proportionally. If an 'm' exists in the $w or $h and if both are present the $w and $h is regarded as the Maximum w/h and the proportions will be kept
string	Height. See $w
string	Additional ImageMagick parameters.
string	Refers to which frame-number to select in the image. '' or 0 will select the first frame, 1 will select the next and so on...
array	An array with options passed to getImageScale (see this function).
boolean	If set, then another image than the input imagefile MUST be returned. Otherwise you can risk that the input image is good enough regarding messures etc and is of course not rendered to a new, temporary file in typo3temp/. But this option will force it to.

Returns:: array [0]/[1] is w/h, [2] is file extension and [3] is the filename.

See also:: getImageScale(), typo3/show_item.php, fileList_ext::renderImage(), tslib_cObj::getImgResource(), SC_tslib_showpic::show(), maskImageOntoImage(), copyImageOntoImage(), scale()

Definition at line 2171 of file class.t3lib_stdgraphic.php.

References $GLOBALS, createTempSubDir(), file_exists_typo3temp_file(), getImageDimensions(), getImageScale(), t3lib_div\gif_compress(), gif_or_jpg(), imageMagickExec(), t3lib_div\inList(), and t3lib_div\shortMD5().

Referenced by copyImageOntoImage(), maskImageOntoImage(), and scale().

t3lib_stdGraphic::imageMagickExec	(	$	input,
		$	output,
		$	params,
		$	frame = `0`
	)

Executes a ImageMagick "convert" on two filenames, $input and $output using $params before them. Can be used for many things, mostly scaling and effects.

Parameters:

string	The relative (to PATH_site) image filepath, input file (read from)
string	The relative (to PATH_site) image filepath, output filename (written to)
string	ImageMagick parameters
integer	Optional, refers to which frame-number to select in the image. '' or 0 will select the first frame, 1 will select the next and so on...

Returns:: string The result of a call to PHP function "exec()"

Definition at line 2602 of file class.t3lib_stdgraphic.php.

References t3lib_utility_Command\exec(), t3lib_div\fixPermissions(), t3lib_div\imageMagickCommand(), and wrapFileName().

Referenced by applyImageMagickToPHPGif(), combineExec(), imageMagickConvert(), IMreduceColors(), makeShadow(), makeText(), and unifyColors().

t3lib_stdGraphic::imageMagickIdentify ( $ imagefile )

Returns an array where [0]/[1] is w/h, [2] is extension and [3] is the filename. Using ImageMagick

Parameters:

string The relative (to PATH_site) image filepath

Returns:: array

Definition at line 2563 of file class.t3lib_stdgraphic.php.

References t3lib_utility_Command\exec(), t3lib_div\imageMagickCommand(), and wrapFileName().

Referenced by getImageDimensions().

t3lib_stdGraphic::ImageTTFBBoxWrapper	(	$	fontSize,
		$	angle,
		$	fontFile,
		$	string,
		$	splitRendering,
		$	sF = `1`
	)

Wrapper for ImageTTFBBox

Parameters:

integer	(See argument for PHP function ImageTTFBBox())
integer	(See argument for PHP function ImageTTFBBox())
string	(See argument for PHP function ImageTTFBBox())
string	(See argument for PHP function ImageTTFBBox())
array	Split-rendering configuration
integer	Scale factor

Returns:: array Information array.

Definition at line 923 of file class.t3lib_stdgraphic.php.

References debug(), t3lib_div\freetypeDpiComp(), prependAbsolutePath(), and splitString().

Referenced by calcBBox(), fontResize(), getRenderedTextWidth(), and SpacedImageTTFText().

t3lib_stdGraphic::ImageTTFTextWrapper	(	$	im,
		$	fontSize,
		$	angle,
		$	x,
		$	y,
		$	color,
		$	fontFile,
		$	string,
		$	splitRendering,
		$	sF = `1`
	)

Wrapper for ImageTTFText

Parameters:

pointer	(See argument for PHP function imageTTFtext())
integer	(See argument for PHP function imageTTFtext())
integer	(See argument for PHP function imageTTFtext())
integer	(See argument for PHP function imageTTFtext())
integer	(See argument for PHP function imageTTFtext())
integer	(See argument for PHP function imageTTFtext())
string	(See argument for PHP function imageTTFtext())
string	(See argument for PHP function imageTTFtext()). UTF-8 string, possibly with entities in.
array	Split-rendering configuration
integer	Scale factor

Returns:: void

Definition at line 970 of file class.t3lib_stdgraphic.php.

References convertColor(), debug(), t3lib_div\freetypeDpiComp(), prependAbsolutePath(), and splitString().

Referenced by renderTTFText(), and SpacedImageTTFText().

t3lib_stdGraphic::ImageWrite	(	$	destImg,
		$	theImage,
		$	quality = `0`
	)

Writes the input GDlib image pointer to file

Parameters:

pointer	The GDlib image resource pointer
string	The filename to write to
integer	The image quality (for JPEGs)

Returns:: boolean The output of either imageGif, imagePng or imageJpeg based on the filename to write

See also:: maskImageOntoImage(), scale(), output()

Definition at line 2834 of file class.t3lib_stdgraphic.php.

References t3lib_div\fixPermissions().

Referenced by applyImageMagickToPHPGif(), makeShadow(), makeText(), maskImageOntoImage(), output(), and scale().

t3lib_stdGraphic::imgTag ( $ imgInfo )

Returns Image Tag for input image information array.

Parameters:

array Image information array, key 0/1 is width/height and key 3 is the src value

Returns:: string Image tag for the input image information array.

Definition at line 2821 of file class.t3lib_stdgraphic.php.

t3lib_stdGraphic::IMparams ( $ setup )

Creating ImageMagick paramters from TypoScript property

Parameters:

string A string with effect keywords=value pairs separated by "|"

Returns:: string ImageMagick prepared parameters. private

See also:: makeEffect()

Definition at line 1600 of file class.t3lib_stdgraphic.php.

References $value, t3lib_div\intExplode(), t3lib_div\intInRange(), v5_blur(), and v5_sharpen().

Referenced by makeEffect().

t3lib_stdGraphic::IMreduceColors	(	$	file,
		$	cols
	)

Reduce colors in image using IM and create a palette based image if possible (<=256 colors)

Parameters:

string	Image file to reduce
integer	Number of colors to reduce the image to.

Returns:: string Reduced file

Definition at line 1907 of file class.t3lib_stdgraphic.php.

References imageMagickExec(), t3lib_div\intInRange(), randomName(), and t3lib_div\split_fileref().

Referenced by output().

t3lib_stdGraphic::init ( )

Init function. Must always call this when using the class. This function will read the configuration information from $GLOBALS['TYPO3_CONF_VARS']['GFX'] can set some values in internal variables.

Returns:: void

Definition at line 224 of file class.t3lib_stdgraphic.php.

References $GLOBALS, t3lib_div\deprecationLog(), t3lib_div\intInRange(), t3lib_div\makeInstance(), and v5_sharpen().

t3lib_stdGraphic::inputLevels	(	&$	im,
		$	low,
		$	high,
		$	swap = `''`
	)

Apply input levels to input image pointer (increasing contrast)

Parameters:

integer	GDlib Image Pointer
integer	The "low" value (close to 0)
integer	The "high" value (close to 255)
boolean	If swap, then low and high are swapped. (Useful for negated masks...)

Returns:: void

Definition at line 1877 of file class.t3lib_stdgraphic.php.

References t3lib_div\intInRange().

Referenced by adjust(), and makeShadow().

t3lib_stdGraphic::makeBox	(	&$	im,
		$	conf,
		$	workArea
	)

Implements the "BOX" GIFBUILDER object

Parameters:

pointer	GDlib image pointer
array	TypoScript array with configuration for the GIFBUILDER object.
array	The current working area coordinates.

Returns:: void

See also:: tslib_gifBuilder::make()

Definition at line 1523 of file class.t3lib_stdgraphic.php.

References $workArea, convertColor(), t3lib_div\intExplode(), t3lib_div\intInRange(), and objPosition().

Referenced by tslib_gifBuilder\make().

t3lib_stdGraphic::makeEffect	(	&$	im,
		$	conf
	)

Implements the "EFFECT" GIFBUILDER object The operation involves ImageMagick for applying effects

Parameters:

pointer	GDlib image pointer
array	TypoScript array with configuration for the GIFBUILDER object.

Returns:: void

See also:: tslib_gifBuilder::make(), applyImageMagickToPHPGif()

Definition at line 1585 of file class.t3lib_stdgraphic.php.

References applyImageMagickToPHPGif(), and IMparams().

Referenced by tslib_gifBuilder\make().

t3lib_stdGraphic::makeEllipse	(	&$	im,
		array $	conf,
		array $	workArea
	)

Implements the "Ellipse" GIFBUILDER object Example Typoscript: file = GIFBUILDER file { XY = 200,200 format = jpg quality = 100 10 = ELLIPSE 10.dimensions = 100,100,50,50 10.color = red

$workArea = X,Y $conf['dimensions'] = offset x, offset y, width of ellipse, height of ellipse

Parameters:

	pointer	GDlib image pointer
array	$conf	TypoScript array with configuration for the GIFBUILDER object.
array	$workArea	The current working area coordinates.

Returns:: void

See also:: tslib_gifBuilder::make()

Definition at line 1564 of file class.t3lib_stdgraphic.php.

References convertColor(), t3lib_div\intExplode(), and objPosition().

Referenced by tslib_gifBuilder\make().

t3lib_stdGraphic::makeEmboss	(	&$	im,
		$	conf,
		$	workArea,
		$	txtConf
	)

Implements the "EMBOSS" GIFBUILDER object / property for the TEXT object

Parameters:

pointer	GDlib image pointer
array	TypoScript array with configuration for the GIFBUILDER object.
array	The current working area coordinates.
array	TypoScript array with configuration for the associated TEXT GIFBUILDER object.

Returns:: void

See also:: tslib_gifBuilder::make(), makeShadow()

Definition at line 1388 of file class.t3lib_stdgraphic.php.

References $workArea, t3lib_div\intExplode(), and makeShadow().

Referenced by tslib_gifBuilder\make().

t3lib_stdGraphic::makeOutline	(	&$	im,
		$	conf,
		$	workArea,
		$	txtConf
	)

Implements the "OUTLINE" GIFBUILDER object / property for the TEXT object

Parameters:

pointer	GDlib image pointer
array	TypoScript array with configuration for the GIFBUILDER object.
array	The current working area coordinates.
array	TypoScript array with configuration for the associated TEXT GIFBUILDER object.

Returns:: void

See also:: tslib_gifBuilder::make(), makeText()

Definition at line 1331 of file class.t3lib_stdgraphic.php.

References $workArea, applyOffset(), circleOffset(), t3lib_div\intInRange(), and makeText().

Referenced by tslib_gifBuilder\make().

t3lib_stdGraphic::makeShadow	(	&$	im,
		$	conf,
		$	workArea,
		$	txtConf
	)

Implements the "SHADOW" GIFBUILDER object / property for the TEXT object The operation involves ImageMagick for combining.

Parameters:

pointer	GDlib image pointer
array	TypoScript array with configuration for the GIFBUILDER object.
array	The current working area coordinates.
array	TypoScript array with configuration for the associated TEXT GIFBUILDER object.

Returns:: void

See also:: tslib_gifBuilder::make(), makeText(), makeEmboss()

Definition at line 1410 of file class.t3lib_stdgraphic.php.

References $workArea, applyOffset(), combineExec(), convertColor(), imagecopyresized(), imageCreateFromFile(), imageMagickExec(), ImageWrite(), inputLevels(), t3lib_div\intExplode(), t3lib_div\intInRange(), makeText(), outputLevels(), randomName(), and v5_blur().

Referenced by tslib_gifBuilder\make(), and makeEmboss().

t3lib_stdGraphic::makeText	(	&$	im,
		$	conf,
		$	workArea
	)

Implements the "TEXT" GIFBUILDER object

Parameters:

pointer	GDlib image pointer
array	TypoScript array with configuration for the GIFBUILDER object.
array	The current working area coordinates.

Returns:: void

See also:: tslib_gifBuilder::make()

Definition at line 536 of file class.t3lib_stdgraphic.php.

References $workArea, addToMap(), calcTextCordsForMap(), calcWordSpacing(), combineExec(), convertColor(), imageCreateFromFile(), imageMagickExec(), ImageWrite(), t3lib_div\intInRange(), prependAbsolutePath(), randomName(), recodeString(), renderTTFText(), SpacedImageTTFText(), txtPosition(), and v5_sharpen().

Referenced by tslib_gifBuilder\make(), makeOutline(), and makeShadow().

t3lib_stdGraphic::maskImageOntoImage	(	&$	im,
		$	conf,
		$	workArea
	)

Implements the "IMAGE" GIFBUILDER object, when the "mask" property is true. It reads the two images defined by $conf['file'] and $conf['mask'] and copies the $conf['file'] onto the input image pointer image using the $conf['mask'] as a grayscale mask The operation involves ImageMagick for combining.

Parameters:

pointer	GDlib image pointer
array	TypoScript array with configuration for the GIFBUILDER object.
array	The current working area coordinates.

Returns:: void

See also:: tslib_gifBuilder::make()

Definition at line 338 of file class.t3lib_stdgraphic.php.

References $workArea, combineExec(), copyGifOntoGif(), getImageDimensions(), imageCreateFromFile(), imageMagickConvert(), ImageWrite(), t3lib_div\inList(), and randomName().

Referenced by tslib_gifBuilder\make().

t3lib_stdGraphic::objPosition	(	$	conf,
		$	workArea,
		$	BB
	)

Create an array with object position/boundaries based on input TypoScript configuration (such as the "align" property is used), the work area definition and $BB array

Parameters:

array	TypoScript configuration for a GIFBUILDER object
array	Workarea definition
array	BB (Bounding box) array. Not just used for TEXT objects but also for others

Returns:: array [0]=x, [1]=y, [2]=w, [3]=h private

See also:: copyGifOntoGif(), makeBox(), crop()

Definition at line 2111 of file class.t3lib_stdgraphic.php.

References $workArea, applyOffset(), and t3lib_div\intExplode().

Referenced by copyGifOntoGif(), crop(), makeBox(), and makeEllipse().

t3lib_stdGraphic::output ( $ file )

Writing the internal image pointer, $this->im, to file based on the extension of the input filename Used in GIFBUILDER Uses $this->setup['reduceColors'] for gif/png images and $this->setup['quality'] for jpg images to reduce size/quality if needed.

Parameters:

string The filename to write to.

Returns:: string Returns input filename

See also:: tslib_gifBuilder::gifBuild()

Definition at line 2769 of file class.t3lib_stdgraphic.php.

References $GLOBALS, t3lib_div\gif_compress(), ImageWrite(), IMreduceColors(), and t3lib_div\intInRange().

Referenced by tslib_gifBuilder\gifBuild().

t3lib_stdGraphic::outputLevels	(	&$	im,
		$	low,
		$	high,
		$	swap = `''`
	)

Apply output levels to input image pointer (decreasing contrast)

Parameters:

integer	GDlib Image Pointer
integer	The "low" value (close to 0)
integer	The "high" value (close to 255)
boolean	If swap, then low and high are swapped. (Useful for negated masks...)

Returns:: void

Definition at line 1845 of file class.t3lib_stdgraphic.php.

References t3lib_div\intInRange().

Referenced by adjust(), and makeShadow().

t3lib_stdGraphic::prependAbsolutePath ( $ fontFile )

Checks if the $fontFile is already at an absolute path and if not, prepends the correct path. Use PATH_site unless we are in the backend. Call it by t3lib_stdGraphic::prependAbsolutePath()

Parameters:

string The font file

Returns:: string The font file with absolute path.

Definition at line 1945 of file class.t3lib_stdgraphic.php.

References t3lib_div\isAbsPath(), and t3lib_div\resolveBackPath().

Referenced by ImageTTFBBoxWrapper(), ImageTTFTextWrapper(), and makeText().

t3lib_stdGraphic::randomName ( )

Returns a random filename prefixed with "temp_" and then 32 char md5 hash (without extension) from $this->tempPath. Used by functions in this class to create truely temporary files for the on-the-fly processing. These files will most likely be deleted right away.

Returns:: string

Definition at line 1995 of file class.t3lib_stdgraphic.php.

References createTempSubDir().

Referenced by applyImageMagickToPHPGif(), combineExec(), IMreduceColors(), makeShadow(), makeText(), maskImageOntoImage(), scale(), and unifyColors().

t3lib_stdGraphic::recodeString ( $ string )

Recode string Used with text strings for fonts when languages has other character sets.

Parameters:

string The text to recode

Returns:: string The recoded string. Should be UTF-8 output. MAY contain entities (eg. { or &#quot; which should render as real chars).

Definition at line 2071 of file class.t3lib_stdgraphic.php.

Referenced by calcBBox(), fontResize(), getRenderedTextWidth(), and makeText().

t3lib_stdGraphic::renderTTFText	(	&$	im,
		$	fontSize,
		$	angle,
		$	x,
		$	y,
		$	color,
		$	fontFile,
		$	string,
		$	splitRendering,
		$	conf,
		$	sF = `1`
	)		`[protected]`

Renders a regular text and takes care of a possible line break automatically.

Parameters:

	pointer	(See argument for PHP function imageTTFtext())
	integer	(See argument for PHP function imageTTFtext())
	integer	(See argument for PHP function imageTTFtext())
	integer	(See argument for PHP function imageTTFtext())
	integer	(See argument for PHP function imageTTFtext())
	integer	(See argument for PHP function imageTTFtext())
	string	(See argument for PHP function imageTTFtext())
	string	(See argument for PHP function imageTTFtext()). UTF-8 string, possibly with entities in.
	array	Split-rendering configuration
	integer	Scale factor
array	$conf,:	The configuration

Returns:: void

Definition at line 1221 of file class.t3lib_stdgraphic.php.

References getBreakSpace(), getRenderedTextWidth(), getWordPairsForLineBreak(), and ImageTTFTextWrapper().

Referenced by makeText().

t3lib_stdGraphic::scale	(	&$	im,
		$	conf
	)

Implements the "SCALE" GIFBUILDER object

Parameters:

pointer	GDlib image pointer
array	TypoScript array with configuration for the GIFBUILDER object.

Returns:: void

See also:: tslib_gifBuilder::make()

Definition at line 1758 of file class.t3lib_stdgraphic.php.

References imageCreateFromFile(), imageMagickConvert(), ImageWrite(), randomName(), and setWorkArea().

Referenced by tslib_gifBuilder\make().

t3lib_stdGraphic::setWorkArea ( $ workArea )

Implements the "WORKAREA" GIFBUILDER object when setting it Setting internal working area boundaries (->workArea)

Parameters:

string Working area dimensions, comma separated

Returns:: void private

See also:: tslib_gifBuilder::make()

Definition at line 1790 of file class.t3lib_stdgraphic.php.

References $workArea, applyOffset(), and t3lib_div\intExplode().

Referenced by crop(), tslib_gifBuilder\make(), scale(), and tslib_gifBuilder\start().

t3lib_stdGraphic::singleChars	(	$	theText,
		$	returnUnicodeNumber = `FALSE`
	)

Split a string into an array of individual characters The function will look at $this->nativeCharset and if that is set, the input string is expected to be UTF-8 encoded, possibly with entities in it. Otherwise the string is supposed to be a single-byte charset which is just splitted by a for-loop.

Parameters:

string	The text string to split
boolean	Return Unicode numbers instead of chars.

Returns:: array Numerical array with a char as each value.

Definition at line 2088 of file class.t3lib_stdgraphic.php.

Referenced by calcBBox(), SpacedImageTTFText(), and splitString().

t3lib_stdGraphic::SpacedImageTTFText	(	&$	im,
		$	fontSize,
		$	angle,
		$	x,
		$	y,
		$	Fcolor,
		$	fontFile,
		$	text,
		$	spacing,
		$	wordSpacing,
		$	splitRenderingConf,
		$	sF = `1`
	)

Printing text onto an image like the PHP function imageTTFText does but in addition it offers options for spacing of letters and words. Spacing is done by printing one char at a time and this means that the spacing is rather uneven and probably not very nice. See

Parameters:

	pointer	(See argument for PHP function imageTTFtext())
	integer	(See argument for PHP function imageTTFtext())
	integer	(See argument for PHP function imageTTFtext())
	integer	(See argument for PHP function imageTTFtext())
	integer	(See argument for PHP function imageTTFtext())
	integer	(See argument for PHP function imageTTFtext())
	string	(See argument for PHP function imageTTFtext())
	string	(See argument for PHP function imageTTFtext()). UTF-8 string, possibly with entities in.
	integer	The spacing of letters in pixels
	integer	The spacing of words in pixels
array	$splitRenderingConf	array
	integer	Scale factor

Returns:: void private

Definition at line 844 of file class.t3lib_stdgraphic.php.

References ImageTTFBBoxWrapper(), ImageTTFTextWrapper(), and singleChars().

Referenced by makeText().

t3lib_stdGraphic::splitString	(	$	string,
		$	splitRendering,
		$	fontSize,
		$	fontFile
	)

Splitting a string for ImageTTFBBox up into an array where each part has its own configuration options.

Parameters:

string	UTF-8 string
array	Split-rendering configuration from GIFBUILDER TEXT object.
integer	Current fontsize
string	Current font file

Returns:: array Array with input string splitted according to configuration

Definition at line 1023 of file class.t3lib_stdgraphic.php.

References t3lib_div\inList(), t3lib_div\intExplode(), singleChars(), t3lib_TStemplate\sortedKeyList(), and t3lib_div\trimExplode().

Referenced by ImageTTFBBoxWrapper(), and ImageTTFTextWrapper().

t3lib_stdGraphic::txtPosition	(	$	conf,
		$	workArea,
		$	BB
	)

Calculates text position for printing the text onto the image based on configuration like alignment and workarea.

Parameters:

array	TypoScript array for the TEXT GIFBUILDER object
array	Workarea definition
array	Bounding box information, was set in tslib_gifBuilder::start()

Returns:: array [0]=x, [1]=y, [2]=w, [3]=h private

See also:: makeText()

Definition at line 651 of file class.t3lib_stdgraphic.php.

References $workArea, applyOffset(), calcBBox(), and t3lib_div\intExplode().

Referenced by makeText().

t3lib_stdGraphic::unifyColors	(	&$	img,
		$	colArr,
		$	closest = `FALSE`
	)

Unifies all colors given in the colArr color array to the first color in the array.

Parameters:

pointer	Image resource
array	Array containing RGB color arrays
[type]	$closest: ...

Returns:: integer The index of the unified color

Definition at line 2934 of file class.t3lib_stdgraphic.php.

References convertColor(), hexColor(), imageCreateFromFile(), imageMagickExec(), and randomName().

Referenced by tslib_gifBuilder\make().

t3lib_stdGraphic::v5_blur ( $ factor )

Returns the IM command for blurring with ImageMagick 5 (when $this->V5_EFFECTS is set). Uses $this->im5fx_blurSteps for translation of the factor to an actual command.

Parameters:

integer The blurring factor, 0-100 (effectively in 10 steps)

Returns:: string The blurring command, eg. " -blur 3x4"

See also:: makeText(), IMparams(), v5_sharpen()

Definition at line 1978 of file class.t3lib_stdgraphic.php.

References t3lib_div\intInRange().

Referenced by IMparams(), and makeShadow().

t3lib_stdGraphic::v5_sharpen ( $ factor )

Returns the IM command for sharpening with ImageMagick 5 (when $this->V5_EFFECTS is set). Uses $this->im5fx_sharpenSteps for translation of the factor to an actual command.

Parameters:

integer The sharpening factor, 0-100 (effectively in 10 steps)

Returns:: string The sharpening command, eg. " -sharpen 3x4"

See also:: makeText(), IMparams(), v5_blur()

Definition at line 1959 of file class.t3lib_stdgraphic.php.

References t3lib_div\intInRange().

Referenced by IMparams(), init(), and makeText().

t3lib_stdGraphic::wrapFileName ( $ inputName ) [protected]

Escapes a file name so it can safely be used on the command line.

Parameters:

string $inputName filename to safeguard, must not be empty

Returns:: string $inputName escaped as needed

Definition at line 2665 of file class.t3lib_stdgraphic.php.

References $GLOBALS.

Referenced by combineExec(), imageMagickExec(), and imageMagickIdentify().

Member Data Documentation

t3lib_stdGraphic::$absPrefix = ''

Definition at line 185 of file class.t3lib_stdgraphic.php.

t3lib_stdGraphic::$alternativeOutputKey = ''

Definition at line 177 of file class.t3lib_stdgraphic.php.

t3lib_stdGraphic::$cmds

Initial value:

 array(
        'jpg' => '',
        'jpeg' => '',
        'gif' => '',
        'png' => '-colors 64'
    )

Definition at line 160 of file class.t3lib_stdgraphic.php.

t3lib_stdGraphic::$colMap

Initial value:

 array( 
        'aqua' => array(0, 255, 255),
        'black' => array(0, 0, 0),
        'blue' => array(0, 0, 255),
        'fuchsia' => array(255, 0, 255),
        'gray' => array(128, 128, 128),
        'green' => array(0, 128, 0),
        'lime' => array(0, 255, 0),
        'maroon' => array(128, 0, 0),
        'navy' => array(0, 0, 128),
        'olive' => array(128, 128, 0),
        'purple' => array(128, 0, 128),
        'red' => array(255, 0, 0),
        'silver' => array(192, 192, 192),
        'teal' => array(0, 128, 128),
        'yellow' => array(255, 255, 0),
        'white' => array(255, 255, 255)
    )