Notices (#6)

Author: SebKay

inc/notices.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace WPT;
+
+use WPT\Enums\NoticeType;
+
+function adminNotices()
+{
+    return [
+        NoticeType::Test->value => [
+            'enabled' => \get_option('wpt_notice_for_'.NoticeType::Test->value, false),
+            'type' => 'info',
+            'text' => __('This is a test notice.', 'wp-plugin-template'),
+        ],
+    ];
+}
+
+function toggleAdminNotice(NoticeType $type, $enabled = true)
+{
+    return \update_option("wpt_notice_for_{$type->value}", $enabled);
+}
+
+function displayAdminNotices()
+{
+    $html = '';
+
+    \collect(adminNotices())
+        ->each(function ($notice) use (&$html) {
+            if ($notice['enabled']) {
+                $html .= <<< EOT
+                    <div class='notice notice-{$notice['type']}'>
+                        <p>{$notice['text']}</p>
+                    </div>
+                EOT;
+            }
+        });
+
+    echo $html;
+}
+
+add_action('admin_notices', 'WPT\displayAdminNotices');

src/Crons/CronJob.php

@@ -4,8 +4,11 @@
 
 use SebKay\WPCronable\WPCronable;
 use WPT\Concerns\Instanceable;
+use WPT\Enums\NoticeType;
 use WPT\Processes\BackgroundProcess;
 
+use function WPT\toggleAdminNotice;
+
 class CronJob extends WPCronable
 {
     use Instanceable;
@@ -21,9 +24,13 @@ public function __construct(
     public function run(): void
     {
         try {
+            toggleAdminNotice(NoticeType::Test);
+
             $items = \collect([]);
 
             if ($items->isEmpty()) {
+                toggleAdminNotice(NoticeType::Test, false);
+
                 return;
             }
 
@@ -41,6 +48,8 @@ public function run(): void
 
             $this->process->dispatch();
         } catch (\Exception $e) {
+            toggleAdminNotice(NoticeType::Test, false);
+
             \error_log($e);
 
             \wptPlugin()->logger()->general()->error($e->getMessage());

src/Enums/NoticeType.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace WPT\Enums;
+
+enum NoticeType: string
+{
+    case Test = 'test';
+}

src/Processes/BackgroundProcess.php

@@ -2,6 +2,10 @@
 
 namespace WPT\Processes;
 
+use WPT\Enums\NoticeType;
+
+use function WPT\toggleAdminNotice;
+
 class BackgroundProcess extends \WPT_WP_Background_Process
 {
     protected $action = 'wpt_background_process';
@@ -22,4 +26,18 @@ protected function task($data)
 
         return false;
     }
+
+    public function cancel()
+    {
+        parent::cancel();
+
+        toggleAdminNotice(NoticeType::Test, false);
+    }
+
+    public function complete()
+    {
+        toggleAdminNotice(NoticeType::Test, false);
+
+        parent::complete();
+    }
 }

wordpress-plugin-template.php

@@ -21,6 +21,8 @@
 
 require_once WPT_DIR_PATH.'/vendor/autoload.php';
 
+require_once WPT_DIR_PATH.'/inc/notices.php';
+
 function wptPlugin()
 {
     return WPT\Plugin::instance();