Dev: Define the Security and Validation exception.

Author: ping-yee

system/Security/Exceptions/SecurityException.php

@@ -16,20 +16,35 @@
 
 class SecurityException extends FrameworkException implements HTTPExceptionInterface
 {
-    public static function forDisallowedAction(): self
+    /**
+     * Throws when some specific is not allowed.
+     *
+     * @return static
+     */
+    public static function forDisallowedAction()
     {
         return new static(lang('Security.disallowedAction'), 403);
     }
 
-    public static function forInvalidUTF8Chars(string $source, string $string): self
+    /**
+     * Throws when the source string contains invalid UTF-8 characters.
+     *
+     * @return static
+     */
+    public static function forInvalidUTF8Chars(string $source, string $string)
     {
         return new static(
             'Invalid UTF-8 characters in ' . $source . ': ' . $string,
             400
         );
     }
 
-    public static function forInvalidControlChars(string $source, string $string): self
+    /**
+     * Throws when the source string contains invalid control characters.
+     *
+     * @return static
+     */
+    public static function forInvalidControlChars(string $source, string $string)
     {
         return new static(
             'Invalid Control characters in ' . $source . ': ' . $string,
@@ -41,8 +56,10 @@ public static function forInvalidControlChars(string $source, string $string): s
      * @deprecated Use `CookieException::forInvalidSameSite()` instead.
      *
      * @codeCoverageIgnore
+     *
+     * @return static
      */
-    public static function forInvalidSameSite(string $samesite): self
+    public static function forInvalidSameSite(string $samesite)
     {
         return new static(lang('Security.invalidSameSite', [$samesite]));
     }

system/Validation/Exceptions/ValidationException.php

@@ -15,27 +15,52 @@
 
 class ValidationException extends FrameworkException
 {
-    public static function forRuleNotFound(?string $rule = null): ValidationException
+    /**
+     * Throws when the validation rule is not found.
+     *
+     * @return static
+     */
+    public static function forRuleNotFound(?string $rule = null)
     {
         return new static(lang('Validation.ruleNotFound', [$rule]));
     }
 
-    public static function forGroupNotFound(?string $group = null): ValidationException
+    /**
+     * Throws when the group value of config is not isset.
+     *
+     * @return static
+     */
+    public static function forGroupNotFound(?string $group = null)
     {
         return new static(lang('Validation.groupNotFound', [$group]));
     }
 
-    public static function forGroupNotArray(?string $group = null): ValidationException
+    /**
+     * Throws when the group value of config is not array type.
+     *
+     * @return static
+     */
+    public static function forGroupNotArray(?string $group = null)
     {
         return new static(lang('Validation.groupNotArray', [$group]));
     }
 
-    public static function forInvalidTemplate(?string $template = null): ValidationException
+    /**
+     * Throws when the template of config is invalid.
+     *
+     * @return static
+     */
+    public static function forInvalidTemplate(?string $template = null)
     {
         return new static(lang('Validation.invalidTemplate', [$template]));
     }
 
-    public static function forNoRuleSets(): ValidationException
+    /**
+     * Throws when there is no any rule set.
+     *
+     * @return static
+     */
+    public static function forNoRuleSets()
     {
         return new static(lang('Validation.noRuleSets'));
     }