tslib_gifBuilder Class Reference

List of all members.

Public Member Functions
	start ($conf, $data)
	Initialization of the GIFBUILDER objects, in particular TEXT and IMAGE.
	gifBuild ()
	Initiates the image file generation if ->setup is true and if the file did not exist already.
	make ()
	The actual rendering of the image file.
	checkTextObj ($conf)
	Initializing/Cleaning of TypoScript properties for TEXT GIFBUILDER objects.
	calcOffset ($string)
	Calculation of offset using "splitCalc" and insertion of dimensions from other GIFBUILDER objects.
	getResource ($file, $fileArray)
	Returns an "imgResource" creating an instance of the tslib_cObj class and calling tslib_cObj::getImgResource.
	checkFile ($file)
	Returns the reference to a "resource" in TypoScript.
	fileName ($pre)
	Calculates the GIFBUILDER output filename/path based on a serialized, hashed value of this->setup.
	extension ()
	Returns the file extension used in the filename.
Public Attributes
	$im = ''
	$w = 0
	$h = 0
	$map
	$workArea
	$setup = Array ()
	$data = Array()
	$objBB = Array()
	$myClassName = 'gifbuilder'
	$charRangeMap = array()

---

Member Function Documentation

tslib_gifBuilder::calcOffset (  $  string  )

Calculation of offset using "splitCalc" and insertion of dimensions from other GIFBUILDER objects. Example: Input: 2+2, 2*3, 123, [10.w] Output: 4,6,123,45 (provided that the width of object in position 10 was 45 pixels wide) Parameters: string  The string to resolve/calculate the result of. The string is divided by a comma first and each resulting part is calculated into an integer. Returns: string The resolved string with each part (separated by comma) returned separated by comma private Definition at line 552 of file class.tslib_gifbuilder.php. References $val. Referenced by start(). { $numbers=explode(',',$string); while(list($key,$val)=each($numbers)) { $val = trim($val); if ((string)$val==(string)intval($val)) { $value[$key]=intval($val); } else { $parts= t3lib_div::splitCalc($val,'+-*/%'); $value[$key]=0; reset($parts); while(list(,$part)=each($parts)) { $theVal = $part[1]; $sign = $part[0]; if ((string)intval($theVal)==(string)$theVal) { $theVal = intval($theVal); } elseif ('['.substr($theVal,1,-1).']'==$theVal) { $objParts=explode('.',substr($theVal,1,-1)); $theVal=0; if (isset($this->objBB[$objParts[0]])) { if ($objParts[1]=='w') {$theVal=intval($this->objBB[$objParts[0]][0]);} if ($objParts[1]=='h') {$theVal=intval($this->objBB[$objParts[0]][1]);} } } else { $theVal =0; } if ($sign=='-') {$value[$key]-=$theVal;} if ($sign=='+') {$value[$key]+=$theVal;} if ($sign=='/') {if (intval($theVal)) $value[$key]/=intval($theVal);} if ($sign=='*') {$value[$key]*=$theVal;} if ($sign=='%') {if (intval($theVal)) $value[$key]%=intval($theVal);} } $value[$key]=intval($value[$key]); } } $string = implode(',',$value); return $string; }

tslib_gifBuilder::checkFile (  $  file  )

Returns the reference to a "resource" in TypoScript. Parameters: string  The resource value. Returns: string Returns the relative filepath private See also: t3lib_TStemplate::getFileName() Definition at line 616 of file class.tslib_gifbuilder.php. Referenced by checkTextObj(). { return $GLOBALS['TSFE']->tmpl->getFileName($file); }

tslib_gifBuilder::checkTextObj (  $  conf  )

