diff --git a/docs/components/integrations_configuration.rst b/docs/components/integrations_configuration.rst index e795de64..5f06c172 100644 --- a/docs/components/integrations_configuration.rst +++ b/docs/components/integrations_configuration.rst @@ -213,3 +213,14 @@ Contact/Company syncing interfaces The IntegrationsBundle provides a sync framework for third party services to sync with Mautic's Contacts and Companies. The ``\Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormSyncInterface`` determines the configuration options for this sync feature. Refer to the method DocBlocks in the interface for more details. Read more about how to leverage the :doc:`sync framework`. + +.. vale off + +Config Form notes interface +=========================== + +.. vale on + +The interface, ``\Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface``, provides a way to display notes, either info or warning, on the Plugin configuration Form. + +Read more about to how-tos :doc:`here` diff --git a/docs/components/integrations_configuration_form_notes.rst b/docs/components/integrations_configuration_form_notes.rst new file mode 100644 index 00000000..c2d60bd5 --- /dev/null +++ b/docs/components/integrations_configuration_form_notes.rst @@ -0,0 +1,126 @@ +.. It is a reference only page, not a part of doc tree. + +:orphan: + +.. vale off + +Integration configuration form notes +#################################### + +.. vale on + +The Integration framework lets developer define their custom messages for the Plugin's configuration Form. + +The ``ConfigSupport`` class should implement the ``\Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface`` + +.. php:interface:: \Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface + +.. php:method:: public function getAuthorizationNote(): ?Note + + :return: The message and type for Auth tab. + :returntype: :ref:`Note` + +.. php:method:: public function getFeaturesNote(): ?Note + + :return: The message and type for Features tab. + :returntype: :ref:`Note` + +.. php:method:: public function getFieldMappingNote(): ?Note + + :return: The message and type for Field Mapping tab. + :returntype: :ref:`Note` + +_____ + +.. vale off + +Note Object +*********** + +.. vale:on + +.. php:class:: \Mautic\IntegrationsBundle\DTO\Note + +.. php:attr:: public note; + +.. php:attr:: public type; + +.. php:method:: public function getNote(): string + + :return: The string to display. + :returntype: string + +.. php:method:: public function getType(): string + + :return: The note type, this helps annotate the note. + :returntype: string + +The following code snippet shows the use of ``\Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface``. + + .. code-block:: php + +