From cf97c1d5bbcea47e5deb5ea721760819e884c0a7 Mon Sep 17 00:00:00 2001
From: Marcel Werk <burntime@woltlab.com>
Date: Wed, 21 May 2025 18:08:21 +0200
Subject: [PATCH] Allow the usage of the interaction context menu as a content
 interaction button

---
 .../shared_standaloneInteractionButton.tpl    | 13 +++-
 .../lib/acp/form/StyleEditForm.class.php      |  4 +-
 .../lib/acp/form/UserRankEditForm.class.php   |  4 +-
 .../GetBulkContextMenuOptions.class.php       |  6 +-
 .../GetContextMenuOptions.class.php           |  6 +-
 .../gridView/AbstractGridView.class.php       | 16 ++--
 ...InteractionContextMenuComponent.class.php} | 10 ++-
 ...eInteractionContextMenuComponent.class.php | 78 +++++++++++++++++++
 ...daloneInteractionContextMenuView.class.php | 40 ----------
 ...InteractionContextMenuComponent.class.php} | 10 ++-
 .../listView/AbstractListView.class.php       | 16 ++--
 11 files changed, 132 insertions(+), 71 deletions(-)
 rename wcfsetup/install/files/lib/system/interaction/{InteractionContextMenuView.class.php => InteractionContextMenuComponent.class.php} (91%)
 create mode 100644 wcfsetup/install/files/lib/system/interaction/StandaloneInteractionContextMenuComponent.class.php
 delete mode 100644 wcfsetup/install/files/lib/system/interaction/StandaloneInteractionContextMenuView.class.php
 rename wcfsetup/install/files/lib/system/interaction/bulk/{BulkInteractionContextMenuView.class.php => BulkInteractionContextMenuComponent.class.php} (90%)

diff --git a/com.woltlab.wcf/templates/shared_standaloneInteractionButton.tpl b/com.woltlab.wcf/templates/shared_standaloneInteractionButton.tpl
index 361a62c4514..1a30aa16253 100644
--- a/com.woltlab.wcf/templates/shared_standaloneInteractionButton.tpl
+++ b/com.woltlab.wcf/templates/shared_standaloneInteractionButton.tpl
@@ -1,6 +1,13 @@
-<div class="dropdown" id="{$containerID}">
-	<button type="button" class="button dropdownToggle" aria-label="{lang}wcf.global.button.more{/lang}">
-		{icon name='ellipsis-vertical'}
+<div class="dropdown {$cssClassName}" id="{$containerID}">
+	<button 
+		type="button"
+		class="button dropdownToggle {$buttonCssClassName}"
+		{if !$label}aria-label="{lang}wcf.global.button.more{/lang}"{/if}
+	>
+		{icon name=$icon}
+		{if $label}
+			<span>{$label}</span>
+		{/if}
 	</button>
 
 	<ul class="dropdownMenu">
diff --git a/wcfsetup/install/files/lib/acp/form/StyleEditForm.class.php b/wcfsetup/install/files/lib/acp/form/StyleEditForm.class.php
index f292bf303c4..cc629b30f82 100644
--- a/wcfsetup/install/files/lib/acp/form/StyleEditForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/StyleEditForm.class.php
@@ -12,7 +12,7 @@
 use wcf\system\file\upload\UploadFile;
 use wcf\system\file\upload\UploadHandler;
 use wcf\system\interaction\admin\StyleInteractions;
-use wcf\system\interaction\StandaloneInteractionContextMenuView;
+use wcf\system\interaction\StandaloneInteractionContextMenuComponent;
 use wcf\system\language\I18nHandler;
 use wcf\system\request\LinkHandler;
 use wcf\system\style\StyleCompiler;
@@ -453,7 +453,7 @@ public function assignVariables()
             'style' => $this->style,
             'styleID' => $this->styleID,
             'isDarkMode' => $this->isDarkMode,
