TYPO3\CMS\Backend\Preview\PreviewRendererInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Backend\Preview\PreviewRendererInterface:

Public Member Functions
	renderPageModulePreviewHeader (GridColumnItem $item)
	renderPageModulePreviewContent (GridColumnItem $item)
	renderPageModulePreviewFooter (GridColumnItem $item)
	wrapPageModulePreview (string $previewHeader, string $previewContent, GridColumnItem $item)

Detailed Description

Interface PreviewRendererInterface

Contract for classes capable of rendering previews of a given record from a table. Responsible for rendering preview header, preview content and wrapping of those two values.

Responsibilities are segmented into three methods, one for each responsibility, which is done in order to allow overriding classes to change those parts individually without having to replace other parts. Rather than relying on implementations to be friendly and divide code into smaller pieces and give them (at least) protected visibility, the key methods are instead required on the interface directly.

Callers are then responsible for calling each method and combining/wrapping the output appropriately.

Definition at line 39 of file PreviewRendererInterface.php.

Member Function Documentation

renderPageModulePreviewContent()

TYPO3\CMS\Backend\Preview\PreviewRendererInterface::renderPageModulePreviewContent

(

GridColumnItem

$item

)

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.

Implemented in TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer, TYPO3\CMS\Form\Hooks\FormPagePreviewRenderer, TYPO3\CMS\Frontend\Preview\ImagePreviewRenderer, TYPO3\CMS\Frontend\Preview\TextmediaPreviewRenderer, TYPO3\CMS\Frontend\Preview\TextpicPreviewRenderer, and TYPO3\CMS\Frontend\Preview\TextPreviewRenderer.

renderPageModulePreviewFooter()

TYPO3\CMS\Backend\Preview\PreviewRendererInterface::renderPageModulePreviewFooter

(

GridColumnItem

$item

)

Render a footer for the record to display in page module below the body of the item's preview.

Implemented in TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer.

renderPageModulePreviewHeader()

TYPO3\CMS\Backend\Preview\PreviewRendererInterface::renderPageModulePreviewHeader

(

GridColumnItem

$item

)

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.

Implemented in TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer.

wrapPageModulePreview()

TYPO3\CMS\Backend\Preview\PreviewRendererInterface::wrapPageModulePreview	(	string	$previewHeader,
		string	$previewContent,
		GridColumnItem	$item
	)

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.

Implemented in TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer.