Skip to content

Commit 2f307d8

Browse files
author
Vitaliy
authored
Merge branch '1.0.0-develop' into inspection-plugin-possible-duplication
2 parents 657cba0 + 6023280 commit 2f307d8

File tree

2 files changed

+60
-1
lines changed

2 files changed

+60
-1
lines changed

resources/fileTemplates/code/Magento Module Events Xml Observer.xml.html

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,46 @@
66
-->
77
<html>
88
<body>
9+
<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
10+
<tr>
11+
<td><font face="verdana" size="-1">
12+
Observers are a certain type of Magento class that can influence general behavior, performance, or change business logic.
13+
Observers are executed whenever the event they are configured to watch is dispatched by the eobservent manager.
14+
</font><br>
15+
</td>
16+
</tr>
17+
<tr>
18+
<td><font face="verdana" size="-1">
19+
A observer is declared (registered) for a class in the di.xml file.
20+
</font><br>
21+
</td>
22+
</tr>
23+
<tr>
24+
<td><font face="verdana" size="-1">
25+
<a href="https://devdocs.magento.com/guides/v2.3/extension-dev-guide/events-and-observers.html#observers">Read more</a> about Observer, including when those can be used.
26+
</font><br>
27+
</td>
28+
</tr>
29+
</table>
30+
<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
31+
<tr>
32+
<td colspan="3"><font face="verdana" size="-1">Predefined variables will take the following values:</font></td>
33+
</tr>
34+
<tr>
35+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${EVENT_NAME}</b></font></nobr></td>
36+
<td width="10">&nbsp;</td>
37+
<td width="100%" valign="top"><font face="verdana" size="-1">The name of the observer for the event definition.</font></td>
38+
</tr>
39+
<tr>
40+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${OBSERVER_NAME}</b></font></nobr></td>
41+
<td width="10">&nbsp;</td>
42+
<td width="100%" valign="top"><font face="verdana" size="-1">Observer name.</font></td>
43+
</tr>
44+
<tr>
45+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${OBSERVER_CLASS}</b></font></nobr></td>
46+
<td width="10">&nbsp;</td>
47+
<td width="100%" valign="top"><font face="verdana" size="-1">The fully qualified class name of the observer.</font></td>
48+
</tr>
49+
</table>
950
</body>
10-
</html>
51+
</html>

resources/fileTemplates/code/Magento Observer Execute Method.php.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,23 @@
66
-->
77
<html>
88
<body>
9+
<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
10+
<tr>
11+
<td><font face="verdana" size="-1">Your observer class should implement Magento\Framework\Event\ObserverInterface and define its execute function.
12+
One of the more powerful feature of observers is that they are able to use parameters passed into the event when it was dispatched
13+
</font><br>
14+
</td>
15+
</tr>
16+
</table>
17+
<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
18+
<tr>
19+
<td colspan="3"><font face="verdana" size="-1">Predefined variables will take the following values:</font></td>
20+
</tr>
21+
<tr>
22+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${EVENT_NAME}</b></font></nobr></td>
23+
<td width="10">&nbsp;</td>
24+
<td width="100%" valign="top"><font face="verdana" size="-1">The name of the observer for the event definition.</font></td>
25+
</tr>
26+
</table>
927
</body>
1028
</html>

0 commit comments

Comments
 (0)