[TASK] Update Code snippets (#6165)

Releases: main

Author: linawolf

Documentation/ApiOverview/Backend/BackendModules/_ModuleTemplate.rst.txt

@@ -128,3 +128,12 @@
         Generates a menu in the docheader to access third-level modules
 
         :param $additionalQueryParams: the additionalQueryParams, default: []
+
+    ..  php:method:: addButtonToButtonBar(\TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface $button, string $buttonPosition = 'left', int $buttonGroup = 1)
+        :returns: `self`
+
+        Shorthand method to add a new button to the button bar
+
+        :param $button: the button
+        :param $buttonPosition: the buttonPosition, default: 'left'
+        :param $buttonGroup: the buttonGroup, default: 1

Documentation/CodeSnippets/Events/Backend/AfterSectionMarkupGeneratedEvent.rst.txt

@@ -13,7 +13,7 @@
         :returns: `\TYPO3\CMS\Backend\View\PageLayoutContext`
 
     ..  php:method:: getRecords()
-        :returns: `array`
+        :returns: `\RecordInterface[]`
 
     ..  php:method:: setContent(string $content = '')
 

Documentation/CodeSnippets/Events/Backend/BeforeSectionMarkupGeneratedEvent.rst.txt

@@ -13,7 +13,7 @@
         :returns: `\TYPO3\CMS\Backend\View\PageLayoutContext`
 
     ..  php:method:: getRecords()
-        :returns: `array`
+        :returns: `\RecordInterface[]`
 
     ..  php:method:: setContent(string $content = '')
 

Documentation/CodeSnippets/Events/Backend/ModifyRecordListRecordActionsEvent.rst.txt

@@ -7,7 +7,7 @@
 
     "edit", "copy", "delete") for a table in the RecordList.
 
-    ..  php:method:: setAction(string $action, string $actionName = '', string $group = '', string $before = '', string $after = '')
+    ..  php:method:: setAction(?\TYPO3\CMS\Backend\Template\Components\ComponentInterface $action, string $actionName, \TYPO3\CMS\Backend\Template\Components\ActionGroup $group = \TYPO3\CMS\Backend\Template\Components\ActionGroup::secondary, string $before = '', string $after = '')
 
         Add a new action or override an existing one. Latter is only possible,
         in case $columnName is given. Otherwise, the column will be added with
@@ -19,62 +19,60 @@
         be added to the secondary group.
 
         :param $action: the action
-        :param $actionName: the actionName, default: ''
-        :param $group: the group, default: ''
+        :param $actionName: the actionName
+        :param $group: the group, default: \TYPO3\CMS\Backend\Template\Components\ActionGroup::secondary
         :param $before: the before, default: ''
         :param $after: the after, default: ''
 
-    ..  php:method:: hasAction(string $actionName, string $group = '')
+    ..  php:method:: hasAction(string $actionName, ?\TYPO3\CMS\Backend\Template\Components\ActionGroup $group = NULL)
         :returns: `bool`
 
         Whether the action exists in the given group. In case non or
         an invalid $group is provided, both groups will be checked.
 
         :param $actionName: the actionName
-        :param $group: the group, default: ''
+        :param $group: the group, default: NULL
 
-    ..  php:method:: getAction(string $actionName, string $group = '')
-        :returns: `?string`
+    ..  php:method:: getAction(string $actionName, ?\TYPO3\CMS\Backend\Template\Components\ActionGroup $group = NULL)
+        :returns: `?\TYPO3\CMS\Backend\Template\Components\ComponentInterface`
 
         Get action by its name. In case the action exists in both groups
         and non or an invalid $group is provided, the action from the
         "primary" group will be returned.
 
         :param $actionName: the actionName
-        :param $group: the group, default: ''
+        :param $group: the group, default: NULL
 
-    ..  php:method:: removeAction(string $actionName, string $group = '')
-        :returns: `bool`
+    ..  php:method:: removeAction(string $actionName, ?\TYPO3\CMS\Backend\Template\Components\ActionGroup $group = NULL)
 
         Remove action by its name. In case the action exists in both groups
         and non or an invalid $group is provided, the action will be removed
         from both groups.
 
         :param $actionName: the actionName
-        :param $group: the group, default: ''
-        :Return description: Whether the action could be removed - Will thereforereturn FALSE if the action to remove does not exist.
-
-    ..  php:method:: getActionGroup(string $group)
-        :returns: `?array`
+        :param $group: the group, default: NULL
 
-        Get the actions of a specific group
+    ..  php:method:: moveActionTo(string $actionName, \TYPO3\CMS\Backend\Template\Components\ActionGroup $group, string $before = '', string $after = '')
 
+        :param $actionName: the actionName
         :param $group: the group
+        :param $before: the before, default: ''
+        :param $after: the after, default: ''
 
-    ..  php:method:: setActions(array $actions)
-
-        :param $actions: the actions
+    ..  php:method:: getActionGroup(\TYPO3\CMS\Backend\Template\Components\ActionGroup $group)
+        :returns: `\TYPO3\CMS\Backend\Template\Components\ComponentGroup`
 
-    ..  php:method:: getActions()
-        :returns: `array`
+        Get the actions of a specific group
 
