mautic / helloworld-bundle
Hello World plugin built on the Integrations framework.
Installs: 9
Dependents: 0
Suggesters: 0
Security: 0
Stars: 13
Watchers: 16
Forks: 13
Open Issues: 4
Type:mautic-plugin
Requires
- php: >=7.4.0 <8.1
- mautic/core-lib: ^4.0
This package is auto-updated.
Last update: 2024-10-09 15:00:03 UTC
README
This is a sample plugin built for Mautic 4 using the integrations framework included in core that was originally based on the Integrations plugin.
An example for Mautic 2 for the Oauth2 client credentials grant can be found here. An example for Mautic 3 for the Oauth2 authorization code grant can be found here.
This can be used as an example in combination with the Integrations plugin wiki.
This plugin has examples for:
- Plugin migrations
- OAuth2 client credentials client
- Configuration UI interfaces
- Syncing Mautic contacts and companies
Mocked Responses
The following places have mocked code to simulate a working plugin:
- \MauticPlugin\HelloWorldBundle\Connection\Config::setIntegrationConfiguration()
- \MauticPlugin\HelloWorldBundle\Connection\Client::getClient()
- \MauticPlugin\HelloWorldBundle\Connection\MockedHandler
Code Expectations and Standards
This plugin also tries to exemplify code standards and expectations.
- Code should be clean (see https://github.com/jupeter/clean-code-php)
- Code should be well covered with unit and/or functional tests
- Code should meet CS standards (includes
symplify/easy-coding-standard
which can be ran withcomposer fixcs
) - Code should pass phpstan standards (run
composer phpstan
)