mangoweb-sylius/sylius-order-comments-plugin

Order comments plugin for Sylius

v0.0.1-alpha 2020-06-08 09:15 UTC

Requires

• php: ^7.3
• sylius/sylius: 1.7.*

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
• phpstan/phpstan-doctrine: ^0.10
• phpstan/phpstan-shim: ^0.10
• phpstan/phpstan-symfony: ^0.10
• phpstan/phpstan-webmozart-assert: ^0.10
• phpunit/phpunit: ^6.5
• sensiolabs/security-checker: ^5.0
• sylius-labs/coding-standard: ^2.0
• symfony/browser-kit: ^3.4|^4.1
• symfony/debug-bundle: ^3.4|^4.1
• symfony/dotenv: ^4.2
• symfony/intl: ^3.4|^4.1
• symfony/web-profiler-bundle: ^3.4|^4.1
• symfony/web-server-bundle: ^3.4|^4.1

Conflicts

• symfony/browser-kit: 4.1.8
• symfony/dependency-injection: 4.1.8
• symfony/dom-crawler: 4.1.8
• symfony/routing: 4.1.8
• symfony/symfony: 4.1.8

MIT

• sylius
• sylius-plugin

README

Order Comments Plugin

Features

• Create notes on order details
• Send personalized email to the addressee of the order

Installation

1. Run $ composer require mangoweb-sylius/sylius-order-comments-plugin.

2. Add plugin classes to your config/bundles.php:

   return [
      ...
      MangoSylius\OrderCommentsPlugin\MangoSyliusOrderCommentsPlugin::class => ['all' => true],
   ];

3. Add resource to config/packages/_sylius.yaml

   imports:
        ...
        - { resource: "@MangoSyliusOrderCommentsPlugin/Resources/config/config.yml" }

4. Add routing to config/_routes.yaml

   mango_sylius_order_comments_plugin:
     resource: "@MangoSyliusOrderCommentsPlugin/Resources/config/routing.yml"
     prefix: /admin

5. Override the template in @SyliusAdminBundle/Order/Show/_notes.html.twig

   ...
    {{ include('@MangoSyliusOrderCommentsPlugin/Admin/_order.html.twig') }}

6. Create and run doctrine database migrations.

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

Usage

• Comment can be written from the order detail.
• If I check the "Send to customer" checkbox, it will send an email to the customer's email.

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.

$ composer install
$ bin/console doctrine:schema:create -e test
$ bin/behat.sh
$ bin/phpstan.sh
$ bin/ecs.sh

License

This library is under the MIT license.

Credits

Developed by manGoweb.