Added: alter template column so it can accept longer template path (#36)

* Added: alter template column so it can accept longer template path

* Changed: limit maximum length to 100, and added documentation about it

* Added: throw exception if `template` length is greater than maximum allowed

Author: noglitchyo

README.md

@@ -63,7 +63,7 @@ and queue a new one by storing the correct data:
 - Third arguments is an array of options, possible options are
  * `subject`: Email's subject
  * `send_at`: date time sting representing the time this email should be sent at (in UTC)
- * `template`:  the name of the element to use as template for the email message
+ * `template`:  the name of the element to use as template for the email message. (maximum supported length is 100 chars)
  * `layout`: the name of the layout to be used to wrap email message
  * `format`: Type of template to use (html, text or both)
  * `headers`: A key-value list of headers to send in the email

config/Migrations/20190814000000_AlterTemplateToEmailQueue.php

@@ -0,0 +1,40 @@
+<?php
+use Migrations\AbstractMigration;
+use Phinx\Db\Adapter\MysqlAdapter;
+
+class AlterTemplateToEmailQueue extends AbstractMigration
+{
+    /**
+     * Up Method
+     *
+     * More information on this method is available here:
+     * http://docs.phinx.org/en/latest/migrations.html#the-up-method
+     *
+     * @return void
+     */
+    public function up()
+    {
+        $this->table('email_queue')
+            ->changeColumn('template', 'string', [
+                'limit' => 100,
+            ])
+            ->update();
+    }
+
+    /**
+     * Down Method
+     *
+     * More information on this method is available here:
+     * http://docs.phinx.org/en/latest/migrations.html#the-down-method
+     *
+     * @return void
+     */
+    public function down()
+    {
+        $this->table('email_queue')
+            ->changeColumn('template', 'string', [
+                'limit' => 50,
+            ])
+            ->update();
+    }
+}

src/Model/Table/EmailQueueTable.php

@@ -9,12 +9,15 @@
 use Cake\ORM\Table;
 use EmailQueue\Database\Type\JsonType;
 use EmailQueue\Database\Type\SerializeType;
+use LengthException;
 
 /**
  * EmailQueue Table.
  */
 class EmailQueueTable extends Table
 {
+    const MAX_TEMPLATE_LENGTH = 100;
+
     /**
      * {@inheritdoc}
      */
@@ -50,10 +53,15 @@ public function initialize(array $config = [])
      * - config : the name of the email config to be used for sending
      *
      * @throws \Exception any exception raised in transactional callback
+     * @throws LengthException If `template` option length is greater than maximum allowed length
      * @return bool
      */
     public function enqueue($to, array $data, array $options = [])
     {
+        if (strlen($options['template']) > self::MAX_TEMPLATE_LENGTH) {
+            throw new LengthException('`template` length must be less or equal to ' . self::MAX_TEMPLATE_LENGTH);
+        }
+
         $defaults = [
             'subject' => '',
             'send_at' => new FrozenTime('now'),