TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler Class Reference

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

Public Member Functions
	__construct ()
	generate ()
	getAvailableIconNames ()

Protected Member Functions
	loadRegisteredSprites ()
	collectTcaSpriteIcons ()

Protected Attributes
	$iconNames = array()
	$styleSheetData = ''
	$cssTcaFile = ''

Detailed Description

An abstract class implementing SpriteIconGeneratorInterface. Provides base functionality for all handlers.

Author

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

Definition at line 27 of file AbstractSpriteHandler.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler::__construct

(

)

constructor just init's the temp-file-name

Returns

void

Definition at line 55 of file AbstractSpriteHandler.php.

References TYPO3\CMS\Backend\Sprite\SpriteManager\$tempPath.

Member Function Documentation

collectTcaSpriteIcons()

TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler::collectTcaSpriteIcons ( )

protected

this method creates sprite icon names for all tables in TCA (including their possible type-icons) where there is no "typeicon_classes" of this TCA table ctrl section (moved form )

Returns

array Array as $iconName => $fileName

Definition at line 127 of file AbstractSpriteHandler.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extRelPath(), TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), and TYPO3\CMS\Core\Utility\GeneralUtility\resolveBackPath().

Referenced by TYPO3\CMS\Backend\Sprite\SimpleSpriteHandler\buildCssAndRegisterIcons(), and TYPO3\CMS\Backend\Sprite\SpriteBuildingHandler\generate().

generate()

TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler::generate

(

)

Interface function. This will be called from the sprite manager to refresh all caches.

Returns

void

Implements TYPO3\CMS\Backend\Sprite\SpriteIconGeneratorInterface.

Definition at line 103 of file AbstractSpriteHandler.php.

References TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler\loadRegisteredSprites(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

getAvailableIconNames()

TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler::getAvailableIconNames

(

)

Returns the detected icon-names which may be used through ::getSpriteIcon.

Returns

array all generated and registered sprite-icon-names, will be empty if there are none

Implements TYPO3\CMS\Backend\Sprite\SpriteIconGeneratorInterface.

Definition at line 116 of file AbstractSpriteHandler.php.

References TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler\$iconNames.

loadRegisteredSprites()

TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler::loadRegisteredSprites ( )

protected

Loads all stylesheet files registered through ::addIconSprite

In fact the stylesheet-files are copied to ::tempPath where they automatically will be included from via and

Returns

void

Definition at line 72 of file AbstractSpriteHandler.php.

References $GLOBALS, TYPO3\CMS\Backend\Sprite\SpriteManager\$tempPath, and TYPO3\CMS\Core\Utility\GeneralUtility\getFilesInDir().

Referenced by TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler\generate().

Member Data Documentation

$cssTcaFile

TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler::$cssTcaFile = ''

protected

Definition at line 48 of file AbstractSpriteHandler.php.

$iconNames

TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler::$iconNames = array()

protected

Definition at line 34 of file AbstractSpriteHandler.php.

Referenced by TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler\getAvailableIconNames().

$styleSheetData

TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler::$styleSheetData = ''

protected

Definition at line 41 of file AbstractSpriteHandler.php.