Track templates with email event

Author: MGatner

src/Database/Migrations/2020-11-10-102311_add_emails_template.php

@@ -0,0 +1,20 @@
+<?php namespace Tatter\Outbox\Database\Migrations;
+
+use CodeIgniter\Database\Migration;
+
+class AddEmailsTemplate extends Migration
+{
+	public function up()
+	{
+		$this->forge->addColumn('outbox_emails', [
+			'template_id' => ['type' => 'int', 'null' => true, 'after' => 'BCCBatchSize'],
+			'template'    => ['type' => 'varchar', 'constraint' => 255, 'null' => true, 'after' => 'BCCBatchSize'],
+		]);
+	}
+
+	public function down()
+	{
+		$this->forge->dropColumn('outbox_emails', 'template');
+		$this->forge->dropColumn('outbox_emails', 'template_id');
+	}
+}

src/Entities/Email.php

@@ -19,6 +19,7 @@ class Email extends Entity
 		'sendMultipart' => 'boolean',
 		'BCCBatchMode'  => 'boolean',
 		'BCCBatchSize'  => 'int',
+		'template_id'   => '?int',
 	];
 
 	/**

src/Entities/Template.php

@@ -149,9 +149,11 @@ public function renderSubject($data = []): string
 	public function email($data = [], string $styles = null): Email
 	{
 		// Start with the default config and add necessary settings
-		$email           = service('email');
-		$email->mailType = 'html';
-		$email->wordWrap = false;
+		$email              = service('email');
+		$email->mailType    = 'html';
+		$email->wordWrap    = false;
+		$email->template    = $this->attributes['name'];
+		$email->template_id = $this->attributes['id'] ?? null;
 
 		// Render the subject and body and return the Email instance
 		return $email

src/Models/EmailModel.php

@@ -16,5 +16,6 @@ class EmailModel extends Model
 	protected $allowedFields = [
 		'subject', 'body', 'fromEmail', 'fromName', 'userAgent', 'protocol', 'mailType',
 		'charset', 'priority', 'sendMultipart', 'BCCBatchMode', 'BCCBatchSize',
+		'template', 'template_id',
 	];
 }

tests/unit/EventTest.php

@@ -1,7 +1,9 @@
 <?php
 
 use CodeIgniter\Config\Config;
+use Tatter\Outbox\Entities\Template;
 use Tatter\Outbox\Models\AttachmentModel;
+use Tatter\Outbox\Models\TemplateModel;
 use Tests\Support\DatabaseTestCase;
 
 class EventTest extends DatabaseTestCase
@@ -79,4 +81,19 @@ public function testEventRespectsConfigLogging()
 		$this->assertTrue($result);
 		$this->dontSeeInDatabase('outbox_emails', ['subject' => 'Email test']);
 	}
+
+	public function testEventRecordsTemplate()
+	{
+		$templateId = model(TemplateModel::class)->insert(new Template([
+			'name'      => 'Test Template',
+			'subject'   => 'Some {subject}',
+			'body'      => '<p>{number}</p>',
+		]));
+
+		$template = model(TemplateModel::class)->findByName('Test Template');
+		$template->email()->send();
+
+		$this->seeInDatabase('outbox_emails', ['template' => 'Test Template']);
+		$this->seeInDatabase('outbox_emails', ['template_id' => $templateId]);
+	}
 }