class PluginViewDefinition (View source)

A plugin view definition

Properties

protected NodeType $pluginNodeType
protected string $name

Name of this plugin view. Example: "SomePluginView"

protected array $configuration

Configuration for this node type, can be an arbitrarily nested array.

Methods

__construct(NodeType $pluginNodeType, string $name, array $configuration)

No description

getPluginNodeType()

No description

string
getName()

Returns the name of the plugin view

array
getConfiguration()

Get the full configuration of the node type. Should only be used internally.

string
getLabel()

Get the human-readable label of this node type

array
getControllerActionPairs()

No description

bool
matchesControllerActionPair($controllerObjectName, $actionName)

Whether or not the current PluginView is configured to handle the specified controller/action pair

string
__toString()

Renders the unique name of this PluginView in the format :/

Details

__construct(NodeType $pluginNodeType, string $name, array $configuration)

No description

Parameters

NodeType $pluginNodeType
string $name

Name of the view

array $configuration

the configuration for this node type which is defined in the schema

NodeType getPluginNodeType()

No description

Return Value

NodeType

string getName()

Returns the name of the plugin view

Return Value

string

array getConfiguration()

Get the full configuration of the node type. Should only be used internally.

Instead, use the get / has methods which exist for every configuration property.

Return Value

array

string getLabel()

Get the human-readable label of this node type

Return Value

string

array getControllerActionPairs()

No description

Return Value

array

bool matchesControllerActionPair($controllerObjectName, $actionName)

Whether or not the current PluginView is configured to handle the specified controller/action pair

Parameters

$controllerObjectName
$actionName

Return Value

bool

string __toString()

Renders the unique name of this PluginView in the format :/

Return Value

string