Add endpoints to disable or enable contact options and recipients

Author: Cyperghost

wcfsetup/install/files/lib/bootstrap/com.woltlab.wcf.php

@@ -249,9 +249,13 @@ static function (\wcf\event\endpoint\ControllerCollecting $event) {
             $event->register(new \wcf\system\endpoint\controller\core\contact\options\DeleteOption());
             $event->register(new \wcf\system\endpoint\controller\core\contact\options\ChangeShowOrder());
             $event->register(new \wcf\system\endpoint\controller\core\contact\options\GetShowOrder());
+            $event->register(new \wcf\system\endpoint\controller\core\contact\options\DisableOption());
+            $event->register(new \wcf\system\endpoint\controller\core\contact\options\EnableOption());
             $event->register(new \wcf\system\endpoint\controller\core\contact\recipients\DeleteRecipient());
             $event->register(new \wcf\system\endpoint\controller\core\contact\recipients\ChangeShowOrder());
             $event->register(new \wcf\system\endpoint\controller\core\contact\recipients\GetShowOrder());
+            $event->register(new \wcf\system\endpoint\controller\core\contact\recipients\DisableRecipient());
+            $event->register(new \wcf\system\endpoint\controller\core\contact\recipients\EnableRecipient());
         }
     );
 

wcfsetup/install/files/lib/data/contact/option/ContactOptionAction.class.php

@@ -4,6 +4,7 @@
 
 use wcf\data\AbstractDatabaseObjectAction;
 use wcf\data\ISortableAction;
+use wcf\data\TDatabaseObjectToggle;
 use wcf\data\TI18nDatabaseObjectAction;
 use wcf\system\exception\UserInputException;
 use wcf\system\WCF;