-            'interactionContextMenu' => new StandaloneInteractionContextMenuView(
+            'interactionContextMenu' => new StandaloneInteractionContextMenuComponent(
                 new StyleInteractions(),
                 $this->style,
                 LinkHandler::getInstance()->getControllerLink(StyleListPage::class)
diff --git a/wcfsetup/install/files/lib/acp/form/UserRankEditForm.class.php b/wcfsetup/install/files/lib/acp/form/UserRankEditForm.class.php
index ecf27131ed2..12af51a9156 100644
--- a/wcfsetup/install/files/lib/acp/form/UserRankEditForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/UserRankEditForm.class.php
@@ -8,7 +8,7 @@
 use wcf\http\Helper;
 use wcf\system\exception\IllegalLinkException;
 use wcf\system\interaction\admin\UserRankInteractions;
-use wcf\system\interaction\StandaloneInteractionContextMenuView;
+use wcf\system\interaction\StandaloneInteractionContextMenuComponent;
 use wcf\system\request\LinkHandler;
 use wcf\system\WCF;
 
@@ -66,7 +66,7 @@ public function assignVariables()
         parent::assignVariables();
 
         WCF::getTPL()->assign([
-            'interactionContextMenu' => new StandaloneInteractionContextMenuView(
+            'interactionContextMenu' => new StandaloneInteractionContextMenuComponent(
                 new UserRankInteractions(),
                 $this->formObject,
                 LinkHandler::getInstance()->getControllerLink(UserRankListPage::class)
diff --git a/wcfsetup/install/files/lib/system/endpoint/controller/core/interactions/GetBulkContextMenuOptions.class.php b/wcfsetup/install/files/lib/system/endpoint/controller/core/interactions/GetBulkContextMenuOptions.class.php
index 0a58b9fa969..e5abec50c9a 100644
--- a/wcfsetup/install/files/lib/system/endpoint/controller/core/interactions/GetBulkContextMenuOptions.class.php
+++ b/wcfsetup/install/files/lib/system/endpoint/controller/core/interactions/GetBulkContextMenuOptions.class.php
@@ -10,7 +10,7 @@
 use wcf\system\endpoint\IController;
 use wcf\system\endpoint\PostRequest;
 use wcf\system\exception\UserInputException;
-use wcf\system\interaction\bulk\BulkInteractionContextMenuView;
+use wcf\system\interaction\bulk\BulkInteractionContextMenuComponent;
 use wcf\system\interaction\bulk\IBulkInteractionProvider;
 
 /**
@@ -42,10 +42,10 @@ public function __invoke(ServerRequestInterface $request, array $variables): Res
         $list->setObjectIDs($parameters->objectIDs);
         $list->readObjects();
 
-        $view = new BulkInteractionContextMenuView($provider);
+        $component = new BulkInteractionContextMenuComponent($provider);
 
         return new JsonResponse([
-            'template' => $view->renderContextMenuOptions($list->getObjects()),
+            'template' => $component->renderContextMenuOptions($list->getObjects()),
         ]);
     }
 }
diff --git a/wcfsetup/install/files/lib/system/endpoint/controller/core/interactions/GetContextMenuOptions.class.php b/wcfsetup/install/files/lib/system/endpoint/controller/core/interactions/GetContextMenuOptions.class.php
index f8d2f259369..da8ba2d0ca6 100644
--- a/wcfsetup/install/files/lib/system/endpoint/controller/core/interactions/GetContextMenuOptions.class.php
+++ b/wcfsetup/install/files/lib/system/endpoint/controller/core/interactions/GetContextMenuOptions.class.php
@@ -11,7 +11,7 @@
 use wcf\system\endpoint\IController;
 use wcf\system\exception\UserInputException;
 use wcf\system\interaction\IInteractionProvider;
-use wcf\system\interaction\InteractionContextMenuView;
+use wcf\system\interaction\InteractionContextMenuComponent;
 
 /**
  * Retrieves the options for an interaction context menu.
@@ -40,10 +40,10 @@ public function __invoke(ServerRequestInterface $request, array $variables): Res
         $object = new ($provider->getObjectClassName())($parameters->objectID);
         \assert($object instanceof DatabaseObject);
 
-        $view = new InteractionContextMenuView($provider);
+        $contextMenu = new InteractionContextMenuComponent($provider);
 
         return new JsonResponse([
-            'template' => $view->renderContextMenuOptions($object),
+            'template' => $contextMenu->renderContextMenuOptions($object),
         ]);
     }
 }
diff --git a/wcfsetup/install/files/lib/system/gridView/AbstractGridView.class.php b/wcfsetup/install/files/lib/system/gridView/AbstractGridView.class.php
index ca285d91a3d..ee322b79a7a 100644
--- a/wcfsetup/install/files/lib/system/gridView/AbstractGridView.class.php
+++ b/wcfsetup/install/files/lib/system/gridView/AbstractGridView.class.php
@@ -11,7 +11,7 @@
 use wcf\system\interaction\bulk\IBulkInteractionProvider;
 use wcf\system\interaction\IInteraction;
 use wcf\system\interaction\IInteractionProvider;
-use wcf\system\interaction\InteractionContextMenuView;
+use wcf\system\interaction\InteractionContextMenuComponent;
 use wcf\system\request\LinkHandler;
 use wcf\system\WCF;
 use wcf\util\StringUtil;
@@ -64,7 +64,7 @@ abstract class AbstractGridView
     private string|int|null $objectIDFilter = null;
     private ?IInteractionProvider $interactionProvider = null;
     private ?IBulkInteractionProvider $bulkInteractionProvider = null;
-    private InteractionContextMenuView $interactionContextMenuView;
+    private InteractionContextMenuComponent $interactionContextMenuComponent;
 
     /**
      * Adds a new column to the grid view.
@@ -308,17 +308,17 @@ public function renderColumn(GridViewColumn $column, DatabaseObject $row): strin
     /**
      * Returns the view of the interaction context menu.
      */
-    public function getInteractionContextMenuView(): InteractionContextMenuView
+    public function getInteractionContextMenuComponent(): InteractionContextMenuComponent
     {
         if ($this->interactionProvider === null) {
             throw new \BadMethodCallException("Missing interaction provider.");
         }
 
-        if (!isset($this->interactionContextMenuView)) {
-            $this->interactionContextMenuView = new InteractionContextMenuView($this->interactionProvider);
+        if (!isset($this->interactionContextMenuComponent)) {
+            $this->interactionContextMenuComponent = new InteractionContextMenuComponent($this->interactionProvider);
         }
 
-        return $this->interactionContextMenuView;
+        return $this->interactionContextMenuComponent;
     }
 
     /**
@@ -328,7 +328,7 @@ public function renderInteractionInitialization(): string
     {
         $code = '';
         if ($this->interactionProvider !== null) {
-            $code = $this->getInteractionContextMenuView()->renderInitialization($this->getID() . '_table');
+            $code = $this->getInteractionContextMenuComponent()->renderInitialization($this->getID() . '_table');
         }
 
         if ($this->quickInteractions !== []) {
@@ -368,7 +368,7 @@ public function renderInteractionContextMenuButton(DatabaseObject $row): string
             return '';
         }
 
-        return $this->getInteractionContextMenuView()->renderButton($row);
+        return $this->getInteractionContextMenuComponent()->renderButton($row);
     }
 
     /**
diff --git a/wcfsetup/install/files/lib/system/interaction/InteractionContextMenuView.class.php b/wcfsetup/install/files/lib/system/interaction/InteractionContextMenuComponent.class.php
similarity index 91%
rename from wcfsetup/install/files/lib/system/interaction/InteractionContextMenuView.class.php
rename to wcfsetup/install/files/lib/system/interaction/InteractionContextMenuComponent.class.php
index 6b08318d3ed..811e3663aa0 100644
--- a/wcfsetup/install/files/lib/system/interaction/InteractionContextMenuView.class.php
+++ b/wcfsetup/install/files/lib/system/interaction/InteractionContextMenuComponent.class.php
@@ -5,7 +5,15 @@
 use wcf\data\DatabaseObject;
 use wcf\system\WCF;
 
-class InteractionContextMenuView
+/**
+ * Represents the component of an interaction content menu.
+ *
+ * @author      Marcel Werk
+ * @copyright   2001-2025 WoltLab GmbH
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since       6.2
+ */
+class InteractionContextMenuComponent
 {
     public function __construct(
         protected readonly IInteractionProvider $provider
diff --git a/wcfsetup/install/files/lib/system/interaction/StandaloneInteractionContextMenuComponent.class.php b/wcfsetup/install/files/lib/system/interaction/StandaloneInteractionContextMenuComponent.class.php
new file mode 100644
index 00000000000..6198b529256
--- /dev/null
+++ b/wcfsetup/install/files/lib/system/interaction/StandaloneInteractionContextMenuComponent.class.php
@@ -0,0 +1,78 @@
+<?php
+
+namespace wcf\system\interaction;
+
+use wcf\data\DatabaseObject;
+use wcf\system\WCF;
+
+/**
+ * Represents the component of a standalone button for an interaction content menu.
+ *
+ * @author      Marcel Werk
+ * @copyright   2001-2025 WoltLab GmbH
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since       6.2
+ */
+class StandaloneInteractionContextMenuComponent extends InteractionContextMenuComponent
+{
+    public function __construct(
+        IInteractionProvider $provider,
+        protected readonly DatabaseObject $object,
+        protected readonly string $redirectUrl,
+        protected readonly string $label = '',
+        protected readonly string $icon = 'ellipsis-vertical',
+        protected readonly string $cssClassName = '',
+        protected readonly string $buttonCssClassName = ''
+    ) {
+        parent::__construct($provider);
+    }
+
+    public function render(): string
+    {
+        $contextMenuOptions = $this->renderContextMenuOptions($this->object);
+        if (!$contextMenuOptions) {
+            return '';
+        }
+
+        return WCF::getTPL()->render(
+            'wcf',
+            'shared_standaloneInteractionButton',
+            [
+                'contextMenuOptions' => $contextMenuOptions,
+                'initializationCode' => $this->renderInitialization($this->getContainerID()),
+                'containerID' => $this->getContainerID(),
+                'providerClassName' => \get_class($this->provider),
+                'objectID' => $this->object->getObjectID(),
+                'redirectUrl' => $this->redirectUrl,
+                'label' => $this->label,
+                'icon' => $this->icon,
+                'cssClassName' => $this->cssClassName,
+                'buttonCssClassName' => $this->buttonCssClassName,
+            ],
+        );
+    }
+
+    public function getContainerID(): string
+    {
+        $classNamePieces = \explode('\\', \get_class($this->object));
+
+        return \implode('-', $classNamePieces) . '-' . $this->object->getObjectID();
+    }
+
+    public static function forContentHeaderButton(
+        IInteractionProvider $provider,
+        DatabaseObject $object,
+        string $redirectUrl,
+    ): self {
+        return new self($provider, $object, $redirectUrl, icon: 'ellipsis-vertical');
+    }
+
+    public static function forContentInteractionButton(
+        IInteractionProvider $provider,
+        DatabaseObject $object,
+        string $redirectUrl,
+        string $label,
+    ): self {
+        return new self($provider, $object, $redirectUrl, $label, 'pencil', 'contentInteractionButton', 'small');
+    }
+}
diff --git a/wcfsetup/install/files/lib/system/interaction/StandaloneInteractionContextMenuView.class.php b/wcfsetup/install/files/lib/system/interaction/StandaloneInteractionContextMenuView.class.php
deleted file mode 100644
index 4467e805bb5..00000000000
--- a/wcfsetup/install/files/lib/system/interaction/StandaloneInteractionContextMenuView.class.php
+++ /dev/null
@@ -1,40 +0,0 @@
-<?php
-
-namespace wcf\system\interaction;
-
-use wcf\data\DatabaseObject;
-use wcf\system\WCF;
-
-class StandaloneInteractionContextMenuView extends InteractionContextMenuView
-{
-    public function __construct(
-        IInteractionProvider $provider,
-        protected readonly DatabaseObject $object,
-        protected readonly string $redirectUrl
-    ) {
-        parent::__construct($provider);
-    }
-
-    public function render(): string
-    {
-        return WCF::getTPL()->render(
-            'wcf',
-            'shared_standaloneInteractionButton',
-            [
-                'contextMenuOptions' => $this->renderContextMenuOptions($this->object),
-                'initializationCode' => $this->renderInitialization($this->getContainerID()),
-                'containerID' => $this->getContainerID(),
-                'providerClassName' => \get_class($this->provider),
-                'objectID' => $this->object->getObjectID(),
-                'redirectUrl' => $this->redirectUrl,
-            ],
-        );
-    }
-
-    public function getContainerID(): string
-    {
-        $classNamePieces = \explode('\\', \get_class($this->object));
-
-        return \implode('-', $classNamePieces) . '-' . $this->object->getObjectID();
-    }
-}
diff --git a/wcfsetup/install/files/lib/system/interaction/bulk/BulkInteractionContextMenuView.class.php b/wcfsetup/install/files/lib/system/interaction/bulk/BulkInteractionContextMenuComponent.class.php
similarity index 90%
rename from wcfsetup/install/files/lib/system/interaction/bulk/BulkInteractionContextMenuView.class.php
rename to wcfsetup/install/files/lib/system/interaction/bulk/BulkInteractionContextMenuComponent.class.php
index a073215fc55..74350be1bb9 100644
--- a/wcfsetup/install/files/lib/system/interaction/bulk/BulkInteractionContextMenuView.class.php
+++ b/wcfsetup/install/files/lib/system/interaction/bulk/BulkInteractionContextMenuComponent.class.php
@@ -6,7 +6,15 @@
 use wcf\system\interaction\Divider;
 use wcf\system\WCF;
 
-class BulkInteractionContextMenuView
+/**
+ * Represents the component of an bulk interaction content menu.
+ *
+ * @author      Olaf Braun
+ * @copyright   2001-2025 WoltLab GmbH
+ * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since       6.2
+ */
+class BulkInteractionContextMenuComponent
 {
     public function __construct(
         protected readonly IBulkInteractionProvider $provider
diff --git a/wcfsetup/install/files/lib/system/listView/AbstractListView.class.php b/wcfsetup/install/files/lib/system/listView/AbstractListView.class.php
index c43125af780..c0a96a4004a 100644
--- a/wcfsetup/install/files/lib/system/listView/AbstractListView.class.php
+++ b/wcfsetup/install/files/lib/system/listView/AbstractListView.class.php
@@ -10,7 +10,7 @@
 use wcf\system\event\EventHandler;
 use wcf\system\interaction\bulk\IBulkInteractionProvider;
 use wcf\system\interaction\IInteractionProvider;
-use wcf\system\interaction\InteractionContextMenuView;
+use wcf\system\interaction\InteractionContextMenuComponent;
 use wcf\system\listView\filter\IListViewFilter;
 use wcf\system\request\LinkHandler;
 use wcf\system\WCF;
@@ -38,7 +38,7 @@ abstract class AbstractListView
     private string|int|null $objectIDFilter = null;
     private ?IInteractionProvider $interactionProvider = null;
     private ?IBulkInteractionProvider $bulkInteractionProvider = null;
-    private InteractionContextMenuView $interactionContextMenuView;
+    private InteractionContextMenuComponent $interactionContextMenuComponent;
 
     /**
      * @var array<string, string>
@@ -461,7 +461,7 @@ public function renderInteractionInitialization(): string
             return '';
         }
 
-        return $this->getInteractionContextMenuView()->renderInitialization($this->getID() . '_items');
+        return $this->getInteractionContextMenuComponent()->renderInitialization($this->getID() . '_items');
     }
 
     /**
@@ -482,17 +482,17 @@ public function renderBulkInteractionInitialization(): string
     /**
      * Returns the view of the interaction context menu.
      */
-    public function getInteractionContextMenuView(): InteractionContextMenuView
+    public function getInteractionContextMenuComponent(): InteractionContextMenuComponent
     {
         if ($this->interactionProvider === null) {
             throw new \BadMethodCallException("Missing interaction provider.");
         }
 
-        if (!isset($this->interactionContextMenuView)) {
-            $this->interactionContextMenuView = new InteractionContextMenuView($this->interactionProvider);
+        if (!isset($this->interactionContextMenuComponent)) {
+            $this->interactionContextMenuComponent = new InteractionContextMenuComponent($this->interactionProvider);
         }
 
-        return $this->interactionContextMenuView;
+        return $this->interactionContextMenuComponent;
     }
 
     /**
@@ -506,7 +506,7 @@ public function renderInteractionContextMenuButton(DatabaseObject $item): string
             return '';
         }
 
-        return $this->getInteractionContextMenuView()->renderButton($item);
+        return $this->getInteractionContextMenuComponent()->renderButton($item);
     }
 
     /**