Skip to content

Commit a1d8ad9

Browse files
committed
Added template description for Magento Resource Model Class
1 parent 0dfc0b3 commit a1d8ad9

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
<!--
2+
/*
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
-->
7+
<html>
8+
<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+
The Resource model it is the object through which all actual operations with the database are performed.
13+
This model is a part of Magento 2 Persistence layer.
14+
</font><br>
15+
</td>
16+
</tr>
17+
<tr>
18+
<td><font face="verdana" size="-1">
19+
Link to documentation
20+
<a href="https://devdocs.magento.com/guides/v2.4/architecture/archi_perspectives/persist_layer.html?itm_source=devdocs&itm_medium=quick_search&itm_campaign=federated_search&itm_term=Resource%20Mode">
21+
DevDocs</a>.
22+
</font><br>
23+
</td>
24+
</tr>
25+
</table>
26+
<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
27+
<tr>
28+
<td colspan="3"><font face="verdana" size="-1">Predefined variables explanation:</font></td>
29+
</tr>
30+
<tr>
31+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${NAMESPACE}</b></font></nobr></td>
32+
<td width="10">&nbsp;</td>
33+
<td width="100%" valign="top"><font face="verdana" size="-1">A fully qualified name of the field namespace without a leading slash.
34+
</font>
35+
</td>
36+
</tr>
37+
<tr>
38+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${USE}</b></font></nobr></td>
39+
<td width="10">&nbsp;</td>
40+
<td width="100%" valign="top"><font face="verdana" size="-1">List of imports separated by comma.
41+
</font>
42+
</td>
43+
</tr>
44+
<tr>
45+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${NAME}</b></font></nobr></td>
46+
<td width="10">&nbsp;</td>
47+
<td width="100%" valign="top"><font face="verdana" size="-1">PHP Class name.
48+
</font>
49+
</td>
50+
</tr>
51+
<tr>
52+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${EXTENDS}</b></font></nobr></td>
53+
<td width="10">&nbsp;</td>
54+
<td width="100%" valign="top"><font face="verdana" size="-1">Name of the PHP class that the Class extends.
55+
</font>
56+
</td>
57+
</tr>
58+
<tr>
59+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${IMPLEMENTS}</b></font></nobr></td>
60+
<td width="10">&nbsp;</td>
61+
<td width="100%" valign="top"><font face="verdana" size="-1">Name of the PHP class that the Class implements.
62+
</font>
63+
</td>
64+
</tr>
65+
<tr>
66+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${DB_NAME}</b></font></nobr></td>
67+
<td width="10">&nbsp;</td>
68+
<td width="100%" valign="top"><font face="verdana" size="-1">Target table name.
69+
</font>
70+
</td>
71+
</tr>
72+
<tr>
73+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${ENTITY_ID_COLUMN}</b></font></nobr></td>
74+
<td width="10">&nbsp;</td>
75+
<td width="100%" valign="top"><font face="verdana" size="-1">Target table's primary column name.
76+
</font>
77+
</td>
78+
</tr>
79+
</table>
80+
</body>
81+
</html>

0 commit comments

Comments
 (0)