Documentation TYPO3 par Ameos

Disponible dans d'autres versions de TYPO3 -> 3.7.0 3.8.1 4.0.0 4.0.1 4.1.0 <- Available in other TYPO3 versions

t3lib_stdGraphic Class Reference

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)
	makeOutline (&$im, $conf, $workArea, $txtConf)
	circleOffset ($distance, $iterations)
	makeEmboss (&$im, $conf, $workArea, $txtConf)
	makeShadow (&$im, $conf, $workArea, $txtConf)
	makeBox (&$im, $conf, $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='')
	reduceColors (&$im, $limit, $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)
	combineExec ($input, $overlay, $mask, $output)
	wrapFileName ($inputName)
	checkFile ($file)
	createTempSubDir ($dirName)
	applyImageMagickToPHPGif (&$im, $command)
	gif_or_jpg ($type, $w, $h)
	output ($file)
	destroy ()
	imgTag ($imgInfo)
	ImageGif ($destImg, $theImage)
	imageCreateFromGif ($sourceImg)
	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)
	makeOutline (&$im, $conf, $workArea, $txtConf)
	circleOffset ($distance, $iterations)
	makeEmboss (&$im, $conf, $workArea, $txtConf)
	makeShadow (&$im, $conf, $workArea, $txtConf)
	makeBox (&$im, $conf, $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='')
	reduceColors (&$im, $limit, $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)
	combineExec ($input, $overlay, $mask, $output)
	wrapFileName ($inputName)
	checkFile ($file)
	createTempSubDir ($dirName)
	applyImageMagickToPHPGif (&$im, $command)
	gif_or_jpg ($type, $w, $h)
	output ($file)
	destroy ()
	imgTag ($imgInfo)
	ImageGif ($destImg, $theImage)
	imageCreateFromGif ($sourceImg)
Public Attributes
	$combineScript = 'combine'
	$noFramePrepended = 0
	$GD2 = 0
	$imagecopyresized_fix = 0
	$gifExtension = 'gif'
	$TTFLocaleConv = ''
	$enable_typo3temp_db_tracking = 0
	$imageMagickPath = ''
	$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
	$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 = ''

Detailed Description

Definition at line 147 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 774 of file class.t3lib_stdgraphic.php.

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 1490 of file class.t3lib_stdgraphic.php.
References t3lib_div::intExplode().

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 2482 of file class.t3lib_stdgraphic.php.

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 1820 of file class.t3lib_stdgraphic.php.

t3lib_stdGraphic::autolevels ( &$ im )

Apply auto-levels to input image pointer

Parameters:

integer GDlib Image Pointer

Returns:
void

Definition at line 1625 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 <mundaun@gmx.ch> / Robert Lemke <rl@robertlemke.de>

Definition at line 2123 of file class.t3lib_stdgraphic.php.
References t3lib_div::getURL().

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 t3lib_div::intInRange().

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 797 of file class.t3lib_stdgraphic.php.
References t3lib_div::intExplode().

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, and tslib_gifBuilder.
Definition at line 2446 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 1197 of file class.t3lib_stdgraphic.php.

t3lib_stdGraphic::combineExec ( $ input,

$ overlay,

$ mask,

$ output

)

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)

Returns:
void

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

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 1833 of file class.t3lib_stdgraphic.php.
References t3lib_div::intInRange().

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 407 of file class.t3lib_stdgraphic.php.
References $workArea, t3lib_div::intExplode(), t3lib_div::intInRange(), and objPosition().

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 385 of file class.t3lib_stdgraphic.php.
References $workArea, copyGifOntoGif(), imageCreateFromGif(), and imageMagickConvert().

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 2460 of file class.t3lib_stdgraphic.php.
References t3lib_div::isFirstPartOfStr(), and t3lib_div::mkdir().

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 1522 of file class.t3lib_stdgraphic.php.
References t3lib_div::intExplode().

t3lib_stdGraphic::destroy ( )

Destroy internal image pointer, $this->im

Returns:
void

See also:
tslib_gifBuilder::gifBuild()

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

t3lib_stdGraphic::destroy ( )

Destroy internal image pointer, $this->im

Returns:
void

See also:
tslib_gifBuilder::gifBuild()

Definition at line 2569 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 2277 of file class.t3lib_stdgraphic.php.

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:
Rene Fritz <r.fritz@colorcube.de>

See also:
tslib_gifBuilder::start()

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

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 <mundaun@gmx.ch> / Robert Lemke <rl@robertlemke.de>

Definition at line 2155 of file class.t3lib_stdgraphic.php.
References t3lib_div::getURL().

Documentation TYPO3 par Ameos

t3lib_stdGraphic Class Reference

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation