Lots of documentation and basic tests

1 files changed, 37 insertions, 0 deletions

diff --git a/src/Validators/EmailValidator.php b/src/Validators/EmailValidator.php
new file mode 100644
index 0000000..5d69b5b
--- /dev/null
+++ b/src/Validators/EmailValidator.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace Askonomm\Bouncer\Validators;
+
+/**
+ * Implements an e-mail validator that has a job 
+ * of validating e-mail addresses.
+ * 
+ * @author Asko Nomm <asko@bien.ee>
+ */
+class EmailValidator implements Validator
+{
+    /**
+     * Returns a boolean `true` when given `$value` is a valid e-mail
+     * address. Returns `false` otherwise.
+     *
+     * @param string $value
+     * @param mixed $modifier
+     * @return boolean
+     */
+    public static function validate(string $value, mixed $modifier = null): bool
+    {
+        return filter_var($value, FILTER_VALIDATE_EMAIL);
+    }
+
+    /**
+     * Composes the error message in case the validation fails.
+     *
+     * @param string $field
+     * @param mixed $modifier
+     * @return string
+     */
+    public static function composeError(string $field, mixed $modifier = null): string
+    {
+        return "${field} is not a valid e-mail address.";
+    }
+}