add documentation URL option to setting modals

Author: OrdinaryJellyfish

docs/src/content/docs/guides/creating-a-module.mdx

@@ -41,9 +41,41 @@ class MyModule implements ModuleInterface
     return [];
   }
 
-  public function handle(array $data, Post $post, User $user)
+  public function handle(Post $post, User $user)
   {
     // Do something with the data
   }
 }
+```
+
+## Module Actions
+
+### Flagging a Post
+
+To flag a post within your module, use the `ModuleUtils` class:
+
+```php
+// MyModule.php
+use OrdinaryJellyfish\Sentra\ModuleUtils;
+use OrdinaryJellyfish\Sentra\Modules\ModuleInterface;
+
+class MyModule implements ModuleInterface
+{
+  private ModuleUtils $utils;
+
+  public function __construct(ModuleUtils $utils)
+  {
+    $this->utils = $utils;
+  }
+
+  public function getDependencies(): array
+  {
+    return [];
+  }
+
+  public function handle(Post $post, User $user)
+  {
+    $this->utils->unapproveAndFlag($post, 'Short Reason', 'Optional Details');
+  }
+}
 ```

js/src/admin/components/ModuleModal.tsx

@@ -24,6 +24,7 @@ import Switch from 'flarum/common/components/Switch';
 export default class ModuleModal extends SettingsModal {
   static isDismissible = true;
   key = '';
+  docUrl: string | null = null;
 
   className() {
     return 'Modal--large';
@@ -54,6 +55,11 @@ export default class ModuleModal extends SettingsModal {
     return (
       <div className="Modal-body">
         <p className="helpText">{this.helpText()}</p>
+        {this.docUrl && (
+          <a className="Button Button--primary" style="margin-bottom:10px" icon="fas fa-book" href={this.docUrl} external={true} target="_blank">
+            {app.translator.trans('ordinaryjellyfish-sentra.admin.view_documentation')}
+          </a>
+        )}
         {requiredServices.length > 0 && (
           <p>
             {app.translator.trans('ordinaryjellyfish-sentra.admin.modules.requires', {

js/src/admin/components/PostShieldModal.tsx

@@ -22,6 +22,7 @@ import Select from 'flarum/common/components/Select';
 
 export default class PostShieldModal extends ModuleModal {
   key = 'post_shield';
+  docUrl = 'https://sentra.ordinaryjellyfish.xyz';
 
   dependencies() {
     return ['content_safety'];

js/src/admin/components/ServiceModal.tsx

@@ -23,6 +23,7 @@ import Switch from 'flarum/common/components/Switch';
 export default class ServiceModal extends SettingsModal {
   static isDismissible = true;
   key = '';
+  docUrl: string | null = null;
 
   className() {
     return 'Modal--large';
@@ -43,6 +44,11 @@ export default class ServiceModal extends SettingsModal {
     return (
       <div className="Modal-body">
         <p className="helpText">{this.helpText()}</p>
+        {this.docUrl && (
+          <a className="Button Button--primary" style="margin-bottom:10px" icon="fas fa-book" href={this.docUrl} external={true} target="_blank">
+            {app.translator.trans('ordinaryjellyfish-sentra.admin.view_documentation')}
+          </a>
+        )}
         <div className="Form">
           <div className="Form-group">
             <Switch state={!!value && value !== '0'} onchange={this.settings[setting]}>

locale/en.yml

@@ -2,6 +2,7 @@ ordinaryjellyfish-sentra:
   # For more details on the format
   # Checkout https://docs.flarum.org/2.x/extend/i18n/#appendix-a-standard-key-format
   admin:
+    view_documentation: View Documentation
     api_key: API Key
     endpoint: Endpoint
     enable: Enable