PHP Class Neos\Neos\Domain\Model\PluginViewDefinition

Show file Open project: neos/neos-development-collection

Protected Properties

Property Type Description
$configuration array Configuration for this node type, can be an arbitrarily nested array.
$name string Name of this plugin view. Example: "SomePluginView"
$pluginNodeType Neos\ContentRepository\Domain\Model\NodeType

Public Methods

Method Description
__construct ( NodeType $pluginNodeType, string $name, array $configuration )
__toString ( ) : string Renders the unique name of this PluginView in the format :/
getConfiguration ( ) : array Get the full configuration of the node type. Should only be used internally.
getControllerActionPairs ( ) : array
getLabel ( ) : string Get the human-readable label of this node type
getName ( ) : string Returns the name of the plugin view
getPluginNodeType ( ) : NodeType
matchesControllerActionPair ( $controllerObjectName, $actionName ) : boolean Whether or not the current PluginView is configured to handle the specified controller/action pair

Method Details

__construct() public method

public __construct ( NodeType $pluginNodeType, string $name, array $configuration )
$pluginNodeType Neos\ContentRepository\Domain\Model\NodeType
$name string Name of the view
$configuration array the configuration for this node type which is defined in the schema

__toString() public method

Renders the unique name of this PluginView in the format :/
public __toString ( ) : string
return string

getConfiguration() public method

Instead, use the get* / has* methods which exist for every configuration property.
public getConfiguration ( ) : array
return array

getControllerActionPairs() public method

public getControllerActionPairs ( ) : array
return array

getLabel() public method

Get the human-readable label of this node type
public getLabel ( ) : string
return string

getName() public method

Returns the name of the plugin view
public getName ( ) : string
return string

getPluginNodeType() public method

public getPluginNodeType ( ) : NodeType
return Neos\ContentRepository\Domain\Model\NodeType

matchesControllerActionPair() public method

Whether or not the current PluginView is configured to handle the specified controller/action pair
public matchesControllerActionPair ( $controllerObjectName, $actionName ) : boolean
$controllerObjectName
$actionName
return boolean

Property Details

$configuration protected property

Configuration for this node type, can be an arbitrarily nested array.
protected array $configuration
return array

$name protected property

Name of this plugin view. Example: "SomePluginView"
protected string $name
return string

$pluginNodeType protected property

protected NodeType,Neos\ContentRepository\Domain\Model $pluginNodeType
return Neos\ContentRepository\Domain\Model\NodeType