README

A batteries included Laravel wrapper for Mautic API.

Installation

You can install the package via composer:

composer require swisnl/laravel-mautic

Configuration

Laravel Mautic requires connection configuration.

To get started, you'll need to publish all vendor assets:

php artisan vendor:publish --tag="mautic-config"

This will create a config/mautic.php file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.

There are two config options:

Default Connection Name

This option ('default') is where you may specify which of the connections below you wish to use as your default connection for all work. Of course, you may use many connections at once using the manager class. The default value for this setting is 'main'.

Mautic Connections

This option ('connections') is where each of the connections are set up for your application. Example configuration has been included, but you may add as many connections as you would like. Note that the 2 supported authentication methods are: "oauth" and "password".

Usage

MauticManager

This is the class of most interest. It is bound to the ioc container as 'laravel-mautic' and can be accessed using the Facades\Mautic facade. This class implements the ManagerInterface by extending AbstractManager. The interface and abstract class are both part of my Laravel Manager package, so you may want to go and checkout the docs for how to use the manager class over at that repo. Note that the connection class returned will always be an instance of Swis\Laravel\Mautic\Client.

Facades\Mautic

This facade will dynamically pass static method calls to the 'laravel-mautic' object in the ioc container which by default is the MauticManager class.

LaravelMauticServiceProvider

This class contains no public methods of interest. This class should be added to the providers array in config/app.php. This class will set up ioc bindings.

Real Examples

Here you can see an example of just how simple this package is to use. Out of the box, the default adapter is main. After you enter your authentication details in the config file, it will just work:

use Swis\Laravel\Mautic\Facades\Mautic;
// you can alias this in config/app.php if you like

Mautic::contacts()->find(1);
// we're done here - how easy was that, it just works!

The mautic manager will behave like it is a Swis\Laravel\Mautic\Client class. If you want to call specific connections, you can do with the connection method:

use Swis\Laravel\Mautic\Facades\Mautic;

// writing this:
Mautic::connection('main')->contacts()->find(1);

// is identical to writing this:
Mautic::contacts()->find(1);

// and is also identical to writing this:
Mautic::connection()->contacts()->find(1);

// this is because the main connection is configured to be the default
Mautic::getDefaultConnection(); // this will return main

// we can change the default connection
Mautic::setDefaultConnection('alternative'); // the default is now alternative

// Get all the contacts
Mautic::contacts()->getList();

If you prefer to use dependency injection over facades like me, then you can easily inject the manager like so:

use Illuminate\Support\Facades\App; // you probably have this aliased already
use Swis\Laravel\Mautic\MauticManager;

class Foo
{
    protected $mautic;

    public function __construct(MauticManager $mautic)
    {
        $this->mautic = $mautic;
    }

    public function bar()
    {
        $this->mautic->contacts()->find(1);
    }
}

App::make('Foo')->bar();

For more information on what features are available on the Swis\Laravel\Mautic\Client class, check out the Mautic docs at https://developer.mautic.org/#endpoints, and the manager class at https://github.com/GrahamCampbell/Laravel-Manager#usage.

Notifications

To use the notification driver built into this package make sure the entity you want to notify has the following traits:

class User extends Model
{
    use Notifiable;
    use SynchronizesWithMauticTrait;
    use NotifiableViaMauticTrait;
}

Then make sure to add a Notification to your Laravel project. This notification should include the MauticChannel from this package in the via() method. Make sure your notification includes a toMautic() method which returns an instance of MauticMessage. For this you can use the create() method:

<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Notifications\Notification;
use Swis\Laravel\Mautic\Notifications\MauticChannel;
use Swis\Laravel\Mautic\Notifications\MauticMessage;

class OrderFulfilled extends Notification
{
    use Queueable;

    public function __construct(
        public readonly string $message,
    ) {
    }

    public function via(mixed $notifiable): array
    {
        return [MauticChannel::class];
    }

    public function toMautic(mixed $notifiable): MauticMessage
    {
        return MauticMessage::create(1) // The id of the mail in Mautic
            ->tokens([
                'message' => $message,
            ])
            ->to($mauticUserId); // Optional
    }
}

In this example we set Tokens and To on the MauticMessage. Tokens are used to add placeholders in a Mautic mail template. To is optional and will use $notifiable->routeNotificationFor('mautic') as fallback.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email security@swis.nl instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

SWIS ❤️ Open Source

SWIS is a web agency from Leiden, the Netherlands. We love working with open source software.

swisnl / laravel-mautic

Maintainers

Details