Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/escopecz/mautic-form-submit
PHP library to forward data to a Mautic form
https://github.com/escopecz/mautic-form-submit
mautic php-library
Last synced: 20 days ago
JSON representation
PHP library to forward data to a Mautic form
- Host: GitHub
- URL: https://github.com/escopecz/mautic-form-submit
- Owner: escopecz
- License: mit
- Created: 2017-04-25T19:23:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-29T13:08:06.000Z (3 months ago)
- Last Synced: 2024-11-16T09:09:12.493Z (26 days ago)
- Topics: mautic, php-library
- Language: PHP
- Size: 60.5 KB
- Stars: 57
- Watchers: 12
- Forks: 14
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-mautic - escopez/mautic-form-submit - PHP library to forward data to a Mautic form (Libraries)
README
# PHP library for submitting Mautic Form from 3rd party app
[](https://scrutinizer-ci.com/g/escopecz/mautic-form-submit/?branch=master)
[](https://scrutinizer-ci.com/g/escopecz/mautic-form-submit/build-status/master)
[](https://scrutinizer-ci.com/g/escopecz/mautic-form-submit/?branch=master)
Submitting a form can get handy if you want to process the data with your app, but you want to send them to Mautic too. Mautic can then run automated tasks triggered by the form submission. [Read more about it](https://medium.com/@jan_linhart/the-simplest-way-how-to-submit-a-form-data-to-mautic-1454d3afd005) in the original post.
Since the new Mautic versions prefer cookie tracking over IP tracking which makes more tedious to submit the form as the tracked contact, this library will take care of the cookie sending via CURL. It will also listen the cookie from the response and updates the contact cookie with the values from the submit response. This way if the contact ID changes because of contact merge, the contact will continue browsing under the new contact ID.
The automatic cookie handling requires that your form will be on a page tracked by the Mautic JS tracking which provides the Mautic contact cookie in the first place.
## Install
### Via Composer
```bash
composer require escopecz/mautic-form-submit
```
## Usage
```php
// Require Composer autoloader
require __DIR__.'/vendor/autoload.php';
// Define the namespace of the Mautic object
use Escopecz\MauticFormSubmit\Mautic;
// Define the namespace of the Mautic configuration object
use Escopecz\MauticFormSubmit\Mautic\Config;
// It's optional to declare the configuration object to change some default values.
// For example to disable Curl verbose logging.
$config = new Config;
$config->setCurlVerbose(true);
// Instantiate the Mautic object with the base URL where the Mautic runs
$mautic = new Mautic('https://mymautic.com');
// Create a new instance of the Form object with the form ID 342
$form = $mautic->getForm(342);
// Submit provided data array to the form 342
$result = $form->submit(['f_email' => '[email protected]']);
```
- The integer passed to the `getForm()` method must be ID of the Mautic form.
- The array passed to the `submit()` method must be associative array of `['mautic_field_alias' => 'the_value']`.
For working example see the `examples` dir.
## Run project
```
ddev start
```
Project url: https://mautic-form-submit.ddev.site/
## Testing
```
composer test
composer cs
composer phpstan
```
### Current status
[Travis](https://travis-ci.org/escopecz/mautic-form-submit)
[Scrutinizer](https://scrutinizer-ci.com/g/escopecz/mautic-form-submit)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.