AbstractSvgIconProvider

abstract class \TYPO3\CMS\Core\Imaging\IconProvider\AbstractSvgIconProvider

Implements
IconProviderInterface

Abstract class for all SVG-based icon providers

Table of Contents

Interfaces

IconProviderInterface
Interface IconProviderInterface

Constants

MARKUP_IDENTIFIER_INLINE  : mixed = 'inline'

Properties

$svgDocumentFactory  : SvgDocumentFactory
$svgDocumentService  : SvgDocumentService

Methods

injectSvgDocumentFactory()  : void
injectSvgDocumentService()  : void
prepareIconMarkup()  : void
Prepare the icon markup and set it to the icon by setMarkup()
generateInlineMarkup()  : string
generateMarkup()  : string
getInlineSvg()  : string
getInlineSvgContents()  : string|null
getPublicPath()  : string
Calculate public path of SVG file

Constants

MARKUP_IDENTIFIER_INLINE

public mixed MARKUP_IDENTIFIER_INLINE = 'inline'

Properties

Methods

prepareIconMarkup()

Prepare the icon markup and set it to the icon by setMarkup()

public prepareIconMarkup(Icon $icon[, array $options = [] ]) : void

Parameters

$icon : Icon
$options : array = []

generateInlineMarkup()

protected abstract generateInlineMarkup(array $options) : string

Parameters

$options : array

Return values

string

generateMarkup()

protected abstract generateMarkup(Icon $icon, array $options) : string

Parameters

$icon : Icon
$options : array

Return values

string

getInlineSvg()

protected getInlineSvg(string $source) : string

Parameters

$source : string

Return values

string

getInlineSvgContents()

protected getInlineSvgContents(string $source) : string|null

Parameters

$source : string

Return values

string|null

getPublicPath()

Calculate public path of SVG file

protected getPublicPath(string $source) : string

Parameters

$source : string

Return values

string
On this page