Solutions Open Source

Référence de la classe t3lib_stdGraphic

Graphe d'héritage de t3lib_stdGraphic:

[légende]

Liste de tous les membres

Fonctions membres publiques
	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)
	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)
	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)
	combineExec ($input, $overlay, $mask, $output, $handleNegation=false)
	wrapFileName ($inputName)
	checkFile ($file)
	createTempSubDir ($dirName)
	applyImageMagickToPHPGif (&$im, $command)
	gif_or_jpg ($type, $w, $h)
	output ($file)
	destroy ()
	imgTag ($imgInfo)
	ImageWrite ($destImg, $theImage)
	imageGif ($destImg, $theImage)
	imageCreateFromGif ($sourceImg)
	imageCreateFromFile ($sourceImg)
	imagecreate ($w, $h)
	hexColor ($col)
	unifyColors (&$img, $colArr, $closest=false)
Attributs publics
	$combineScript = 'combine'
	$noFramePrepended = 0
	$GD2 = 0
	$imagecopyresized_fix = 0
	$gifExtension = 'gif'
	$gdlibExtensions = ''
	$truecolor = true
	$png_truecolor = false
	$truecolorColors = 0xffffff
	$TTFLocaleConv = ''
	$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 = ''

---

Documentation des fonctions membres

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.

Renvoie:

void

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.

Paramètres:

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

Renvoie:

void

Voir également:

tslib_gifBuilder::make()

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

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

Paramètres:

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

Renvoie:

void

Voir également:

tslib_gifBuilder::make(), maskImageOntoImage()

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.

Paramètres:

	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

Renvoie:

void Works on the $im image pointer private

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()"

Paramètres:

	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()"

Renvoie:

void private

Voir également:

t3lib_iconWorks::imagecopyresized()

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

Implements the "TEXT" GIFBUILDER object

Paramètres:

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

Renvoie:

void

Voir également:

tslib_gifBuilder::make()

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

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

Paramètres:

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

Renvoie:

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

Voir également:

makeText()

t3lib_stdGraphic::calcBBox

(

$

conf

)

Calculates bounding box information for the TEXT GIFBUILDER object.

Paramètres:

array

TypoScript array for the TEXT GIFBUILDER object

Renvoie:

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

Voir également:

txtPosition(), tslib_gifBuilder::start()

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

Paramètres:

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

Renvoie:

void private

Voir également:

makeText(), calcTextCordsForMap()

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

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

Paramètres:

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

Renvoie:

array private

Voir également:

makeText(), calcTextCordsForMap()

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

Paramètres:

	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

Renvoie:

void private

t3lib_stdGraphic::fontResize

(

$

conf

)

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

Paramètres:

array

The TypoScript properties of the TEXT GIFBUILDER object

Renvoie:

integer The new fontSize private

Auteur:

Rene Fritz <r.fritz@colorcube.de>

Voir également:

tslib_gifBuilder::start()

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

Wrapper for ImageTTFBBox

Paramètres:

	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

Renvoie:

array Information array.

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

Wrapper for ImageTTFText

Paramètres:

	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

Renvoie:

void

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

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

Paramètres:

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

Renvoie:

array Array with input string splitted according to configuration

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

Calculates the spacing and wordSpacing values

Paramètres:

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

Renvoie:

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

Voir également:

calcBBox()

t3lib_stdGraphic::getTextScalFactor

(

$

conf

)

Calculates and returns the niceText.scaleFactor

Paramètres:

array

TypoScript array for the TEXT GIFBUILDER object

Renvoie:

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

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

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

Paramètres:

	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.

Renvoie:

void

Voir également:

tslib_gifBuilder::make(), makeText()

t3lib_stdGraphic::circleOffset	(	$	distance,
		$	iterations
	)

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

access private

Paramètres:

	integer	Distance
	integer	Iterations.

Renvoie:

array

Voir également:

makeOutline()

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

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

Paramètres:

	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.

Renvoie:

void

Voir également:

tslib_gifBuilder::make(), makeShadow()

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

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

Paramètres:

	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.

Renvoie:

void

Voir également:

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

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

Implements the "BOX" GIFBUILDER object

Paramètres:

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

Renvoie:

void

Voir également:

tslib_gifBuilder::make()

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

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

Paramètres:

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

Renvoie:

void

Voir également:

tslib_gifBuilder::make(), applyImageMagickToPHPGif()

t3lib_stdGraphic::IMparams

(

$

setup

)

Creating ImageMagick paramters from TypoScript property

Paramètres:

string

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

Renvoie:

string ImageMagick prepared parameters. private

