Story #40599: Include arbitrary Flow-Applications as Plugins - Base Distribution - TYPO3 Forge

Base Distribution TYPO3.Form TYPO3.Imagine TYPO3.Media TYPO3.Neos TYPO3.Neos.NodeTypes TYPO3.Party TYPO3.Setup TYPO3.SiteKickstarter TYPO3.Twitter.Bootstrap TYPO3.TYPO3CR TYPO3.TypoScript Coordination Group Website and Communication

Story #40599

Work Package #45013: Flexible plugin integration (TODO: Reviews)

Include arbitrary Flow-Applications as Plugins

Added by Sebastian Kurfuerst almost 3 years ago. Updated over 1 year ago.

Status:

Resolved

Start date:

2013-03-26

Priority:

Should have

Due date:

2013-04-20

Assigned To:

Marc Neuhaus

% Done:

100%

Category:

Content Rendering

Spent time:

Target version:

Sprint February 2013

Story points

Velocity based estimate

Description

As a content editor, I want to include an arbitrary Flow-Application inside a page.

Definition of done:

FLOW3 packages should run as plugin inside the frontend
we use the Blog package as example
the controllers and most of the views should be re-used

PluginInspector_01.png (14.6 kB) Bastian Waidelich, 2012-09-04 20:45

PluginViewInspector_01.png (11.3 kB) Bastian Waidelich, 2012-09-04 20:45

PluginInspector_02.png (14.8 kB) Bastian Waidelich, 2012-09-04 20:45

Subtasks

Related issues

History

#1 Updated by Sebastian Kurfuerst almost 3 years ago

Subject changed from As a content editor, I want to include the Blog inside a page to [DISCUSS] As a content editor, I want to include the Blog inside a page
Position deleted (1)
Position set to 1

#2 Updated by Bastian Waidelich almost 3 years ago

Current Status¶

Plugin TypoScript Object contains properties package, subpackage, controller & action
action is the default action that is invoked when the plugin is called (if no PluginArguments specify other (sub)package, controller and/or action)
There is currently no official way to link to Plugin actions on a different page (we currently use an AOP Aspect to solve this)

Ideas¶

The Plugin TypoScript Object contains an (optional) PluginConfiguration and at least one PluginViewDefinitions
The PluginSettings consists of arbitrary settings that are relevant to the plugin (e.g. max. number of posts per page)
A PluginViewDefinition is configured globally (e.g. via YAML). It specifies (sub)package(s), controller(s) and action(s) that are part of a PluginView (e.g. PostController->showAction, PostController->deleteAction for the Post Details PluginView). The first controller/action pair defines the default. Later, a PluginViewConfiguration might also define (non)cacheable actions etc.
The PluginView TypoScript Object references one PluginViewDefinition and a Plugin node (aka Master Plugin)

User Interface¶

When a plugin is inserted, the available PluginViews are displayed in the inspector panel:

As soon as at least one plugin with multiple PluginViewDefinitions is available, the user can insert PluginView Content Objects. A PluginView has to define Master Plugin node and the PluginViewDefinition it refers to:

When the user edits the Master Plugin instance again, the linked PluginViews are displayed in the inspector:

#3 Updated by Bastian Waidelich almost 3 years ago

File PluginInspector_01.png added
File PluginViewInspector_01.png added
File PluginInspector_02.png added

#4 Updated by Sebastian Kurfuerst almost 3 years ago

Example for Form Builder: https://review.typo3.org/#/q/topic:formbuilder,n,z

#5 Updated by Sebastian Kurfuerst almost 3 years ago

Subject changed from [DISCUSS] As a content editor, I want to include the Blog inside a page to As a content editor, I want to include the Blog inside a page
Position deleted (5)
Position set to 5