Inheritance diagram for TYPO3\CMS\Core\Imaging\IconRegistry:

Public Member Functions
	__construct ()

bool	isRegistered ($identifier)

bool	isDeprecated ($identifier)

string	getDefaultIconIdentifier ()

	registerIcon ($identifier, $iconProviderClassName, array $options=[])

	registerFileExtension ($fileExtension, $iconIdentifier)

	registerMimeTypeIcon ($mimeType, $iconIdentifier)

mixed	getIconConfigurationByIdentifier ($identifier)

array	getAllRegisteredIconIdentifiers ()

array	getDeprecatedIcons ()

string	getIconIdentifierForFileExtension ($fileExtension)

string null	getIconIdentifierForMimeType ($mimeType)

string	getCacheIdentifier ()

string	detectIconProvider ($iconReference)

Static Public Member Functions
static	setCache (FrontendInterface $cache)

Protected Member Functions
	initialize ()

	getCachedBackendIcons ()

	registerBackendIcons ()

	registerTCAIcons ()

	registerModuleIcons ()

	registerFlags ()

Protected Attributes
bool	$fullInitialized = false

bool	$tcaInitialized = false

bool	$flagsInitialized = false

bool	$moduleIconsInitialized = false

bool	$backendIconsInitialized = false

array	$icons = array( )

string[]	$backendIconPaths

string[]	$backendIconAllowedExtensionsWithProvider

array	$staticIcons

string[]	$fileExtensionMapping

string[]	$mimeTypeMapping

array	$deprecatedIcons

string	$defaultIconIdentifier = 'default-not-found'

Static Protected Attributes
static FrontendInterface	$cache = null

Detailed Description

Class IconRegistry, which makes it possible to register custom icons from within an extension.

Definition at line 33 of file IconRegistry.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Imaging\IconRegistry::__construct ( )

The constructor

Definition at line 478 of file IconRegistry.php.

References TYPO3\CMS\Core\Imaging\IconRegistry\initialize().

Member Function Documentation

◆ detectIconProvider()

string TYPO3\CMS\Core\Imaging\IconRegistry::detectIconProvider ( $iconReference )

Detect the IconProvider of an icon

Parameters

string $iconReference

Returns: ‪string

Definition at line 867 of file IconRegistry.php.

References TYPO3\CMS\Core\Utility\StringUtility\endsWith().

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\registerModuleIcons(), and TYPO3\CMS\Core\Imaging\IconRegistry\registerTCAIcons().

◆ getAllRegisteredIconIdentifiers()

array TYPO3\CMS\Core\Imaging\IconRegistry::getAllRegisteredIconIdentifiers ( )

Returns: ‪array

Definition at line 689 of file IconRegistry.php.

References TYPO3\CMS\Core\Imaging\IconRegistry\initialize().

◆ getCachedBackendIcons()

TYPO3\CMS\Core\Imaging\IconRegistry::getCachedBackendIcons ( )

protected

Retrieve the icons from cache render them when not cached yet

Definition at line 522 of file IconRegistry.php.

References TYPO3\CMS\Core\Core\Environment\getProjectPath(), and TYPO3\CMS\Core\Imaging\IconRegistry\registerBackendIcons().

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\initialize().

◆ getCacheIdentifier()

string TYPO3\CMS\Core\Imaging\IconRegistry::getCacheIdentifier ( )

Calculates the cache identifier based on the current registry

Returns: ‪string

Definition at line 738 of file IconRegistry.php.

References TYPO3\CMS\Core\Imaging\IconRegistry\initialize().

◆ getDefaultIconIdentifier()

string TYPO3\CMS\Core\Imaging\IconRegistry::getDefaultIconIdentifier ( )

Returns: ‪string

Definition at line 608 of file IconRegistry.php.

References TYPO3\CMS\Core\Imaging\IconRegistry\$defaultIconIdentifier.

◆ getDeprecatedIcons()

array TYPO3\CMS\Core\Imaging\IconRegistry::getDeprecatedIcons ( )

Returns: ‪array

Definition at line 700 of file IconRegistry.php.

References TYPO3\CMS\Core\Imaging\IconRegistry\$deprecatedIcons.

◆ getIconConfigurationByIdentifier()

mixed TYPO3\CMS\Core\Imaging\IconRegistry::getIconConfigurationByIdentifier ( $identifier )

Fetches the configuration provided by registerIcon()

Parameters

string $identifier ‪the icon identifier

Returns: ‪mixed

Exceptions

Exception

Definition at line 663 of file IconRegistry.php.

References TYPO3\CMS\Core\Imaging\IconRegistry\initialize(), TYPO3\CMS\Core\Imaging\IconRegistry\isDeprecated(), and TYPO3\CMS\Core\Imaging\IconRegistry\isRegistered().

◆ getIconIdentifierForFileExtension()

string TYPO3\CMS\Core\Imaging\IconRegistry::getIconIdentifierForFileExtension ( $fileExtension )

Parameters

string $fileExtension

