Merge pull request #94 from magento/87-description-for-di-xml-preference-template

Vitaliy · web-flow · commit 1b1d03ea90c6 · 2020-04-05T11:04:54.000+03:00
[TemplateDescription] #87 - Added description for dependency injectio…
diff --git a/resources/fileTemplates/code/Magento Module DI Xml Preference.xml.ft b/resources/fileTemplates/code/Magento Module DI Xml Preference.xml.ft
@@ -1 +1 @@
-<preference for="${FOR}" type="${TYPE}" />
+<preference for="${FOR}" type="${TYPE}" />
diff --git a/resources/fileTemplates/code/Magento Module DI Xml Preference.xml.html b/resources/fileTemplates/code/Magento Module DI Xml Preference.xml.html
@@ -6,5 +6,36 @@
 -->
 <html>
 <body>
+<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
+    <tr>
+        <td><font face="verdana" size="-1">
+            The object manager uses abstraction-implementation mappings when the constructor signature of a class requests
+            an object by its interface. The object manager uses these mappings to determine what the default implementation
+            is for that class for a particular scope.
+        </font><br>
+        </td>
+    </tr>
+    <tr>
+        <td><font face="verdana" size="-1">
+            If you want to override a public or protected method from a core class, utilize the preference node from di.xml to achieve it.
+        </font><br>
+        </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">Predefined variables will take the following values:</font></td>
+    </tr>
+    <tr>
+        <td valign="top"><nobr><font face="verdana" size="-2"><b>${FOR}</b></font></nobr></td>
+        <td width="10">&nbsp;</td>
+        <td width="100%" valign="top"><font face="verdana" size="-1">Target PHP Class to change its concrete implementation</font></td>
+    </tr>
+    <tr>
+        <td valign="top"><nobr><font face="verdana" size="-2"><b>${TYPE}</b></font></nobr></td>
+        <td width="10">&nbsp;</td>
+        <td width="100%" valign="top"><font face="verdana" size="-1">PHP Class that will be instantiated instead of specified in predefined ${FOR} variable</font></td>
+    </tr>
+</table>
 </body>
-</html>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-<preference for="${FOR}" type="${TYPE}" />`
	`1`	`+<preference for="${FOR}" type="${TYPE}" />`