TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler:
TYPO3\CMS\Backend\Sprite\SpriteIconGeneratorInterface TYPO3\CMS\Backend\Sprite\SimpleSpriteHandler TYPO3\CMS\Backend\Sprite\SpriteBuildingHandler

Public Member Functions

 __construct ()
 
 generate ()
 
 getAvailableIconNames ()
 

Protected Member Functions

 loadRegisteredSprites ()
 
 collectTcaSpriteIcons ()
 

Protected Attributes

 $iconNames = []
 
 $styleSheetData = ''
 
 $cssTcaFile = ''
 

Detailed Description

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

Deprecated:
since TYPO3 CMS 7, will be removed with TYPO3 CMS 8

Definition at line 25 of file AbstractSpriteHandler.php.

Constructor & Destructor Documentation

◆ __construct()

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

constructor just init's the temp-file-name

Deprecated:
since TYPO3 CMS 7, will be removed with TYPO3 CMS 8

Definition at line 53 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 129 of file AbstractSpriteHandler.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\PathUtility\getRelativePathTo(), TYPO3\CMS\Core\Utility\PathUtility\pathinfo(), 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 117 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 71 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 46 of file AbstractSpriteHandler.php.

◆ $iconNames

TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler::$iconNames = []
protected

◆ $styleSheetData

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

Definition at line 39 of file AbstractSpriteHandler.php.