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

Public Member Functions
bool	isRegistered ($identifier)

bool	isDeprecated ($identifier)

string	getDefaultIconIdentifier ()

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

	registerAlias ($alias, $identifier)

	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)

Public Attributes
$this	deprecatedIcons ['status-status-reference-soft'] = 'status-reference-soft'

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	$backendIconDeclaration = 'EXT:core/Resources/Public/Icons/T3Icons/icons.json'

string[]	$backendIconAllowedExtensionsWithProvider

array	$staticIcons

string[]	$fileExtensionMapping

string[]	$mimeTypeMapping

array< string, $iconAliases=array();protected array $deprecatedIcons=array('module-web'=> 'modulegroup-web', 'module-site'=> 'modulegroup-site', 'module-file'=> 'modulegroup-file', 'module-tools'=> 'modulegroup-tools', 'module-system'=> 'modulegroup-system', 'module-help'=> 'modulegroup-help', 'module-workspaces-action-preview-link'=> 'actions-version-workspaces-preview-link', 'generate-ws-preview-link'=> 'actions-version-workspaces-preview-link', 'extensions-workspaces-generatepreviewlink'=> 'actions-version-workspaces-preview-link', 'extensions-extensionmanager-update-script'=> 'actions-refresh', 'extensions-scheduler-run-task'=> 'actions-play', 'extensions-scheduler-run-task-cron'=> 'actions-clock', 'status-warning-lock'=> 'warning-lock', 'status-warning-in-use'=> 'warning-in-use', 'status-status-edit-read-only'=> 'status-edit-read-only', 't3-form-icon-advanced-password'=> 'form-advanced-password', 't3-form-icon-checkbox'=> 'form-checkbox', 't3-form-icon-content-element'=> 'form-content-element', 't3-form-icon-date-picker'=> 'form-date-picker', 't3-form-icon-duplicate'=> 'actions-duplicate', 't3-form-icon-email'=> 'form-email', 't3-form-icon-fieldset'=> 'form-fieldset', 't3-form-icon-file-upload'=> 'form-file-upload', 't3-form-icon-finisher'=> 'form-finisher', 't3-form-icon-form-element-selector'=> 'actions-variable-select', 't3-form-icon-gridcontainer'=> 'form-gridcontainer', 't3-form-icon-gridrow'=> 'form-gridrow', 't3-form-icon-hidden'=> 'form-hidden', 't3-form-icon-image-upload'=> 'form-image-upload', 't3-form-icon-insert-after'=> 'actions-form-insert-after', 't3-form-icon-insert-in'=> 'actions-form-insert-in', 't3-form-icon-multi-checkbox'=> 'form-multi-checkbox', 't3-form-icon-multi-select'=> 'form-multi-select', 't3-form-icon-number'=> 'form-number', 't3-form-icon-page'=> 'form-page', 't3-form-icon-password'=> 'form-password', 't3-form-icon-radio-button'=> 'form-radio-button', 't3-form-icon-single-select'=> 'form-single-select', 't3-form-icon-static-text'=> 'form-static-text', 't3-form-icon-summary-page'=> 'form-summary-page', 't3-form-icon-telephone'=> 'form-telephone', 't3-form-icon-text'=> 'form-text', 't3-form-icon-textarea'=> 'form-textarea', 't3-form-icon-url'=> 'form-url', 't3-form-icon-validator'=> 'form-validator',);protected string $defaultIconIdentifier='default-not-found';protected static FrontendInterface $cache=null;public function __construct() { if(ExtensionManagementUtility::isLoaded( 'impexp')) { $this->	deprecatedIcons ['status-status-reference-hard'] = 'status-reference-hard'

Detailed Description

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

Definition at line 37 of file IconRegistry.php.

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 845 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 667 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 495 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 716 of file IconRegistry.php.

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

◆ getDefaultIconIdentifier()

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

Returns: ‪string

Definition at line 570 of file IconRegistry.php.

◆ getDeprecatedIcons()

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

Returns: ‪array

Definition at line 678 of file IconRegistry.php.

◆ 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 641 of file IconRegistry.php.

References TYPO3\CMS\Core\Imaging\IconRegistry\deprecatedIcons, 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 687 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 702 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 470 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\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 562 of file IconRegistry.php.

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

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 550 of file IconRegistry.php.

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

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

◆ registerAlias()

TYPO3\CMS\Core\Imaging\IconRegistry::registerAlias	(	$alias,
		$identifier
	)

Registers an icon to be available inside the Icon Factory

Parameters

string	$alias
string	$identifier

Exceptions

Definition at line 604 of file IconRegistry.php.

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

◆ registerBackendIcons()

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

protected

Automatically find and register the core backend icons

Definition at line 519 of file IconRegistry.php.

References $dir, TYPO3\CMS\Core\Imaging\IconRegistry\registerAlias(), 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 618 of file IconRegistry.php.

◆ registerFlags()

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

protected

Register flags

Definition at line 793 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 584 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 629 of file IconRegistry.php.

◆ registerModuleIcons()

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

protected

Register module icons

Definition at line 761 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 728 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 $cache

Definition at line 460 of file IconRegistry.php.

Referenced by TYPO3\CMS\Core\Core\Bootstrap\init(), and TYPO3\CMS\Install\Service\LateBootService\loadExtLocalconfDatabaseAndExtTables().

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 73 of file IconRegistry.php.

◆ $backendIconDeclaration

string TYPO3\CMS\Core\Imaging\IconRegistry::$backendIconDeclaration = 'EXT:core/Resources/Public/Icons/T3Icons/icons.json'

protected

Definition at line 67 of file IconRegistry.php.

◆ $backendIconsInitialized

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

protected

Definition at line 57 of file IconRegistry.php.

◆ $fileExtensionMapping

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

protected

Mapping of file extensions to mimetypes

Definition at line 281 of file IconRegistry.php.

◆ $flagsInitialized

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

protected

Definition at line 49 of file IconRegistry.php.

◆ $fullInitialized

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

protected

Definition at line 41 of file IconRegistry.php.

◆ $icons

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

protected

Registered icons

Definition at line 63 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 363 of file IconRegistry.php.

◆ $moduleIconsInitialized

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

protected

Definition at line 53 of file IconRegistry.php.

◆ $staticIcons

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

protected

manually registered icons hopefully obsolete one day

Definition at line 83 of file IconRegistry.php.

◆ $tcaInitialized

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

protected

Definition at line 45 of file IconRegistry.php.

◆ deprecatedIcons [1/2]

array<string, $iconAliases = array( ); protected array $deprecatedIcons = array( 'module-web' => 'modulegroup-web', 'module-site' => 'modulegroup-site', 'module-file' => 'modulegroup-file', 'module-tools' => 'modulegroup-tools', 'module-system' => 'modulegroup-system', 'module-help' => 'modulegroup-help', 'module-workspaces-action-preview-link' => 'actions-version-workspaces-preview-link', 'generate-ws-preview-link' => 'actions-version-workspaces-preview-link', 'extensions-workspaces-generatepreviewlink' => 'actions-version-workspaces-preview-link', 'extensions-extensionmanager-update-script' => 'actions-refresh', 'extensions-scheduler-run-task' => 'actions-play', 'extensions-scheduler-run-task-cron' => 'actions-clock', 'status-warning-lock' => 'warning-lock', 'status-warning-in-use' => 'warning-in-use', 'status-status-edit-read-only' => 'status-edit-read-only', 't3-form-icon-advanced-password' => 'form-advanced-password', 't3-form-icon-checkbox' => 'form-checkbox', 't3-form-icon-content-element' => 'form-content-element', 't3-form-icon-date-picker' => 'form-date-picker', 't3-form-icon-duplicate' => 'actions-duplicate', 't3-form-icon-email' => 'form-email', 't3-form-icon-fieldset' => 'form-fieldset', 't3-form-icon-file-upload' => 'form-file-upload', 't3-form-icon-finisher' => 'form-finisher', 't3-form-icon-form-element-selector' => 'actions-variable-select', 't3-form-icon-gridcontainer' => 'form-gridcontainer', 't3-form-icon-gridrow' => 'form-gridrow', 't3-form-icon-hidden' => 'form-hidden', 't3-form-icon-image-upload' => 'form-image-upload', 't3-form-icon-insert-after' => 'actions-form-insert-after', 't3-form-icon-insert-in' => 'actions-form-insert-in', 't3-form-icon-multi-checkbox' => 'form-multi-checkbox', 't3-form-icon-multi-select' => 'form-multi-select', 't3-form-icon-number' => 'form-number', 't3-form-icon-page' => 'form-page', 't3-form-icon-password' => 'form-password', 't3-form-icon-radio-button' => 'form-radio-button', 't3-form-icon-single-select' => 'form-single-select', 't3-form-icon-static-text' => 'form-static-text', 't3-form-icon-summary-page' => 'form-summary-page', 't3-form-icon-telephone' => 'form-telephone', 't3-form-icon-text' => 'form-text', 't3-form-icon-textarea' => 'form-textarea', 't3-form-icon-url' => 'form-url', 't3-form-icon-validator' => 'form-validator', ); protected string $defaultIconIdentifier = 'default-not-found'; protected static FrontendInterface $cache = null; public function __construct() { if (ExtensionManagementUtility::isLoaded('impexp')) { $this-> TYPO3\CMS\Core\Imaging\IconRegistry::deprecatedIcons[ 'status-status-reference-hard'] = 'status-reference-hard'

protected

string>

Definition at line 450 of file IconRegistry.php.

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

◆ deprecatedIcons [2/2]

$this TYPO3\CMS\Core\Imaging\IconRegistry::deprecatedIcons[ 'status-status-reference-soft'] = 'status-reference-soft'

Definition at line 451 of file IconRegistry.php.

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ detectIconProvider()

◆ getAllRegisteredIconIdentifiers()

◆ getCachedBackendIcons()

◆ getCacheIdentifier()

◆ getDefaultIconIdentifier()

◆ getDeprecatedIcons()

◆ getIconConfigurationByIdentifier()

◆ getIconIdentifierForFileExtension()

◆ getIconIdentifierForMimeType()

◆ initialize()

◆ isDeprecated()

◆ isRegistered()

◆ registerAlias()

◆ registerBackendIcons()

◆ registerFileExtension()

◆ registerFlags()

◆ registerIcon()

◆ registerMimeTypeIcon()

◆ registerModuleIcons()

◆ registerTCAIcons()

◆ setCache()

Member Data Documentation

◆ $backendIconAllowedExtensionsWithProvider

◆ $backendIconDeclaration

◆ $backendIconsInitialized

◆ $fileExtensionMapping

◆ $flagsInitialized

◆ $fullInitialized

◆ $icons

◆ $mimeTypeMapping

◆ $moduleIconsInitialized

◆ $staticIcons

◆ $tcaInitialized

◆ deprecatedIcons [1/2]

◆ deprecatedIcons [2/2]