Add “Publisher Notifications User Group” to optionally specify a user group just for publisher notifications

Author: engram-design

src/controllers/BaseController.php

@@ -22,37 +22,19 @@ public function actionSettings(): Response
     {
         $settings = Workflow::$plugin->getSettings();
 
-        $publishers = [];
+        $userGroups = [
+            ['label' => Craft::t('workflow', 'All Publishers'), 'value' => ''],
+        ];
 
-        if ($settings->publisherUserGroup) {
-            $publisherUserGroup = $settings->publisherUserGroup;
-
-            // Backward-compatibility support for config files, which won't be migrated
-            if (!is_array($publisherUserGroup)) {
-                Craft::$app->getDeprecator()->log('publisherUserGroup', 'The `publisherUserGroup` setting has been updated, and will cause a fatal error in Craft 4. Please review our [docs](https://verbb.io/craft-plugins/workflow/docs/get-started/configuration).');
-
-                $publisherUserGroupUid = $publisherUserGroup;
-                $publisherUserGroup = [];
-
-                foreach (Craft::$app->getSites()->getAllSites() as $site) {
-                    $publisherUserGroup[$site->uid] = $publisherUserGroupUid;
-                }
-            }
-
-            foreach ($publisherUserGroup as $siteUid => $publisherUserGroupUid) {
-                $publisherUserGroupId = Db::idByUid(Table::USERGROUPS, $publisherUserGroupUid);
-
-                foreach (User::find()->groupId($publisherUserGroupId)->all() as $user) {
-                    $publishers[] = ['value' => $user->id, 'label' => (string)$user];
-                }
-            }
+        foreach (Craft::$app->getUserGroups()->getAllGroups() as $userGroup) {
+            $userGroups[] = ['label' => $userGroup->name, 'value' => $userGroup->uid];
         }
 
-        $publishers = array_unique($publishers, SORT_REGULAR);
+        $userGroups = array_unique($userGroups, SORT_REGULAR);
 
         return $this->renderTemplate('workflow/settings', [
             'settings' => $settings,
-            'publishers' => $publishers,
+            'userGroups' => $userGroups,
         ]);
     }
 

src/models/Settings.php

@@ -3,6 +3,7 @@
 
 use Craft;
 use craft\base\Model;
+use craft\elements\User;
 use craft\helpers\ArrayHelper;
 
 class Settings extends Model
@@ -25,11 +26,14 @@ class Settings extends Model
     public bool $reviewerApprovalNotifications = false;
     public bool $publisherNotifications = true;
     public bool $publishedAuthorNotifications = false;
-    public mixed $selectedPublishers = '*';
+    public ?string $publisherNotificationsUserGroup = null;
 
     // Permissions
     public mixed $enabledSections = '*';
 
+    // Deprecated
+    public mixed $selectedPublishers = '*';
+
 
     // Public Methods
     // =========================================================================
@@ -140,6 +144,18 @@ public function getPublisherNotesRequired($site)
         return $this->publisherNotesRequired[$site->uid] ?? false;
     }
 
+    public function getPublishersForNotificationEmail($site): array
+    {
+        // Get the user group for email notifications
+        $publisherGroup = $this->publisherNotificationsUserGroup ?? $this->getPublisherUserGroup($site);
+
+        if (!$publisherGroup) {
+            return [];
+        }
+
+        return User::find()->groupId($publisherGroup->id)->all();
+    }
+
 
     // Private Methods
     // =========================================================================

src/services/Emails.php

@@ -117,20 +117,7 @@ public function sendPublisherNotificationEmail(Submission $submission, Review $r
 
         $settings = Workflow::$plugin->getSettings();
 
-        $publisherGroup = $settings->getPublisherUserGroup($entry->site);
-
-        if (!$publisherGroup) {
-            Workflow::log('No publisher group found to send notifications to.');
-        }
-
-        $query = User::find()->groupId($publisherGroup->id);
-
-        // Check settings to see if we should email all publishers or not
-        if (isset($settings->selectedPublishers) && $settings->selectedPublishers != '*') {
-            $query->id($settings->selectedPublishers);
-        }
-
-        $publishers = $query->all();
+        $publishers = $settings->getPublishersForNotificationEmail($entry->site);
 
         // Fire a 'preparePublisherEmail' event
         $event = new PrepareEmailEvent([

src/templates/settings/_panes/notifications.html

@@ -56,34 +56,15 @@
     warning: macros.configWarning('publisherNotifications', 'workflow'),
 }) }}
 
-{% if settings.publisherUserGroup %}
-    {{ forms.checkboxSelectField({
-        label: 'Publishers To Receive Notifications' | t('workflow'),
-        instructions: 'Select all, or specific publishers to receive email notifications. By default, all will be notified.' | t('workflow'),
-        id: 'selectedPublishers',
-        name: 'selectedPublishers',
-        values: settings.selectedPublishers,
-        options: publishers,
-        showAllOption: true,
-        warning: macros.configWarning('selectedPublishers', 'workflow'),
-    }) }}
-{% else %}
-    <div class="field">
-        <div class="heading">
-            <label>
-                {{ "Publishers To Receive Notifications" | t('workflow') }}
-            </label>
-
-            <div class="instructions">
-                <p>{{ "Select all, or specific publishers to receive email notifications. By default, all will be notified." | t('workflow') }}</p>
-            </div>
-        </div>
-
-        <p class="small warning">
-            {{ "Select a Publisher User Group first." | t('workflow') }}
-        </p>
-    </div>
-{% endif %}
+{{ forms.selectField({
+    label: 'Publisher Notifications User Group' | t('workflow'),
+    instructions: 'By default, all users in the "Publisher User Group" will receive email notifications. Set a specific group to receive email notifications.' | t('workflow'),
+    id: 'publisherNotificationsUserGroup',
+    name: 'publisherNotificationsUserGroup',
+    value: settings.publisherNotificationsUserGroup,
+    options: userGroups,
+    warning: macros.configWarning('publisherNotificationsUserGroup', 'workflow'),
+}) }}
 
 {{ forms.lightswitchField({
     label: 'Published Author Notifications' | t('workflow'),