mangoweb-sylius/sylius-mailchimp-plugin

MailChimp plugin for Sylius

v0.3.0 2020-08-20 12:03 UTC

Requires

• php: ^7.3
• ext-json: *
• drewm/mailchimp-api: ^2.5
• sylius/sylius: ^1.7.0

Requires (Dev)

• behat/behat: ^3.4
• behat/mink: ^1.7@dev
• behat/mink-browserkit-driver: ^1.3
• behat/mink-extension: ^2.2
• behat/mink-selenium2-driver: ^1.3
• friends-of-behat/page-object-extension: ^0.3
• friends-of-behat/suite-settings-extension: ^1.0
• friends-of-behat/symfony-extension: ^2.0
• friends-of-behat/variadic-extension: ^1.1
• lakion/mink-debug-extension: ^1.2.3
• phpspec/phpspec: ^6.0
• phpstan/phpstan: ^0.12.0
• phpstan/phpstan-doctrine: ^0.12.0
• phpstan/phpstan-strict-rules: ^0.12.0
• phpstan/phpstan-symfony: ^0.12.4
• phpstan/phpstan-webmozart-assert: ^0.12.0
• phpunit/phpunit: ^8.0
• sensiolabs/security-checker: ^6.0
• sylius-labs/coding-standard: ^3.1
• symfony/browser-kit: ^4.4
• symfony/debug-bundle: ^4.4
• symfony/dotenv: ^4.4
• symfony/intl: ^4.4
• symfony/web-profiler-bundle: ^4.4
• symfony/web-server-bundle: ^4.4

MIT

README

MailChimp Plugin

Features

• Per channel configurable options
• Subscribe user during checkout
• Subscribe user during registration
• Sync newsletter preferences in customer's profile
• Select the mailing list per channel
• Configure double opt-in per channel
• This plugin, unlike others, can handle large mailing lists

Installation

1. Run $ composer require mangoweb-sylius/sylius-mailchimp-plugin.
2. Register \MangoSylius\MailChimpPlugin\MangoSyliusMailChimpPlugin in your Kernel.
3. Your Entity Channel has to implement \MangoSylius\MailChimpPlugin\Entity\ChannelMailChimpSettingsInterface. You can use Trait MangoSylius\MailChimpPlugin\Entity\ChannelMailChimpSettingsTrait.
4. Include {{ include('@MangoSyliusMailChimpPlugin/mailChimpChannelSettingsForm.html.twig') }} in channel edit page.

For guide to use your own entity see Sylius docs - Customizing Models.

Configuration

Set the API Key in parameters.yml

mango_sylius_mail_chimp:
	mailchimp_api_key: API_KEY

Optional (subscription from checkout)

• Include subscribe checkbox template into checkout {{ include('@MangoSyliusMailChimpPlugin/newsletterSubscribeForm.html.twig') }}

Development

Usage

• Create symlink from .env.dist to .env or create your own .env file
• Develop your plugin in /src
• See bin/ for useful commands

Testing

After your changes you must ensure that the tests are still passing.

• Easy Coding Standard

  bin/ecs.sh

• PHPStan

  bin/phpstan.sh

License

This library is under the MIT license.

Credits

Developed by manGoweb.