Static Public Member Functions
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)
static	getSpriteIcon ($iconName, array $options=array(), array $overlays=array())
static	getSpriteIconForFile ($fileExtension, array $options=array())
static	mapFileExtensionToSpriteIconClass ($fileExtension)
static	mapFileExtensionToSpriteIconName ($fileExtension)
static	getSpriteIconForRecord ($table, array $row, array $options=array())
static	mapRecordTypeToSpriteIconClass ($table, array $row)
static	mapRecordTypeToSpriteIconName ($table, array $row)
static	mapRecordOverlayToSpriteIconName ($table, array $row)
static	getSpriteIconClasses ($iconName)
Static Public Attributes
static	$fileSpriteIconNames
Static Protected Member Functions
static	buildSpriteHtmlIconTag (array $tagAttributes, $innerHtml=NULL, $tagName=NULL)

Detailed Description

Definition at line 77 of file class.t3lib_iconworks.php.

Member Function Documentation

static t3lib_iconWorks::buildSpriteHtmlIconTag	(	array $	tagAttributes,
		$	innerHtml = `NULL`,
		$	tagName = `NULL`
	)		`[static, protected]`

low level function that generates the HTML tag for the sprite icon is usually called by the three API classes (getSpriteIcon, getSpriteIconForFile, getSpriteIconForRecord) it does not care about classes or anything else, but just plainly builds the HTML tag

Parameters:

array	$tagAttributes	an associative array of additional tagAttributes for the HTML tag
string	$innerHtml	(optional) the content within the tag, a " " by default
string	$tagName	(optional) the name of the HTML element that should be used (span by default)

Definition at line 1017 of file class.t3lib_iconworks.php.

References $value.

Referenced by getSpriteIcon(), getSpriteIconForFile(), and getSpriteIconForRecord().

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

Parameters:

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

Returns:: string Icon filename

See also:: getIconImage()

Definition at line 180 of file class.t3lib_iconworks.php.

References $GLOBALS, $ICON_TYPES, $PAGES_TYPES, $row, $TCA, t3lib_pageSelect\DOKTYPE_ADVANCED, t3lib_pageSelect\DOKTYPE_DEFAULT, t3lib_pageSelect\DOKTYPE_HIDE_IN_MENU, and makeIcon().

Referenced by ShortcutMenu\getShortcutIcon(), TBE_browser_recordList\linkWrapItems(), tx_tstemplateobjbrowser\main(), and user_SC_mod_user_ws_workspaceForms\processUserAndGroups().

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

Parameters:

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

Returns:: string -tag

See also:: getIcon()

Definition at line 158 of file class.t3lib_iconworks.php.

References $row, and skinImg().

Referenced by SC_mod_user_ws_index\moduleContent_publish(), SC_mod_user_ws_index\workspaceList_getUserListForSysWorkspace(), and SC_mod_user_ws_index\workspaceList_getUserListWithAccess().

static t3lib_iconWorks::getSpriteIcon	(	$	iconName,
		array $	options = `array()`,
		array $	overlays = `array()`
	)		`[static]`

This generic method is used throughout the TYPO3 Backend to show icons in any variation which are not bound to any file type (see getSpriteIconForFile) or database record (see getSpriteIconForRecord)

Generates a HTML tag with proper CSS classes. The TYPO3 skin has defined these CSS classes already to have a pre-defined background image, and the correct background-position to show the necessary icon.

Parameters:

string	$iconName	the name of the icon to fetch
array	$options	an associative array with additional options and attributes for the tag. by default, the key is the name of the attribute, and the value is the parameter string that is set. However, there are some additional special reserved keywords that can be used as keys: "html" (which is the HTML that will be inside the icon HTML tag), "tagName" (which is an alternative tagName than "span"), and "class" (additional class names that will be merged with the sprite icon CSS classes)
array	$overlays	an associative array with the icon-name as key, and the options for this overlay as an array again (see the parameter $options again)

Returns:: string the full HTML tag (usually a ) public

Definition at line 648 of file class.t3lib_iconworks.php.

References $GLOBALS, buildSpriteHtmlIconTag(), and getSpriteIconClasses().

static t3lib_iconWorks::getSpriteIconClasses ( $ iconName ) [static]

generic method to create the final CSS classes based on the sprite icon name with the base class and splits the name into parts is usually called by the methods that are responsible for fetching the names out of the file name, or the record type

Parameters:

string $name iconname like 'actions-document-new'

Returns:: string a list of all CSS classes needed for the HTML tag public

Definition at line 992 of file class.t3lib_iconworks.php.

