TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
Icon Class Reference

Public Member Functions

 getMarkup ($alternativeMarkupIdentifier=null)
 
 setMarkup ($markup)
 
 getAlternativeMarkup ($markupIdentifier)
 
 setAlternativeMarkup ($markupIdentifier, $markup)
 
 getIdentifier ()
 
 setIdentifier ($identifier)
 
 getOverlayIcon ()
 
 setOverlayIcon ($overlayIcon)
 
 getSize ()
 
 setSize ($size)
 
 isSpinning ()
 
 setSpinning ($spinning)
 
 getState ()
 
 setState (IconState $state)
 
 getDimension ()
 
 render ($alternativeMarkupIdentifier=null)
 
 __toString ()
 

Public Attributes

const SIZE_SMALL = 'small'
 
const SIZE_DEFAULT = 'default'
 
const SIZE_LARGE = 'large'
 
const SIZE_OVERLAY = 'overlay'
 

Protected Member Functions

 wrappedIcon ($alternativeMarkupIdentifier=null)
 

Protected Attributes

 $identifier
 
 $overlayIcon = null
 
 $size = ''
 
 $spinning = false
 
 $state
 
 $dimension
 
 $markup
 
 $alternativeMarkups = []
 

Detailed Description

Icon object, holds all information for one icon, identified by the "identifier" property. Is available to render itself as string.

Definition at line 24 of file Icon.php.

Member Function Documentation

__toString ( )

Render the icon as HTML code

Returns
string

Definition at line 253 of file Icon.php.

References Icon\render().

getAlternativeMarkup (   $markupIdentifier)
Parameters
string$markupIdentifier
Returns
string

Definition at line 125 of file Icon.php.

getIdentifier ( )
Returns
string

Definition at line 142 of file Icon.php.

References Icon\$identifier.

Referenced by BitmapIconProvider\generateMarkup(), SvgIconProvider\generateMarkup(), and Icon\wrappedIcon().

getMarkup (   $alternativeMarkupIdentifier = null)

Definition at line 104 of file Icon.php.

References Icon\$markup.

Referenced by Icon\wrappedIcon().

getOverlayIcon ( )
Returns
Icon

Definition at line 158 of file Icon.php.

References Icon\$overlayIcon.

getSize ( )
Returns
string

Definition at line 174 of file Icon.php.

References Icon\$size.

getState ( )
Returns
IconState

Definition at line 209 of file Icon.php.

References Icon\$state.

isSpinning ( )
Returns
bool

Definition at line 193 of file Icon.php.

References Icon\$spinning.

Referenced by Icon\wrappedIcon().

render (   $alternativeMarkupIdentifier = null)

Render the icon as HTML code

Parameters
string$alternativeMarkupIdentifier
Returns
string

Definition at line 239 of file Icon.php.

References Icon\wrappedIcon().

Referenced by Icon\__toString().

setAlternativeMarkup (   $markupIdentifier,
  $markup 
)
Parameters
string$markupIdentifier
string$markup

Definition at line 134 of file Icon.php.

References Icon\$markup.

Referenced by BitmapIconProvider\prepareIconMarkup(), and SvgIconProvider\prepareIconMarkup().

setIdentifier (   $identifier)
Parameters
string$identifier

Definition at line 150 of file Icon.php.

References Icon\$identifier.

setMarkup (   $markup)
Parameters
string$markup

Definition at line 115 of file Icon.php.

References Icon\$markup.

Referenced by FontawesomeIconProvider\prepareIconMarkup(), SvgIconProvider\prepareIconMarkup(), and BitmapIconProvider\prepareIconMarkup().

setOverlayIcon (   $overlayIcon)
Parameters
Icon$overlayIcon

Definition at line 166 of file Icon.php.

References Icon\$overlayIcon.

setSize (   $size)

Sets the size and creates the new dimension

Parameters
string$size

Definition at line 184 of file Icon.php.

References Icon\$size, and GeneralUtility\makeInstance().

setSpinning (   $spinning)
Parameters
bool$spinning

Definition at line 201 of file Icon.php.

References Icon\$spinning.

setState ( IconState  $state)

Sets the state of the icon

Parameters
IconState$state

Definition at line 219 of file Icon.php.

References Icon\$state.

wrappedIcon (   $alternativeMarkupIdentifier = null)
protected

Wrap icon markup in unified HTML code

Parameters
string$alternativeMarkupIdentifier
Returns
string

Definition at line 265 of file Icon.php.

References Icon\$markup, Icon\$size, Icon\getIdentifier(), Icon\getMarkup(), and Icon\isSpinning().

