Add OR validation

Author: phpfui

Tests/Fixtures/Validation/LogicalOr.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Tests\Fixtures\Validation;
+
+class LogicalOr extends \PHPFUI\ORM\Validator
+	{
+	public static array $validators = [
+		'alpha' => ['alpha|starts_with:/', 'required', 'ends_with:4'],
+	];
+	}

Tests/Unit/ValidationTest.php

@@ -811,6 +811,24 @@ public function testNumber() : void
 		$this->assertNotEmpty($validator->getErrors());
 		}
 
+	public function testOr() : void
+		{
+		$crud = new \Tests\Fixtures\Record\Alpha();
+		$validator = new \Tests\Fixtures\Validation\LogicalOr($crud);
+
+		$crud->alpha = '/1234';
+		$validator->validate();
+		$errors = $validator->getErrors();
+		$this->assertEmpty($errors);
+
+		$crud->alpha = '1234';
+		$validator->validate();
+		$errors = $validator->getErrors();
+		$this->assertNotEmpty($errors);
+		$this->assertContains('1234 is not characters only', $errors['alpha']);
+		$this->assertContains('1234 does not start with one of (/) of the same case', $errors['alpha']);
+		}
+
 	public function testRequired() : void
 		{
 		$crud = new \Tests\Fixtures\Record\Required();

src/PHPFUI/ORM/Schema/Field.php

@@ -30,11 +30,11 @@ public function __construct(\PHPFUI\ORM\PDOInstance $pdo, array $fields, bool $a
 			return;
 			}
 		// SQLite
-		$this->name = $fields['name']; /** @phpstan-ignore-line */
-		$this->type = \strtolower($fields['type']); /** @phpstan-ignore-line */
-		$this->nullable = ! (bool)$fields['notnull']; /** @phpstan-ignore-line */
-		$this->defaultValue = $fields['dflt_value']; /** @phpstan-ignore-line */
-		$this->primaryKey = (bool)$fields['pk']; /** @phpstan-ignore-line */
-		$this->autoIncrement = $autoIncrement && $this->primaryKey; /** @phpstan-ignore-line */
+		$this->name = $fields['name'];
+		$this->type = \strtolower($fields['type']);
+		$this->nullable = ! (bool)$fields['notnull'];
+		$this->defaultValue = $fields['dflt_value'];
+		$this->primaryKey = (bool)$fields['pk'];
+		$this->autoIncrement = $autoIncrement && $this->primaryKey;
 		}
 	}

src/PHPFUI/ORM/Schema/Index.php

@@ -20,9 +20,9 @@ public function __construct(\PHPFUI\ORM\PDOInstance $pdo, array $fields)
 			}
 		else
 			{
-			$this->name = $fields['name']; /** @phpstan-ignore-line */
-			$this->extra = $fields['sql'] ?? ''; /** @phpstan-ignore-line */
-			$this->primaryKey = false; /** @phpstan-ignore-line */
+			$this->name = $fields['name'];
+			$this->extra = $fields['sql'] ?? '';
+			$this->primaryKey = false;
 			}
 		}
 	}

src/PHPFUI/ORM/Tool/Generate/CRUD.php

@@ -185,11 +185,6 @@ protected function getLine(\PHPFUI\ORM\Schema\Field $field) : string
 				break;
 			}
 
-		if ('boolean' == \gettype($field->defaultValue))
-			{
-			$defaultValue = (int)$field->defaultValue;
-			}
-
 		$retVal .= $this->line($allowNulls ? 'true' : 'false');
 
 		if (null !== $defaultValue)

src/PHPFUI/ORM/Validator.php

@@ -92,6 +92,12 @@
  * You want the name to be unique for a specific type in the division: *unique:type,shoes,division*
  * You want the name to be unique for a specific type and division: *unique:type,shoes,division,10*
  *
+ * ## OR Operator
+ * You can validate a field if any one of the validators passes.  Use the vertical bar (|) to separate validators. If one of the validators passes, then the the field is valid.
+ *
+ * **Example:**
+ * website|starts_with:/ will validate a fully qualified http url, or a root relative url.
+ *
  * ## Optional Validation
  * You may need to do additional checks for a specific record type.  A second parameter can be passed to the contructor which would represent the original values of the record.
  *
@@ -167,9 +173,9 @@ public function validate(string $optionalMethod = '') : bool
 	/**
 	 * Gets the errors for a value with the record definition and associated validators
 	 *
-	 * @param array<int, array<mixed>> $fieldDefinitions
+	 * @param array<int, array<string>> $fieldDefinitions
 	 *
-	 * @return array  of errors of translated text
+	 * @return array<string> of errors of translated text
 	 */
 	private function getFieldErrors(mixed $value, array $validators, array $fieldDefinitions) : array
 		{
@@ -203,35 +209,40 @@ private function getFieldErrors(mixed $value, array $validators, array $fieldDef
 			return $errors;
 			}
 
+		$orErrors = [];
+
 		foreach ($validators as $validator)
 			{
-			$parts = \explode(':', (string)$validator);
-
-			$parameters = [];
+			// Implements OR logic, any rule passes, the whole rule passes
+			$orValidators = \explode('|', (string)$validator);
 
-			if (\count($parts) > 1)
+			if (\count($orValidators) > 1)
 				{
-				$parameters = \explode(',', $parts[1]);
-				}
-			$validator = $parts[0];
-			$method = 'validate_' . $validator;
-
-			if (\method_exists($this, $method))
-				{
-				$error = $this->{$method}($value, $parameters, $fieldDefinitions);
+				$orErrors = [];
 
-				if ($error)
+				foreach ($orValidators as $validator)
 					{
-					$errors[] = $error;
+					$error = $this->validateRule($validator, $value, $fieldDefinitions);
+
+					if ($error)
+						{
+						$orErrors = \array_merge($orErrors, $error);
+						}
+					else
+						{
+						$orErrors = [];
+
+						break;
+						}
 					}
 				}
 			else
 				{
-				throw new \Exception("Validator {$validator} (validate_{$validator} method) not found in class " . self::class);
+				$errors = \array_merge($errors, $this->validateRule($validator, $value, $fieldDefinitions));
 				}
 			}
 
-		return $errors;
+		return \array_merge($errors, $orErrors);
 		}
 
 	/**
@@ -873,4 +884,40 @@ private function validate_year_month(mixed $value, array $parameters, array $fie
 
 		return \checkdate((int)($parts[$month] ?? 0), $day, (int)($parts[$year] ?? 0)) ? '' : \PHPFUI\ORM::trans('.validator.year_month', ['value' => $value]);
 		}
+
+	/**
+	 * Validate one rule.
+	 *
+	 * @return array<string> of errors of translated text
+	 */
+	private function validateRule(string $validator, mixed $value, array $fieldDefinitions) : array
+		{
+		$parts = \explode(':', (string)$validator);
+
+		$parameters = $errors = [];
+
+		if (\count($parts) > 1)
+			{
+			$parameters = \explode(',', $parts[1]);
+			}
+		$validator = $parts[0];
+
+		$method = 'validate_' . $validator;
+
+		if (\method_exists($this, $method))
+			{
+			$error = $this->{$method}($value, $parameters, $fieldDefinitions);
+
+			if ($error)
+				{
+				$errors[] = $error;
+				}
+			}
+		else
+			{
+			throw new \Exception("Validator {$validator} (validate_{$validator} method) not found in class " . self::class);
+			}
+
+		return $errors;
+		}
 	}