Referenced by t3lib_tree_pagetree_extdirect_Tree\getNodeTypes(), getSpriteIcon(), t3lib_iconWorksTest\getSpriteIconClassesWithEmptyStringReturnsT3Icon(), t3lib_iconWorksTest\getSpriteIconClassesWithFourPartsReturnsT3IconAndCombinedParts(), t3lib_iconWorksTest\getSpriteIconClassesWithOnePartReturnsT3Icon(), t3lib_iconWorksTest\getSpriteIconClassesWithThreePartsReturnsT3IconAndCombinedParts(), t3lib_iconWorksTest\getSpriteIconClassesWithTwoPartsReturnsT3IconAndCombinedParts(), t3lib_tree_pagetree_extdirect_Tree\loadResources(), mapFileExtensionToSpriteIconClass(), and mapRecordTypeToSpriteIconClass().

static t3lib_iconWorks::getSpriteIconForFile	(	$	fileExtension,
		array $	options = `array()`
	)		`[static]`

This method is used throughout the TYPO3 Backend to show icons for a file type

Generates a HTML tag with proper CSS classes. The TYPO3 skin has defined these CSS classes already to have a pre-defined background image, and the correct background-position to show the necessary icon.

Parameters:

string	$fileExtension	the name of the icon to fetch, can be a file extension, full file path or one of the special keywords "folder" or "mount"
array	$options	an associative array with additional options and attributes for the tag. by default, the key is the name of the attribute, and the value is the parameter string that is set. However, there are some additional special reserved keywords that can be used as keys: "html" (which is the HTML that will be inside the icon HTML tag), "tagName" (which is an alternative tagName than "span"), and "class" (additional class names that will be merged with the sprite icon CSS classes)

Returns:: string the full HTML tag (usually a ) public

Definition at line 685 of file class.t3lib_iconworks.php.

References buildSpriteHtmlIconTag(), and mapFileExtensionToSpriteIconClass().

Referenced by t3lib_iconWorksTest\getSpriteIconForFileWithNoFileTypeReturnsOtherSprite(), t3lib_iconWorksTest\getSpriteIconForFileWithNoUnknowFileTypeReturnsOtherSprite(), t3lib_iconWorksTest\getSpriteIconForFileWithPdfReturnsPdfSprite(), t3lib_iconWorksTest\getSpriteIconForFileWithPngAndOptionsReturnsPngSpriteAndOptions(), t3lib_iconWorksTest\getSpriteIconForFileWithPngReturnsPngSprite(), t3lib_TCEforms\previewFieldValue(), clickMenu\printFileClickMenu(), and SC_show_item\renderFileInfo().

static t3lib_iconWorks::getSpriteIconForRecord	(	$	table,
		array $	row,
		array $	options = `array()`
	)		`[static]`

This method is used throughout the TYPO3 Backend to show icons for a DB record

Generates a HTML tag with proper CSS classes. The TYPO3 skin has defined these CSS classes already to have a pre-defined background image, and the correct background-position to show the necessary icon.

Parameters:

string	$table	the TCA table name
array	$row	the DB record of the TCA table
array	$options	an associative array with additional options and attributes for the tag. by default, the key is the name of the attribute, and the value is the parameter string that is set. However, there are some additional special reserved keywords that can be used as keys: "html" (which is the HTML that will be inside the icon HTML tag), "tagName" (which is an alternative tagName than "span"), and "class" (additional class names that will be merged with the sprite icon CSS classes)

Returns:: string the full HTML tag (usually a ) public

Definition at line 762 of file class.t3lib_iconworks.php.

References buildSpriteHtmlIconTag(), getSpriteIcon(), mapRecordOverlayToSpriteIconName(), and mapRecordTypeToSpriteIconClass().

