feat: Let modules inject admin tabs when editing a user group

admin/controllers/Groups.php

@@ -14,12 +14,16 @@
 
 use Nails\Admin\Controller\DefaultController;
 use Nails\Auth\Constants;
+use Nails\Auth\Interfaces\Admin\User\Group\Tab;
 use Nails\Auth\Model\User\Group;
 use Nails\Auth\Model\User\Password;
 use Nails\Common\Exception\ValidationException;
+use Nails\Common\Factory\Component;
 use Nails\Common\Resource;
+use Nails\Common\Service\FormValidation;
 use Nails\Common\Service\Input;
 use Nails\Common\Service\Uri;
+use Nails\Components;
 use Nails\Config;
 use Nails\Factory;
 
@@ -43,6 +47,13 @@ class Groups extends DefaultController
 
     // --------------------------------------------------------------------------
 
+    /**
+     * @var Tab[]
+     */
+    protected array $aGroupTabs = [];
+
+    // --------------------------------------------------------------------------
+
     /**
      * Load data for the edit/create view
      *
@@ -54,6 +65,22 @@ protected function loadEditViewData(?Resource $oItem = null): void
     {
         parent::loadEditViewData($oItem);
 
+        $this->aGroupTabs = [];
+        /** @var Component $oComponent */
+        foreach (Components::available() as $oComponent) {
+            $aClasses = $oComponent
+                ->findClasses('Auth\\Admin\\User\\Group\\Tab')
+                ->whichImplement(Tab::class);
+
+            foreach ($aClasses as $sClass) {
+                if ($sClass::isEnabled($oItem)) {
+                    $this->aGroupTabs[$sClass] = new $sClass();
+                }
+            }
+        }
+
+        $this->data['aGroupTabs'] = $this->aGroupTabs;
+
         //  Get all available permissions
         $this->data['aPermissions'] = [];
         foreach ($this->data['adminControllers'] as $module => $oModuleDetails) {
@@ -107,6 +134,20 @@ protected function runFormValidation(string $sMode, array $aOverrides = []): voi
                 'description' => ['required'],
             ]
         );
+
+        /** @var Input $oInput */
+        $oInput = Factory::service('Input');
+        $aRules = [];
+        /** @var Tab $oTab */
+        foreach ($this->aGroupTabs as $oTab) {
+            $aRules = array_merge($aRules, $oTab->getValidationRules($this->data['item']));
+        }
+
+        if ($aRules) {
+            /** @var FormValidation $oFormValidation */
+            $oFormValidation = Factory::service('FormValidation');
+            $oFormValidation->buildValidator($aRules, [], $oInput->post())->run();
+        }
     }
 
     // --------------------------------------------------------------------------
@@ -125,7 +166,7 @@ protected function getPostObject(): array
         /** @var Password $oUserPasswordModel */
         $oUserPasswordModel = Factory::model('UserPassword', Constants::MODULE_SLUG);
 
-        return [
+        $aData = [
             'slug'                  => $oInput->post('slug'),
             'label'                 => $oInput->post('label'),
             'description'           => $oInput->post('description'),
@@ -134,6 +175,34 @@ protected function getPostObject(): array
             'acl'                   => $oUserGroupModel->processPermissions($oInput->post('acl') ?: []),
             'password_rules'        => $oUserPasswordModel->processRules($oInput->post('pw') ?: []),
         ];
+
+        /** @var Tab $oTab */
+        foreach ($this->aGroupTabs as $oTab) {
+            $aData = array_merge($aData, $oTab->getPostData($this->data['item'], $oInput->post()));
+        }
+
+        return $aData;
+    }
+
+    // --------------------------------------------------------------------------
+
+    protected function afterCreateAndEdit(
+        $sMode,
+        ?Resource $oNewItem,
+        ?Resource $oOldItem = null
+    ): void {
+        parent::afterCreateAndEdit($sMode, $oNewItem, $oOldItem);
+
+        if (!$oNewItem instanceof \Nails\Auth\Resource\User\Group) {
+            return;
+        }
+
+        /** @var Input $oInput */
+        $oInput = Factory::service('Input');
+        /** @var Tab $oTab */
+        foreach ($this->aGroupTabs as $oTab) {
+            $oTab->afterSave($oNewItem, $oInput->post());
+        }
     }
 
     // --------------------------------------------------------------------------

