Merge pull request #13 from CommonGateway/feature/update-product-page

Update product page

.phpdoc-md

@@ -6,6 +6,7 @@ return (object)[
     'classes' => [
         '\CommonGateway\CustomerNotificationsBundle\Service\InstallationService',
         '\CommonGateway\CustomerNotificationsBundle\Service\NotificationsService',
-        '\CommonGateway\CustomerNotificationsBundle\Service\EmailService'
+        '\CommonGateway\CustomerNotificationsBundle\Service\EmailService',
+        '\CommonGateway\CustomerNotificationsBundle\Service\SmsService'
     ],
 ];

docs/classes/README.md

@@ -3,3 +3,4 @@
 * [Service\InstallationService](Service/InstallationService.md) 
 * [Service\NotificationsService](Service/NotificationsService.md) 
 * [Service\EmailService](Service/EmailService.md) 
+* [Service\SmsService](Service/SmsService.md) 

docs/classes/Service/README.md

@@ -0,0 +1,6 @@
+# CommonGateway\CustomerNotificationsBundle
+
+* [Service\EmailService](EmailService.md)
+* [Service\InstallationService](InstallationService.md) 
+* [Service\NotificationsService](NotificationsService.md)
+* [Service\SmsService](SmsService.md)

docs/classes/Service/SmsService.md

@@ -0,0 +1,74 @@
+# CommonGateway\CustomerNotificationsBundle\Service\SmsService  
+
+Triggers sending a SMS via the Symfony Notifier.
+
+
+
+
+
+## Methods
+
+| Name | Description |
+|------|-------------|
+|[SmsHandler](#smsservicesmshandler)|Handles the sending of an sms based on an event.|
+|[__construct](#smsservice__construct)||
+
+
+
+
+### SmsService::SmsHandler  
+
+**Description**
+
+```php
+public SmsHandler (array $data, array $configuration)
+```
+
+Handles the sending of an sms based on an event. 
+
+
+
+**Parameters**
+
+* `(array) $data`
+* `(array) $configuration`
+
+**Return Values**
+
+`array`
+
+
+
+
+**Throws Exceptions**
+
+
+`\LoaderError|\RuntimeError|\SyntaxError|\TransportExceptionInterface`
+
+
+<hr />
+
+
+### SmsService::__construct  
+
+**Description**
+
+```php
+ __construct (void)
+```
+
+
+
+
+
+**Parameters**
+
+`This function has no parameters.`
+
+**Return Values**
+
+`void`
+
+
+<hr />
+

docs/footerContent.json

@@ -8,34 +8,22 @@
         "link": "/",
         "icon": { "prefix": "fas", "icon": "home", "placement": "left" }
       },
-      {
-        "ariaLabel": "Documentation",
-        "value": "Documentation",
-        "link": "https://commongateway.readthedocs.io/en/latest/",
-        "icon": { "prefix": "fab", "icon": "readthedocs", "placement": "left" }
-      },
-      {
-        "ariaLabel": "Slack",
-        "value": "Slack",
-        "link": "#",
-        "icon": { "prefix": "fab", "icon": "slack", "placement": "left" }
-      },
       {
         "ariaLabel": "Github",
         "value": "Github",
-        "link": "https://github.com/CommonGateway/CoreBundle",
+        "link": "https://github.com/commonGateway/customerNotificationsBundle",
         "icon": { "prefix": "fab", "icon": "github", "placement": "left" }
       }
     ]
   },
   {
-    "title": "Classes",
+    "title": "Services",
     "items": [
       {
         "ariaLabel": "Readme",
         "value": "Readme",
         "internalMarkdown": {
-          "directoryName": "Classes",
+          "directoryName": "Service",
           "fileName": "README"
         }
       },
@@ -46,6 +34,30 @@
           "directoryName": "Service",
           "fileName": "EmailService"
         }
+      },
+      {
+        "ariaLabel": "InstallationService",
+        "value": "InstallationService",
+        "internalMarkdown": {
+          "directoryName": "Service",
+          "fileName": "InstallationService"
+        }
+      },
+      {
+        "ariaLabel": "NotificationsService",
+        "value": "NotificationsService",
+        "internalMarkdown": {
+          "directoryName": "Service",
+          "fileName": "NotificationsService"
+        }
+      },
+      {
+        "ariaLabel": "SmsService",
+        "value": "SmsService",
+        "internalMarkdown": {
+          "directoryName": "Service",
+          "fileName": "SmsService"
+        }
       }
     ]
   },

docs/navbarContent.json

@@ -10,20 +10,20 @@
     }
   },
   {
-    "label": "Classes",
+    "label": "Services",
     "current": {
-      "pathname": "/Classes"
+      "pathname": "/Service"
     },
     "subItems": [
       {
         "label": "README",
         "type": "internalMarkdown",
         "current": {
-          "pathname": "/Classes/README"
+          "pathname": "/Service/README"
         },
         "handleClick": {
           "internalMarkdown": {
-            "directoryName": "Classes",
+            "directoryName": "Service",
             "fileName": "README"
           }
         }
@@ -40,6 +40,45 @@
             "fileName": "EmailService"
           }
         }
+      },
+      {
+        "label": "InstallationService",
+        "type": "internalMarkdown",
+        "current": {
+          "pathname": "/Service/InstallationService"
+        },
+        "handleClick": {
+          "internalMarkdown": {
+            "directoryName": "Service",
+            "fileName": "InstallationService"
+          }
+        }
+      },
+      {
+        "label": "NotificationsService",
+        "type": "internalMarkdown",
+        "current": {
+          "pathname": "/Service/NotificationsService"
+        },
+        "handleClick": {
+          "internalMarkdown": {
+            "directoryName": "Service",
+            "fileName": "NotificationsService"
+          }
+        }
+      },
+      {
+        "label": "SmsService",
+        "type": "internalMarkdown",
+        "current": {
+          "pathname": "/Service/SmsService"
+        },
+        "handleClick": {
+          "internalMarkdown": {
+            "directoryName": "Service",
+            "fileName": "SmsService"
+          }
+        }
       }
     ]
   }