PHP Class Neos\Neos\View\TypoScriptView

Inheritance: extends Neos\Flow\Mvc\View\AbstractView
Show file Open project: neos/neos-development-collection Class Usage Examples

Protected Properties

Property Type Description
$i18nService Neos\Flow\I18n\Service
$securityContext Neos\Flow\Security\Context
$supportedOptions array This contains the supported options, their default values, descriptions and types.
$typoScriptPath string The TypoScript path to use for rendering the node given in "value", defaults to "page".
$typoScriptRuntime Neos\Fusion\Core\Runtime
$typoScriptService Neos\Neos\Domain\Service\TypoScriptService

Public Methods

Method Description
assign ( string $key, mixed $value ) : TypoScriptView Clear the cached runtime instance on assignment of variables
canRenderWithNodeAndPath ( ) : boolean Is it possible to render $node with $his->typoScriptPath?
getTypoScriptPath ( ) : string
render ( ) : string Renders the view
setTypoScriptPath ( string $typoScriptPath ) : void Set the TypoScript path to use for rendering the node given in "value"

Protected Methods

Method Description
getClosestDocumentNode ( Neos\ContentRepository\Domain\Model\NodeInterface $node ) : Neos\ContentRepository\Domain\Model\NodeInterface
getCurrentNode ( ) : Neos\ContentRepository\Domain\Model\NodeInterface
getTypoScriptRuntime ( Neos\ContentRepository\Domain\Model\NodeInterface $currentSiteNode ) : Runtime
mergeHttpResponseFromOutput ( string $output, Runtime $typoScriptRuntime ) : string

Method Details

assign() public method

Clear the cached runtime instance on assignment of variables
public assign ( string $key, mixed $value ) : TypoScriptView
$key string
$value mixed
return TypoScriptView

canRenderWithNodeAndPath() public method

Is it possible to render $node with $his->typoScriptPath?
public canRenderWithNodeAndPath ( ) : boolean
return boolean TRUE if $node can be rendered at $typoScriptPath

getClosestDocumentNode() protected method

protected getClosestDocumentNode ( Neos\ContentRepository\Domain\Model\NodeInterface $node ) : Neos\ContentRepository\Domain\Model\NodeInterface
$node Neos\ContentRepository\Domain\Model\NodeInterface
return Neos\ContentRepository\Domain\Model\NodeInterface

getCurrentNode() protected method

protected getCurrentNode ( ) : Neos\ContentRepository\Domain\Model\NodeInterface
return Neos\ContentRepository\Domain\Model\NodeInterface

getTypoScriptPath() public method

public getTypoScriptPath ( ) : string
return string

getTypoScriptRuntime() protected method

protected getTypoScriptRuntime ( Neos\ContentRepository\Domain\Model\NodeInterface $currentSiteNode ) : Runtime
$currentSiteNode Neos\ContentRepository\Domain\Model\NodeInterface
return Neos\Fusion\Core\Runtime

mergeHttpResponseFromOutput() protected method

protected mergeHttpResponseFromOutput ( string $output, Runtime $typoScriptRuntime ) : string
$output string
$typoScriptRuntime Neos\Fusion\Core\Runtime
return string The message body without the message head

render() public method

Renders the view
public render ( ) : string
return string The rendered view

setTypoScriptPath() public method

Set the TypoScript path to use for rendering the node given in "value"
public setTypoScriptPath ( string $typoScriptPath ) : void
$typoScriptPath string
return void

Property Details

$i18nService protected property

protected Service,Neos\Flow\I18n $i18nService
return Neos\Flow\I18n\Service

$securityContext protected property

protected Context,Neos\Flow\Security $securityContext
return Neos\Flow\Security\Context

$supportedOptions protected property

This contains the supported options, their default values, descriptions and types.
protected array $supportedOptions
return array

$typoScriptPath protected property

The TypoScript path to use for rendering the node given in "value", defaults to "page".
protected string $typoScriptPath
return string

$typoScriptRuntime protected property

protected Runtime,Neos\Fusion\Core $typoScriptRuntime
return Neos\Fusion\Core\Runtime

$typoScriptService protected property

protected TypoScriptService,Neos\Neos\Domain\Service $typoScriptService
return Neos\Neos\Domain\Service\TypoScriptService