copy django message semantics

Author: simonLeary42

resources/lib/UnityHTTPD.php

@@ -6,11 +6,13 @@
 use UnityWebPortal\lib\exceptions\ArrayKeyException;
 use RuntimeException;
 
-enum UnityHTTPDMessageSeverity: string
+enum UnityHTTPDMessageLevel: string
 {
+    case DEBUG = "debug";
     case INFO = "info";
-    case GOOD = "good";
-    case BAD = "bad";
+    case SUCCESS = "success";
+    case WARNING = "warning";
+    case ERROR = "error";
 }
 
 class UnityHTTPD
@@ -206,22 +208,30 @@ public static function alert(string $message): void
         echo "<script type='text/javascript'>alert(" . \jsonEncode($message) . ");</script>";
     }
 
-    public static function message(string $title, string $body, UnityHTTPDMessageSeverity $severity)
+    public static function message(string $title, string $body, UnityHTTPDMessageLevel $level)
     {
-        array_push($_SESSION["messages"], [$title, $body, $severity]);
+        array_push($_SESSION["messages"], [$title, $body, $level]);
     }
 
-    public static function messageGood(string $title, string $body)
+    public static function messageDebug(string $title, string $body)
     {
-        return self::message($title, $body, UnityHTTPDMessageSeverity::GOOD);
+        return self::message($title, $body, UnityHTTPDMessageLevel::DEBUG);
     }
-    public static function messageBad(string $title, string $body)
+    public static function messageInfo(string $title, string $body)
     {
-        return self::message($title, $body, UnityHTTPDMessageSeverity::BAD);
+        return self::message($title, $body, UnityHTTPDMessageLevel::INFO);
     }
-    public static function messageInfo(string $title, string $body)
+    public static function messageSuccess(string $title, string $body)
+    {
+        return self::message($title, $body, UnityHTTPDMessageLevel::SUCCESS);
+    }
+    public static function messageWarning(string $title, string $body)
+    {
+        return self::message($title, $body, UnityHTTPDMessageLevel::WARNING);
+    }
+    public static function messageError(string $title, string $body)
     {
-        return self::message($title, $body, UnityHTTPDMessageSeverity::INFO);
+        return self::message($title, $body, UnityHTTPDMessageLevel::ERROR);
     }
 
     public static function getMessages()
@@ -248,11 +258,11 @@ public static function clearMessages()
     public static function exportMessagesHTML()
     {
         $output = "";
-        foreach (self::getMessages() as [$title, $body, $severity]) {
+        foreach (self::getMessages() as [$title, $body, $level]) {
             $title_stripped = strip_tags($title);
             $body_stripped = strip_tags($body);
-            $severity_str = $severity->value;
-            $output .= "<div class='message $severity_str'><h2>$title_stripped</h2><p>$body_stripped</p></div>\n";
+            $level_str = $level->value;
+            $output .= "<div class='message $level_str'><h2>$title_stripped</h2><p>$body_stripped</p></div>\n";
         }
         return $output;
     }

test/functional/PIMemberRequestTest.php

@@ -1,7 +1,7 @@
 <?php
 
 use PHPUnit\Framework\TestCase;
-use UnityWebPortal\lib\UnityHTTPDMessageSeverity;
+use UnityWebPortal\lib\UnityHTTPDMessageLevel;
 use UnityWebPortal\lib\UnitySQL;
 use UnityWebPortal\lib\UnityHTTPD;
 
@@ -49,7 +49,7 @@ public function testRequestMembership()
             $this->requestMembership("asdlkjasldkj");
             assertMessageExists(
                 $this,
-                UnityHTTPDMessageSeverity::BAD,
+                UnityHTTPDMessageLevel::ERROR,
                 "/.*/",
                 "/^This PI doesn't exist$/",
             );

test/phpunit-bootstrap.php

@@ -26,7 +26,7 @@
 
 use UnityWebPortal\lib\UnityGroup;
 use UnityWebPortal\lib\UnityHTTPD;
-use UnityWebPortal\lib\UnityHTTPDMessageSeverity;
+use UnityWebPortal\lib\UnityHTTPDMessageLevel;
 use PHPUnit\Framework\TestCase;
 
 $_SERVER["HTTP_HOST"] = "phpunit"; // used for config override
@@ -329,14 +329,14 @@ function getAdminUser()
 
 function assertMessageExists(
     TestCase $test_case,
-    UnityHTTPDMessageSeverity $severity,
+    UnityHTTPDMessageLevel $level,
     string $title_regex,
     string $body_regex,
 ) {
     $messages = UnityHTTPD::getMessages();
     $error_msg = sprintf(
-        "message(severity='%s' title_regex='%s' body_regex='%s'), not found. found messages: %s",
-        $severity->value,
+        "message(level='%s' title_regex='%s' body_regex='%s'), not found. found messages: %s",
+        $level->value,
         $title_regex,
         $body_regex,
         jsonEncode($messages),
@@ -346,9 +346,9 @@ function assertMessageExists(
         $messages_with_title,
         fn($x) => preg_match($body_regex, $x[1]),
     );
-    $messages_with_title_and_body_and_severity = array_filter(
+    $messages_with_title_and_body_and_level = array_filter(
         $messages_with_title_and_body,
-        fn($x) => $x[2] == $severity,
+        fn($x) => $x[2] == $level,
     );
-    $test_case->assertNotEmpty($messages_with_title_and_body_and_severity, $error_msg);
+    $test_case->assertNotEmpty($messages_with_title_and_body_and_level, $error_msg);
 }

webroot/panel/groups.php

@@ -45,17 +45,17 @@
                     }
                 }
                 $pi_account->newUserRequest($USER);
-                UnityHTTPD::messageGood("Group Membership Request Submitted", "");
+                UnityHTTPD::messageSuccess("Group Membership Request Submitted", "");
                 UnityHTTPD::redirect();
                 break;
             case "removePIForm":
                 $pi_account->removeUser($USER);
-                UnityHTTPD::messageGood("Group Membership Removed", "");
+                UnityHTTPD::messageSuccess("Group Membership Removed", "");
                 UnityHTTPD::redirect();
                 break;
             case "cancelPIForm":
                 $pi_account->cancelGroupJoinRequest($USER);
-                UnityHTTPD::messageGood("Group Membership Request Cancelled", "");
+                UnityHTTPD::messageSuccess("Group Membership Request Cancelled", "");
                 UnityHTTPD::redirect();
                 break;
         }