Voir également:

makeEffect()

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

Implements the "ADJUST" GIFBUILDER object

Paramètres:

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

Renvoie:

void

Voir également:

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

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

Implements the "CROP" GIFBUILDER object

Paramètres:

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

Renvoie:

void

Voir également:

tslib_gifBuilder::make()

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

Implements the "SCALE" GIFBUILDER object

Paramètres:

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

Renvoie:

void

Voir également:

tslib_gifBuilder::make()

t3lib_stdGraphic::setWorkArea

(

$

workArea

)

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

Paramètres:

string

Working area dimensions, comma separated

Renvoie:

void private

Voir également:

tslib_gifBuilder::make()

t3lib_stdGraphic::autolevels

(

&$

im

)

Apply auto-levels to input image pointer

Paramètres:

integer

GDlib Image Pointer

Renvoie:

void

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

Apply output levels to input image pointer (decreasing contrast)

Paramètres:

	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...)

Renvoie:

void

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

Apply input levels to input image pointer (increasing contrast)

Paramètres:

	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...)

Renvoie:

void

t3lib_stdGraphic::reduceColors	(	&$	im,
		$	limit,
		$	cols
	)

Reduce colors in image dependend on the actual amount of colors (Only works if we are not in truecolor mode)

Paramètres:

	integer	GDlib Image Pointer
	integer	The max number of colors in the image before a reduction will happen; basically this means that IF the GD image current has the same amount or more colors than $limit define, THEN a reduction is performed.
	integer	Number of colors to reduce the image to.

Renvoie:

void

t3lib_stdGraphic::IMreduceColors	(	$	file,
		$	cols
	)

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

Paramètres:

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

Renvoie:

string Reduced file

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()

Paramètres:

string

The font file

Renvoie:

string The font file with absolute path.

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.

Paramètres:

integer

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

Renvoie:

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

Voir également:

makeText(), IMparams(), v5_blur()

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.

Paramètres:

integer

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

Renvoie:

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

Voir également:

makeText(), IMparams(), v5_sharpen()

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.

Renvoie:

string

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

Paramètres:

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

Renvoie:

array Modified $cords array

t3lib_stdGraphic::convertColor

(

$

string

)

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

Paramètres:

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

Renvoie:

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

t3lib_stdGraphic::recodeString

(

$

string

)

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

Paramètres:

string

The text to recode

Renvoie:

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

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.

Paramètres:

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

Renvoie:

array Numerical array with a char as each value.

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

Paramètres:

	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

Renvoie:

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

Voir également:

copyGifOntoGif(), makeBox(), crop()

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

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

Paramètres:

	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.

Renvoie:

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

Voir également:

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

t3lib_stdGraphic::getImageDimensions

(

$

imageFile

)

Gets the input image dimensions.

Paramètres:

string

The image filepath

Renvoie:

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

Voir également:

imageMagickConvert(), tslib_cObj::getImgResource()

t3lib_stdGraphic::cacheImageDimensions

(

$

identifyResult

)

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

Paramètres:

array

$identifyResult: Result of the getImageDimensions function

Renvoie:

boolean True if operation was successful

Auteur:

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

t3lib_stdGraphic::getCachedImageDimensions

(

$

imageFile

)

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

Paramètres:

string

The image filepath

Renvoie:

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

Auteur:

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

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

Get numbers for scaling the image based on input

Paramètres:

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

Renvoie:

array private

Voir également:

imageMagickConvert()

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)

Paramètres:

	string	Output imagefile
	string	Original basis file

Renvoie:

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

t3lib_stdGraphic::imageMagickIdentify

(

$

imagefile

)

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

Paramètres:

string

The relative (to PATH_site) image filepath

Renvoie:

array

t3lib_stdGraphic::imageMagickExec	(	$	input,
		$	output,
		$	params
	)

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

Paramètres:

	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

Renvoie:

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

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.

Paramètres:

	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: ...

Renvoie:

void

t3lib_stdGraphic::wrapFileName

(

$

inputName

)

Wrapping the input filename in double-quotes

Paramètres:

string

Input filename

Renvoie:

string The output wrapped in "" (if there are spaces in the filepath) private

t3lib_stdGraphic::checkFile

(

$

file

)

Returns true if the input file existed

Paramètres:

string

Input file to check

Renvoie:

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

Réimplémentée dans tslib_gifBuilder.

t3lib_stdGraphic::createTempSubDir

(

$

dirName

)

Creates subdirectory in typo3temp/ if not already found.

Paramètres:

string

Name of sub directory

Renvoie:

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

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.