Skip to content

Commit 2764bfc

Browse files
author
m.mezhensky
committed
description for graphQL resolver templates
1 parent 804b40b commit 2764bfc

File tree

2 files changed

+58
-1
lines changed

2 files changed

+58
-1
lines changed

‎resources/fileTemplates/code/Magento GraphQL Resolver.php.html

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,24 @@
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">A resolver performs GraphQL request processing. In general, it is responsible
12+
for constructing a query, fetching data and performing any calculations, then transforming the fetched and
13+
calculated data into a GraphQL array format. Finally, it returns the results wrapped by a callable function.
14+
</font><br>
15+
</td>
16+
</tr>
17+
</table>
18+
<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
19+
<tr>
20+
<tr>
21+
<td><font face="verdana" size="-1">
22+
<a href="https://devdocs.magento.com/guides/v2.3/graphql/develop/resolvers.html">Read more</a> about GraphQL Resolver, including when those can be used.
23+
</font><br>
24+
</td>
25+
</tr>
26+
</tr>
27+
</table>
928
</body>
1029
</html>

‎resources/fileTemplates/internal/Magento GraphQL Resolver Class.php.html

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,43 @@
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">A resolver performs GraphQL request processing. In general, it is responsible
12+
for constructing a query, fetching data and performing any calculations, then transforming the fetched and
13+
calculated data into a GraphQL array format. Finally, it returns the results wrapped by a callable function.
14+
</font><br>
15+
</td>
16+
</tr>
17+
<tr>
18+
<td><font face="verdana" size="-1">A GraphQL resolver must implement interface Magento\Framework\GraphQl\Query\Resolver\BatchResolverInterface.
19+
This interface provides a way to resolve multiple branches/leaves at once (known as batching).
20+
Magento recommends using batch resolvers for queries because they improve performance by fetching information
21+
required to resolve multiple GraphQL requests with a single operation.
22+
</font><br>
23+
</td>
24+
</tr>
25+
<tr>
26+
<td><font face="verdana" size="-1">
27+
<a href="https://devdocs.magento.com/guides/v2.3/graphql/develop/resolvers.html">Read more</a> about GraphQL Resolver, including when those can be used.
28+
</font><br>
29+
</td>
30+
</tr>
31+
</table>
32+
<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse">
33+
<tr>
34+
<td colspan="3"><font face="verdana" size="-1">Template's variables:</font></td>
35+
</tr>
36+
<tr>
37+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${NAMESPACE}</b></font></nobr></td>
38+
<td width="10">&nbsp;</td>
39+
<td width="100%" valign="top"><font face="verdana" size="-1">Created PHP GraphQL resolver class namespace.</font></td>
40+
</tr>
41+
<tr>
42+
<td valign="top"><nobr><font face="verdana" size="-2"><b>${NAME}</b></font></nobr></td>
43+
<td width="10">&nbsp;</td>
44+
<td width="100%" valign="top"><font face="verdana" size="-1">PHP class for the GraphQL resolver name.</font></td>
45+
</tr>
46+
</table>
947
</body>
10-
</html>
48+
</html>

0 commit comments

Comments
 (0)