fitratech/sylius-facebook-messenger-plugin

A plugin to integrate facebook messenger chat box in Sylius.

v0.1.3 2021-12-02 21:46 UTC

Requires

• php: ^7.3|^8.0
• sylius/sylius: ^1.7.5

Requires (Dev)

• behat/behat: ^3.6.1
• behat/mink-selenium2-driver: ^1.4
• dmore/behat-chrome-extension: ^1.3
• dmore/chrome-mink-driver: ^2.7
• friends-of-behat/mink: ^1.8
• friends-of-behat/mink-browserkit-driver: ^1.4
• friends-of-behat/mink-extension: ^2.4
• friends-of-behat/page-object-extension: ^0.3
• friends-of-behat/suite-settings-extension: ^1.0
• friends-of-behat/symfony-extension: ^2.1
• friends-of-behat/variadic-extension: ^1.3
• phpspec/phpspec: ^7.0
• phpstan/phpstan: 0.12.82
• phpstan/phpstan-doctrine: 0.12.33
• phpstan/phpstan-webmozart-assert: 0.12.12
• phpunit/phpunit: ^8.5
• sensiolabs/security-checker: ^6.0
• sylius-labs/coding-standard: ^3.1
• symfony/browser-kit: ^4.4
• symfony/debug-bundle: ^4.4|^5.0
• symfony/dotenv: ^4.4|^5.0
• symfony/intl: ^4.4|^5.0
• symfony/web-profiler-bundle: ^4.4|^5.0
• symfony/web-server-bundle: ^4.4|^5.0

MIT

• chat
• sylius
• Messenger
• facebook messenger
• sylius-plugin
• chatbox

README

    

Facebook Messenger

A facebook messenger plugin to embed the chat box for Sylius.

Features

enable the chat box & set the page id from the back office

inject the chat box directly via template event

Installation

Require the plugin :
composer require fitratech/sylius-facebook-messenger

If you are using Symfony Flex skip the bundles.php modification.

Modify config/bundles.php to add this line at the end :

    FitraTech\SyliusFacebookMessengerPlugin\FitraTechSyliusFacebookMessengerPlugin::class => ['all' => true],

Usage

1. Your Channel entity need to implement the FitraTech\SyliusFacebookMessengerPlugin\Model\ChannelInterface interface and use the FitraTech\SyliusFacebookMessengerPlugin\Model\ChannelTrait trait.

2. You need to run a diff of your doctrine's migrations: bin/console doctrine:migrations:diff. Don't forget to run it! (bin/console doctrine:migrations:migrate)

3. Override SyliusAdminBundle/Channel/_form.html.twig (if you are not familiar with template overriding check the official doc) and include @FitraTechSyliusFacebookMessengerPlugin/Channel/form.html.twig

   <div class="ui hidden divider"></div>
   {% include '@FitraTechSyliusFacebookMessengerPlugin/Channel/form.html.twig' %}
   

Front customization

You can override the chat box templates in your theme (src/FitraTechSyliusFacebookMessengerPlugin/Resources/views/embed.html.twig)

Local Development

Facebook Messenger chat box require a fully qualified domain name (FQDN) localhost & ip doesn't work, you need to setup a local domain if you use symfony cli follow the official doc and or this blog post