TYPO3 CMS  TYPO3_6-2
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\Sprite\SpriteGenerator Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Sprite\SpriteGenerator:
t3lib_spritemanager_SpriteGenerator

Public Member Functions

 __construct ($spriteName)
 
 setNamespace ($nameSpace)
 
 setSpriteName ($spriteName)
 
 setSpriteFolder ($folder)
 
 setCSSFolder ($folder)
 
 setEnableHighDensitySprite ($enable=TRUE)
 
 setOmmitSpriteNameInIconName ($value)
 
 setOmitSpriteNameInIconName ($value)
 
 setIconSpace ($value)
 
 setIncludeTimestampInCSS ($value)
 
 generateSpriteFromFolder (array $inputFolder)
 
 generateSpriteFromArray (array $files)
 

Protected Member Functions

 generateCSS ()
 
 resolveSpritePath ()
 
 generateGraphic ()
 
 generateHighDensityGraphic ()
 
 calculateSpritePositions ()
 
 getFolder ($directoryPath)
 
 buildFileInformationCache (array $files)
 
 explodeSizeTag ($tag='')
 

Protected Attributes

 $templateSprite
 
 $templateSpriteHighDensity
 
 $templateIcon
 
 $enableHighDensitySprite = TRUE
 
 $defaultWidth = 0
 
 $defaultHeight = 0
 
 $spriteWidth = 0
 
 $spriteHeight = 0
 
 $spriteName = ''
 
 $spriteFolder = 'typo3temp/sprites/'
 
 $cssFolder = 'typo3temp/sprites/'
 
 $omitSpriteNameInIconName = FALSE
 
 $nameSpace = 't3-icon'
 
 $includeTimestampInCSS = TRUE
 
 $spriteBases = array()
 
 $iconsData = array()
 
 $iconSizes = array()
 
 $iconNamesPerSize = array()
 
 $space = 2
 

Detailed Description

Sprite generator

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

Definition at line 25 of file SpriteGenerator.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::__construct (   $spriteName)

Initializes the configuration of the spritegenerator

Parameters
string$spriteNameThe name of the sprite to be generated

Definition at line 179 of file SpriteGenerator.php.

References TYPO3\CMS\Backend\Sprite\SpriteGenerator\$spriteName.

Member Function Documentation

◆ buildFileInformationCache()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::buildFileInformationCache ( array  $files)
protected

Generates file information cache from file array

Parameters
array$filesList of all files with their icon name
Returns
void

Definition at line 562 of file SpriteGenerator.php.