-    ..  php:method:: getTable()
-        :returns: `string`
+        :param $group: the group
 
     ..  php:method:: getRecord()
-        :returns: `array`
+        :returns: `\TYPO3\CMS\Core\Domain\RecordInterface`
 
     ..  php:method:: getRecordList()
         :returns: `\TYPO3\CMS\Backend\RecordList\DatabaseRecordList`
 
         Returns the current DatabaseRecordList instance.
+
+    ..  php:method:: getRequest()
+        :returns: `\Psr\Http\Message\RequestInterface`

Documentation/CodeSnippets/Events/Backend/PageContentPreviewRenderingEvent.rst.txt

@@ -12,9 +12,9 @@
         :returns: `string`
 
     ..  php:method:: getRecord()
-        :returns: `array`
+        :returns: `\TYPO3\CMS\Core\Domain\RecordInterface`
 
-    ..  php:method:: setRecord(array $record)
+    ..  php:method:: setRecord(\TYPO3\CMS\Core\Domain\RecordInterface $record)
 
         :param $record: the record
 

Documentation/CodeSnippets/Events/Filelist/ProcessFileListActionsEvent.rst.txt

@@ -11,9 +11,64 @@
     ..  php:method:: isFile()
         :returns: `bool`
 
-    ..  php:method:: getActionItems()
-        :returns: `array`
+    ..  php:method:: setAction(?\TYPO3\CMS\Backend\Template\Components\ComponentInterface $action, string $actionName, \TYPO3\CMS\Backend\Template\Components\ActionGroup $group = \TYPO3\CMS\Backend\Template\Components\ActionGroup::secondary, string $before = '', string $after = '')
 
-    ..  php:method:: setActionItems(array $actionItems)
+        Add a new action or override an existing one. Latter is only possible,
+        in case $columnName is given. Otherwise, the column will be added with
+        a numeric index, which is generally not recommended. It's also possible
+        to define the position of an action with either the "before" or "after"
+        argument, while their value must be an existing action.
 
-        :param $actionItems: the actionItems
+        Note: In case none or an invalid $group is provided, the new action will
+        be added to the secondary group.
+
+        :param $action: the action
+        :param $actionName: the actionName
+        :param $group: the group, default: \TYPO3\CMS\Backend\Template\Components\ActionGroup::secondary
+        :param $before: the before, default: ''
+        :param $after: the after, default: ''
+
+    ..  php:method:: hasAction(string $actionName, ?\TYPO3\CMS\Backend\Template\Components\ActionGroup $group = NULL)
+        :returns: `bool`
+
+        Whether the action exists in the given group. In case none or
+        an invalid $group is provided, both groups will be checked.
+
+        :param $actionName: the actionName
+        :param $group: the group, default: NULL
+
+    ..  php:method:: getAction(string $actionName, ?\TYPO3\CMS\Backend\Template\Components\ActionGroup $group = NULL)
+        :returns: `?\TYPO3\CMS\Backend\Template\Components\ComponentInterface`
+
+        Get action by its name. In case the action exists in both groups
+        and none or an invalid $group is provided, the action from the
+        "primary" group will be returned.
+
+        :param $actionName: the actionName
+        :param $group: the group, default: NULL
+
+    ..  php:method:: removeAction(string $actionName, ?\TYPO3\CMS\Backend\Template\Components\ActionGroup $group = NULL)
+
+        Remove action by its name. In case the action exists in both groups
+        and none or an invalid $group is provided, the action will be removed
+        from both groups.
+
+        :param $actionName: the actionName
+        :param $group: the group, default: NULL
+
+    ..  php:method:: moveActionTo(string $actionName, \TYPO3\CMS\Backend\Template\Components\ActionGroup $group, string $before = '', string $after = '')
+
+        :param $actionName: the actionName
+        :param $group: the group
+        :param $before: the before, default: ''
+        :param $after: the after, default: ''
+
+    ..  php:method:: getActionGroup(\TYPO3\CMS\Backend\Template\Components\ActionGroup $group)
+        :returns: `\TYPO3\CMS\Backend\Template\Components\ComponentGroup`
+
+        Get the actions of a specific group
+
+        :param $group: the group
+
+    ..  php:method:: getRequest()
+        :returns: `\Psr\Http\Message\RequestInterface`

Documentation/CodeSnippets/Events/Form/BeforeRenderableIsRemovedFromFormEvent.rst.txt

@@ -3,14 +3,17 @@
 
 ..  php:class:: BeforeRenderableIsRemovedFromFormEvent
 
-    Listeners to this event will be able to prevent deletion of the renderable (form element) and to add custom logic based on the deletion.
+    Listeners to this Event will be able to:
+    - Get the renderable that is about to be removed from the form
+    - Stop the deletion process by setting preventRemoval to true
+    - Add custom logic, e.g. cleanup tasks, before deletion
 
     ..  php:attr:: renderable
+        :readonly:
         :public:
 
-        The form element (readonly)
-
     ..  php:attr:: preventRemoval
         :public:
 
-        A boolean flag that can be set to true to prevent removal of the renderable.
+    ..  php:method:: isPropagationStopped()
+        :returns: `bool`