TYPO3\CMS\Backend\Sprite\SpriteManager Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Sprite\SpriteManager:

Static Public Member Functions
static	isInitialized ()
static	addIconSprite (array $icons, $styleSheetFile='')
static	addSingleIcons (array $icons, $extKey='')
static	addTcaTypeIcon ($table, $type, $iconFile)

Static Public Attributes
static	$tempPath = 'typo3temp/sprites/'

Static Protected Member Functions
static	getCacheIdentifier ()

Static Protected Attributes
static	$isInitialized = FALSE

Detailed Description

TYPO3 sprite manager, used in BE and in FE if a BE user is logged in.

This class builds CSS definitions of registered icons, writes TCA definitions and registers sprite icons in a cache file.

A configurable handler class does the business task.

Author

Steffen Ritter info@.nosp@m.stef.nosp@m.fen-r.nosp@m.itte.nosp@m.r.net

Definition at line 29 of file SpriteManager.php.

Member Function Documentation

addIconSprite()

static TYPO3\CMS\Backend\Sprite\SpriteManager::addIconSprite ( array  $icons,   $styleSheetFile = ''  )

static

API for extensions to register own sprites.

Get an array of icon names and the styleSheetFile with defined sprite icons. The stylesheet filename should contain the extension name to be unique.

Naming conventions:

• IconName: extensions-$extKey-$iconName
• CSS class for loading the sprite: t3-icon-extensions-$extKey
• CSS class for single icons: t3-icon-$extKey-$iconName

Parameters

array	$icons	Icon names
string	$styleSheetFile	Stylesheet filename relative to PATH_typo3. Skins do not need to supply the $styleSheetFile, if the CSS file is within the registered stylesheet folders

Returns

void

Definition at line 134 of file SpriteManager.php.

References $GLOBALS.

addSingleIcons()

static TYPO3\CMS\Backend\Sprite\SpriteManager::addSingleIcons ( array  $icons,   $extKey = ''  )

static

API for extensions to register new sprite images which can be used with ::getSpriteIcon('extensions-$extKey-iconName');

Parameters

array	$icons	Icons to be registered, $iconname => $iconFile, $iconFile must be relative to PATH_site
string	$extKey	Extension key

Returns

void

Definition at line 149 of file SpriteManager.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tests\Unit\Sprite\SpriteManagerTest\addSingleIconsWithEmptyValueSetsArrayKey(), TYPO3\CMS\Backend\Tests\Unit\Sprite\SpriteManagerTest\addSingleIconsWithEmptyValueSetsImagePathValue(), TYPO3\CMS\Backend\Tests\Unit\Sprite\SpriteManagerTest\addSingleIconsWithNormalValueSetsArrayKey(), and TYPO3\CMS\Backend\Tests\Unit\Sprite\SpriteManagerTest\addSingleIconsWithNormalValueSetsImagePathValue().

addTcaTypeIcon()

static TYPO3\CMS\Backend\Sprite\SpriteManager::addTcaTypeIcon (   $table,   $type,   $iconFile  )

static

API to register new type icons for tables which use "typeicon_classes" Can be used to provide icons for "modules" in pages table

Parameters

string	$table	Table name to which the type icon should be added
string	$type	Type column name of the table
string	$iconFile	Icon filename, relative to PATH_typo3

Returns

void

Definition at line 164 of file SpriteManager.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Tests\Unit\Sprite\SpriteManagerTest\addTcaTypeIconWithEmptyValueSetsArrayKey(), TYPO3\CMS\Backend\Tests\Unit\Sprite\SpriteManagerTest\addTcaTypeIconWithEmptyValueSetsEmptyArrayValue(), TYPO3\CMS\Backend\Tests\Unit\Sprite\SpriteManagerTest\addTcaTypeIconWithTableAndTypeAndValueSetsArrayValue(), and TYPO3\CMS\Backend\Tests\Unit\Sprite\SpriteManagerTest\addTcaTypeIconWithTableAndTypeSetsArrayKey().

getCacheIdentifier()

static TYPO3\CMS\Backend\Sprite\SpriteManager::getCacheIdentifier ( )

staticprotected

Get cache identifier for $GLOBALS['TBE_STYLES']['spriteIconApi']['iconsAvailable']

Returns

string

Definition at line 115 of file SpriteManager.php.

isInitialized()

static TYPO3\CMS\Backend\Sprite\SpriteManager::isInitialized ( )

static

Whether the sprite manager is initialized.

Returns

boolean TRUE if sprite manager is initialized

Definition at line 67 of file SpriteManager.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Utility\GeneralUtility\mkdir().

Member Data Documentation

$isInitialized

TYPO3\CMS\Backend\Sprite\SpriteManager::$isInitialized = FALSE

staticprotected

Is sprite manager initialized

Definition at line 39 of file SpriteManager.php.

$tempPath

TYPO3\CMS\Backend\Sprite\SpriteManager::$tempPath = 'typo3temp/sprites/'

static

Definition at line 34 of file SpriteManager.php.

Referenced by TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler\__construct(), TYPO3\CMS\Backend\Sprite\SpriteBuildingHandler\generate(), and TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler\loadRegisteredSprites().