Returns: ‪string

Definition at line 709 of file IconRegistry.php.

◆ getIconIdentifierForMimeType()

string null TYPO3\CMS\Core\Imaging\IconRegistry::getIconIdentifierForMimeType ( $mimeType )

Get iconIdentifier for given mimeType

Parameters

string $mimeType

Returns: ‪string|null Returns null if no icon is registered for the mimeType

Definition at line 724 of file IconRegistry.php.

◆ initialize()

TYPO3\CMS\Core\Imaging\IconRegistry::initialize ( )

protected

Initialize the registry This method can be called multiple times, depending on initialization status. In some cases e.g. TCA is not available, the method must be called multiple times.

Definition at line 497 of file IconRegistry.php.

References $GLOBALS, TYPO3\CMS\Core\Imaging\IconRegistry\getCachedBackendIcons(), TYPO3\CMS\Core\Imaging\IconRegistry\registerFlags(), TYPO3\CMS\Core\Imaging\IconRegistry\registerModuleIcons(), and TYPO3\CMS\Core\Imaging\IconRegistry\registerTCAIcons().

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\__construct(), TYPO3\CMS\Core\Imaging\IconRegistry\getAllRegisteredIconIdentifiers(), TYPO3\CMS\Core\Imaging\IconRegistry\getCacheIdentifier(), TYPO3\CMS\Core\Imaging\IconRegistry\getIconConfigurationByIdentifier(), and TYPO3\CMS\Core\Imaging\IconRegistry\isRegistered().

◆ isDeprecated()

bool TYPO3\CMS\Core\Imaging\IconRegistry::isDeprecated ( $identifier )

Parameters

string $identifier

Returns: ‪bool

Definition at line 600 of file IconRegistry.php.

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\getIconConfigurationByIdentifier().

◆ isRegistered()

bool TYPO3\CMS\Core\Imaging\IconRegistry::isRegistered ( $identifier )

Parameters

string $identifier

Returns: ‪bool

Definition at line 588 of file IconRegistry.php.

References TYPO3\CMS\Core\Imaging\IconRegistry\initialize().

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\getIconConfigurationByIdentifier().

◆ registerBackendIcons()

TYPO3\CMS\Core\Imaging\IconRegistry::registerBackendIcons ( )

protected

Automatically find and register the core backend icons

Definition at line 546 of file IconRegistry.php.

References $finder, and TYPO3\CMS\Core\Imaging\IconRegistry\registerIcon().

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\getCachedBackendIcons().

◆ registerFileExtension()

TYPO3\CMS\Core\Imaging\IconRegistry::registerFileExtension	(	$fileExtension,
		$iconIdentifier
	)

Register an icon for a file extension

Parameters

string	$fileExtension
string	$iconIdentifier

Definition at line 640 of file IconRegistry.php.

◆ registerFlags()

TYPO3\CMS\Core\Imaging\IconRegistry::registerFlags ( )

protected

Register flags

Definition at line 815 of file IconRegistry.php.

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\initialize().

◆ registerIcon()

TYPO3\CMS\Core\Imaging\IconRegistry::registerIcon	(		$identifier,
			$iconProviderClassName,
		array	$options = `[]`
	)

Registers an icon to be available inside the Icon Factory

Parameters

string	$identifier
string	$iconProviderClassName
array	$options

Exceptions

Definition at line 622 of file IconRegistry.php.

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\registerBackendIcons().

◆ registerMimeTypeIcon()

TYPO3\CMS\Core\Imaging\IconRegistry::registerMimeTypeIcon	(	$mimeType,
		$iconIdentifier
	)

Register an icon for a mime-type

Parameters

string	$mimeType
string	$iconIdentifier

Definition at line 651 of file IconRegistry.php.

◆ registerModuleIcons()

TYPO3\CMS\Core\Imaging\IconRegistry::registerModuleIcons ( )

protected

Register module icons

Definition at line 783 of file IconRegistry.php.

References $GLOBALS, and TYPO3\CMS\Core\Imaging\IconRegistry\detectIconProvider().

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\initialize().

◆ registerTCAIcons()

TYPO3\CMS\Core\Imaging\IconRegistry::registerTCAIcons ( )

protected

Load icons from TCA for each table and add them as "tcarecords-XX" to $this->icons

Definition at line 750 of file IconRegistry.php.

References $GLOBALS, and TYPO3\CMS\Core\Imaging\IconRegistry\detectIconProvider().

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\initialize().

◆ setCache()

static TYPO3\CMS\Core\Imaging\IconRegistry::setCache ( FrontendInterface $cache )

static

Parameters

FrontendInterface $coreCache

Definition at line 487 of file IconRegistry.php.

References TYPO3\CMS\Core\Imaging\IconRegistry\$cache.

Referenced by TYPO3\CMS\Core\Core\Bootstrap\init().

Member Data Documentation

◆ $backendIconAllowedExtensionsWithProvider

string [] TYPO3\CMS\Core\Imaging\IconRegistry::$backendIconAllowedExtensionsWithProvider