Referenced by SC_mod_tools_be_user_index\compareUsers(), browse_links\expandPage(), SC_mod_tools_log_index\exportData(), local_beUserAuth\ext_getReadableButNonmounted(), t3lib_tsparser_ext\ext_getTemplateHierarchyArr(), localPageTree\ext_tree(), SC_mod_tools_dbint_index\func_records(), t3lib_admin\genTree(), t3lib_admin\genTree_records(), template\getHeader(), tx_cms_layout\getIcon(), template\getPageInfo(), tx_cms_layout\getPageInfoBox(), t3lib_search_livesearch\getRecordArray(), t3lib_iconWorksTest\getSpriteIconForRecordWithEmptyRecordReturnsNormalSprite(), t3lib_iconWorksTest\getSpriteIconForRecordWithMockRecordAndOptionsReturnsNormalSprite(), t3lib_iconWorksTest\getSpriteIconForRecordWithMockRecordOfTypePluginReturnsPluginSprite(), t3lib_iconWorksTest\getSpriteIconForRecordWithMockRecordReturnsNormalSprite(), t3lib_iconWorksTest\getSpriteIconForRecordWithMockRecordWithHiddenFlagReturnsNormalSpriteAndOverlay(), t3lib_iconWorksTest\getSpriteIconForRecordWithNullTableReturnsMissingIcon(), tx_cms_layout\getTable_pages(), tx_cms_layout\getTable_tt_content(), tx_cms_layout\getTableMenu(), tx_tstemplateanalyzer\main(), tx_tstemplateceditor\main(), tx_cms_webinfo_lang\main(), tx_tstemplateinfo\main(), SC_db_new\main(), clickMenu\printDBClickMenu(), clickMenu\printDragDropClickMenu(), clickMenu\printNewDBLevel(), SC_db_new\regularNew(), Tx_Fluid_ViewHelpers_Be_PageInfoViewHelper\render(), t3lib_TCEforms_inline\renderForeignRecordHeader(), tx_cms_webinfo_lang\renderL10nTable(), SC_mod_web_ts_index\renderList(), tx_opendocs\renderMenuEntry(), recordList\showSysNotesForPage(), tx_version_cm1\versioningMgm(), SC_mod_user_ws_index\workspaceList_getFileMountPoints(), SC_mod_user_ws_index\workspaceList_getWebMountPoints(), and SC_alt_shortcut\workspaceSelector().

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

Parameters:

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

Returns:: void private

Definition at line 573 of file class.t3lib_iconworks.php.

Referenced by makeIcon().

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

Parameters:

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

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

See also:: t3lib_div::read_png_gif

Definition at line 585 of file class.t3lib_iconworks.php.

References $GLOBALS, and t3lib_div\read_png_gif().

Referenced by makeIcon().

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

Write the icon in $im pointer to $path

Parameters:

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

Returns:: void private

Definition at line 602 of file class.t3lib_iconworks.php.

References $GLOBALS, and t3lib_div\fixPermissions().

Referenced by t3lib_iconWorksTest\imagemakeFixesPermissionsOnNewFiles(), and makeIcon().

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

Creates the icon file for the function getIcon()

Parameters:

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

Returns:: string Filename relative to PATH_typo3 private

Definition at line 443 of file class.t3lib_iconworks.php.

References $GLOBALS, t3lib_div\gif_compress(), imagecopyresized(), imagecreatefrom(), imagemake(), and t3lib_div\shortMD5().

Referenced by getIcon(), and skinImg().

static t3lib_iconWorks::mapFileExtensionToSpriteIconClass ( $ fileExtension ) [static]

Generates the spriteicon css classes name for a given path or fileExtension usually called from getSpriteIconForFile or ExtJs Provider

Parameters:

string fileExtension can be jpg, gif etc, but also be 'mount' or 'folder', but can also be a full path which will be resolved then

Returns:: string the string of the CSS class, see t3lib_iconworks::$fileSpriteIconNames private

Definition at line 706 of file class.t3lib_iconworks.php.

References getSpriteIconClasses().

Referenced by getSpriteIconForFile().

static t3lib_iconWorks::mapFileExtensionToSpriteIconName ( $ fileExtension ) [static]

Generates the spriteicon name for a given path or fileExtension usually called from mapFileExtensionToSpriteIconClass and tceforms

Parameters:

string fileExtension can be jpg, gif etc, but also be 'mount' or 'folder', but can also be a full path which will be resolved then

Returns:: string the string of the CSS class, see t3lib_iconworks::$fileSpriteIconNames private

Definition at line 718 of file class.t3lib_iconworks.php.

References $GLOBALS, t3lib_div\getIndpEnv(), and t3lib_div\resolveBackPath().

static t3lib_iconWorks::mapRecordOverlayToSpriteIconName	(	$	table,
		array $	row
	)		`[static]`

this helper functions checks if the DB record ($row) has any special status based on the TCA settings like hidden, starttime etc, and then returns a specific Sprite icon class for the overlay of this DB record This method solely takes care of the overlay of this record, not any type

Please note that this only returns one overlay, one status, that is prioritized by $GLOBALS['TYPO3_CONF_VARS']['BE']['spriteIconRecordOverlayPriorities'] We wanted to not have these icons blown over by tons of overlays, so this is limited to just one.

see t3lib/config_default.php for the default options, you will find $GLOBALS['TYPO3_CONF_VARS']['BE']['spriteIconRecordOverlayNames'] that shows the list of CSS classes that will be used for the sprites, mapped to the statuses here

Parameters:

string	$table	the TCA table
array	$row	the selected record

Returns:: string the CSS class for the sprite icon of that DB record private

Definition at line 910 of file class.t3lib_iconworks.php.

References $GLOBALS.

Referenced by getSpriteIconForRecord().

