nfq/sylius-omnisend-plugin

Omnisend plugin for Sylius.

v1.2.8 2024-02-14 13:53 UTC

Requires

• php: ^7.4 || ^8.0
• guzzlehttp/psr7: ^1.7
• http-interop/http-factory-guzzle: ^1.0
• php-http/guzzle6-adapter: ^2.0
• php-http/httplug: ^2.0
• php-http/httplug-bundle: ^1.19
• sylius/sylius: ^1.10
• symfony/lock: ^4.4 || ^5.4 || ^6.0
• symfony/messenger: ^4.4 || ^5.4 || ^6.0
• symfony/property-info: ^4.4 || ^5.4 || ^6.0
• symfony/serializer: ^4.4 || ^5.4 || ^6.0

Requires (Dev)

• behat/behat: ^3.6.1
• behat/mink-selenium2-driver: ^1.4
• coduo/php-matcher: ^6.0
• 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-debug-extension: ^2.1.0
• 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
• phpstan/extension-installer: ^1.0
• phpstan/phpstan: ^1.4
• phpstan/phpstan-doctrine: ^1.2
• phpstan/phpstan-strict-rules: ^1.1
• phpstan/phpstan-webmozart-assert: ^1.0
• phpunit/phpunit: ^8.5
• sensiolabs/security-checker: ^6.0
• sylius-labs/coding-standard: ^4.1
• symfony/browser-kit: ^4.4 || ^5.4 || ^6.0
• symfony/debug-bundle: ^4.4 || ^5.4 || ^6.0
• symfony/dotenv: ^4.4 || ^5.4 || ^6.0
• symfony/intl: ^4.4 || ^5.4 || ^6.0
• symfony/web-profiler-bundle: ^4.4 || ^5.4 || ^6.0
• symfony/web-server-bundle: ^4.4 || ^5.4 || ^6.0
• vimeo/psalm: 3.11.4

MIT

• sylius
• sylius-plugin

README

Omnisend Plugin

Documentation

This plugin implements Omnisend API and all required tracking scripts.

• Instalation
• Configuration
• Fixtures
• Omnisend tracking scripts
• Omnisend API
• Batch commands
• Async implementation

Tests

Running plugin tests

• PHPUnit

  vendor/bin/phpunit

• Behat (non-JS scenarios)

  vendor/bin/behat --strict --tags="~@javascript"

• Behat (JS scenarios)

  1. Install Symfony CLI command.

  2. Start Headless Chrome:

  google-chrome-stable --enable-automation --disable-background-networking --no-default-browser-check --no-first-run --disable-popup-blocking --disable-default-apps --allow-insecure-localhost --disable-translate --disable-extensions --no-sandbox --enable-features=Metal --headless --remote-debugging-port=9222 --window-size=2880,1800 --proxy-server='direct://' --proxy-bypass-list='*' http://127.0.0.1

  1. Install SSL certificates (only once needed) and run test application's webserver on 127.0.0.1:8080:

  symfony server:ca:install
  APP_ENV=test symfony server:start --port=8080 --dir=tests/Application/public --daemon

  1. Run Behat:

  vendor/bin/behat --strict --tags="@javascript"

• Static Analysis

  • Psalm

    vendor/bin/psalm

  • PHPStan

    vendor/bin/phpstan analyse -c phpstan.neon -l max src/  

• Coding Standard

  vendor/bin/ecs check src

Opening Sylius with your plugin

• Using test environment:

  (cd tests/Application && APP_ENV=test bin/console sylius:fixtures:load)
  (cd tests/Application && APP_ENV=test bin/console server:run -d public)

• Using dev environment:

  (cd tests/Application && APP_ENV=dev bin/console sylius:fixtures:load)
  (cd tests/Application && APP_ENV=dev bin/console server:run -d public)