protected

Initial value:

= array( 
        'png' => BitmapIconProvider::class,
        'svg' => SvgIconProvider::class
     )

List of allowed icon file extensions with their Provider class

Definition at line 76 of file IconRegistry.php.

◆ $backendIconPaths

string [] TYPO3\CMS\Core\Imaging\IconRegistry::$backendIconPaths

protected

Initial value:

= array( 
        'EXT:backend/Resources/Public/Icons/',
        'EXT:core/Resources/Public/Icons/T3Icons/',
        'EXT:impexp/Resources/Public/Icons/',
        'EXT:install/Resources/Public/Icons/'
     )

Paths to backend icon folders for automatic registration

Definition at line 65 of file IconRegistry.php.

◆ $backendIconsInitialized

bool TYPO3\CMS\Core\Imaging\IconRegistry::$backendIconsInitialized = false

protected

Definition at line 53 of file IconRegistry.php.

◆ $cache

FrontendInterface TYPO3\CMS\Core\Imaging\IconRegistry::$cache = null

staticprotected

Definition at line 473 of file IconRegistry.php.

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\setCache().

◆ $defaultIconIdentifier

string TYPO3\CMS\Core\Imaging\IconRegistry::$defaultIconIdentifier = 'default-not-found'

protected

Definition at line 469 of file IconRegistry.php.

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\getDefaultIconIdentifier().

◆ $deprecatedIcons

array TYPO3\CMS\Core\Imaging\IconRegistry::$deprecatedIcons

protected

Array of deprecated icons, add deprecated icons to this array and remove it from registry

‪Index of this array contains the deprecated icon
‪Value of each entry may contain a possible new identifier

Example: [ 'deprecated-icon-identifier' => 'new-icon-identifier', 'another-deprecated-identifier' => null, ]

Definition at line 423 of file IconRegistry.php.

Referenced by TYPO3\CMS\Core\Imaging\IconRegistry\getDeprecatedIcons().

◆ $fileExtensionMapping

string [] TYPO3\CMS\Core\Imaging\IconRegistry::$fileExtensionMapping

protected

Mapping of file extensions to mimetypes

Definition at line 322 of file IconRegistry.php.

◆ $flagsInitialized

bool TYPO3\CMS\Core\Imaging\IconRegistry::$flagsInitialized = false

protected

Definition at line 45 of file IconRegistry.php.

◆ $fullInitialized

bool TYPO3\CMS\Core\Imaging\IconRegistry::$fullInitialized = false

protected

Definition at line 37 of file IconRegistry.php.

◆ $icons

array TYPO3\CMS\Core\Imaging\IconRegistry::$icons = array( )

protected

Registered icons

Definition at line 59 of file IconRegistry.php.

◆ $mimeTypeMapping

string [] TYPO3\CMS\Core\Imaging\IconRegistry::$mimeTypeMapping

protected

Initial value:

= array( 
        'video/*' => 'mimetypes-media-video',
        'audio/*' => 'mimetypes-media-audio',
        'image/*' => 'mimetypes-media-image',
        'text/*' => 'mimetypes-text-text',
     )

Mapping of mime types to icons

Definition at line 404 of file IconRegistry.php.

◆ $moduleIconsInitialized

bool TYPO3\CMS\Core\Imaging\IconRegistry::$moduleIconsInitialized = false

protected

Definition at line 49 of file IconRegistry.php.

◆ $staticIcons

array TYPO3\CMS\Core\Imaging\IconRegistry::$staticIcons

protected

manually registered icons hopefully obsolete one day

Definition at line 86 of file IconRegistry.php.

◆ $tcaInitialized

bool TYPO3\CMS\Core\Imaging\IconRegistry::$tcaInitialized = false

protected

Definition at line 41 of file IconRegistry.php.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ detectIconProvider()

◆ getAllRegisteredIconIdentifiers()

◆ getCachedBackendIcons()

◆ getCacheIdentifier()

◆ getDefaultIconIdentifier()

◆ getDeprecatedIcons()

◆ getIconConfigurationByIdentifier()

◆ getIconIdentifierForFileExtension()

◆ getIconIdentifierForMimeType()

◆ initialize()

◆ isDeprecated()

◆ isRegistered()

◆ registerBackendIcons()

◆ registerFileExtension()

◆ registerFlags()

◆ registerIcon()

◆ registerMimeTypeIcon()

◆ registerModuleIcons()

◆ registerTCAIcons()

◆ setCache()

Member Data Documentation

◆ $backendIconAllowedExtensionsWithProvider

◆ $backendIconPaths

◆ $backendIconsInitialized

◆ $cache

◆ $defaultIconIdentifier

◆ $deprecatedIcons

◆ $fileExtensionMapping

◆ $flagsInitialized

◆ $fullInitialized

◆ $icons

◆ $mimeTypeMapping

◆ $moduleIconsInitialized

◆ $staticIcons

◆ $tcaInitialized