Skip to content

docs: Port "Integrations" extension page to 7.2#590

Open
promptless-for-oss wants to merge 1 commit into
mautic:7.2from
Promptless:promptless/docs-issue-329-integrations-7.2
Open

docs: Port "Integrations" extension page to 7.2#590
promptless-for-oss wants to merge 1 commit into
mautic:7.2from
Promptless:promptless/docs-issue-329-integrations-7.2

Conversation

@promptless-for-oss

Copy link
Copy Markdown
Contributor

Open this suggestion in Promptless to view citations and reasoning process

Ports the legacy AbstractIntegration guide from the legacy developer-documentation repo into docs/plugin_extensions/integrations.rst, converting Markdown to RST with a pointer to the modern Integrations framework. Targets the 7.2 base branch. Resolves docs issue #329 (content from parent #328).

Trigger Events


Tip: Sort by Shortest Review in the Dashboard to find quick wins ⚡

Ports the legacy AbstractIntegration guide from the legacy developer-documentation
repo into docs/plugin_extensions/integrations.rst, converting Markdown to RST and
pointing readers to the modern Integrations framework. Resolves docs issue mautic#329
(content from mautic#328), targeting the 7.2 base branch.

Ref: mautic#329, mautic#328
Integration class
*****************

A Plugin can provide multiple Integrations, each defined as its own class in the bundle's ``Integration`` folder. The class extends ``Mautic\PluginBundle\Integration\AbstractIntegration``, which provides many helper methods, including OAuth authorization and request signing:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ported the Integration class, Integration image, Authorization, Functions, and makeRequest sections plus the MarsIntegration example from the legacy _plugin_extending_integrations.md source, cleaning up the duplicated <?php line and the missing semicolon after return 'Red Mars' and adding PHP return types per the org style guide.

Source: https://github.com/mautic/developer-documentation/blob/main/source/includes/_plugin_extending_integrations.md


.. note::

This page covers the legacy ``AbstractIntegration`` approach. New Integrations should use the :doc:`Integrations framework</plugin_integrations/integrations>`, which separates authentication, configuration, and sync concerns into dedicated interfaces.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issue #328 (parent of #329) supplied the legacy source URL and the "transfer the content under the note admonition" guidance, so the ported content is placed under the existing .. note:: placeholder and the legacy AbstractIntegration approach is cross-linked to the modern plugin_integrations/integrations framework page.

Source: #328

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant