getExampleValue can now return null

Author: eceltov

app/helpers/MetaFormats/Validators/BaseValidator.php

@@ -21,10 +21,11 @@ class BaseValidator
     /**
      * @return string Returns a sample expected value to be validated by the validator.
      *  This value will be used in generated swagger documents.
+     *  Can return null, signalling to the swagger generator to omit the example field.
      */
-    public function getExampleValue()
+    public function getExampleValue(): string | null
     {
-        return "No example provided.";
+        return null;
     }
 
     /**

app/helpers/MetaFormats/Validators/VArray.php

@@ -22,7 +22,7 @@ public function __construct(mixed $nestedValidator = null)
         $this->nestedValidator = $nestedValidator;
     }
 
-    public function getExampleValue()
+    public function getExampleValue(): string | null
     {
         if ($this->nestedValidator !== null) {
             return $this->nestedValidator->getExampleValue();

app/helpers/MetaFormats/Validators/VEmail.php

@@ -13,7 +13,7 @@ public function __construct()
         parent::__construct(1);
     }
 
-    public function getExampleValue()
+    public function getExampleValue(): string
     {
         return "name@domain.tld";
     }

app/helpers/MetaFormats/Validators/VString.php

@@ -26,7 +26,7 @@ public function __construct(int $minLength = 0, int $maxLength = -1, ?string $re
         $this->regex = $regex;
     }
 
-    public function getExampleValue()
+    public function getExampleValue(): string
     {
         return "text";
     }

app/helpers/MetaFormats/Validators/VUuid.php

@@ -12,7 +12,7 @@ public function __construct()
         parent::__construct(regex: "/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/");
     }
 
-    public function getExampleValue()
+    public function getExampleValue(): string
     {
         return "10000000-2000-4000-8000-160000000000";
     }