Initializing/Cleaning of TypoScript properties for TEXT GIFBUILDER objects. 'cleans' TEXT-object; Checks fontfile and other vital setup Finds the title if its a 'variable' (instantiates a cObj and loads it with the ->data record) Performs caseshift if any. Parameters: array  GIFBUILDER object TypoScript properties Returns: array Modified $conf array IF the "text" property is not blank private Definition at line 475 of file class.tslib_gifbuilder.php. References checkFile(). Referenced by make(), and start(). { $conf['fontFile']=$this->checkFile($conf['fontFile']); if (!$conf['fontFile']){$conf['fontFile']='t3lib/fonts/arial.ttf';} if (!$conf['iterations']){$conf['iterations'] = 1;} if (!$conf['fontSize']){$conf['fontSize']=12;} if ($conf['spacing'] || $conf['wordSpacing']) { // If any kind of spacing applys, we cannot use angles!! $conf['angle']=0; } if (!isset($conf['antiAlias'])){$conf['antiAlias']=1;} $cObj =t3lib_div::makeInstance('tslib_cObj'); $cObj->start($this->data); $conf['text']=$cObj->stdWrap($conf['text'],$conf['text.']); // Strip HTML if (!$conf['doNotStripHTML']) { $conf['text'] = strip_tags($conf['text']); } // Max length = 100 $tlen = intval($conf['textMaxLength']) ? intval($conf['textMaxLength']) : 100; $conf['text'] = substr($conf['text'],0,$tlen); if ((string)$conf['text']!='') { // Char range map thingie: $fontBaseName = basename($conf['fontFile']); if (is_array($this->charRangeMap[$fontBaseName])) { // Initialize splitRendering array: if (!is_array($conf['splitRendering.'])) { $conf['splitRendering.'] = array(); } $cfgK = $this->charRangeMap[$fontBaseName]['cfgKey']; if (!isset($conf['splitRendering.'][$cfgK])) { // Do not impose settings if a splitRendering object already exists: // Set configuration: $conf['splitRendering.'][$cfgK] = 'charRange'; $conf['splitRendering.'][$cfgK.'.'] = $this->charRangeMap[$fontBaseName]['charMapConfig']; // multiplicator of fontsize: if ($this->charRangeMap[$fontBaseName]['multiplicator']) { $conf['splitRendering.'][$cfgK.'.']['fontSize'] = round($conf['fontSize'] * $this->charRangeMap[$fontBaseName]['multiplicator']); } // multiplicator of pixelSpace: if ($this->charRangeMap[$fontBaseName]['pixelSpace']) { $travKeys = array('xSpaceBefore','xSpaceAfter','ySpaceBefore','ySpaceAfter'); foreach($travKeys as $pxKey) { if (isset($conf['splitRendering.'][$cfgK.'.'][$pxKey])) { $conf['splitRendering.'][$cfgK.'.'][$pxKey] = round($conf['splitRendering.'][$cfgK.'.'][$pxKey] * ($conf['fontSize'] / $this->charRangeMap[$fontBaseName]['pixelSpace'])); } } } } } if (is_array($conf['splitRendering.'])) { foreach($conf['splitRendering.'] as $key => $value) { if (is_array($conf['splitRendering.'][$key])) { if (isset($conf['splitRendering.'][$key]['fontFile'])) { $conf['splitRendering.'][$key]['fontFile'] = $this->checkFile($conf['splitRendering.'][$key]['fontFile']); } } } } return $conf; } }

tslib_gifBuilder::extension (   )

Returns the file extension used in the filename. Returns: string Extension; "jpg" or "gif"/"png" private Definition at line 637 of file class.tslib_gifbuilder.php. Referenced by fileName(). { switch(strtolower($this->setup['format'])) { case 'jpg': case 'jpeg': return 'jpg'; break; default: return $this->gifExtension; break; } }

tslib_gifBuilder::fileName (  $  pre  )

Calculates the GIFBUILDER output filename/path based on a serialized, hashed value of this->setup. Parameters: string  Filename prefix, eg. "GB_" Returns: string The relative filepath (relative to PATH_site) private Definition at line 627 of file class.tslib_gifbuilder.php. References extension(). Referenced by gifBuild(). { return $this->tempPath.$pre.t3lib_div::shortMD5(serialize($this->setup)).'.'.$this->extension(); }

tslib_gifBuilder::getResource (  $  file, $  fileArray )

Returns an "imgResource" creating an instance of the tslib_cObj class and calling tslib_cObj::getImgResource. Parameters: string  Filename value OR the string "GIFBUILDER", see documentation in TSref for the "datatype" called "imgResource" array  TypoScript properties passed to the function. Either GIFBUILDER properties or imgResource properties, depending on the value of $file (whether that is "GIFBUILDER" or a file reference) Returns: array Returns an array with file information if an image was returned. Otherwise false. private See also: tslib_cObj::getImgResource() &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=315&cHash=63b593a934 http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=282&cHash=831a95115d Definition at line 601 of file class.tslib_gifbuilder.php. Referenced by start(). { $fileArray['ext']= $this->gifExtension; $cObj =t3lib_div::makeInstance('tslib_cObj'); $cObj->start($this->data); return $cObj->getImgResource($file,$fileArray); }

tslib_gifBuilder::gifBuild (   )

Initiates the image file generation if ->setup is true and if the file did not exist already. Gets filename from fileName() and if file exists in typo3temp/ dir it will - of course - not be rendered again. Otherwise rendering means calling ->make(), then ->output(), then ->destroy() Returns: string The filename for the created GIF/PNG file. The filename will be prefixed "GB_" See also: make(), fileName() Definition at line 296 of file class.tslib_gifbuilder.php. References fileName(), and make(). { if ($this->setup) { $gifFileName = $this->fileName('GB/'); // Relative to PATH_site if (!@file_exists($gifFileName)) { // File exists // Create temporary directory if not done: $this->createTempSubDir('GB/'); // Create file: $this->make(); $this->output($gifFileName); $this->destroy(); } return $gifFileName; } }

tslib_gifBuilder::make (   )

The actual rendering of the image file. Basically sets the dimensions, the background color, the traverses the array of GIFBUILDER objects and finally setting the transparent color if defined. Creates a GDlib resource in $this->im and works on that Called by gifBuild() Returns: void private See also: gifBuild() &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=378&cHash=3c2ae4a1ab Definition at line 324 of file class.tslib_gifbuilder.php. References checkTextObj(), and crop(). Referenced by gifBuild(). { // Get trivial data $XY = $this->XY; // Gif-start $this->im = imagecreate($XY[0],$XY[1]); $this->w = $XY[0]; $this->h = $XY[1]; // backColor is set $cols=$this->convertColor($this->setup['backColor']); ImageColorAllocate($this->im, $cols[0],$cols[1],$cols[2]); // Traverse the GIFBUILDER objects an render each one: if (is_array($this->setup)) { $sKeyArray=t3lib_TStemplate::sortedKeyList($this->setup); foreach($sKeyArray as $theKey) { $theValue=$this->setup[$theKey]; if (intval($theKey) && $conf=$this->setup[$theKey.'.']) { switch($theValue) { // Images case 'IMAGE': if ($conf['mask']) { $this->maskImageOntoImage($this->im,$conf,$this->workArea); } else { $this->copyImageOntoImage($this->im,$conf,$this->workArea); } break; // Text case 'TEXT': if (!$conf['hide']) { if (is_array($conf['shadow.'])) { $this->makeShadow($this->im,$conf['shadow.'],$this->workArea,$conf); } if (is_array($conf['emboss.'])) { $this->makeEmboss($this->im,$conf['emboss.'],$this->workArea,$conf); } if (is_array($conf['outline.'])) { $this->makeOutline($this->im,$conf['outline.'],$this->workArea,$conf); } $conf['imgMap']=1; $this->makeText($this->im,$conf,$this->workArea); } break; // Text effects: case 'OUTLINE': if ($this->setup[$conf['textObjNum']]=='TEXT' && $txtConf=$this->checkTextObj($this->setup[$conf['textObjNum'].'.'])) { $this->makeOutline($this->im,$conf,$this->workArea,$txtConf); } break; case 'EMBOSS': if ($this->setup[$conf['textObjNum']]=='TEXT' && $txtConf=$this->checkTextObj($this->setup[$conf['textObjNum'].'.'])) { $this->makeEmboss($this->im,$conf,$this->workArea,$txtConf); } break; case 'SHADOW': if ($this->setup[$conf['textObjNum']]=='TEXT' && $txtConf=$this->checkTextObj($this->setup[$conf['textObjNum'].'.'])) { $this->makeShadow($this->im,$conf,$this->workArea,$txtConf); } break; // Other case 'BOX': $this->makeBox($this->im,$conf,$this->workArea); break; case 'EFFECT': $this->makeEffect($this->im,$conf); break; case 'ADJUST': $this->adjust($this->im,$conf); break; case 'CROP': $this->crop($this->im,$conf); break; case 'SCALE': $this->scale($this->im,$conf); break; case 'WORKAREA': if ($conf['set']) { $this->setWorkArea($conf['set']); // this sets the workArea } if (isset($conf['clear'])) { $this->workArea = $this->defaultWorkArea; // this sets the current to the default; } break; } } } } // Auto transparent background is set if ($this->setup['transparentBackground']) { imagecolortransparent($this->im, imagecolorat($this->im, 0, 0)); } // TransparentColors are set if (is_array($this->setup['transparentColor_array'])) { reset($this->setup['transparentColor_array']); while(list(,$transparentColor)=each($this->setup['transparentColor_array'])) { $cols=$this->convertColor($transparentColor); if ($this->setup['transparentColor.']['closest']) { $colIndex = ImageColorClosest ($this->im, $cols[0],$cols[1],$cols[2]); } else { $colIndex = ImageColorExact ($this->im, $cols[0],$cols[1],$cols[2]); } if ($colIndex > -1) { ImageColorTransparent($this->im, $colIndex); } else { ImageColorTransparent($this->im, ImageColorAllocate($this->im, $cols[0],$cols[1],$cols[2])); } break; // Originally we thought of letting many colors be defined as transparent, but GDlib seems to accept only one definition. Therefore we break here. Maybe in the future this 'break' will be cancelled if a method of truly defining many transparent colors could be found. } } }

tslib_gifBuilder::start (  $  conf, $  data )

Initialization of the GIFBUILDER objects, in particular TEXT and IMAGE. This includes finding the bounding box, setting dimensions and offset values before the actual rendering is started. Modifies the ->setup, ->objBB internal arrays Should be called after the ->init() function which initializes the parent class functions/variables in general. The class tslib_gmenu also uses gifbuilder and here there is an interesting use since the function findLargestDims() from that class calls the init() and start() functions to find the total dimensions before starting the rendering of the images. Parameters: array  TypoScript properties for the GIFBUILDER session. Stored internally in the variable ->setup array  The current data record from tslib_cObj. Stored internally in the variable ->data Returns: void See also: tslib_cObj::getImgResource(), tslib_gmenu::makeGifs(), tslib_gmenu::findLargestDims() Definition at line 127 of file class.tslib_gifbuilder.php. References calcOffset(), checkTextObj(), crop(), and getResource(). { if (is_array($conf)) { $this->setup = $conf; $this->data = $data; // Initializing global Char Range Map $this->charRangeMap = array(); if (is_array($GLOBALS['TSFE']->tmpl->setup['_GIFBUILDER.']['charRangeMap.'])) { foreach($GLOBALS['TSFE']->tmpl->setup['_GIFBUILDER.']['charRangeMap.'] as $cRMcfgkey => $cRMcfg) { if (is_array($cRMcfg)) { // Initializing: $cRMkey = $GLOBALS['TSFE']->tmpl->setup['_GIFBUILDER.']['charRangeMap.'][substr($cRMcfgkey,0,-1)]; $this->charRangeMap[$cRMkey] = array(); $this->charRangeMap[$cRMkey]['charMapConfig'] = $cRMcfg['charMapConfig.']; $this->charRangeMap[$cRMkey]['cfgKey'] = substr($cRMcfgkey,0,-1); $this->charRangeMap[$cRMkey]['multiplicator'] = (double)$cRMcfg['fontSizeMultiplicator']; $this->charRangeMap[$cRMkey]['pixelSpace'] = intval($cRMcfg['pixelSpaceFontSizeRef']); } } } // Getting sorted list of TypoScript keys from setup. $sKeyArray=t3lib_TStemplate::sortedKeyList($this->setup); // Setting the background color, passing it through stdWrap if ($conf['backColor.'] || $conf['backColor']) { $cObj =t3lib_div::makeInstance('tslib_cObj'); $cObj->start($this->data); $this->setup['backColor'] = trim($cObj->stdWrap($this->setup['backColor'], $this->setup['backColor.'])); } if (!$this->setup['backColor']) {$this->setup['backColor']='white';} // Transparent GIFs // not working with reduceColors // there's an option for IM: -transparent colors if ($conf['transparentColor.'] || $conf['transparentColor']) { $cObj =t3lib_div::makeInstance('tslib_cObj'); $cObj->start($this->data); $this->setup['transparentColor_array'] = explode('|', trim($cObj->stdWrap($this->setup['transparentColor'], $this->setup['transparentColor.']))); } // Set default dimensions if (!$this->setup['XY']) {$this->setup['XY']='120,50';} // Checking TEXT and IMAGE objects for files. If any errors the objects are cleared. // The Bounding Box for the objects is stored in an array foreach($sKeyArray as $theKey) { $theValue=$this->setup[$theKey]; if (intval($theKey) && $conf=$this->setup[$theKey.'.']) { // Swipes through TEXT and IMAGE-objects switch($theValue) { case 'TEXT': if ($this->setup[$theKey.'.'] = $this->checkTextObj($conf)) { // Adjust font width if max size is set: if ($this->setup[$theKey.'.']['maxWidth']) { $this->setup[$theKey.'.']['fontSize'] = $this->fontResize($this->setup[$theKey.'.']); //RTF - this has to be done before calcBBox } // Calculate bounding box: $txtInfo=$this->calcBBox($this->setup[$theKey.'.']); $this->setup[$theKey.'.']['BBOX']=$txtInfo; $this->objBB[$theKey]=$txtInfo; $this->setup[$theKey.'.']['imgMap']=0; } break; case 'IMAGE': $fileInfo = $this->getResource($conf['file'],$conf['file.']); if ($fileInfo) { $this->setup[$theKey.'.']['file']=$fileInfo[3]; $this->setup[$theKey.'.']['BBOX']=$fileInfo; $this->objBB[$theKey]=$fileInfo; if ($conf['mask']) { $maskInfo = $this->getResource($conf['mask'],$conf['mask.']); if ($maskInfo) { $this->setup[$theKey.'.']['mask']=$maskInfo[3]; } else { $this->setup[$theKey.'.']['mask'] = ''; } } } else { unset($this->setup[$theKey.'.']); } break; } // Checks if disabled is set... (this is also done in menu.php / imgmenu!!) if ($conf['if.']) { $cObj =t3lib_div::makeInstance('tslib_cObj'); $cObj->start($this->data); if (!$cObj->checkIf($conf['if.'])) { unset($this->setup[$theKey]); unset($this->setup[$theKey.'.']); } } } } // Calculate offsets on elements $this->setup['XY'] = $this->calcOffset($this->setup['XY']); $this->setup['offset'] = $this->calcOffset($this->setup['offset']); $this->setup['workArea'] = $this->calcOffset($this->setup['workArea']); foreach ($sKeyArray as $theKey) { $theValue=$this->setup[$theKey]; if (intval($theKey) && $conf=$this->setup[$theKey.'.']) { switch($theValue) { case 'TEXT': case 'IMAGE': if ($this->setup[$theKey.'.']['offset']) { $this->setup[$theKey.'.']['offset'] = $this->calcOffset($this->setup[$theKey.'.']['offset']); } break; case 'BOX': if ($this->setup[$theKey.'.']['dimensions']) { $this->setup[$theKey.'.']['dimensions'] = $this->calcOffset($this->setup[$theKey.'.']['dimensions']); } break; case 'WORKAREA': if ($this->setup[$theKey.'.']['set']) { $this->setup[$theKey.'.']['set'] = $this->calcOffset($this->setup[$theKey.'.']['set']); } break; case 'CROP': if ($this->setup[$theKey.'.']['crop']) { $this->setup[$theKey.'.']['crop'] = $this->calcOffset($this->setup[$theKey.'.']['crop']); } break; case 'SCALE': if ($this->setup[$theKey.'.']['width']) { $this->setup[$theKey.'.']['width'] = $this->calcOffset($this->setup[$theKey.'.']['width']); } if ($this->setup[$theKey.'.']['height']) { $this->setup[$theKey.'.']['height'] = $this->calcOffset($this->setup[$theKey.'.']['height']); } break; } } } // Get trivial data $XY = t3lib_div::intExplode(',',$this->setup['XY']); $maxWidth = intval($this->setup['maxWidth']); $maxHeight = intval($this->setup['maxHeight']); $XY[0] = t3lib_div::intInRange($XY[0],1, $maxWidth?$maxWidth:2000); $XY[1] = t3lib_div::intInRange($XY[1],1, $maxHeight?$maxHeight:2000); $this->XY = $XY; $this->w = $XY[0]; $this->h = $XY[1]; $this->OFFSET = t3lib_div::intExplode(',',$this->setup['offset']); $this->setWorkArea($this->setup['workArea']); // this sets the workArea $this->defaultWorkArea = $this->workArea; // this sets the default to the current; } }

---

Member Data Documentation

tslib_gifBuilder::$charRangeMap = array()

Definition at line 114 of file class.tslib_gifbuilder.php.

tslib_gifBuilder::$data = Array()

Definition at line 111 of file class.tslib_gifbuilder.php.

tslib_gifBuilder::$h = 0

Definition at line 107 of file class.tslib_gifbuilder.php.

tslib_gifBuilder::$im = ''

Definition at line 105 of file class.tslib_gifbuilder.php.

tslib_gifBuilder::$map

Definition at line 108 of file class.tslib_gifbuilder.php.

tslib_gifBuilder::$myClassName = 'gifbuilder'

Definition at line 113 of file class.tslib_gifbuilder.php.

tslib_gifBuilder::$objBB = Array()

Definition at line 112 of file class.tslib_gifbuilder.php.

tslib_gifBuilder::$setup = Array ()

Definition at line 110 of file class.tslib_gifbuilder.php.

tslib_gifBuilder::$w = 0

Definition at line 106 of file class.tslib_gifbuilder.php.

tslib_gifBuilder::$workArea

Definition at line 109 of file class.tslib_gifbuilder.php.

---

The documentation for this class was generated from the following file:

• typo3/sysext/cms/tslib/class.tslib_gifbuilder.php

---