static t3lib_iconWorks::mapRecordTypeToSpriteIconClass	(	$	table,
		array $	row
	)		`[static]`

this helper functions looks up the column that is used for the type of the chosen TCA table. And then fetches the corresponding class based on the chosen iconsprite class in this TCA The TCA looks up

[ctrl][typeicon_column]
This method solely takes care of the type of this record, not any statuses, used for overlays. You should not use this directly besides if you need classes for ExtJS iconCls.

see t3lib/stddb/tables.php for an example with the TCA table "pages"

Parameters:

string	$table	the TCA table
array	$row	the selected record

Returns:: string the CSS class for the sprite icon of that DB record private

Definition at line 803 of file class.t3lib_iconworks.php.

References getSpriteIconClasses().

Referenced by t3lib_tree_Tca_DatabaseTreeDataProvider\buildRepresentationForNode(), tx_Workspaces_ExtDirect_Server\getRowDetails(), and getSpriteIconForRecord().

static t3lib_iconWorks::mapRecordTypeToSpriteIconName	(	$	table,
		array $	row
	)		`[static]`

this helper functions looks up the column that is used for the type of the chosen TCA table. And then fetches the corresponding iconname based on the chosen iconsprite class in this TCA The TCA looks up

[ctrl][typeicon_column]
This method solely takes care of the type of this record, not any statuses, used for overlays. You should not use this directly besides if you need it in tceforms/core classes

see t3lib/stddb/tables.php for an example with the TCA table "pages"

Parameters:

string	$table	the TCA table
array	$row	the selected record

Returns:: string the CSS class for the sprite icon of that DB record private

Definition at line 825 of file class.t3lib_iconworks.php.

References $GLOBALS, and t3lib_div\callUserFunction().

Referenced by t3lib_transl8tools\getSystemLanguages().

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

Parameters:

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.

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

See also:: skinImgFile()

Definition at line 349 of file class.t3lib_iconworks.php.

References $GLOBALS, $temp_path, and makeIcon().

Referenced by tx_sysaction_task\action_linkUserName(), tx_impexp\addRelations(), SC_mod_tools_em_index\browseLinks(), recordHistory\createRollbackLink(), t3lib_tsStyleConfig\ext_getKeyImage(), tslib_AdminPanel\ext_makeToolBar(), localPageTree\ext_tree(), clickMenu\FILE_launch(), clickMenu\FILE_upload(), SC_mod_tools_dbint_index\func_records(), t3lib_admin\genTree(), t3lib_admin\genTree_records(), tx_sysaction_task\getActions(), t3lib_treeView\getBrowsableTree(), SC_mod_web_ts_index\getButtons(), SC_mod_user_ws_workspaceForms\getButtons(), SC_wizard_rte\getButtons(), SC_mod_user_ws_index\getButtons(), SC_alt_doc\getButtons(), tslib_AdminPanel\getCacheModule(), filelistFolderTree\getFolderTree(), t3lib_queryGenerator\getFormElements(), t3lib_TCEforms_Suggest_DefaultReceiver\getIcon(), getIconImage(), tslib_AdminPanel\getPublishModule(), ShortcutMenu\getShortcutIcon(), tx_cms_layout\getTable_tt_content(), SC_file_upload\init(), SC_alt_menu\main(), tx_tstemplateobjbrowser\main(), SC_alt_file_navframe\main(), SC_mod_tools_log_index\main(), tx_rtehtmlarea_clearcachemenu\manipulateCacheActions(), SC_mod_user_task_index\openInNewWindow(), tx_cms_layout\pages_getTree(), t3lib_pageTree\PMicon(), t3lib_treeView\PMicon(), t3lib_clipboard\printClipboard(), clickMenu\printItems(), SC_db_new\regularNew(), Tx_Fluid_ViewHelpers_Be_PageInfoViewHelper\render(), Tx_Fluid_ViewHelpers_Be_Buttons_IconViewHelper\render(), SC_mod_help_about_index\renderAboutTypo3(), tx_sysaction_task\renderActionList(), SC_mod_user_task_index\renderListMenu(), t3lib_arrayBrowser\tree(), tx_cms_layout\tt_board_getTree(), t3lib_BEfunc\TYPO3_copyRightNotice(), t3lib_queryGenerator\updateIcon(), tx_sysaction_task\viewSqlQuery(), SC_mod_user_ws_index\workspaceList_displayIcons(), SC_mod_user_ws_index\workspaceList_displayUserWorkspaceList(), and t3lib_recordList\writeBottom().

Member Data Documentation

t3lib_iconWorks::$fileSpriteIconNames [static]

Definition at line 79 of file class.t3lib_iconworks.php.

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

t3lib/class.t3lib_iconworks.php

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation