Merge pull request #117 from vasilii-b/code-generation-observer-class

Vitaliy · web-flow · commit ef1ada06c18c · 2020-04-07T17:30:15.000+03:00
Added the observer's template must-have implemented method and template description
diff --git a/resources/fileTemplates/internal/Magento Observer Class.php.ft b/resources/fileTemplates/internal/Magento Observer Class.php.ft
@@ -10,4 +10,4 @@ use Magento\Framework\Event\ObserverInterface;
 use Magento\Framework\Event\Observer;
 
 class ${NAME} implements ObserverInterface {
-}
+}
diff --git a/resources/fileTemplates/internal/Magento Observer Class.php.html b/resources/fileTemplates/internal/Magento Observer Class.php.html
@@ -1,10 +1,45 @@
 <!--
-/*
+/**
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 -->
-<html>
-<body>
-</body>
+<html lang="en">
+    <body>
+        <table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
+            <tr>
+                <td>
+                    <font face="verdana" size="-1">Observers are a certain type of Magento class that can influence
+                        general behavior, performance, or change business logic. Observers are executed whenever the
+                        event they are configured to watch is dispatched by the event manager.
+                        <a href="https://devdocs.magento.com/guides/v2.3/extension-dev-guide/events-and-observers.html">
+                        Read more</a> about observers.
+                    </font>
+                </td>
+            </tr>
+            <tr>
+                <td>
+                    <font face="verdana" size="-1">Check out the
+                        <a href="https://devdocs.magento.com/guides/v2.3/ext-best-practices/extension-coding/observers-bp.html">
+                        Observers best practices</a> to have a clean and professional implementation.</font>
+                </td>
+            </tr>
+        </table>
+
+        <table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
+            <tr>
+                <td colspan="3"><font face="verdana" size="-1">Template's variables:</font></td>
+            </tr>
+            <tr>
+                <td valign="top"><nobr><font face="verdana" size="-2"><b>${NAMESPACE}</b></font></nobr></td>
+                <td width="10">&nbsp;</td>
+                <td width="100%" valign="top"><font face="verdana" size="-1">Created PHP observer class namespace.</font></td>
+            </tr>
+            <tr>
+                <td valign="top"><nobr><font face="verdana" size="-2"><b>${NAME}</b></font></nobr></td>
+                <td width="10">&nbsp;</td>
+                <td width="100%" valign="top"><font face="verdana" size="-1">PHP class for the observer name.</font></td>
+            </tr>
+        </table>
+    </body>
 </html>
