Adds templates config file for managing templates

README.md

@@ -33,15 +33,48 @@ After loading the plugin you need to migrate the tables for the plugin using:
 
 #### Templates
 
-Before sending any notification, we need to register a template. An example about how to add templates:
+Before sending any notification, we need to register a template. There are two ways to add templates:
+
+##### 1. Using NotificationManager utility class to create templates
 
 ```php
+    use Bakkerij\Notifier\Utility\NotificationManager;
+
+    $notificationManager = NotificationManager::instance();
     $notificationManager->addTemplate('newBlog', [
         'title' => 'New blog by :username',
         'body' => ':username has posted a new blog named :name'
     ]);
 ```
 
+##### 2. Using config files to define templates
+
+Create a file in your config folder named `templates.php` and create your templates as below:
+
+```php
+    return [
+        'Notifier' => [
+            'templates' => [
+                'newBlog' => [
+                    'title' => 'New blog by :username',
+                    'body' => ':username has posted a new blog named :name'
+                ],
+                'newMessage' => [
+                    'title' => 'New message from :username',
+                    'body' => ':username sent you a message on :timeago'
+                ]
+            ]
+        ]
+    ];
+```
+
+Then load your file from your bootstrap.php file:
+
+```php
+    Configure::write('Notifier.config', ['templates']);
+```
+
+
 When adding a new template, you have to add a `title` and a `body`. Both are able to contain variables like `:username`
 and `:name`. Later on we will tell more about these variables.
 

config/bootstrap.php

@@ -20,4 +20,8 @@
     'body' => ':body'
 ]);
 
-Configure::write('Notifier.recipientLists', []);
+Configure::write('Notifier.recipientLists', []);
+
+collection((array)Configure::read('Notifier.config'))->each(function ($file) {
+    Configure::load($file);
+});

src/Model/Entity/Notification.php

@@ -94,6 +94,7 @@ protected function _getTitle()
 
             return Text::insert($template['title'], $vars);
         }
+
         return '';
     }
 
@@ -117,6 +118,7 @@ protected function _getBody()
 
             return Text::insert($template['body'], $vars);
         }
+
         return '';
     }
 
@@ -132,6 +134,7 @@ protected function _getUnread()
         if ($this->_properties['state'] === 1) {
             return true;
         }
+
         return false;
     }
 
@@ -147,6 +150,7 @@ protected function _getRead()
         if ($this->_properties['state'] === 0) {
             return true;
         }
+
         return false;
     }
 

src/Utility/NotificationManager.php

@@ -43,6 +43,7 @@ public static function instance($manager = null)
         if (empty(static::$_generalManager)) {
             static::$_generalManager = new NotificationManager();
         }
+
         return static::$_generalManager;
     }
 
@@ -203,6 +204,7 @@ public function getTemplate($name, $type = null)
             if ($type == 'body') {
                 return $templates[$name]['body'];
             }
+
             return $templates[$name];
         }
 
@@ -224,6 +226,7 @@ public function getTrackingId()
         for ($i = 0; $i < 10; $i++) {
             $trackingId .= $characters[rand(0, $charactersLength - 1)];
         }
+
         return $trackingId;
     }
 }

tests/TestCase/Model/Table/NotificationsTableTest.php

@@ -23,7 +23,7 @@
  */
 class NotificationsTableTest extends TestCase
 {
-    
+
     public $fixtures = [
         'plugin.bakkerij\Notifier.notifications',
     ];