urbanara/catalog-promotion-plugin

Catalog promotion extension for Sylius.

v1.0.0-alpha.12 2018-02-02 12:23 UTC

Requires

• php: ^7.1
• sylius/elastic-search-plugin: ^1.0@beta
• sylius/shop-api-plugin: ^1.0@beta
• sylius/sylius: ^1.1@dev
• symfony/monolog-bundle: ^3.0

Requires (Dev)

• behat/behat: ^3.3
• behat/mink: ^1.7
• behat/mink-browserkit-driver: ^1.3
• behat/mink-extension: ^2.2
• behat/mink-selenium2-driver: ^1.3
• doctrine/common: <2.8
• friends-of-behat/context-service-extension: ^0.3
• friends-of-behat/cross-container-extension: ^0.2
• friends-of-behat/performance-extension: ^1.0
• friends-of-behat/service-container-extension: ^0.3
• friends-of-behat/symfony-extension: ^0.2.1
• friends-of-behat/variadic-extension: ^0.1
• lakion/api-test-case: ^1.2
• lakion/mink-debug-extension: ^1.2.3
• matthiasnoback/symfony-dependency-injection-test: ^1.0
• phpspec/phpspec: ^4.0
• phpunit/phpunit: ^5.6
• se/selenium-server-standalone: ^2.52

MIT

• Łukasz Chruściel

README

Plugin provides basic functionality of catalog promotion on a top of Sylius platform

Installation

1. Add plugin to your vendors:

$ composer require urbanara/catalog-promotion-plugin

1. Extend config files:

   1. Import project config:

      # app/config/config.yml
      
      imports:
          ...
          - { resource: "@CatalogPromotionPlugin/Resources/config/app/grid.yml" }

   2. Import project routing:

      # app/config/routing.yml
      ...
      
      urbanara_catalog_plugin:
          resource: "@CatalogPromotionPlugin/Resources/config/routing.yml"
          prefix: /admin

   3. Add plugin to AppKernel:

      // app/AppKernel.php
      
      $bundles = [
         ...
          new \Urbanara\CatalogPromotionPlugin\CatalogPromotionPlugin(),
      ];

   4. Extend gulp file with following script:

      // Gulpfile.js
      
      gulp.task('catalog-promotion', function() {
          return gulp.src([
              'node_modules/jquery/dist/jquery.min.js',
              'vendor/sylius/sylius/src/Sylius/Bundle/UiBundle/Resources/private/js/sylius-prototype-handler.js',
              'vendor/sylius/sylius/src/Sylius/Bundle/UiBundle/Resources/private/js/sylius-form-collection.js',
              'vendor/urbanara/catalog-promotion-plugin/src/Resources/public/**'
          ])
              .pipe(concat('app.js'))
              .pipe(sourcemaps.write('./'))
              .pipe(gulp.dest('web/assets/catalog/' + 'js/'))
              ;
      });
      
      gulp.task('default', ['admin', 'shop', 'catalog-promotion']);

2. To support SyliusElasticSearchPlugin apply the following changes:

   1. Configure ONGR in app/config/config.yml:

      # app/config/config.yml
      
      ongr_elasticsearch:
          managers:
              default:
                  index:
                      index_name: sylius
                  mappings:
                      CatalogPromotionPlugin:
                          document_dir: ElasticSearch\Document

   2. Add required bundles to app/AppKernel.php:

      // app/AppKernel.php
      
      $bundles = [
          // ...
          new \Sylius\ElasticSearchPlugin\SyliusElasticSearchPlugin(),
          new \ONGR\ElasticsearchBundle\ONGRElasticsearchBundle(),
          new \ONGR\FilterManagerBundle\ONGRFilterManagerBundle(),
          new \SimpleBus\SymfonyBridge\SimpleBusCommandBusBundle(),
          new \SimpleBus\SymfonyBridge\SimpleBusEventBusBundle(),
      ];

3. If you want to see strikeout prices in your shop you need to customize templates on your own. A sample customization is available under tests/Application/app/Resources/SyliusShopBundle

Usage

Plugin provides basic crud functionality for catalog promotion as well as processor which will influence unit price of bought items. In addition, a twig helper is provided, which will return a ValueObject with old and current price.

Plugin supports catalog promotion with start date, ends date, promotion prioritization, custom promotion per channel, exclusive promotions. By default plugin provides two rules which will reduce a number of influenced items and two action. Rules:

• Is product - the promotion will be applied only to the products selected in select box.
• Is from taxon - the promotion will be applied only to the products which has at least one taxon from selected taxons in select box.

Actions:

• Fixed value action - will reduce the price of product by fixed value. Value is set per channel.
• Percentage action - will reduce the price of product by a percentage.

All features are described in features/ section.