@@ -21,6 +22,7 @@
 class ContactOptionAction extends AbstractDatabaseObjectAction implements ISortableAction
 {
     use TI18nDatabaseObjectAction;
+    use TDatabaseObjectToggle;
 
     /**
      * @inheritDoc
@@ -45,7 +47,7 @@ class ContactOptionAction extends AbstractDatabaseObjectAction implements ISorta
     /**
      * @inheritDoc
      */
-    protected $requireACP = ['create', 'delete', 'update', 'updatePosition'];
+    protected $requireACP = ['create', 'delete', 'update', 'updatePosition', 'toggle'];
 
     /**
      * @inheritDoc

wcfsetup/install/files/lib/system/endpoint/controller/core/contact/options/DisableOption.class.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace wcf\system\endpoint\controller\core\contact\options;
+
+use Laminas\Diactoros\Response\JsonResponse;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use wcf\data\contact\option\ContactOption;
+use wcf\data\contact\option\ContactOptionAction;
+use wcf\http\Helper;
+use wcf\system\endpoint\IController;
+use wcf\system\endpoint\PostRequest;
+use wcf\system\exception\IllegalLinkException;
+use wcf\system\WCF;
+
+/**
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.2
+ */
+#[PostRequest("/core/contact/options/{id:\d+}/disable")]
+final class DisableOption implements IController
+{
+    public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface
+    {
+        $this->assertOptionCanBeDisabled();
+
+        $option = Helper::fetchObjectFromRequestParameter($variables['id'], ContactOption::class);
+
+        if (!$option->isDisabled) {
+            (new ContactOptionAction([$option], 'toggle'))->executeAction();
+        }
+
+        return new JsonResponse([]);
+    }
+
+    private function assertOptionCanBeDisabled(): void
+    {
+        if (!\MODULE_CONTACT_FORM) {
+            throw new IllegalLinkException();
+        }
+
+        WCF::getSession()->checkPermissions(["admin.contact.canManageContactForm"]);
+    }
+}

wcfsetup/install/files/lib/system/endpoint/controller/core/contact/options/EnableOption.class.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace wcf\system\endpoint\controller\core\contact\options;
+
+use Laminas\Diactoros\Response\JsonResponse;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use wcf\data\contact\option\ContactOption;
+use wcf\data\contact\option\ContactOptionAction;
+use wcf\http\Helper;
+use wcf\system\endpoint\IController;
+use wcf\system\endpoint\PostRequest;
+use wcf\system\exception\IllegalLinkException;
+use wcf\system\WCF;
+
+/**
+ * API endpoint for enabling a contact option.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.2
+ */
+#[PostRequest("/core/contact/options/{id:\d+}/enable")]
+final class EnableOption implements IController
+{
+    public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface
+    {
+        $this->assertOptionCanBeEnabled();
+
+        $option = Helper::fetchObjectFromRequestParameter($variables['id'], ContactOption::class);
+
+        if ($option->isDisabled) {
+            (new ContactOptionAction([$option], 'toggle'))->executeAction();
+        }
+
+        return new JsonResponse([]);
+    }
+
+    private function assertOptionCanBeEnabled(): void
+    {
+        if (!\MODULE_CONTACT_FORM) {
+            throw new IllegalLinkException();
+        }
+
+        WCF::getSession()->checkPermissions(["admin.contact.canManageContactForm"]);
+    }
+}

wcfsetup/install/files/lib/system/endpoint/controller/core/contact/recipients/DisableRecipient.class.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace wcf\system\endpoint\controller\core\contact\recipients;
+
+use Laminas\Diactoros\Response\JsonResponse;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use wcf\data\contact\recipient\ContactRecipient;
+use wcf\data\contact\recipient\ContactRecipientAction;
+use wcf\http\Helper;
+use wcf\system\endpoint\IController;
+use wcf\system\endpoint\PostRequest;
+use wcf\system\exception\IllegalLinkException;
+use wcf\system\WCF;
+
+/**
+ * API endpoint for disabling a contact recipient.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.2
+ */
+#[PostRequest("/core/contact/recipients/{id:\d+}/disable")]
+final class DisableRecipient implements IController
+{
+    public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface
+    {
+        $this->assertRecipientCanBeDisabled();
+
+        $recipient = Helper::fetchObjectFromRequestParameter($variables['id'], ContactRecipient::class);
+
+        if (!$recipient->isDisabled) {
+            (new ContactRecipientAction([$recipient], 'toggle'))->executeAction();
+        }
+
+        return new JsonResponse([]);
+    }
+
+    private function assertRecipientCanBeDisabled(): void
+    {
+        if (!\MODULE_CONTACT_FORM) {
+            throw new IllegalLinkException();
+        }
+
+        WCF::getSession()->checkPermissions(["admin.contact.canManageContactForm"]);
+    }
+}

wcfsetup/install/files/lib/system/endpoint/controller/core/contact/recipients/EnableRecipient.class.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace wcf\system\endpoint\controller\core\contact\recipients;
+
+use Laminas\Diactoros\Response\JsonResponse;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use wcf\data\contact\recipient\ContactRecipient;
+use wcf\data\contact\recipient\ContactRecipientAction;
+use wcf\http\Helper;
+use wcf\system\endpoint\IController;
+use wcf\system\endpoint\PostRequest;
+use wcf\system\exception\IllegalLinkException;
+use wcf\system\WCF;
+
+/**
+ * API endpoint for enabling a contact recipient.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.2
+ */
+#[PostRequest("/core/contact/recipients/{id:\d+}/enable")]
+final class EnableRecipient implements IController
+{
+    public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface
+    {
+        $this->assertRecipientCanBeEnabled();
+
+        $recipient = Helper::fetchObjectFromRequestParameter($variables['id'], ContactRecipient::class);
+
+        if ($recipient->isDisabled) {
+            (new ContactRecipientAction([$recipient], 'toggle'))->executeAction();
+        }
+
+        return new JsonResponse([]);
+    }
+
+    private function assertRecipientCanBeEnabled(): void
+    {
+        if (!\MODULE_CONTACT_FORM) {
+            throw new IllegalLinkException();
+        }
+
+        WCF::getSession()->checkPermissions(["admin.contact.canManageContactForm"]);
+    }
+}

wcfsetup/install/files/lib/system/gridView/admin/ContactOptionGridView.class.php

@@ -20,6 +20,7 @@
 use wcf\system\interaction\admin\ContactOptionInteractions;
 use wcf\system\interaction\Divider;
 use wcf\system\interaction\EditInteraction;
+use wcf\system\interaction\ToggleInteraction;
 use wcf\system\WCF;
 
 /**
@@ -66,6 +67,14 @@ public function __construct()
         ]);
         $this->setInteractionProvider($provider);
 
+        $this->addQuickInteraction(
+            new ToggleInteraction(
+                "isDisabled",
+                "core/contact/options/%s/enable",
+                "core/contact/options/%s/disable"
+            )
+        );
+
         $this->addRowLink(new GridViewRowLink(ContactOptionEditForm::class));
 
         $this->setSortField("showOrder");

wcfsetup/install/files/lib/system/gridView/admin/ContactRecipientGridView.class.php

@@ -19,6 +19,7 @@
 use wcf\system\interaction\admin\ContactRecipientInteractions;
 use wcf\system\interaction\Divider;
 use wcf\system\interaction\EditInteraction;
+use wcf\system\interaction\ToggleInteraction;
 use wcf\system\WCF;
 
 /**
@@ -64,6 +65,13 @@ public function __construct()
             new EditInteraction(ContactRecipientEditForm::class),
         ]);
         $this->setInteractionProvider($provider);
+        $this->addQuickInteraction(
+            new ToggleInteraction(
+                "isDisabled",
+                "core/contact/recipients/%s/enable",
+                "core/contact/recipients/%s/disable"
+            )
+        );
 
         $this->addRowLink(new GridViewRowLink(ContactRecipientEditForm::class));