TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
IconRegistry Class Reference
Inheritance diagram for IconRegistry:
SingletonInterface

Public Member Functions

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

Protected Member Functions

 registerTCAIcons ()
 
 registerFlags ()
 

Protected Attributes

 $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 ( )

The constructor

Definition at line 2572 of file IconRegistry.php.

References $GLOBALS, IconRegistry\registerFlags(), and IconRegistry\registerTCAIcons().

Member Function Documentation

getAllRegisteredIconIdentifiers ( )
Returns
array

Definition at line 2698 of file IconRegistry.php.

getDefaultIconIdentifier ( )
Returns
string

Definition at line 2603 of file IconRegistry.php.

References IconRegistry\$defaultIconIdentifier.

getDeprecationSettings (   $identifier)
Parameters
string$identifier
Returns
array
Exceptions
Exception

Definition at line 2686 of file IconRegistry.php.

References IconRegistry\isDeprecated().

Referenced by IconRegistry\getIconConfigurationByIdentifier().

getIconConfigurationByIdentifier (   $identifier)

Fetches the configuration provided by registerIcon()

Parameters
string$identifierthe icon identifier
Returns
mixed
Exceptions
Exception

Definition at line 2657 of file IconRegistry.php.

References $GLOBALS, GeneralUtility\deprecationLog(), IconRegistry\getDeprecationSettings(), IconRegistry\isDeprecated(), IconRegistry\isRegistered(), IconRegistry\registerFlags(), and IconRegistry\registerTCAIcons().

getIconIdentifierForFileExtension (   $fileExtension)
Parameters
string$fileExtension
Returns
string

Definition at line 2707 of file IconRegistry.php.

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

isDeprecated (   $identifier)
Parameters
string$identifier
Returns
bool

Definition at line 2595 of file IconRegistry.php.

Referenced by IconRegistry\getDeprecationSettings(), and IconRegistry\getIconConfigurationByIdentifier().

isRegistered (   $identifier)
Parameters
string$identifier
Returns
bool

Definition at line 2585 of file IconRegistry.php.

Referenced by IconRegistry\getIconConfigurationByIdentifier(), and IconRegistry\registerTCAIcons().

registerFileExtension (   $fileExtension,
  $iconIdentifier 
)

Register an icon for a file extension

Parameters
string$fileExtension
string$iconIdentifier

Definition at line 2634 of file IconRegistry.php.

registerFlags ( )
protected

register flags

Definition at line 2796 of file IconRegistry.php.

Referenced by IconRegistry\__construct(), and IconRegistry\getIconConfigurationByIdentifier().

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

Registers an icon to be available inside the Icon Factory

Parameters
string$identifier
string$iconProviderClassName
array$options
Exceptions
\InvalidArgumentException

Definition at line 2617 of file IconRegistry.php.

registerMimeTypeIcon (   $mimeType,
  $iconIdentifier 
)

Register an icon for a mime-type

Parameters
string$mimeType
string$iconIdentifier

Definition at line 2645 of file IconRegistry.php.

registerTCAIcons ( )
protected

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

Definition at line 2733 of file IconRegistry.php.

References $GLOBALS, StringUtility\beginsWith(), elseif, StringUtility\endsWith(), IconRegistry\isRegistered(), and GeneralUtility\resolveBackPath().

Referenced by IconRegistry\__construct(), and IconRegistry\getIconConfigurationByIdentifier().

Member Data Documentation

$defaultIconIdentifier = 'default-not-found'
protected

Definition at line 2567 of file IconRegistry.php.

Referenced by IconRegistry\getDefaultIconIdentifier().

$deprecatedIcons
protected
Initial value:
= array(
'actions-system-refresh' => array(
'replacement' => 'actions-refresh',
'message' => '%s is deprecated since TYPO3 CMS 7, this icon will be removed in TYPO3 CMS 8'
),
'actions-system-extension-update-disabled' => array(
'replacement' => 'actions-system-extension-update',
'message' => '%s is deprecated since TYPO3 CMS 7, this icon will be removed in TYPO3 CMS 8'
)
)

Definition at line 2553 of file IconRegistry.php.

$fileExtensionMapping
protected

Definition at line 2452 of file IconRegistry.php.

$flagsInitialized = false
protected

Definition at line 38 of file IconRegistry.php.

$icons
protected

Definition at line 45 of file IconRegistry.php.

$mimeTypeMapping
protected
Initial value:
= array(
'video/*' => 'mimetypes-media-video',
'audio/*' => 'mimetypes-media-audio',
'image/*' => 'mimetypes-media-image',
'text/*' => 'mimetypes-text-text',
)

Definition at line 2531 of file IconRegistry.php.

$tcaInitialized = false
protected

Definition at line 33 of file IconRegistry.php.