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<string|int, mixed>
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
stringrenderPageModulePreviewFooter()
Render a footer for the record
public
renderPageModulePreviewFooter(GridColumnItem $item) : string
Parameters
- $item : GridColumnItem
Return values
stringrenderPageModulePreviewHeader()
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
stringwrapPageModulePreview()
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
stringgenerateListForMenuContentTypes()
Generates a list of selected pages or categories for the menu content types
protected
generateListForMenuContentTypes(array<string|int, mixed> $record, string $contentType) : string
Parameters
- $record : array<string|int, mixed>
-
row from pages
- $contentType : string
Return values
stringgetBackendUser()
protected
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetIconFactory()
protected
getIconFactory() : IconFactory
Return values
IconFactorygetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetProcessedValue()
protected
getProcessedValue(GridColumnItem $item, string $fieldList, array<string|int, mixed> &$info) : void
Parameters
- $item : GridColumnItem
- $fieldList : string
- $info : array<string|int, mixed>
getThumbCodeUnlinked()
Create thumbnail code for record/field but not linked
protected
getThumbCodeUnlinked(array<string|int, mixed> $row, string $table, string $field) : string
Parameters
- $row : array<string|int, mixed>
-
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<string|int, mixed> $row[, string $table = 'tt_content' ]) : 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<string|int, mixed>
-
The row.
- $table : string = 'tt_content'
Return values
string —If the whole thing was editable and $linkText is not empty $linkText is returned with link around. Otherwise just $linkText.
renderContentElementPreviewFromFluidTemplate()
protected
renderContentElementPreviewFromFluidTemplate(array<string|int, mixed> $row[, GridColumnItem|null $item = null ]) : string|null
Parameters
- $row : array<string|int, mixed>
- $item : GridColumnItem|null = null
Return values
string|nullrenderText()
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<string|int, mixed> $targetRecord, array<string|int, mixed> $shortcutRecord, string $tableName, int $uid) : array<string|int, mixed>
Parameters
- $targetRecord : array<string|int, mixed>
- $shortcutRecord : array<string|int, mixed>
- $tableName : string
- $uid : int