Referenced by Icon\render().

Member Data Documentation

$alternativeMarkups = []
protected

Definition at line 95 of file Icon.php.

$dimension
protected

Definition at line 85 of file Icon.php.

Referenced by Icon\getDimension().

$identifier
protected

Definition at line 52 of file Icon.php.

Referenced by Icon\getIdentifier(), and Icon\setIdentifier().

$markup
protected
$overlayIcon = null
protected

Definition at line 59 of file Icon.php.

Referenced by Icon\getOverlayIcon(), and Icon\setOverlayIcon().

$size = ''
protected

Definition at line 66 of file Icon.php.

Referenced by Icon\getSize(), Icon\setSize(), and Icon\wrappedIcon().

$spinning = false
protected

Definition at line 73 of file Icon.php.

Referenced by Icon\isSpinning(), and Icon\setSpinning().

$state
protected

Definition at line 80 of file Icon.php.

Referenced by Icon\getState(), and Icon\setState().

const SIZE_OVERLAY = 'overlay'

Definition at line 45 of file Icon.php.

Referenced by Dimension\__construct(), and IconFactory\createIcon().

const SIZE_SMALL = 'small'

Definition at line 29 of file Icon.php.

Referenced by Dimension\__construct(), ClearCacheToolbarItem\__construct(), ActionTask\action_linkUserName(), AbstractItemProvider\addItemsFromPageTsConfig(), DatabaseRecordList\addSortLink(), VersionModuleController\adminLinks(), ClickMenu\DB_changeFlag(), ClickMenu\DB_copycut(), ClickMenu\DB_db_list(), ClickMenu\DB_delete(), ClickMenu\DB_edit(), ClickMenu\DB_editAccess(), ClickMenu\DB_editPageProperties(), ClickMenu\DB_history(), ClickMenu\DB_info(), ClickMenu\DB_moveWizard(), ClickMenu\DB_new(), ClickMenu\DB_newWizard(), ClickMenu\DB_paste(), ClickMenu\DB_perms(), ClickMenu\DB_tempMountPoint(), ClickMenu\DB_view(), IconFactoryTest\differentSizesDataProvider(), RecordHistory\displayHistory(), ClickMenu\dragDrop_copymovefolder(), ClickMenu\dragDrop_copymovepage(), FrontendEditPanel\editIcons(), FrontendEditPanel\editPanel(), FileLinkHandler\expandFolder(), ExportPageTreeView\ext_tree(), ClickMenu\FILE_copycut(), ClickMenu\FILE_delete(), ClickMenu\FILE_launch(), ClickMenu\FILE_paste(), FileController\flattenResultDataValue(), FileList\formatDirList(), FileList\formatFileList(), AbstractRecordList\fwd_rwd_HTML(), ActionTask\getActions(), SystemInformationToolbarItem\getApplicationContext(), ElementHistoryController\getButtons(), InfoModuleController\getButtons(), TableController\getButtons(), PageFunctionsController\getButtons(), DatabaseRecordList\getButtons(), VersionModuleController\getButtons(), EditFileController\getButtons(), RteController\getButtons(), MoveElementController\getButtons(), ImportExportController\getButtons(), TypoScriptTemplateModuleController\getButtons(), NewRecordController\getButtons(), NewContentElementController\getButtons(), SetupModuleController\getButtons(), EditDocumentController\getButtons(), SchedulerModuleController\getButtons(), AdminPanelView\getCacheModule(), SystemInformationToolbarItem\getComposerMode(), Clipboard\getContentFromTab(), ActionTask\getCreatedUsers(), SystemInformationToolbarItem\getDatabase(), DatabaseRecordList\getDocHeaderButtons(), WorkspaceSelectorToolbarItem\getDropDown(), SystemInformationToolbarItem\getGitRevision(), DocumentTemplate\getHeader(), FileFacade\getIcon(), AbstractTreeView\getIcon(), PageLayoutView\getIcon(), FormatsViewHelper\getIconForFileExtension(), FormEngineUtility\getIconHtml(), ActionToolbarItem\getItem(), LiveSearchToolbarItem\getItem(), WorkspaceSelectorToolbarItem\getItem(), HelpToolbarItem\getItem(), ClearCacheToolbarItem\getItem(), SystemInformationToolbarItem\getItem(), InlineControlContainer\getLevelInteractionLink(), FileList\getLinkToParentFolder(), InfoPageTyposcriptConfigController\getList(), ExtdirectTreeDataProvider\getNodeTypes(), SystemInformationToolbarItem\getOperatingSystem(), DocumentTemplate\getPageInfo(), ElementInformationController\getPageTitle(), SystemInformationToolbarItem\getPhpVersion(), FormManagerController\getProcessedReferencesRows(), LiveSearch\getRecordArray(), PagePositionMap\getRecordHeader(), MetaInformation\getRecordInformation(), LocalizationController\getRecordLocalizeSummary(), PageLinkHandler\getRecordsOnExpandedPage(), DocumentTemplate\getResourceHeader(), AbstractTreeView\getRootIcon(), ShortcutToolbarItem\getShortcutIcon(), IconTest\getSizedentifierReturnsCorrectIdentifier(), RemoteServer\getSystemLanguages(), PageLayoutView\getTable_pages(), PageLayoutView\getTableMenu(), SystemInformationToolbarItem\getTypo3Version(), SystemInformationToolbarItem\getWebServer(), ModuleTemplate\icons(), DocumentTemplate\icons(), EditFileController\init(), AbstractController\initializeAction(), ActionToolbarItem\initializeActionEntries(), IconForRecordViewHelper\initializeArguments(), IconViewHelper\initializeArguments(), AbstractRecordList\languageFlag(), ElementBrowserRecordList\linkWrapItems(), FileList\linkWrapSort(), ExtdirectTreeDataProvider\loadResources(), VersionClickMenu\main(), Clickmenu\main(), TranslationStatusController\main(), InfoPageTyposcriptConfigController\main(), FileUploadController\main(), RenameFileController\main(), ReplaceFileController\main(), CreateFolderController\main(), PageLayoutController\makeButtons(), FileList\makeClip(), DatabaseRecordList\makeClip(), ImportExportController\makeConfigurationForm(), DatabaseRecordList\makeControl(), FileList\makeEdit(), DatabaseRecordList\makeLocalizationPanel(), PageLayoutView\makeOrdinaryList(), DocumentTemplate\makeShortcutIcon(), ModuleTemplate\makeShortcutIcon(), PageLayoutView\noEditIcon(), EditDocumentController\openInNewWindowLink(), PageLayoutView\pages_drawItem(), VersionModuleController\pageSubContent(), LanguageController\prepareDocHeaderButtons(), AbstractContainer\previewFieldValue(), ViewModuleController\registerButtons(), NewRecordController\regularNew(), InputTextElement\render(), SelectCheckBoxElement\render(), FlexFormContainerContainer\render(), OuterWrapContainer\render(), RemoveExtensionViewHelper\render(), ConfigureExtensionViewHelper\render(), Avatar\render(), ActionTask\renderActionList(), IconViewHelperTest\renderCallsIconFactoryWithDefaultSizeAndDefaultStateAndReturnsResult(), IconViewHelperTest\renderCallsIconFactoryWithGivenStateAndReturnsResult(), FileBrowser\renderFilesInFolder(), AddImageHandler\renderFilesInFolder(), FolderBrowser\renderFolders(), InlineRecordContainer\renderForeignRecordHeader(), PermissionAjaxController\renderGroupSelector(), FolderLinkHandler\renderItem(), FileLinkHandler\renderItem(), TranslationStatusController\renderL10nTable(), TypoScriptTemplateModuleController\renderList(), DatabaseRecordList\renderListHeader(), DatabaseRecordList\renderListNavigation(), DatabaseRecordList\renderListRow(), InlineControlContainer\renderPossibleRecordsSelectorTypeGroupDB(), InlineControlContainer\renderPossibleRecordsSelectorTypeSelect(), SelectSingleBoxElement\renderResetButtonElement(), SwitchUserViewHelper\renderStatic(), ErrorIconViewHelper\renderStatic(), LinkValidatorReport\renderTableRow(), PermissionAjaxController\renderToggleEditLock(), PermissionAjaxController\renderUserSelector(), SetupModuleController\renderUserSetup(), TimeTracker\setTSlogMessage(), FontawesomeIconProviderTest\setUp(), BitmapIconProviderTest\setUp(), SvgIconProviderTest\setUp(), IconTest\setUp(), AdministrationController\statisticDetailsAction(), DeletedRecordsController\transform(), PageLayoutView\tt_content_drawColHeader(), PageLayoutView\tt_content_drawHeader(), VersionModuleController\versioningMgm(), ActionTask\viewEditRecord(), DocumentTemplate\viewPageIcon(), ActionTask\viewSqlQuery(), and ElementBrowserPageTreeView\wrapTitle().