Settings page

Author: brandonkelly

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 ### Added
+- Added a settings page in the control panel.
 - Webhook URLs can now be set to environment variables or Twig code. ([#18](https://github.com/craftcms/webhooks/issues/18))
 - Webhooks can now send PUT requests. ([#21](https://github.com/craftcms/webhooks/issues/21))
 

src/Plugin.php

@@ -65,6 +65,11 @@ class Plugin extends \craft\base\Plugin
      */
     const EVENT_REGISTER_FILTER_TYPES = 'registerFilterTypes';
 
+    /**
+     * @inheritdoc
+     */
+    public $hasCpSettings = true;
+
     /**
      * @inheritdoc
      */
@@ -189,6 +194,16 @@ public function init()
         });
     }
 
+    /**
+     * @inheritdoc
+     */
+    protected function settingsHtml()
+    {
+        return Craft::$app->getView()->renderTemplate('webhooks/_settings', [
+            'settings' => $this->getSettings(),
+        ]);
+    }
+
     /**
      * @inheritdoc
      */

src/Settings.php

@@ -21,4 +21,15 @@ class Settings extends Model
      * @var int The time delay in seconds between request attempts.
      */
     public $attemptDelay = 60;
+
+    /**
+     * @inheritdoc
+     */
+    protected function defineRules(): array
+    {
+        return [
+            [['maxDepth', 'maxAttempts'], 'number', 'integerOnly' => true, 'min' => 1],
+            [['attemptDelay'], 'number', 'integerOnly' => true, 'min' => 0],
+        ];
+    }
 }

src/templates/_settings.twig

@@ -0,0 +1,31 @@
+{% import '_includes/forms' as forms %}
+
+{{ forms.textField({
+    first: true,
+    id: 'max-depth',
+    label: 'Max Payload Depth'|t('webhooks'),
+    instructions: 'The maximum depth that the plugin should go into objects/arrays when converting them to arrays for event payloads.'|t('webhooks'),
+    size: 5,
+    name: 'maxDepth',
+    value: settings.maxDepth,
+}) }}
+
+{{ forms.textField({
+    first: true,
+    id: 'max-attempts',
+    label: 'Max Attempts'|t('webhooks'),
+    instructions: 'The maximum number of request attempts that should be made.'|t('webhooks'),
+    size: 5,
+    name: 'maxAttempts',
+    value: settings.maxAttempts,
+}) }}
+
+{{ forms.textField({
+    first: true,
+    id: 'attempt-delay',
+    label: 'Attempt Delay'|t('webhooks'),
+    instructions: 'The time delay in seconds between request attempts.'|t('webhooks'),
+    size: 5,
+    name: 'attemptDelay',
+    value: settings.attemptDelay,
+}) }}