https://github.com/mautic/plugin-helloworld
Hello World plugin built on the Integration framework
https://github.com/mautic/plugin-helloworld
hacktoberfest mautic php
Last synced: about 2 months ago
JSON representation
Hello World plugin built on the Integration framework
- Host: GitHub
- URL: https://github.com/mautic/plugin-helloworld
- Owner: mautic
- Created: 2020-02-14T02:38:55.000Z (over 5 years ago)
- Default Branch: mautic-4
- Last Pushed: 2025-05-02T16:04:36.000Z (5 months ago)
- Last Synced: 2025-08-06T10:39:46.346Z (2 months ago)
- Topics: hacktoberfest, mautic, php
- Language: PHP
- Homepage:
- Size: 114 KB
- Stars: 13
- Watchers: 16
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hello World
This is a sample plugin built for Mautic 4 using the integrations framework included in core that was originally based on the [Integrations plugin](https://github.com/mautic-inc/plugin-integrations).
An example for Mautic 2 for the Oauth2 client credentials grant can be found [here](https://github.com/mautic-inc/plugin-helloworld/tree/mautic-2).
An example for Mautic 3 for the Oauth2 authorization code grant can be found [here](https://github.com/mautic-inc/plugin-helloworld/tree/mautic-3-authorization-code-grant-example).
This can be used as an example in combination with the [Integrations plugin wiki](https://github.com/mautic-inc/plugin-integrations/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](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 with `composer fixcs`)
* Code should pass phpstan standards (run `composer phpstan`)