References TYPO3\CMS\Backend\Sprite\SpriteGenerator\explodeSizeTag(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateSpriteFromArray().

◆ calculateSpritePositions()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::calculateSpritePositions ( )
protected

Arranges icons in sprites, afterwards all icons have information about the position in sprite

Definition at line 477 of file SpriteGenerator.php.

References TYPO3\CMS\Backend\Sprite\SpriteGenerator\$space, TYPO3\CMS\Backend\Sprite\SpriteGenerator\$spriteWidth, and TYPO3\CMS\Backend\Sprite\SpriteGenerator\explodeSizeTag().

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateSpriteFromArray().

◆ explodeSizeTag()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::explodeSizeTag (   $tag = '')
protected

Transforms size tag into size array

Parameters
string$tagA size tag at the cache arrays
Returns
array

Definition at line 610 of file SpriteGenerator.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\buildFileInformationCache(), and TYPO3\CMS\Backend\Sprite\SpriteGenerator\calculateSpritePositions().

◆ generateCSS()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::generateCSS ( )
protected

Generates the css files

Returns
void

Definition at line 334 of file SpriteGenerator.php.

References TYPO3\CMS\Backend\Sprite\SpriteGenerator\resolveSpritePath(), TYPO3\CMS\Core\Html\HtmlParser\substituteMarkerArray(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateSpriteFromArray().

◆ generateGraphic()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::generateGraphic ( )
protected

The actual sprite generator, renders the command for Im/GM and executes

Returns
void

Definition at line 420 of file SpriteGenerator.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\tempnam(), TYPO3\CMS\Core\Utility\GeneralUtility\unlink_tempfile(), and TYPO3\CMS\Core\Utility\GeneralUtility\upload_copy_move().

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateSpriteFromArray().

◆ generateHighDensityGraphic()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::generateHighDensityGraphic ( )
protected

The actual sprite generator, renders the command for IM/GM and executes

Returns
void

Definition at line 446 of file SpriteGenerator.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\tempnam(), TYPO3\CMS\Core\Utility\GeneralUtility\unlink_tempfile(), and TYPO3\CMS\Core\Utility\GeneralUtility\upload_copy_move().

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateSpriteFromArray().

◆ generateSpriteFromArray()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::generateSpriteFromArray ( array  $files)

Method processes an array of files into an sprite, the array can be build from files within an folder or by hand (as the SpriteManager does)

Parameters
array$filesarray(icon name => icon file)
Returns
array

Definition at line 308 of file SpriteGenerator.php.

References TYPO3\CMS\Backend\Sprite\SpriteGenerator\$spriteName, TYPO3\CMS\Backend\Sprite\SpriteGenerator\buildFileInformationCache(), TYPO3\CMS\Backend\Sprite\SpriteGenerator\calculateSpritePositions(), TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateCSS(), TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateGraphic(), and TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateHighDensityGraphic().

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateSpriteFromFolder().

◆ generateSpriteFromFolder()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::generateSpriteFromFolder ( array  $inputFolder)

Reads all png,gif,jpg files from the passed folder name (including 1 subfolder level) extracts size information and stores data in internal array, afterwards triggers sprite generation.

Parameters
array$inputFolderFolder from which files are read
Returns
array

Definition at line 291 of file SpriteGenerator.php.

References TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateSpriteFromArray(), and TYPO3\CMS\Backend\Sprite\SpriteGenerator\getFolder().

◆ getFolder()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::getFolder (   $directoryPath)
protected

Function getFolder traverses the target directory, locates all iconFiles and collects them into an array

Parameters
string$directoryPathPath to an folder which contains images
Returns
array Returns an array with all files key: iconname, value: fileName

Definition at line 531 of file SpriteGenerator.php.

References $icons, TYPO3\CMS\Core\Utility\GeneralUtility\get_dirs(), and TYPO3\CMS\Core\Utility\GeneralUtility\getFilesInDir().

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateSpriteFromFolder().

◆ resolveSpritePath()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::resolveSpritePath ( )
protected

Compares image path to CSS path and creates the relative backpath from css to the sprites

Returns
string

Definition at line 395 of file SpriteGenerator.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\resolveBackPath(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateCSS().

◆ setCSSFolder()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::setCSSFolder (   $folder)

Sets the sprite-css target-folder

Parameters
string$folderthe target folder where the generated CSS files are stored
Returns
SpriteGenerator An instance of $this, to enable "chaining".

Definition at line 222 of file SpriteGenerator.php.

◆ setEnableHighDensitySprite()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::setEnableHighDensitySprite (   $enable = TRUE)

Enables/Disables HighDensitySprite Generation

Parameters
boolean$enable
Returns
SpriteGenerator An instance of $this, to enable "chaining".

Definition at line 233 of file SpriteGenerator.php.

◆ setIconSpace()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::setIconSpace (   $value)

Setter to adjust how much space is between to icons in the sprite

Parameters
integer$value
Returns
SpriteGenerator An instance of $this, to enable "chaining".

Definition at line 267 of file SpriteGenerator.php.

◆ setIncludeTimestampInCSS()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::setIncludeTimestampInCSS (   $value)

Setter for timestamp inclusion: imageFiles will be included with ?timestamp

Parameters
boolean$value
Returns
SpriteGenerator An instance of $this, to enable "chaining".

Definition at line 278 of file SpriteGenerator.php.

◆ setNamespace()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::setNamespace (   $nameSpace)

Sets namespace of css code

Parameters
string$nameSpace
Returns
SpriteGenerator An instance of $this, to enable "chaining".

Definition at line 189 of file SpriteGenerator.php.

References TYPO3\CMS\Backend\Sprite\SpriteGenerator\$nameSpace.

◆ setOmitSpriteNameInIconName()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::setOmitSpriteNameInIconName (   $value)

Setter do enable the exclusion of the sprites-name from iconnames

Parameters
boolean$value
Returns
SpriteGenerator An instance of $this, to enable "chaining".

Definition at line 256 of file SpriteGenerator.php.

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\setOmmitSpriteNameInIconName().

◆ setOmmitSpriteNameInIconName()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::setOmmitSpriteNameInIconName (   $value)

Setter do enable the exclusion of the sprites-name from iconnames

Parameters
boolean$value
Returns
SpriteGenerator An instance of $this, to enable "chaining".
Deprecated:
since 6.2, will be removed two versions later - use setOmitSpriteNameInIconName() instead

Definition at line 245 of file SpriteGenerator.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3\CMS\Backend\Sprite\SpriteGenerator\setOmitSpriteNameInIconName().

◆ setSpriteFolder()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::setSpriteFolder (   $folder)

Sets the sprite-graphics target-folder

Parameters
string$folderThe target folder where the generated sprite is stored
Returns
SpriteGenerator An instance of $this, to enable "chaining".

Definition at line 211 of file SpriteGenerator.php.

◆ setSpriteName()

TYPO3\CMS\Backend\Sprite\SpriteGenerator::setSpriteName (   $spriteName)

Sets the spritename

Parameters
string$spriteNameThe name of the sprite to be generated
Returns
SpriteGenerator An instance of $this, to enable "chaining".

Definition at line 200 of file SpriteGenerator.php.

References TYPO3\CMS\Backend\Sprite\SpriteGenerator\$spriteName.

Member Data Documentation

◆ $cssFolder

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$cssFolder = 'typo3temp/sprites/'
protected

Definition at line 114 of file SpriteGenerator.php.

◆ $defaultHeight

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$defaultHeight = 0
protected

Definition at line 79 of file SpriteGenerator.php.

◆ $defaultWidth

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$defaultWidth = 0
protected

Definition at line 72 of file SpriteGenerator.php.

◆ $enableHighDensitySprite

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$enableHighDensitySprite = TRUE
protected

Definition at line 65 of file SpriteGenerator.php.

◆ $iconNamesPerSize

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$iconNamesPerSize = array()
protected

Definition at line 165 of file SpriteGenerator.php.

◆ $iconsData

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$iconsData = array()
protected

Definition at line 151 of file SpriteGenerator.php.

◆ $iconSizes

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$iconSizes = array()
protected

Definition at line 158 of file SpriteGenerator.php.

◆ $includeTimestampInCSS

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$includeTimestampInCSS = TRUE
protected

Definition at line 136 of file SpriteGenerator.php.

◆ $nameSpace

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$nameSpace = 't3-icon'
protected

Definition at line 128 of file SpriteGenerator.php.

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\setNamespace().

◆ $omitSpriteNameInIconName

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$omitSpriteNameInIconName = FALSE
protected

Definition at line 121 of file SpriteGenerator.php.

◆ $space

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$space = 2
protected

Definition at line 172 of file SpriteGenerator.php.

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\calculateSpritePositions().

◆ $spriteBases

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$spriteBases = array()
protected

Definition at line 144 of file SpriteGenerator.php.

◆ $spriteFolder

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$spriteFolder = 'typo3temp/sprites/'
protected

Definition at line 107 of file SpriteGenerator.php.

◆ $spriteHeight

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$spriteHeight = 0
protected

Definition at line 93 of file SpriteGenerator.php.

◆ $spriteName

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$spriteName = ''
protected

Definition at line 100 of file SpriteGenerator.php.

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\__construct(), TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateSpriteFromArray(), and TYPO3\CMS\Backend\Sprite\SpriteGenerator\setSpriteName().

◆ $spriteWidth

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$spriteWidth = 0
protected

Definition at line 86 of file SpriteGenerator.php.

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\calculateSpritePositions().

◆ $templateIcon

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$templateIcon
protected
Initial value:
= '.###NAMESPACE###-###ICONNAME### {
background-position: -###LEFT###px -###TOP###px !important;
###SIZE_INFO###
}
'

Definition at line 56 of file SpriteGenerator.php.

◆ $templateSprite

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$templateSprite
protected
Initial value:
= '
.###NAMESPACE###-###SPRITENAME### {
background-image: url(\'###SPRITEURL###\') !important;
height: ###DEFAULTHEIGHT###px;
width: ###DEFAULTWIDTH###px;
}
'

Definition at line 32 of file SpriteGenerator.php.

◆ $templateSpriteHighDensity

TYPO3\CMS\Backend\Sprite\SpriteGenerator::$templateSpriteHighDensity
protected
Initial value:
= '
.backgroundsize .###NAMESPACE###-###SPRITENAME### {
background-image: url(\'###SPRITEURL###\') !important;
background-size:###BGWIDTH### ###BGHEIGHT###;
}
'

Definition at line 45 of file SpriteGenerator.php.