PluginService
class PluginService (View source)
Central authority for interactions with plugins.
Whenever details about Plugins or PluginViews are needed this service should be used.
For some methods the ContentContext has to be specified. This is required in order for the ContentRepository to fetch nodes of the current workspace. The context can be retrieved from any node of the correct workspace & tree. If no node is available (e.g. for CLI requests) the ContentContextFactory can be used to create a context instance.
Properties
| protected Context | $securityContext | ||
| protected | $contentRepositoryRegistry | ||
| protected | $siteNodeUtility |
Methods
Returns an array of all plugin nodes with View Definitions
Get all configured PluginView definitions for a specific $pluginNodeType
No description
returns a plugin node or one of it's view nodes if an view has been configured for that specific controller and action combination
Fetch a PluginView definition that matches the specified controller and action combination
returns a specific view node of an master plugin or NULL if it does not exist
Details
Nodes
getPluginNodesWithViewDefinitions(WorkspaceName $workspaceName, DimensionSpacePoint $dimensionSpacePoint, ContentRepositoryId $contentRepositoryIdentifier)
Returns an array of all plugin nodes with View Definitions
protected Nodes
getNodes(Node $siteNode, NodeTypeNames $nodeTypeNames)
Find all nodes of a specific node type
PluginViewDefinition[]
getPluginViewDefinitionsByPluginNodeType(NodeType $pluginNodeType)
Get all configured PluginView definitions for a specific $pluginNodeType
protected array<string,mixed>
getPluginViewConfigurationsByPluginNodeType(NodeType $pluginNodeType)
No description
Node|null
getPluginNodeByAction(Node $currentNode, string $controllerObjectName, string $actionName)
returns a plugin node or one of it's view nodes if an view has been configured for that specific controller and action combination
PluginViewDefinition|null
getPluginViewDefinitionByAction(ContentRepositoryId $contentRepositoryIdentifier, string $controllerObjectName, string $actionName)
Fetch a PluginView definition that matches the specified controller and action combination
Node|null
getPluginViewNodeByMasterPlugin(Node $node, string $viewName)
returns a specific view node of an master plugin or NULL if it does not exist