refactored strictness in validators

Author: eceltov

app/helpers/MetaFormats/Attributes/FPath.php

@@ -24,7 +24,5 @@ public function __construct(
         bool $nullable = false,
     ) {
         parent::__construct(Type::Path, $validators, $description, $required, $nullable);
-        // do not use json validation for path params
-        $this->disableJsonValidation();
     }
 }

app/helpers/MetaFormats/Attributes/FQuery.php

@@ -24,7 +24,5 @@ public function __construct(
         bool $nullable = false,
     ) {
         parent::__construct(Type::Query, $validators, $description, $required, $nullable);
-        // do not use json validation for query params
-        $this->disableJsonValidation();
     }
 }

app/helpers/MetaFormats/Attributes/FormatParameterAttribute.php

@@ -53,15 +53,12 @@ public function __construct(
             }
             $this->validators = $validators;
         }
-    }
 
-    /**
-     * Disables JSON validation for all validators.
-     */
-    protected function disableJsonValidation()
-    {
-        foreach ($this->validators as $validator) {
-            $validator->useJsonValidation = false;
+        // remove strict type checking for query and path parameters
+        if ($type === Type::Path || $type === Type::Query) {
+            foreach ($this->validators as $validator) {
+                $validator->setStrict(false);
+            }
         }
     }
 }

app/helpers/MetaFormats/Attributes/Path.php

@@ -26,7 +26,5 @@ public function __construct(
         bool $nullable = false,
     ) {
         parent::__construct(Type::Path, $name, $validators, $description, $required, $nullable);
-        // do not use json validation for path params
-        $this->disableJsonValidation();
     }
 }

app/helpers/MetaFormats/Attributes/Query.php

@@ -26,7 +26,5 @@ public function __construct(
         bool $nullable = false,
     ) {
         parent::__construct(Type::Query, $name, $validators, $description, $required, $nullable);
-        // do not use json validation for query params
-        $this->disableJsonValidation();
     }
 }

app/helpers/MetaFormats/Validators/BaseValidator.php

@@ -7,59 +7,50 @@
  */
 class BaseValidator
 {
+    public function __construct(bool $strict = true)
+    {
+        $this->strict = $strict;
+    }
+
     /**
      * @var string One of the valid swagger types (https://swagger.io/docs/specification/v3_0/data-models/data-types/).
      */
     public const SWAGGER_TYPE = "invalid";
 
     /**
-     * @var bool If true, the validateJson method will be used instead of the validateText one for validation.
-     *  Intended to be changed by Attributes containing validators to change their behavior based on the Attribute type.
+     * @var bool Whether strict type checking is done in validation.
      */
-    public bool $useJsonValidation = true;
+    protected bool $strict;
 
     /**
-     * @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.
+     * Sets the strict flag.
+     * Expected to be changed by Attributes containing validators to change their behavior based on the Attribute type.
+     * @param bool $strict Whether validation type checking should be done.
+     *  When false, the validation step will no longer enforce the correct type of the value.
      */
-    public function getExampleValue(): string | null
+    public function setStrict(bool $strict)
     {
-        return null;
+        $this->strict = $strict;
     }
 
     /**
-     * Validates a value retrieved from unstructured data sources, such as query parameters.
-     * @param mixed $value The value to be validated.
-     * @return bool Whether the value passed the test.
+     * @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 validateText(mixed $value): bool
+    public function getExampleValue(): string | null
     {
-        // return false by default to enforce overriding in derived types
-        return false;
+        return null;
     }
 
     /**
-     * Validates a value retrieved from json files (usually request bodies).
+     * Validates a value with the configured validation strictness.
      * @param mixed $value The value to be validated.
      * @return bool Whether the value passed the test.
      */
-    public function validateJson(mixed $value): bool
+    public function validate(mixed $value): bool
     {
         // return false by default to enforce overriding in derived types
         return false;
     }
-
-    /**
-     * Validates a value with the configured validator method.
-     * @param mixed $value The value to be validated.
-     * @return bool Whether the value passed the test.
-     */
-    public function validate(mixed $value): bool
-    {
-        if ($this->useJsonValidation) {
-            return $this->validateJson($value);
-        }
-        return $this->validateText($value);
-    }
 }

