TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer Class Reference

Inheritance diagram for TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer:

Public Member Functions
	__construct (PageLayoutContext $context)
	getGridForPageLayoutContext (PageLayoutContext $context)
LanguageColumn[]	getLanguageColumnsForPageLayoutContext (PageLayoutContext $context)
string	drawContent (bool $renderUnused=true)

Protected Member Functions
	getLanguageColumnsWithDefLangBindingForPageLayoutContext (PageLayoutContext $context)
	initializeClipboard ()
	isContentEditable ()
	getBackendUser ()
	getLanguageService ()

Protected Attributes
IconFactory	$iconFactory
PageLayoutContext	$context
ContentFetcher	$contentFetcher
Clipboard	$clipboard
TemplateView	$view

Private Member Functions
string	drawPasteIcon (int $pasteItem, string $pasteTitle, string $copyMode, string $cssClass, string $title)

Detailed Description

Backend Layout Renderer

Draws a page layout - essentially, behaves as a wrapper for a view which renders the Resources/Private/PageLayout/PageLayout template with necessary assigned template variables.

• ‪Initializes the clipboard used in the page layout
• ‪Inserts an encoded paste icon as JS which is made visible when clipboard elements are registered

this is experimental and subject to change in TYPO3 v10 / v11

Definition at line 57 of file BackendLayoutRenderer.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::__construct

(

PageLayoutContext

$context

)

Definition at line 80 of file BackendLayoutRenderer.php.

References TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\$context, and TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\initializeClipboard().

Member Function Documentation

drawContent()

string TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::drawContent

(

bool

$renderUnused = true

)

Parameters

bool

$renderUnused

‪If true, renders the bottom column with unused records

Returns

‪string

Definition at line 231 of file BackendLayoutRenderer.php.

References TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\$context, TYPO3\CMS\Backend\View\PageLayoutContext\cloneForLanguage(), TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getBackendUser(), TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getGridForPageLayoutContext(), TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getLanguageColumnsForPageLayoutContext(), TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getLanguageColumnsWithDefLangBindingForPageLayoutContext(), TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), and TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING.

drawPasteIcon()

string TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::drawPasteIcon ( int  $pasteItem, string  $pasteTitle, string  $copyMode, string  $cssClass, string  $title  )

private

Draw a paste icon either for pasting into a column or for pasting after a record

Parameters

int	$pasteItem	‪ID of the item in the clipboard
string	$pasteTitle	‪Title for the JS modal
string	$copyMode	‪copy or cut
string	$cssClass	‪CSS class to determine if pasting is done into column or after record
string	$title	‪title attribute of the generated link

Returns

‪string Generated HTML code with link and icon

Definition at line 341 of file BackendLayoutRenderer.php.

References TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getLanguageService(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\initializeClipboard().

getBackendUser()

TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::getBackendUser ( )

protected

Definition at line 368 of file BackendLayoutRenderer.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\drawContent(), and TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\isContentEditable().

getGridForPageLayoutContext()

TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::getGridForPageLayoutContext

(

PageLayoutContext

$context

)

Definition at line 97 of file BackendLayoutRenderer.php.

References TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\$context, TYPO3\CMS\Backend\View\PageLayoutContext\getBackendLayout(), TYPO3\CMS\Backend\View\PageLayoutContext\getDrawingConfiguration(), and TYPO3\CMS\Backend\View\PageLayoutContext\getSiteLanguage().

Referenced by TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\drawContent(), TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getLanguageColumnsForPageLayoutContext(), and TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getLanguageColumnsWithDefLangBindingForPageLayoutContext().

getLanguageColumnsForPageLayoutContext()

LanguageColumn [] TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::getLanguageColumnsForPageLayoutContext

(

PageLayoutContext

$context

)

Returns

‪LanguageColumn[]

Definition at line 128 of file BackendLayoutRenderer.php.

References TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\$context, TYPO3\CMS\Backend\View\PageLayoutContext\cloneForLanguage(), TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getGridForPageLayoutContext(), and TYPO3\CMS\Backend\View\PageLayoutContext\getLanguagesToShow().

Referenced by TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\drawContent().

getLanguageColumnsWithDefLangBindingForPageLayoutContext()

TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::getLanguageColumnsWithDefLangBindingForPageLayoutContext ( PageLayoutContext  $context )

protected

Definition at line 159 of file BackendLayoutRenderer.php.

References TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\$context, TYPO3\CMS\Backend\View\PageLayoutContext\cloneForLanguage(), TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getGridForPageLayoutContext(), and TYPO3\CMS\Backend\View\PageLayoutContext\getLanguagesToShow().

Referenced by TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\drawContent().

getLanguageService()

TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::getLanguageService ( )

protected

Definition at line 373 of file BackendLayoutRenderer.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\drawContent(), and TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\drawPasteIcon().

initializeClipboard()

TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::initializeClipboard ( )

protected

Initializes the clipboard for generating paste links

See also

‪\TYPO3\CMS\Backend\Controller\ContextMenuController::clipboardAction()

‪\TYPO3\CMS\Filelist\Controller\FileListController::indexAction()

Definition at line 301 of file BackendLayoutRenderer.php.

References TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\drawPasteIcon(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\isContentEditable().

Referenced by TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\__construct().

isContentEditable()

TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::isContentEditable ( )

protected

Definition at line 356 of file BackendLayoutRenderer.php.

References TYPO3\CMS\Core\Type\Bitmask\Permission\CONTENT_EDIT, and TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getBackendUser().

Referenced by TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\initializeClipboard().

Member Data Documentation

$clipboard

Clipboard TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::$clipboard

protected

Definition at line 74 of file BackendLayoutRenderer.php.

$contentFetcher

ContentFetcher TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::$contentFetcher

protected

Definition at line 70 of file BackendLayoutRenderer.php.

$context

PageLayoutContext TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::$context

protected

Definition at line 66 of file BackendLayoutRenderer.php.

Referenced by TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\__construct(), TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\drawContent(), TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getGridForPageLayoutContext(), TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getLanguageColumnsForPageLayoutContext(), and TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer\getLanguageColumnsWithDefLangBindingForPageLayoutContext().

$iconFactory

IconFactory TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::$iconFactory

protected

Definition at line 62 of file BackendLayoutRenderer.php.

$view

TemplateView TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer::$view

protected

Definition at line 78 of file BackendLayoutRenderer.php.