Solutions Open Source

Référence de la classe tslib_gifBuilder

Graphe d'héritage de tslib_gifBuilder:

Inheritance graph
[légende]
Graphe de collaboration de tslib_gifBuilder:

Collaboration graph
[légende]

Liste de tous les membres

Fonctions membres publiques

 start ($conf, $data)
 gifBuild ()
 make ()
 checkTextObj ($conf)
 calcOffset ($string)
 getResource ($file, $fileArray)
 checkFile ($file)
 fileName ($pre)
 extension ()

Attributs publics

 $im = ''
 $w = 0
 $h = 0
 $map
 $workArea
 $setup = Array ()
 $combinedTextStrings = array()
 $combinedFileNames = array()
 $data = Array()
 $objBB = Array()
 $myClassName = 'gifbuilder'
 $charRangeMap = array()


Documentation des fonctions membres

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.

Paramètres:
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
Renvoie:
void
Voir également:
tslib_cObj::getImgResource(), tslib_gmenu::makeGifs(), tslib_gmenu::findLargestDims()

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

Renvoie:
string The filename for the created GIF/PNG file. The filename will be prefixed "GB_"
Voir également:
make(), fileName()

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

Renvoie:
void private
Voir également:
gifBuild() &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=378&cHash=3c2ae4a1ab

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.

Paramètres:
array GIFBUILDER object TypoScript properties
Renvoie:
array Modified $conf array IF the "text" property is not blank private

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)

Paramètres:
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.
Renvoie:
string The resolved string with each part (separated by comma) returned separated by comma private

tslib_gifBuilder::getResource ( file,
fileArray 
)

Returns an "imgResource" creating an instance of the tslib_cObj class and calling tslib_cObj::getImgResource

Paramètres:
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)
Renvoie:
array Returns an array with file information if an image was returned. Otherwise false. private
Voir également:
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

tslib_gifBuilder::checkFile ( file  ) 

Returns the reference to a "resource" in TypoScript.

Paramètres:
string The resource value.
Renvoie:
string Returns the relative filepath private
Voir également:
t3lib_TStemplate::getFileName()

Réimplémentée à partir de t3lib_stdGraphic.

tslib_gifBuilder::fileName ( pre  ) 

Calculates the GIFBUILDER output filename/path based on a serialized, hashed value of this->setup

Paramètres:
string Filename prefix, eg. "GB_"
Renvoie:
string The relative filepath (relative to PATH_site) private

tslib_gifBuilder::extension (  ) 

Returns the file extension used in the filename

Renvoie:
string Extension; "jpg" or "gif"/"png" private


Documentation des données membres

tslib_gifBuilder::$im = ''

tslib_gifBuilder::$w = 0

tslib_gifBuilder::$h = 0

tslib_gifBuilder::$map

tslib_gifBuilder::$workArea

Réimplémentée à partir de t3lib_stdGraphic.

tslib_gifBuilder::$setup = Array ()

tslib_gifBuilder::$combinedTextStrings = array()

tslib_gifBuilder::$combinedFileNames = array()

tslib_gifBuilder::$data = Array()

tslib_gifBuilder::$objBB = Array()

tslib_gifBuilder::$myClassName = 'gifbuilder'

tslib_gifBuilder::$charRangeMap = array()


La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Fri Aug 31 11:43:22 2007 pour OBLADY - Typo3 API v4.1.2 par  doxygen 1.5.3