Some minor adjustments for config panel

magicsunday · Nov 25, 2023 · 2681acb · 2681acb
1 parent a7282e4
commit 2681acb
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 29 deletions.
diff --git a/resources/views/modules/pedigree-chart/config.phtml b/resources/views/modules/pedigree-chart/config.phtml
@@ -1,5 +1,12 @@
 <?php
 
+/**
+ * This file is part of the package magicsunday/webtrees-pedigree-chart.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE file distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 use Fisharebest\Webtrees\Http\RequestHandlers\ControlPanel;
@@ -9,29 +16,37 @@ use MagicSunday\Webtrees\PedigreeChart\Configuration;
 
 /**
  * @var Configuration $configuration
- * @var string $moduleName
- * @var string $title
+ * @var string        $moduleName
+ * @var string        $title
+ * @var string        $description
  */
-
 ?>
 
 <?= view('components/breadcrumbs', ['links' => [route(ControlPanel::class) => I18N::translate('Control panel'), route(ModulesAllPage::class) => I18N::translate('Modules'), $title]]) ?>
 
 <h1><?= $title ?></h1>
+<p><?= $description ?></p>
 
 <form method="post">
-    <?= view($moduleName.'::modules/pedigree-chart/form/generations', ['configuration' => $configuration]) ?>
-
-    <?= view($moduleName.'::modules/pedigree-chart/form/orientation', ['configuration' => $configuration]) ?>
-
-    <button type="submit" class="btn btn-primary">
-        <?= I18N::translate('save') ?>
-    </button>
-
-    <a href="<?= route(ControlPanel::class) ?>" class="btn btn-secondary">
-        <?= view('icons/cancel') ?>
-        <?= I18N::translate('cancel') ?>
-    </a>
+    <div class="mb-3">
+        <?= view($moduleName.'::modules/pedigree-chart/form/generations', ['configuration' => $configuration]) ?>
+    </div>
+    <div class="mb-3">
+        <?= view($moduleName.'::modules/pedigree-chart/form/orientation', ['configuration' => $configuration]) ?>
+    </div>
+
+    <div class="row mb-3">
+        <div class="offset-sm-3 col-sm-9">
+            <button type="submit" class="btn btn-primary">
+                <?= I18N::translate('save') ?>
+            </button>
+
+            <a href="<?= route(ControlPanel::class) ?>" class="btn btn-secondary">
+                <?= view('icons/cancel') ?>
+                <?= I18N::translate('cancel') ?>
+            </a>
+        </div>
+    </div>
 
     <?= csrf_field() ?>
 </form>
diff --git a/resources/views/modules/pedigree-chart/form/generations.phtml b/resources/views/modules/pedigree-chart/form/generations.phtml
@@ -1,5 +1,12 @@
 <?php
 
+/**
+ * This file is part of the package magicsunday/webtrees-pedigree-chart.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE file distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 use Fisharebest\Webtrees\I18N;
@@ -8,7 +15,6 @@ use MagicSunday\Webtrees\PedigreeChart\Configuration;
 /**
  * @var Configuration $configuration
  */
-
 ?>
 
 <div class="form-group row">

diff --git a/resources/views/modules/pedigree-chart/form/orientation.phtml b/resources/views/modules/pedigree-chart/form/orientation.phtml
@@ -1,5 +1,12 @@
 <?php
 
+/**
+ * This file is part of the package magicsunday/webtrees-pedigree-chart.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE file distributed with this source code.
+ */
+
 declare(strict_types=1);
 
 use Fisharebest\Webtrees\I18N;
@@ -8,7 +15,6 @@ use MagicSunday\Webtrees\PedigreeChart\Configuration;
 /**
  * @var Configuration $configuration
  */
-
 ?>
 
 <div class="form-group row">

