TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer Class Reference

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

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

Protected Member Functions
	translateShortcutRecord (array $targetRecord, array $shortcutRecord, string $tableName, int $uid)
	getProcessedValue (GridColumnItem $item, string $fieldList, array &$info)
	renderContentElementPreviewFromFluidTemplate (array $row)
string	getThumbCodeUnlinked ($row, $table, $field)
string	renderText (string $input)
string	generateListForMenuContentTypes (array $record)
string	linkEditContent (string $linkText, $row)
	getBackendUser ()
	getLanguageService ()
	getIconFactory ()

Private Attributes
const	MENU_CONTENT_TYPES

Detailed Description

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.

Definition at line 49 of file StandardContentPreviewRenderer.php.

Member Function Documentation

generateListForMenuContentTypes()

string TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::generateListForMenuContentTypes ( array  $record )

protected

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

Parameters

array

$record

‪row from pages

Returns

‪string

Definition at line 378 of file StandardContentPreviewRenderer.php.

Referenced by TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewContent().

getBackendUser()

TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::getBackendUser ( )

protected

Definition at line 429 of file StandardContentPreviewRenderer.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\linkEditContent(), and TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderContentElementPreviewFromFluidTemplate().

getIconFactory()

TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::getIconFactory ( )

protected

Definition at line 439 of file StandardContentPreviewRenderer.php.

Referenced by TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewContent().

getLanguageService()

TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::getLanguageService ( )

protected

Reimplemented in TYPO3\CMS\Form\Hooks\FormPagePreviewRenderer.

Definition at line 434 of file StandardContentPreviewRenderer.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\linkEditContent(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewContent(), and TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewHeader().

getProcessedValue()

TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::getProcessedValue ( GridColumnItem  $item, string  $fieldList, array &  $info  )

protected

Definition at line 286 of file StandardContentPreviewRenderer.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getContext(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumnItem\getRecord().

Referenced by TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewContent(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewFooter(), and TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewHeader().

getThumbCodeUnlinked()

string TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::getThumbCodeUnlinked (   $row,   $table,   $field  )

protected

Create thumbnail code for record/field but not linked

Parameters

mixed[]	$row	‪Record array
string	$table	‪Table (record is from)
string	$field	‪Field name for which thumbnail are to be rendered.

Returns

‪string HTML for thumbnails, if any.

Definition at line 354 of file StandardContentPreviewRenderer.php.

Referenced by TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewContent().

linkEditContent()

string TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::linkEditContent ( string  $linkText,   $row  )

protected

Will create a link on the input string and possibly a big button after the string which links to editing in the RTE. Used for content element content displayed so the user can click the content / "Edit in Rich Text Editor" button

Parameters

string	$linkText	‪String to link. Must be prepared for HTML output.
array	$row	‪The row.

Returns

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

Definition at line 410 of file StandardContentPreviewRenderer.php.

References $GLOBALS, TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\getBackendUser(), and TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\getLanguageService().

Referenced by TYPO3\CMS\Frontend\Preview\TextmediaPreviewRenderer\renderPageModulePreviewContent(), TYPO3\CMS\Frontend\Preview\TextPreviewRenderer\renderPageModulePreviewContent(), TYPO3\CMS\Frontend\Preview\ImagePreviewRenderer\renderPageModulePreviewContent(), TYPO3\CMS\Frontend\Preview\TextpicPreviewRenderer\renderPageModulePreviewContent(), TYPO3\CMS\Form\Hooks\FormPagePreviewRenderer\renderPageModulePreviewContent(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewContent(), and TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewHeader().

renderContentElementPreviewFromFluidTemplate()

TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::renderContentElementPreviewFromFluidTemplate ( array  $row )

protected

Definition at line 299 of file StandardContentPreviewRenderer.php.

References TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\getBackendUser(), and TYPO3\CMS\Core\Core\Environment\getProjectPath().

Referenced by TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewContent().

renderPageModulePreviewContent()

TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::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.

Parameters

GridColumnItem

$item

Returns

‪string

Implements TYPO3\CMS\Backend\Preview\PreviewRendererInterface.

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

Definition at line 97 of file StandardContentPreviewRenderer.php.

References $GLOBALS, TYPO3\CMS\Backend\View\PageLayoutView\createFromPageLayoutContext(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\generateListForMenuContentTypes(), TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getContext(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\getIconFactory(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\getLanguageService(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\getProcessedValue(), TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumnItem\getRecord(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\getThumbCodeUnlinked(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\linkEditContent(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderContentElementPreviewFromFluidTemplate(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderText(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\translateShortcutRecord().

renderPageModulePreviewFooter()

string TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::renderPageModulePreviewFooter

(

GridColumnItem

$item

)

Render a footer for the record

Parameters

GridColumnItem

$item

Returns

‪string

Implements TYPO3\CMS\Backend\Preview\PreviewRendererInterface.

Definition at line 220 of file StandardContentPreviewRenderer.php.

References $GLOBALS, TYPO3\CMS\Backend\View\PageLayoutView\createFromPageLayoutContext(), TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getContext(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\getProcessedValue(), TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumnItem\getRecord(), and TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumnItem\setRecord().

renderPageModulePreviewHeader()

TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::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.

Parameters

GridColumnItem

$item

Returns

‪string

Implements TYPO3\CMS\Backend\Preview\PreviewRendererInterface.

Definition at line 72 of file StandardContentPreviewRenderer.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\AbstractGridObject\getContext(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\getLanguageService(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\getProcessedValue(), TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumnItem\getRecord(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\linkEditContent(), and TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderText().

renderText()

string TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::renderText ( string  $input )

protected

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

Parameters

string

$input

‪Input string

Returns

‪string Output string

Definition at line 365 of file StandardContentPreviewRenderer.php.

Referenced by TYPO3\CMS\Frontend\Preview\TextmediaPreviewRenderer\renderPageModulePreviewContent(), TYPO3\CMS\Frontend\Preview\TextPreviewRenderer\renderPageModulePreviewContent(), TYPO3\CMS\Frontend\Preview\TextpicPreviewRenderer\renderPageModulePreviewContent(), TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewContent(), and TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewHeader().

translateShortcutRecord()

TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::translateShortcutRecord ( array  $targetRecord, array  $shortcutRecord, string  $tableName, int  $uid  )

protected

Definition at line 264 of file StandardContentPreviewRenderer.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer\renderPageModulePreviewContent().

wrapPageModulePreview()

TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::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.

Parameters

string	$previewHeader
string	$previewContent
GridColumnItem	$item

Returns

‪string

Implements TYPO3\CMS\Backend\Preview\PreviewRendererInterface.

Definition at line 255 of file StandardContentPreviewRenderer.php.

References TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumnItem\isDisabled().

Member Data Documentation

MENU_CONTENT_TYPES

const TYPO3\CMS\Backend\Preview\StandardContentPreviewRenderer::MENU_CONTENT_TYPES

private

Initial value:

= [
        'menu_abstract',
        'menu_categorized_content',
        'menu_categorized_pages',
        'menu_pages',
        'menu_recently_updated',
        'menu_related_pages',
        'menu_section',
        'menu_section_pages',
        'menu_sitemap',
        'menu_sitemap_pages',
        'menu_subpages',
    ]

Definition at line 58 of file StandardContentPreviewRenderer.php.