Refactored files uploads, form rules

Author: aprokopenko

examples/form.php

@@ -13,21 +13,27 @@
 use JustCoded\FormHandler\DataObjects\MailMessage;
 
 $validation = [
-	'rules'  => [
-		'required' => [
-			'fields'  => ['name', 'email', 'subject', 'message'],
-			'message' => '{field} is required'
+	'fields' => [
+		'name' => ['required'],
+		'email' => ['required', 'email'],
+		'subject' => ['required'],
+		'message' => [
+			'required',
+			['lengthMin', 5]
 		],
-		'email'    => [
-			'fields'  => ['email'],
-			'message' => '{field} is not a valid email address'
+		'cv_file' => [
+			[
+				'required',
+				'message' => 'Please upload {field}',
+			],
+			[
+				'file',
+				['jpeg', 'jpg', 'png'], // types.
+				2000000, // size limit 2 MB.
+				'message' => '{field} should be up to 2MB and allows only file types jpeg, png.',
+			],
 		],
-		'file' => [
-			'fields' => ['cv_file', 'image_file'],
-			'allowType' => ['jpeg', 'jpg', 'pdf', 'png'],
-			'allowSize' => 10000000 // 10 MB
-		]
-	], // according to Valitron doc.
+	], // according to Valitron doc for mapFieldsRules.
 	'labels' => [
 		'name'  => 'Name',
 		'email' => 'Email address'
@@ -41,11 +47,12 @@
 	'password' => 'YOUR PASSWORD',
 	'protocol' => 'tls',
 	'port'     => 587,
+	'attachmentsSizeLimit' => 8000000, // around 8MB.
 ];
 
 $fileManager = new FileManager([
 	'uploadPath' => __DIR__ . '/attachments',
-	'uploadUrl' => $_SERVER['HTTP_ORIGIN'] . '/attachments',
+	'uploadUrl' => 'http://MY-DOMAIN.COM/attachments',
 ]);
 
 $message = [

src/DataObjects/MailMessage.php

@@ -155,7 +155,7 @@ public function getBcc()
 	/**
 	 * Getting email Subject
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function getSubject()
 	{
@@ -169,7 +169,7 @@ public function getSubject()
 	/**
 	 * Getting email Body Template
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function getBodyTemplate()
 	{

src/FormHandler.php

@@ -4,7 +4,7 @@
 
 use JustCoded\FormHandler\Handlers\HandlerInterface;
 use Valitron\Validator;
-use JustCoded\FormHandler\Validator\File as FileValidator;
+use JustCoded\FormHandler\Validator\FileValidator;
 
 /**
  * Class FormHandler
@@ -58,6 +58,9 @@ class FormHandler
 	public function __construct(array $validationRules, HandlerInterface $handler, string $response = 'json')
 	{
 		$this->rules = $validationRules;
+		if (empty($this->rules['fields'])) {
+			throw new \Exception("You should specify 'fields' in validation array.");
+		}
 
 		$this->handler = $handler;
 
@@ -74,19 +77,12 @@ public function __construct(array $validationRules, HandlerInterface $handler, s
 	public function validate(array $data)
 	{
 		$this->formFields = $data;
-		$v                = new Validator($data);
-
-		$v = FileValidator::validate($v, $this->rules);
-		// create rules from input array.
-		foreach ($this->rules['rules'] as $key => $params) {
-			$rule = $v->rule($key, $params['fields']);
-			if (!empty($params['message'])) {
-				$rule->message($params['message']);
-			}
-		}
+		$v = $this->getValidator($data);
+
+		$v->mapFieldsRules($this->rules['fields']);
 
 		// apply labels.
-		if (!empty($this->rules)) {
+		if (!empty($this->rules['labels'])) {
 			$v->labels($this->rules['labels']);
 		}
 
@@ -100,6 +96,23 @@ public function validate(array $data)
 		return empty($this->errors);
 	}
 
+	/**
+	 * Create validator object with registered custom validators.
+	 *
+	 * @param array $data Data to validate.
+	 *
+	 * @return Validator
+	 */
+	public function getValidator($data)
+	{
+		$v = new Validator($data);
+
+		// register additional validators.
+		FileValidator::register($v);
+
+		return $v;
+	}
+
 	/**
 	 * Sending email by handler
 	 */

src/Validator/File.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace JustCoded\FormHandler\Validator;
+
+use Valitron\Validator;
+use JustCoded\FormHandler\DataObjects\File;
+
+/**
+ * Class File
+ *
+ * @package JustCoded\FormHandler\Validator
+ */
+class FileValidator
+{
+	/**
+	 * Custom Valitron file attachments validation
+	 *
+	 * @param Validator $v Validator object
+	 *
+	 * @return Validator
+	 */
+	public static function register(Validator &$v)
+	{
+		$v::addRule('file', [static::class, 'validate'], 'is too big or has wrong format.');
+		return $v;
+	}
+
+	/**
+	 * Custom Valitron file attachments validation
+	 *
+	 * @param string $field Field to validate.
+	 * @param File|null $value Field value.
+	 * @param array $params Rule params
+	 * @param array $fields All available fields.
+	 *
+	 * @return bool
+	 */
+	public static function validate($field, $value, array $params, array $fields)
+	{
+		$allowTypes = $params[0] ?? [];
+		$allowSize = $params[1] ?? 2000000;
+
+		if (empty($value) || ! is_a($value, File::class)) {
+			return false;
+		} elseif (0 < $allowSize && $value->size >= $allowSize) {
+			return false;
+		} elseif (!empty($allowTypes) && ! in_array($value->getExtension(), $allowTypes)) {
+			return false;
+		}
+
+		return true;
+	}
+}