README

⚠️ BEWARE! This repository has been deprecated and will not be maintained or evolved by the Sylius Team. You can still use it with compatible Sylius versions, but at your own risk, as no bugs will be fixed on it.

Customer Reorder Plugin

This plugin allows customers to reorder a previously placed order.

Business value

The plugin allows Customer to reorder any Order that has already been placed. Once a Reorder button is clicked, a new cart filled with items taken from a previously placed order is created. If for some reason Reorder can't be fulfilled completely, the Customer is informed about every circumstance that have affected the Order (i. e. promotion being no longer available or differences in item's prices).

Once the Reorder process is completed, the newly created Order is listed in the history just like any other Orders.

Installation

Beware!

This installation instruction assumes that you're using Symfony Flex. If you don't, take a look at the legacy installation instruction. However, we strongly encourage you to use Symfony Flex, it's much quicker! :)

To install plugin, just require it with composer:

composer require sylius/customer-reorder-plugin

Remember to allow community recipes with composer config extra.symfony.allow-contrib true or during plugin installation process

Extension points

Customer Reorder plugin is based on two processes:

• reorder processing
• reorder eligibility checking

They are both based on Symfony's compiler passes and configured in services.xml file.

ReorderProcessing and EligibilityChecking are independent processes - once a Reorder is created using Processors (services tagged as sylius_customer_reorder_plugin.reorder_processor), the created entity is passed to Eligibility Checkers (services tagged as sylius_customer_reorder_plugin.eligibility_checker).

Hence, both processes can be extended separately by adding services that implement ReorderEligibilityChecker and are tagged as sylius_customer_reorder_plugin.eligibility_checker or implement ReorderProcessor and are tagged as sylius_customer_reorder_plugin.reorder_processor.

Both Reorder button layout and action performed on clicking it are defined in reorder.html.twig template which is declared in config.yml file.

What's more, since Order is a Resource, major part of its configuration is placed in *.yml files. Without using the plugin, Order had Show and Pay actions. Adding Reorder action required extending order-related behaviours in config.yml file.

You can read much more about Resources here: http://docs.sylius.com/en/1.2/components_and_bundles/bundles/SyliusResourceBundle/index.html

Security issues

If you think that you have found a security issue, please do not use the issue tracker and do not post it publicly. Instead, all security issues must be sent to security@sylius.com.

Contributing : installation

Traditional

1. Run composer create-project sylius/customer-reorder-plugin ProjectName.

2. From the plugin skeleton root directory, run the following commands:

   $ (cd tests/Application && yarn install)
   $ (cd tests/Application && yarn build)
   $ (cd tests/Application && APP_ENV=test bin/console assets:install public)
   
   $ (cd tests/Application && APP_ENV=test bin/console doctrine:database:create)
   $ (cd tests/Application && APP_ENV=test bin/console doctrine:schema:create)

To be able to set up a plugin's database, remember to configure you database credentials in tests/Application/.env and tests/Application/.env.test.

Docker

1. Initialize plugin make init

2. See your browser open localhost

Usage

Running plugin tests

• PHPUnit

  vendor/bin/phpunit

• PHPSpec

  vendor/bin/phpspec run

• 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