From ae5e0bf55298079e42a809c34100eacdea2f39bb Mon Sep 17 00:00:00 2001 From: Rahul Shinde Date: Tue, 11 Oct 2022 09:03:44 +0530 Subject: [PATCH 1/3] Updated documentation for the ConfigFormNotesInterface usages. --- source/includes/_plugin_integrations_configuration.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/source/includes/_plugin_integrations_configuration.md b/source/includes/_plugin_integrations_configuration.md index 025e272c529..bfee1cfdf46 100644 --- a/source/includes/_plugin_integrations_configuration.md +++ b/source/includes/_plugin_integrations_configuration.md @@ -98,3 +98,6 @@ Currently the integrations bundle provides default features. To use these featur The integrations bundle provides a sync framework for 3rd 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 [sync framework](#integration-sync-engine). + +##### Config Form Notes Interface +The interface, `\Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface`, provides a way to put notes, either info or warning, on the plugin configuration form. From 1a5b2b54d466d74f833a25fa6a42dcee0d9c69c8 Mon Sep 17 00:00:00 2001 From: Rahul Shinde Date: Tue, 11 Oct 2022 09:18:12 +0530 Subject: [PATCH 2/3] Adding new page for the documentation. --- .../_plugin_integrations_configuration.md | 2 + ...n_integrations_configuration_form_notes.md | 81 +++++++++++++++++++ 2 files changed, 83 insertions(+) create mode 100644 source/includes/_plugin_integrations_configuration_form_notes.md diff --git a/source/includes/_plugin_integrations_configuration.md b/source/includes/_plugin_integrations_configuration.md index bfee1cfdf46..fcd991937e6 100644 --- a/source/includes/_plugin_integrations_configuration.md +++ b/source/includes/_plugin_integrations_configuration.md @@ -101,3 +101,5 @@ Read more about how to leverage the [sync framework](#integration-sync-engine). ##### Config Form Notes Interface The interface, `\Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface`, provides a way to put notes, either info or warning, on the plugin configuration form. + +Read more about to how tos [here](#integration-configuration-form-notes) diff --git a/source/includes/_plugin_integrations_configuration_form_notes.md b/source/includes/_plugin_integrations_configuration_form_notes.md new file mode 100644 index 00000000000..b2da9da1847 --- /dev/null +++ b/source/includes/_plugin_integrations_configuration_form_notes.md @@ -0,0 +1,81 @@ +### Integration Configuration Form Notes + +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 + Date: Thu, 13 Oct 2022 16:45:20 +0530 Subject: [PATCH 3/3] Removed unused imports. --- .../includes/_plugin_integrations_configuration_form_notes.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/source/includes/_plugin_integrations_configuration_form_notes.md b/source/includes/_plugin_integrations_configuration_form_notes.md index b2da9da1847..38292cc2322 100644 --- a/source/includes/_plugin_integrations_configuration_form_notes.md +++ b/source/includes/_plugin_integrations_configuration_form_notes.md @@ -20,13 +20,9 @@ use Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormFeaturesInterface use Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormInterface; use Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface; use Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormSyncInterface; -use Mautic\IntegrationsBundle\Mapping\MappedFieldInfoInterface; -use Mautic\IntegrationsBundle\Sync\SyncDataExchange\Internal\Object\Company; -use Mautic\IntegrationsBundle\Sync\SyncDataExchange\Internal\Object\Contact; use MauticPlugin\HelloWorldBundle\Form\Type\ConfigAuthType; use MauticPlugin\HelloWorldBundle\Form\Type\ConfigFeaturesType; use MauticPlugin\HelloWorldBundle\Integration\HelloWorldIntegration; -use MauticPlugin\HelloWorldBundle\Sync\Mapping\Manual\MappingManualFactory; class ConfigSupport extends HelloWorldIntegration implements ConfigFormInterface, ConfigFormAuthInterface, ConfigFormFeatureSettingsInterface, ConfigFormSyncInterface, ConfigFormFeaturesInterface, ConfigFormNotesInterface {