TYPO3\CMS\Extbase\Mvc\View\ViewInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Extbase\Mvc\View\ViewInterface:

Public Member Functions
	setControllerContext (\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
TYPO3 CMS Extbase Mvc View ViewInterface	assign ($key, $value)
TYPO3 CMS Extbase Mvc View ViewInterface	assignMultiple (array $values)
bool	canRender (\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
string	render ()
	initializeView ()

Detailed Description

Interface of a view

Definition at line 20 of file ViewInterface.php.

Member Function Documentation

assign()

TYPO3 CMS Extbase Mvc View ViewInterface TYPO3\CMS\Extbase\Mvc\View\ViewInterface::assign	(		$key,
			$value
	)

Add a variable to the view data collection. Can be chained, so $this->view->assign(..., ...)->assign(..., ...); is possible

Parameters

string	$key	‪Key of variable
mixed	$value	‪Value of object

Returns

‪\TYPO3\CMS\Extbase\Mvc\View\ViewInterface an instance of $this, to enable chaining

Implemented in TYPO3\CMS\Backend\View\BackendTemplateView, TYPO3\CMS\Extbase\Mvc\View\AbstractView, and TYPO3\CMS\Extbase\Mvc\View\EmptyView.

Referenced by TYPO3\CMS\Beuser\Controller\PermissionController\initializeView(), TYPO3\CMS\Backend\LoginProvider\UsernamePasswordLoginProvider\render(), and TYPO3\CMS\Extbase\Mvc\Controller\ActionController\resolveView().

assignMultiple()

TYPO3 CMS Extbase Mvc View ViewInterface TYPO3\CMS\Extbase\Mvc\View\ViewInterface::assignMultiple

(

array

$values

)

Add multiple variables to the view data collection

Parameters

array

$values

‪array in the format array(key1 => value1, key2 => value2)

Returns

‪\TYPO3\CMS\Extbase\Mvc\View\ViewInterface an instance of $this, to enable chaining

Implemented in TYPO3\CMS\Backend\View\BackendTemplateView, TYPO3\CMS\Extbase\Mvc\View\AbstractView, and TYPO3\CMS\Extbase\Mvc\View\EmptyView.

Referenced by TYPO3\CMS\Backend\Template\ModuleTemplate\getDynamicTabMenu(), TYPO3\CMS\Beuser\Controller\BackendUserController\initializeView(), TYPO3\CMS\Recordlist\LinkHandler\RecordLinkHandler\render(), and TYPO3\CMS\Form\Controller\FormEditorController\renderFormEditorTemplates().

canRender()

bool TYPO3\CMS\Extbase\Mvc\View\ViewInterface::canRender

(

\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext

$controllerContext

)

Tells if the view implementation can render the view for the given context.

Parameters

\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext

$controllerContext

Returns

‪bool TRUE if the view has something useful to display, otherwise FALSE

Implemented in TYPO3\CMS\Extbase\Mvc\View\AbstractView, and TYPO3\CMS\Extbase\Mvc\View\EmptyView.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\ActionController\resolveView().

initializeView()

TYPO3\CMS\Extbase\Mvc\View\ViewInterface::initializeView

(

)

Initializes this view.

Implemented in TYPO3\CMS\Backend\View\BackendTemplateView, TYPO3\CMS\Extbase\Mvc\View\EmptyView, TYPO3\CMS\Extbase\Mvc\View\AbstractView, and TYPO3\CMS\Fluid\View\AbstractTemplateView.

Referenced by TYPO3\CMS\Extbase\Mvc\Controller\ActionController\resolveView().

render()

string TYPO3\CMS\Extbase\Mvc\View\ViewInterface::render

(

)

Renders the view

Returns

‪string The rendered view

Implemented in TYPO3\CMS\Extbase\Mvc\View\JsonView, TYPO3\CMS\Extbase\Mvc\View\EmptyView, and TYPO3\CMS\Extbase\Mvc\View\NotFoundView.

Referenced by TYPO3\CMS\Backend\Template\ModuleTemplate\getDynamicTabMenu(), TYPO3\CMS\SysAction\Backend\ToolbarItems\ActionToolbarItem\getItem(), TYPO3\CMS\Backend\Backend\ToolbarItems\LiveSearchToolbarItem\getItem(), TYPO3\CMS\Backend\Backend\ToolbarItems\HelpToolbarItem\getItem(), TYPO3\CMS\Workspaces\Backend\ToolbarItems\WorkspaceSelectorToolbarItem\getItem(), TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem\getItem(), TYPO3\CMS\Backend\Backend\ToolbarItems\ClearCacheToolbarItem\getItem(), TYPO3\CMS\Backend\Backend\ToolbarItems\SystemInformationToolbarItem\getItem(), TYPO3\CMS\Recordlist\LinkHandler\RecordLinkHandler\render(), and TYPO3\CMS\Form\Controller\FormEditorController\renderFormEditorTemplates().

setControllerContext()

TYPO3\CMS\Extbase\Mvc\View\ViewInterface::setControllerContext

(

\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext

$controllerContext

)

Sets the current controller context

Parameters

\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext

$controllerContext

Implemented in TYPO3\CMS\Extbase\Mvc\View\AbstractView, and TYPO3\CMS\Extbase\Mvc\View\EmptyView.

Referenced by TYPO3\CMS\Form\Controller\FormEditorController\renderFormEditorTemplates(), and TYPO3\CMS\Extbase\Mvc\Controller\ActionController\resolveView().