StandardContentPreviewRenderer

class \TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer

Implements
PreviewRendererInterface, LoggerAwareInterface
Uses
LoggerAwareTrait

Class StandardContentPreviewRenderer

Legacy preview rendering refactored from PageLayoutView. Provided as default preview rendering mechanism via StandardPreviewRendererResolver which detects the renderer based on TCA configuration.

Can be replaced and/or subclassed by custom implementations by changing this TCA configuration.

See also PreviewRendererInterface documentation.

Table of Contents

Interfaces

PreviewRendererInterface
Interface PreviewRendererInterface
LoggerAwareInterface

Methods

renderPageModulePreviewContent()  : string
Dedicated method for rendering preview body HTML for the page module only. Receives the the GridColumnItem that contains the record for which a preview should be rendered and returned.
renderPageModulePreviewFooter()  : string
Render a footer for the record
renderPageModulePreviewHeader()  : string
Dedicated method for rendering preview header HTML for the page module only. Receives the the GridColumnItem that contains the record for which a preview header should be rendered and returned.
wrapPageModulePreview()  : string
Dedicated method for wrapping a preview header and body HTML. Receives $item, an instance of GridColumnItem holding among other things the record, which can be used to determine appropriate wrapping.
generateListForMenuContentTypes()  : string
Generates a list of selected pages or categories for the menu content types
getBackendUser()  : BackendUserAuthentication
getIconFactory()  : IconFactory
getLanguageService()  : LanguageService
getProcessedValue()  : void
getThumbCodeUnlinked()  : string
Create thumbnail code for record/field but not linked
linkEditContent()  : string
Will create a link on the input string and possibly a big button after the string which links to editing in the RTE.
renderContentElementPreviewFromFluidTemplate()  : string|null
renderText()  : string
Processing of larger amounts of text (usually from RTE/bodytext fields) with word wrapping etc.
translateShortcutRecord()  : array

Methods

renderPageModulePreviewContent()

Dedicated method for rendering preview body HTML for the page module only. Receives the the GridColumnItem that contains the record for which a preview should be rendered and returned.

public renderPageModulePreviewContent(GridColumnItem $item) : string

Parameters

$item : GridColumnItem

Return values

string

renderPageModulePreviewFooter()

Render a footer for the record

public renderPageModulePreviewFooter(GridColumnItem $item) : string

Parameters

$item : GridColumnItem

Return values

string

renderPageModulePreviewHeader()

Dedicated method for rendering preview header HTML for the page module only. Receives the the GridColumnItem that contains the record for which a preview header should be rendered and returned.

public renderPageModulePreviewHeader(GridColumnItem $item) : string

Parameters

$item : GridColumnItem

Return values

string

wrapPageModulePreview()

Dedicated method for wrapping a preview header and body HTML. Receives $item, an instance of GridColumnItem holding among other things the record, which can be used to determine appropriate wrapping.

public wrapPageModulePreview(string $previewHeader, string $previewContent, GridColumnItem $item) : string

Parameters

$previewHeader : string
$previewContent : string
$item : GridColumnItem

Return values

string

generateListForMenuContentTypes()

Generates a list of selected pages or categories for the menu content types

protected generateListForMenuContentTypes(array $record) : string

Parameters

$record : array

row from pages

Return values

string

getThumbCodeUnlinked()

Create thumbnail code for record/field but not linked

protected getThumbCodeUnlinked(array $row, string $table, string $field) : string

Parameters

$row : array

Record array

$table : string

Table (record is from)

$field : string

Field name for which thumbnail are to be rendered.

Return values

string —

HTML for thumbnails, if any.

linkEditContent()

Will create a link on the input string and possibly a big button after the string which links to editing in the RTE.

protected linkEditContent(string $linkText, array $row) : string

Used for content element content displayed so the user can click the content / "Edit in Rich Text Editor" button

Parameters

$linkText : string

String to link. Must be prepared for HTML output.

$row : array

The row.

Return values

string —

If the whole thing was editable $str is return with link around. Otherwise just $str.

renderContentElementPreviewFromFluidTemplate()

protected renderContentElementPreviewFromFluidTemplate(array $row) : string|null

Parameters

$row : array

Return values

string|null

renderText()

Processing of larger amounts of text (usually from RTE/bodytext fields) with word wrapping etc.

protected renderText(string $input) : string

Parameters

$input : string

Input string

Return values

string —

Output string

translateShortcutRecord()

protected translateShortcutRecord(array $targetRecord, array $shortcutRecord, string $tableName, int $uid) : array

Parameters

$targetRecord : array
$shortcutRecord : array
$tableName : string
$uid : int

Return values

array
On this page