t3lib_iconWorks Klassenreferenz

Aufstellung aller Elemente

Öffentliche, statische Methoden
static	getIconImage ($table, $row=array(), $backPath, $params= '', $shaded=FALSE)
static	getIcon ($table, $row=array(), $shaded=FALSE)
static	skinImg ($backPath, $src, $wHattribs= '', $outputMode=0)
static	makeIcon ($iconfile, $mode, $user, $protectSection, $absFile, $iconFileName_stateTagged)
static	imagecopyresized (&$im, $cpImg, $Xstart, $Ystart, $cpImgCutX, $cpImgCutY, $w, $h, $w, $h)
static	imagecreatefrom ($file)
static	imagemake ($im, $path)

---

Dokumentation der Elementfunktionen

static t3lib_iconWorks::getIcon	(	$	table,
		$	row = array(),
		$	shaded = FALSE
	)			[static]

Creates the icon for input table/row Returns filename for the image icon, relative to PATH_typo3 Usage: 24

Parameter:

	string	The table name
	array	The table row ("enablefields" are at least needed for correct icon display and for pages records some more fields in addition!)
	boolean	If set, the icon will be grayed/shaded

Rückgabe:

string Icon filename

Siehe auch:

getIconImage()

static t3lib_iconWorks::getIconImage	(	$	table,
		$	row = array(),
		$	backPath,
		$	params = '',
		$	shaded = FALSE
	)			[static]

Returns an icon image tag, 18x16 pixels, based on input information. This function is recommended to use in your backend modules. Usage: 60

Parameter:

	string	The table name
	array	The table row ("enablefields" are at least needed for correct icon display and for pages records some more fields in addition!)
	string	The backpath to the main TYPO3 directory (relative path back to PATH_typo3)
	string	Additional attributes for the image tag
	boolean	If set, the icon will be grayed/shaded

Rückgabe:

string -tag

Siehe auch:

getIcon()

static t3lib_iconWorks::imagecopyresized	(	&$	im,
		$	cpImg,
		$	Xstart,
		$	Ystart,
		$	cpImgCutX,
		$	cpImgCutY,
		$	w,
		$	h,
		$	w,
		$	h
	)			[static]

The necessity of using this function for combining two images if GD is version 2 is that GD2 cannot manage to combine two indexed-color images without totally spoiling everything. In class.t3lib_stdgraphic this was solved by combining the images onto a first created true color image However it has turned out that this method will not work if the indexed png-files contains transparency. So I had to turn my attention to ImageMagick - my 'enemy of death'. And so it happend - ImageMagick is now used to combine my two indexed-color images with transparency. And that works. Of course it works only if ImageMagick is able to create valid png-images - which you cannot be sure of with older versions (still 5+) The only drawback is (apparently) that IM creates true-color png's. The transparency of these will not be shown by MSIE on windows at this time (although it's straight 0/100% transparency!) and the file size may be larger.

For parameters, see PHP function "imagecopyresized()"

Parameter:

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

Rückgabe:

void private

static t3lib_iconWorks::imagecreatefrom

(

$

file

)

[static]

Create new image pointer from input file (either gif/png, in case the wrong format it is converted by t3lib_div::read_png_gif())

Parameter:

string

Absolute filename of the image file from which to start the icon creation.

Rückgabe:

mixed If success, image pointer, otherwise "-1" private

Siehe auch:

t3lib_div::read_png_gif

static t3lib_iconWorks::imagemake	(	$	im,
		$	path
	)			[static]

Write the icon in $im pointer to $path

Parameter:

	pointer	Pointer to GDlib image resource
	string	Absolute path to the filename in which to write the icon.

Rückgabe:

void private

static t3lib_iconWorks::makeIcon	(	$	iconfile,
		$	mode,
		$	user,
		$	protectSection,
		$	absFile,
		$	iconFileName_stateTagged
	)			[static]

Creates the icon file for the function getIcon()

Parameter:

	string	Original unprocessed Icon file, relative path to PATH_typo3
	string	Mode string, eg. "deleted" or "futuretiming" determining how the icon will look
	integer	The number of the fe_group record uid if applicable
	boolean	Flag determines if the protected-section icon should be applied.
	string	Absolute path to file from which to create the icon.
	string	The filename that this icon should have had, basically [icon base name]_[flags].[extension] - used for part of temporary filename

Rückgabe:

string Filename relative to PATH_typo3 private

static t3lib_iconWorks::skinImg	(	$	backPath,
		$	src,
		$	wHattribs = '',
		$	outputMode = 0
	)			[static]

Returns the src=... for the input $src value OR any alternative found in $TBE_STYLES['skinImg'] Used for skinning the TYPO3 backend with an alternative set of icons Usage: 336

Parameter:

	string	Current backpath to PATH_typo3 folder
	string	Icon file name relative to PATH_typo3 folder
	string	Default width/height, defined like 'width="12" height="14"'
	integer	Mode: 0 (zero) is default and returns src/width/height. 1 returns value of src+backpath, 2 returns value of w/h.

Rückgabe:

string Returns ' src="[backPath][src]" [wHattribs]'

Siehe auch:

skinImgFile()

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/t3lib/class.t3lib_iconworks.php