>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #2292319. --> Reported by: [almaudoh](https://www.drupal.org/user/488082) >>> <h3 id="summary-problem-motivation">Problem/Motivation</h3> <p>Currently gateways are implemented as separate modules with all the code implemented in the foo.module file and callbacks defined in the foo_gateway_info() function. We want to change this approach and implement gateways as D8 Plugins. There are several good reasons to do this:</p> <ol> <li>There is a lot of boiler-plate code and repetition which would be eliminated by implementing gateways as objects, making it easier to write gateways. DX++</li> <li>Gateway module code is only needed when sending sms via that gateway, but currently is loaded at every page load and kept in memory causing memory bloat. As objects, all that code is lazy-loaded only when needed.</li> <li>A common interface can be enforced to ensure required methods are implemented.</li> <li>More than one gateway can be implemented by a single module - less module overhead.</li> <li>One single gateway plugin can be used to implement multiple gateways.</li> </ol> <p>All the above are the reasons for D8 in the first place and right now is the best practice architecturally.</p> <h3 id="summary-proposed-resolution">Proposed resolution</h3> <ol> <li>Implement a gateway plugin manager in sms module that uses AnotatedDiscovery to find sms gateway plugins</li> <li>Implement a base class for gateway plugins that contains all the basic functionality of sms gateways</li> <li>Retain the current hook_gateway_info based gateways for backward compatibility and convert them to gateway objects</li> </ol> <h3 id="summary-remaining-tasks">Remaining tasks</h3> <p>Patch<br> Reviews / Testing<br> Commit</p> <h3 id="summary-ui-changes">User interface changes</h3> <ol> <li>The SMS Default gateway selection page now has checkboxes for enabling / disabling each gateway. Selecting a disabled gateway as default in the UI automatically enables it. But the default gateway cannot be disabled.</li> <li>Configurable gateways have to be created as they don't exist by default. Non-configurable gateways exist by default once the plugin exists.</li> </ol> <h3 id="summary-api-changes">API changes</h3> <ol> <li>Added a <code>GatewayManagerInterface</code> to represent services that manage sms gateways.</li> <li>Added a <code>GatewayManager</code> class implementing <code>GatewayManagerInterface</code> and the corresponding <code>plugin.manager.sms_gateway</code> service.</li> <li>Added the <code>SmsGateway</code> plugin annotation type for annotating gateway plugins.</li> <li>Added a <code>GatewayInterface</code> to represent SMS Gateways and implemented a <code>GatewayBase</code> base class.</li> <li>Moved the log gateway to a <code>LogGateway</code> plugin class.</li> <li>Added a <code>SmsMessageProviderInterface</code> to represent sms messaging providers.</li> <li>Added a default <code>SmsMessageProviderInterface</code> implementation called <code>DefaultSmsProvider</code> and the corresponding <code>sms_provider.default</code> service, which does basically what the <code>sms_send()</code>, <code>sms_incoming()</code>, <code>sms_receipt()</code>, etc. used to do. More complex implementations of SMS messaging including multiple-gateway routing and load-balancing systems can subclass this default implementation.</li> <li>Added a <code>DeliveryReportController</code> for receiving and handling delivery reports.</li> <li>Added a <code>SmsMessageResultInterface</code> to represent the report / result that is returned by sms gateways for sms send requests. A default implementation <code>SmsMessageResult</code> is also added.</li> </ol>