Merge pull request #2 from justcoded/develop

Added attachments support

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/EmailAddress.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace JustCoded\FormHandler\DataObjects;
 
 /**

src/DataObjects/EmailAttachment.php

@@ -9,7 +9,6 @@
  */
 class MailMessage extends DataObject
 {
-	const ATTACHMENTS_SIZE_LIMIT = 8000000;
 
 	/**
 	 * Property with From email
@@ -84,17 +83,10 @@ class MailMessage extends DataObject
 	/**
 	 * List of attachments
 	 *
-	 * @var array
+	 * @var File[]|null
 	 */
 	protected $attachments = [];
 
-	/**
-	 * List of attachments files
-	 *
-	 * @var array
-	 */
-	protected $files = [];
-
 	/**
 	 * Message constructor.
 	 *
@@ -163,7 +155,7 @@ public function getBcc()
 	/**
 	 * Getting email Subject
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function getSubject()
 	{
@@ -177,7 +169,7 @@ public function getSubject()
 	/**
 	 * Getting email Body Template
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public function getBodyTemplate()
 	{
@@ -235,44 +227,30 @@ public function getAltBody()
 	}
 
 	/**
-	 * Setting attachments file
+	 * Getting attachments files
 	 *
-	 * @return bool
+	 * @return File[]|null
 	 */
-	public function setFiles()
+	public function getAttachments()
 	{
-		foreach ($this->attachments as $file) {
-			/**
-			 * File object
-			 *
-			 * @var File $file
-			 */
-			if ($file->size < self::ATTACHMENTS_SIZE_LIMIT) {
-				$this->addFile([$file->uploadPath => $file->name]);
-			}
-		}
-
-		return true;
+		return $this->attachments;
 	}
 
 	/**
-	 * Getting attachments file
-	 *
-	 * @return array
+	 * Getting total size of attached files
 	 */
-	public function getFiles()
+	public function getAttachmentsSize()
 	{
-		return $this->files;
-	}
+		if (empty($this->attachments)) {
+			return 0;
+		}
 
-	/**
-	 * Add EmailAttachments data to files array
-	 *
-	 * @param array $data File data with ['uploadPath' => name]
-	 */
-	protected function addFile(array $data)
-	{
-		$this->files[] = new EmailAttachment($data);
+		$totalSize = 0;
+		foreach ($this->attachments as $file) {
+			$totalSize += $file->size;
+		}
+
+		return $totalSize;
 	}
 
 }

src/DataObjects/MailMessage.php

@@ -47,15 +47,10 @@ public function upload(array $fields)
 
 				$name = preg_replace('/[^\00-\255]+/u', '', $file->name);
 				$name = str_replace('"', '', trim($name));
-				/**
-				 * File Object
-				 *
-				 * @varFile $file
-				 */
-				$path = realpath($this->uploadPath) . '/' . $name . $file->uniqName;
+				$path = realpath($this->uploadPath) . '/' . $name . $file->uniqueName;
 
 				if ($file->error == 0 && move_uploaded_file($file->tmp_name, $path)) {
-					$file->uploadUrl = $this->uploadUrl . '/' . $name . $file->uniqName;
+					$file->uploadUrl = $this->uploadUrl . '/' . $name . $file->uniqueName;
 					$file->uploadPath = $path;
 					$_POST[$field] = $file;
 					$files[] = $file;

src/FileManager/FileManager.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,26 @@ 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
+	 */
 	public function process()
 	{
 		$this->handler->process($this->formFields);

src/FormHandler.php

@@ -61,7 +61,6 @@ public function __construct(array $config, MailMessage $message)
 	public function process(array $data)
 	{
 		$this->message->setTokens($data);
-		$this->message->setFiles();
 		$this->mailer->send($this->message);
 
 		return true;

src/Handlers/MailHandler.php

@@ -3,13 +3,24 @@
 namespace JustCoded\FormHandler\Mailer;
 
 use JustCoded\FormHandler\DataObjects\DataObject;
-use JustCoded\FormHandler\DataObjects\EmailAttachment;
 use JustCoded\FormHandler\DataObjects\MailMessage;
 use PHPMailer\PHPMailer\PHPMailer as PHPMailerLib;
 use PHPMailer\PHPMailer\Exception as PhpMailerException;
 
+/**
+ * Class PHPMailer
+ *
+ * @package JustCoded\FormHandler\Mailer
+ */
 class PHPMailer extends DataObject implements MailerInterface
 {
+	/**
+	 * Attachments size limit
+	 *
+	 * @var int
+	 */
+	protected $attachmentsSizeLimit = 8000000;
+
 	/**
 	 * The user's host
 	 *
@@ -107,14 +118,11 @@ public function send(MailMessage $message)
 			}
 
 			// Attachments.
-			if ($attachments = $message->getFiles()) {
+			if (0 < $message->getAttachmentsSize() && $message->getAttachmentsSize() < $this->attachmentsSizeLimit
+				&& $attachments = $message->getAttachments()
+			) {
 				foreach ($attachments as $attachment) {
-					/**
-					 * Email attachments
-					 *
-					 * @var EmailAttachment $attachment
-					 */
-					$mail->addAttachment($attachment->getPath(), $attachment->getName()); // Optional name.
+					$mail->addAttachment($attachment->uploadPath, $attachment->name);
 				}
 			}