Merge pull request #112 from utopia-php/feat-add-multiple-validator

Add multiple validator

src/Validator/Multiple.php

@@ -0,0 +1,115 @@
+<?php
+
+namespace Utopia\Validator;
+
+use Utopia\Validator;
+
+/**
+ * Multiple
+ *
+ * Multiple validator is a container of multiple validations each acting as a rule.
+ *
+ * @package Utopia\Validator
+ */
+class Multiple extends Validator
+{
+    /**
+     * @var Validator[]
+     */
+    protected $rules = [];
+
+    protected $type = self::TYPE_MIXED;
+
+    /**
+     * Constructor
+     *
+     * Multiple constructor can get any number of arguments containing Validator instances using PHP func_get_args function.
+     *
+     * Example:
+     *
+     * $multiple = new Multiple([$validator1, $validator2]);
+     * $multiple = new Multiple([$validator1, $validator2, $validator3], self::TYPE_STRING);
+     */
+    public function __construct(array $rules, ?string $type = self::TYPE_MIXED)
+    {
+        foreach ($rules as $rule) {
+            $this->addRule($rule);
+        }
+
+        $this->type = $type;
+    }
+    /**
+     * Add rule
+     *
+     * Add a new rule to the end of the rules containing array
+     *
+     * @param Validator $rule
+     * @return $this
+     */
+    public function addRule(Validator $rule)
+    {
+        $this->rules[] = $rule;
+
+        return $this;
+    }
+
+    /**
+     * Get Description
+     *
+     * Returns validator description
+     *
+     * @return string
+     */
+    public function getDescription(): string
+    {
+        $description = '';
+        foreach ($this->rules as $key => $rule) {
+            $description .= ++$key . '. ' . $rule->getDescription() . " \n";
+        }
+
+        return $description;
+    }
+
+    /**
+     * Is valid
+     *
+     * Validation will pass when all rules are valid if only one of the rules is invalid validation will fail.
+     *
+     * @param  mixed $value
+     * @return bool
+     */
+    public function isValid(mixed $value): bool
+    {
+        foreach ($this->rules as $rule) { /* @var $rule Validator */
+            if (false === $rule->isValid($value)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Get Type
+     *
+     * Returns validator type.
+     *
+     * @return string
+     */
+    public function getType(): string
+    {
+        return $this->type;
+    }
+
+    /**
+     * Is array
+     *
+     * Function will return true if object is array.
+     *
+     * @return bool
+     */
+    public function isArray(): bool
+    {
+        return true;
+    }
+}