PHP Class Neos\FluidAdaptor\View\AbstractTemplateView

Inheritance: extends TYPO3Fluid\Fluid\View\AbstractTemplateView, implements Neos\Flow\Mvc\View\ViewInterface
Datei anzeigen Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$controllerContext Neos\Flow\Mvc\Controller\ControllerContext
$options array The configuration options of this view
$supportedOptions array Syntax example: [ 'someOptionName' => ['defaultValue', 'some description', 'string'), 'someOtherOptionName' => ['defaultValue', some description', integer), ... )

Public Methods

Method Description
__construct ( array $options = null ) Set default options based on the supportedOptions provided
canRender ( ControllerContext $controllerContext ) : boolean
createWithOptions ( array $options ) : AbstractTemplateView Factory method to create an instance with given options.
getOption ( string $optionName ) : mixed Get a specific option of this View
renderSection ( string $sectionName, array $variables = [], boolean $ignoreUnknown = false ) : string Renders a given section.
setControllerContext ( ControllerContext $controllerContext )
setOption ( string $optionName, mixed $value ) : void Set a specific option of this View
setTemplatePathAndFilename ( string $templatePathAndFilename )

Protected Methods

Method Description
renderStandaloneSection ( string $sectionName, array $variables = [], boolean $ignoreUnknown = false ) : string Renders a section on its own, i.e. without the a surrounding template.
setOptions ( array $options ) Merges the given options with the default values and sets the resulting options in this object.
validateOptions ( array $options ) Validate options given to this view.

Method Details

__construct() public method

Set default options based on the supportedOptions provided
public __construct ( array $options = null )
$options array

canRender() public method

public canRender ( ControllerContext $controllerContext ) : boolean
$controllerContext Neos\Flow\Mvc\Controller\ControllerContext
return boolean

createWithOptions() public static method

Factory method to create an instance with given options.
public static createWithOptions ( array $options ) : AbstractTemplateView
$options array
return AbstractTemplateView

getOption() public method

Get a specific option of this View
public getOption ( string $optionName ) : mixed
$optionName string
return mixed

renderSection() public method

Renders a given section.
public renderSection ( string $sectionName, array $variables = [], boolean $ignoreUnknown = false ) : string
$sectionName string Name of section to render
$variables array The variables to use
$ignoreUnknown boolean Ignore an unknown section and just return an empty string
return string rendered template for the section

renderStandaloneSection() protected method

In this case, we just emulate that a surrounding (empty) layout exists, and trigger the normal rendering flow then.
protected renderStandaloneSection ( string $sectionName, array $variables = [], boolean $ignoreUnknown = false ) : string
$sectionName string Name of section to render
$variables array The variables to use
$ignoreUnknown boolean Ignore an unknown section and just return an empty string
return string rendered template for the section

setControllerContext() public method

public setControllerContext ( ControllerContext $controllerContext )
$controllerContext Neos\Flow\Mvc\Controller\ControllerContext

setOption() public method

Set a specific option of this View
public setOption ( string $optionName, mixed $value ) : void
$optionName string
$value mixed
return void

setOptions() protected method

Merges the given options with the default values and sets the resulting options in this object.
protected setOptions ( array $options )
$options array

setTemplatePathAndFilename() public method

public setTemplatePathAndFilename ( string $templatePathAndFilename )
$templatePathAndFilename string

validateOptions() protected method

Validate options given to this view.
protected validateOptions ( array $options )
$options array

Property Details

$controllerContext protected_oe property

protected ControllerContext,Neos\Flow\Mvc\Controller $controllerContext
return Neos\Flow\Mvc\Controller\ControllerContext

$options protected_oe property

The configuration options of this view
protected array $options
return array

$supportedOptions protected_oe property

Syntax example: [ 'someOptionName' => ['defaultValue', 'some description', 'string'), 'someOtherOptionName' => ['defaultValue', some description', integer), ... )
protected array $supportedOptions
return array