app/helpers/MetaFormats/Validators/VArray.php

@@ -10,15 +10,16 @@ class VArray extends BaseValidator
     public const SWAGGER_TYPE = "array";
 
     // validator used for elements
-    private mixed $nestedValidator;
+    private ?BaseValidator $nestedValidator;
 
     /**
      * Creates an array validator.
-     * @param mixed $nestedValidator A validator that will be applied on all elements
+     * @param ?BaseValidator $nestedValidator A validator that will be applied on all elements
      *  (validator arrays are not supported).
      */
-    public function __construct(mixed $nestedValidator = null)
+    public function __construct(?BaseValidator $nestedValidator = null, bool $strict = true)
     {
+        parent::__construct($strict);
         $this->nestedValidator = $nestedValidator;
     }
 
@@ -43,12 +44,19 @@ public function getElementSwaggerType(): mixed
         return $this->nestedValidator::SWAGGER_TYPE;
     }
 
-    public function validateText(mixed $value): bool
+    /**
+     * Sets the strict flag for this validator and the element validator if present.
+     * Expected to be changed by Attributes containing validators to change their behavior based on the Attribute type.
+     * @param bool $strict Whether validation type checking should be done.
+     *  When false, the validation step will no longer enforce the correct type of the value.
+     */
+    public function setStrict(bool $strict)
     {
-        return $this->validateJson($value);
+        parent::setStrict($strict);
+        $this->nestedValidator?->setStrict($strict);
     }
 
-    public function validateJson(mixed $value): bool
+    public function validate(mixed $value): bool
     {
         if (!is_array($value)) {
             return false;

app/helpers/MetaFormats/Validators/VBool.php

@@ -14,23 +14,23 @@ public function getExampleValue(): string
         return "true";
     }
 
-    public function validateText(mixed $value): bool
+    public function validate(mixed $value): bool
     {
-        // FILTER_VALIDATE_BOOL is not used because it additionally allows "on", "yes", "off", "no" and ""
+        if (is_bool($value)) {
+            return true;
+        }
+
+        if ($this->strict) {
+            ///TODO: replace this with 'return false;' once the testUpdateInstance test issue is fixed.
+            return $value === 'false';
+        }
 
-        // urlencoded params are strings
-        return $value === "0"
+        // FILTER_VALIDATE_BOOL is not used because it additionally allows "on", "yes", "off", "no" and ""
+        return $value === 0
+            || $value === 1
+            || $value === "0"
             || $value === "1"
-            || $value === "true"
             || $value === "false"
-            || $value === 0
-            || $value === 1
-            || $this->validateJson($value);
-    }
-
-    public function validateJson(mixed $value): bool
-    {
-        ///TODO: remove 'false' once the testUpdateInstance test issue is fixed.
-        return $value === true || $value === false || $value === 'false';
+            || $value === "true";
     }
 }

app/helpers/MetaFormats/Validators/VDouble.php

@@ -14,18 +14,17 @@ public function getExampleValue(): string
         return "0.1";
     }
 
-    public function validateText(mixed $value): bool
+    public function validate(mixed $value): bool
     {
-        return $this->validateJson($value);
-    }
-
-    public function validateJson(mixed $value): bool
-    {
-        // check if it is a double
-        if (is_double($value)) {
+        // check if it is a double or a whole number (is_double(0) returns false)
+        if (is_double($value) || is_int($value)) {
             return true;
         }
 
+        if ($this->strict) {
+            return false;
+        }
+
         // the value may be a string containing the number, or an integer
         return is_numeric($value);
     }

app/helpers/MetaFormats/Validators/VEmail.php

@@ -7,25 +7,20 @@
  */
 class VEmail extends VString
 {
-    public function __construct()
+    public function __construct(bool $strict = true)
     {
         // the email should not be empty
-        parent::__construct(1);
+        parent::__construct(1, strict: $strict);
     }
 
     public function getExampleValue(): string
     {
         return "name@domain.tld";
     }
 
-    public function validateText(mixed $value): bool
+    public function validate(mixed $value): bool
     {
-        return $this->validateJson($value);
-    }
-
-    public function validateJson(mixed $value): bool
-    {
-        if (!parent::validateJson($value)) {
+        if (!parent::validate($value)) {
             return false;
         }