admin/views/Groups/edit.php

@@ -3,6 +3,18 @@
 use Nails\Factory;
 
 $oInput = Factory::service('Input');
+
+$aRenderedGroupTabs = [];
+/** @var \Nails\Auth\Interfaces\Admin\User\Group\Tab $oTab */
+foreach ($aGroupTabs ?? [] as $oTab) {
+    $aRenderedGroupTabs[] = [
+        'id'      => 'tab-extension-' . count($aRenderedGroupTabs),
+        'order'   => $oTab->getOrder(),
+        'label'   => $oTab->getLabel(),
+        'content' => $oTab->getBody($item ?? null),
+    ];
+}
+arraySortMulti($aRenderedGroupTabs, 'order');
 ?>
 <div class="group-accounts groups edit">
     <div class="alert alert-warning">
@@ -22,9 +34,11 @@
         <li class="tab <?=$oInput->post('activeTab') == 'tab-password' ? 'active' : ''?>">
             <a href="#" data-tab="tab-password">Password</a>
         </li>
-        <li class="tab <?=$oInput->post('activeTab') == 'tab-2fa' ? 'active' : ''?>">
-            <a href="#" data-tab="tab-2fa">2FA</a>
-        </li>
+        <?php foreach ($aRenderedGroupTabs as $aTab) { ?>
+            <li class="tab <?=$oInput->post('activeTab') === $aTab['id'] ? 'active' : ''?>">
+                <a href="#" data-tab="<?=htmlspecialchars($aTab['id'])?>"><?=htmlspecialchars($aTab['label'])?></a>
+            </li>
+        <?php } ?>
         <li class="tab <?=$oInput->post('activeTab') == 'tab-permissions' ? 'active' : ''?>">
             <a href="#" data-tab="tab-permissions">Permissions</a>
         </li>
@@ -166,12 +180,11 @@
                 ?>
             </div>
         </div>
-        <!-- 2FA -->
-        <div class="tab-page tab-2fa <?=$oInput->post('activeTab') == 'tab-2fa' ? 'active' : ''?>">
-            <p class="alert alert-warning">
-                Currently, 2FA settings are done at a code-level and apply to all users.
-            </p>
-        </div>
+        <?php foreach ($aRenderedGroupTabs as $aTab) { ?>
+            <div class="tab-page <?=htmlspecialchars($aTab['id'])?> <?=$oInput->post('activeTab') === $aTab['id'] ? 'active' : ''?>">
+                <?=$aTab['content']?>
+            </div>
+        <?php } ?>
         <!--    PERMISSIONS -->
         <div class="tab-page tab-permissions <?=$oInput->post('activeTab') == 'tab-permissions' ? 'active' : ''?>">
             <p>
@@ -280,5 +293,10 @@
     echo \Nails\Admin\Helper::floatingControls($CONFIG['FLOATING_CONFIG']);
     echo form_close();
 
+    /** @var \Nails\Auth\Interfaces\Admin\User\Group\Tab $oTab */
+    foreach ($aGroupTabs ?? [] as $oTab) {
+        echo $oTab->getAdditionalMarkup($item ?? null);
+    }
+
     ?>
 </div>

src/Interfaces/Admin/User/Group/Tab.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Nails\Auth\Interfaces\Admin\User\Group;
+
+use Nails\Auth\Resource\User\Group;
+
+interface Tab
+{
+    public function getLabel(): string;
+
+    // --------------------------------------------------------------------------
+
+    public static function isEnabled(?Group $oGroup): bool;
+
+    // --------------------------------------------------------------------------
+
+    public function getOrder(): ?float;
+
+    // --------------------------------------------------------------------------
+
+    public function getBody(?Group $oGroup): string;
+
+    // --------------------------------------------------------------------------
+
+    public function getAdditionalMarkup(?Group $oGroup): string;
+
+    // --------------------------------------------------------------------------
+
+    public function getValidationRules(?Group $oGroup): array;
+
+    // --------------------------------------------------------------------------
+
+    public function getPostData(?Group $oGroup, array $aPost): array;
+
+    // --------------------------------------------------------------------------
+
+    public function afterSave(Group $oGroup, array $aPost): void;
+}