feat: Use custom messages for messaging when defined (#99)

* feat: Use custom messages for messaging when defined * chore: Use annotations to configure validation messages * Add messages with priority --------- Co-authored-by: Saul Wilcox <[email protected]>
dvsa · Mar 20, 2024 · acfbaa8 · acfbaa8
1 parent 899237e
commit acfbaa8
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 4 deletions.
diff --git a/module/Olcs/src/Form/Model/Fieldset/Message/CreateInput.php b/module/Olcs/src/Form/Model/Fieldset/Message/CreateInput.php
@@ -10,6 +10,7 @@
 use Laminas\Form\Annotation as Form;
 use Laminas\Form\Element\Textarea;
 use Laminas\Validator\StringLength;
+use Laminas\Validator\NotEmpty;
 use Olcs\Service\Data\MessagingAppOrLicNo;
 
 class CreateInput
@@ -25,7 +26,13 @@ class CreateInput
      *     "class": "govuk-select"
      * })
      * @Form\Type(DynamicSelect::class)
-     * @Form\Required(true)
+     * @Form\Validator(NotEmpty::class,
+     *      options={
+     *          "messages":{NotEmpty::IS_EMPTY:"messaging.form.message.subject.empty.error_message"},
+     *      },
+     *      breakChainOnFailure=true,
+     *      priority=100,
+     * )
      */
     public ?DynamicSelect $messageSubject = null;
 
@@ -41,7 +48,13 @@ class CreateInput
      *     "class": "govuk-select"
      * })
      * @Form\Type(DynamicSelect::class)
-     * @Form\Required(true)
+     * * @Form\Validator(NotEmpty::class,
+     *      options={
+     *          "messages":{NotEmpty::IS_EMPTY:"messaging.form.message.app_or_lic_no.empty.error_message"},
+     *      },
+     *      breakChainOnFailure=true,
+     *      priority=100,
+     * )
      */
     public ?DynamicSelect $appOrLicNo = null;
 
@@ -57,7 +70,24 @@ class CreateInput
      * @Form\Required(true)
      * @Form\Type(Textarea::class)
      * @Form\Filter(StringTrim::class)
-     * @Form\Validator(StringLength::class, options={"min": 5, "max": 1000})
+     * @Form\Validator(NotEmpty::class,
+     *     options={
+     *         "messages": {
+     *             NotEmpty::IS_EMPTY: "messaging.form.message.content.empty.error_message"
+     *         },
+     *     },
+     *     breakChainOnFailure=true
+     *  )
+     * @Form\Validator(StringLength::class,
+     *     options={
+     *         "min": 5,
+     *         "max": 1000,
+     *         "messages": {
+     *              StringLength::TOO_SHORT:"messaging.form.message.content.too_short.error_message",
+     *              StringLength::TOO_LONG:"messaging.form.message.content.too_long.error_message",
+     *          }
+     *     }
+     * )
      */
     public ?Textarea $messageContent = null;
 }
diff --git a/module/Olcs/src/Form/Model/Fieldset/Message/ReplyInput.php b/module/Olcs/src/Form/Model/Fieldset/Message/ReplyInput.php
@@ -8,6 +8,7 @@
 use Laminas\Form\Annotation as Form;
 use Laminas\Form\Element\Textarea;
 use Laminas\Validator\StringLength;
+use Laminas\Validator\NotEmpty;
 
 class ReplyInput
 {
@@ -23,7 +24,22 @@ class ReplyInput
      * @Form\Required(true)
      * @Form\Type(Textarea::class)
      * @Form\Filter(StringTrim::class)
-     * @Form\Validator(StringLength::class, options={"min": 5, "max": 1000})
+     * @Form\Validator(NotEmpty::class,
+     *     options={
+     *         "messages":{NotEmpty::IS_EMPTY: "messaging.form.message.content.empty.error_message"},
+     *     },
+     *     breakChainOnFailure=true
+     *  )
+     * @Form\Validator(StringLength::class,
+     *     options={
+     *         "min": 5,
+     *         "max": 1000,
+     *         "messages": {
+     *              StringLength::TOO_SHORT: "messaging.form.message.content.too_short.error_message",
+     *              StringLength::TOO_LONG: "messaging.form.message.content.too_long.error_message",
+     *          }
+     *     }
+     * )
      */
     public ?TextArea $reply = null;
 }