diff --git a/resources/views/modules/pedigree-chart/page.phtml b/resources/views/modules/pedigree-chart/page.phtml
@@ -52,7 +52,6 @@ use MagicSunday\Webtrees\PedigreeChart\Configuration;
         </div>
 
         <?= view($moduleName.'::modules/pedigree-chart/form/generations', ['configuration' => $configuration]) ?>
-
         <?= view($moduleName.'::modules/pedigree-chart/form/orientation', ['configuration' => $configuration]) ?>
 
         <div class="collapse" id="showMoreOptions">

diff --git a/src/Configuration.php b/src/Configuration.php
@@ -100,10 +100,16 @@ public function getGenerations(): int
         } else {
             $validator = Validator::queryParams($this->request);
         }
+
         return $validator
             ->isBetween(self::MIN_GENERATIONS, self::MAX_GENERATIONS)
-            ->integer('generations', (int) $this->module->getPreference('default_generations',
-                (string) self::DEFAULT_GENERATIONS));
+            ->integer(
+                'generations',
+                (int) $this->module->getPreference(
+                    'default_generations',
+                    (string) self::DEFAULT_GENERATIONS
+                )
+            );
     }
 
     /**
@@ -147,9 +153,18 @@ public function getLayout(): string
         }
 
         return $validator
-            ->isInArray([self::LAYOUT_BOTTOMTOP, self::LAYOUT_LEFTRIGHT, self::LAYOUT_RIGHTLEFT,
-                self::LAYOUT_TOPBOTTOM])
-            ->string('layout', $this->module->getPreference('default_tree_layout',
-                self::DEFAULT_TREE_LAYOUT));
+            ->isInArray([
+                self::LAYOUT_BOTTOMTOP,
+                self::LAYOUT_LEFTRIGHT,
+                self::LAYOUT_RIGHTLEFT,
+                self::LAYOUT_TOPBOTTOM,
+            ])
+            ->string(
+                'layout',
+                $this->module->getPreference(
+                    'default_tree_layout',
+                    self::DEFAULT_TREE_LAYOUT
+                )
+            );
     }
 }
diff --git a/src/Traits/ModuleConfigTrait.php b/src/Traits/ModuleConfigTrait.php
@@ -4,7 +4,7 @@
  * This file is part of the package magicsunday/webtrees-pedigree-chart.
  *
  * For the full copyright and license information, please read the
- * LICENSE file that was distributed with this source code.
+ * LICENSE file distributed with this source code.
  */
 
 declare(strict_types=1);
@@ -13,7 +13,6 @@
 
 use Fisharebest\Webtrees\FlashMessages;
 use Fisharebest\Webtrees\I18N;
-use Fisharebest\Webtrees\Validator;
 use MagicSunday\Webtrees\PedigreeChart\Configuration;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -30,6 +29,8 @@ trait ModuleConfigTrait
     use \Fisharebest\Webtrees\Module\ModuleConfigTrait;
 
     /**
+     * @param ServerRequestInterface $request
+     *
      * @return ResponseInterface
      */
     public function getAdminAction(ServerRequestInterface $request): ResponseInterface
@@ -41,7 +42,8 @@ public function getAdminAction(ServerRequestInterface $request): ResponseInterfa
             [
                 'configuration' => new Configuration($request, $this),
                 'moduleName'    => $this->name(),
-                'title'         => self::title(),
+                'title'         => $this->title(),
+                'description'   => $this->description(),
             ]
         );
     }
@@ -58,8 +60,13 @@ public function postAdminAction(ServerRequestInterface $request): ResponseInterf
         $this->setPreference('default_generations', (string) $configuration->getGenerations());
         $this->setPreference('default_tree_layout', $configuration->getLayout());
 
-        FlashMessages::addMessage(I18N::translate('The preferences for the module “%s” have been updated.',
-            $this->title()), 'success');
+        FlashMessages::addMessage(
+            I18N::translate(
+                'The preferences for the module “%s” have been updated.',
+                $this->title()
+            ),
+            'success'
+        );
 
         return redirect($this->getConfigLink());
     }