TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\Imaging\IconRegistry Class Reference
Inheritance diagram for TYPO3\CMS\Core\Imaging\IconRegistry:
TYPO3\CMS\Core\SingletonInterface

Public Member Functions

 __construct ()
 
 isRegistered ($identifier)
 
 isDeprecated ($identifier)
 
 getDefaultIconIdentifier ()
 
 registerIcon ($identifier, $iconProviderClassName, array $options=[])
 
 registerFileExtension ($fileExtension, $iconIdentifier)
 
 registerMimeTypeIcon ($mimeType, $iconIdentifier)
 
 getIconConfigurationByIdentifier ($identifier)
 
 getDeprecationSettings ($identifier)
 
 getAllRegisteredIconIdentifiers ()
 
 getIconIdentifierForFileExtension ($fileExtension)
 
 getIconIdentifierForMimeType ($mimeType)
 
 detectIconProvider ($iconReference)
 

Protected Member Functions

 initialize ()
 
 registerTCAIcons ()
 
 registerFlags ()
 

Protected Attributes

 $fullInitialized = false
 
 $tcaInitialized = false
 
 $flagsInitialized = false
 
 $icons
 
 $fileExtensionMapping
 
 $mimeTypeMapping
 
 $deprecatedIcons
 
 $defaultIconIdentifier = 'default-not-found'
 

Detailed Description

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

Definition at line 28 of file IconRegistry.php.

Constructor & Destructor Documentation

◆ __construct()

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

The constructor

Definition at line 2793 of file IconRegistry.php.

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

Member Function Documentation

◆ detectIconProvider()

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

Detect the IconProvider of an icon

Parameters
string$iconReference
Returns
string

Definition at line 3074 of file IconRegistry.php.

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

◆ getAllRegisteredIconIdentifiers()

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

Definition at line 2929 of file IconRegistry.php.

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

◆ getDefaultIconIdentifier()

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

Definition at line 2840 of file IconRegistry.php.

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

◆ getDeprecationSettings()

TYPO3\CMS\Core\Imaging\IconRegistry::getDeprecationSettings (   $identifier)
Parameters
string$identifier
Returns
array
Exceptions
Exception

Definition at line 2918 of file IconRegistry.php.

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

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

◆ getIconConfigurationByIdentifier()

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

Fetches the configuration provided by registerIcon()

Parameters
string$identifierthe icon identifier
Returns
mixed
Exceptions
Exception

Definition at line 2894 of file IconRegistry.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), TYPO3\CMS\Core\Imaging\IconRegistry\getDeprecationSettings(), TYPO3\CMS\Core\Imaging\IconRegistry\initialize(), TYPO3\CMS\Core\Imaging\IconRegistry\isDeprecated(), and TYPO3\CMS\Core\Imaging\IconRegistry\isRegistered().

◆ getIconIdentifierForFileExtension()

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

Definition at line 2941 of file IconRegistry.php.

◆ getIconIdentifierForMimeType()

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

References $GLOBALS, TYPO3\CMS\Core\Imaging\IconRegistry\registerFlags(), 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\getIconConfigurationByIdentifier(), and TYPO3\CMS\Core\Imaging\IconRegistry\isRegistered().

◆ isDeprecated()

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

Definition at line 2832 of file IconRegistry.php.

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

◆ isRegistered()

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

Definition at line 2820 of file IconRegistry.php.

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

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

◆ registerFileExtension()

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

Register an icon for a file extension

Parameters
string$fileExtension
string$iconIdentifier

Definition at line 2871 of file IconRegistry.php.

◆ registerFlags()

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

register flags

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

◆ registerMimeTypeIcon()

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

Register an icon for a mime-type

Parameters
string$mimeType
string$iconIdentifier

Definition at line 2882 of file IconRegistry.php.

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

References $GLOBALS, TYPO3\CMS\Core\Utility\StringUtility\beginsWith(), TYPO3\CMS\Core\Utility\StringUtility\endsWith(), and TYPO3\CMS\Core\Utility\GeneralUtility\resolveBackPath().

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

Member Data Documentation

◆ $defaultIconIdentifier

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

Definition at line 2788 of file IconRegistry.php.

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

◆ $deprecatedIcons

TYPO3\CMS\Core\Imaging\IconRegistry::$deprecatedIcons
protected
Initial value:
= [
'actions-system-refresh' => [
'replacement' => 'actions-refresh'

Definition at line 2774 of file IconRegistry.php.

◆ $fileExtensionMapping

TYPO3\CMS\Core\Imaging\IconRegistry::$fileExtensionMapping
protected
Initial value:
= [
'htm' => 'mimetypes-text-html'

Definition at line 2673 of file IconRegistry.php.

◆ $flagsInitialized

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

Definition at line 43 of file IconRegistry.php.

◆ $fullInitialized

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

Definition at line 33 of file IconRegistry.php.

◆ $icons

TYPO3\CMS\Core\Imaging\IconRegistry::$icons
protected
Initial value:
= [
'actions-add' => [
'provider' => SvgIconProvider::class

Definition at line 50 of file IconRegistry.php.

◆ $mimeTypeMapping

TYPO3\CMS\Core\Imaging\IconRegistry::$mimeTypeMapping
protected
Initial value:
= [
'video/*' => 'mimetypes-media-video'

Definition at line 2752 of file IconRegistry.php.

◆ $tcaInitialized

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

Definition at line 38 of file IconRegistry.php.