setono/sylius-review-plugin

Send review requests to your customers

v1.0.0-beta 2024-04-29 10:51 UTC

Requires

• php: >=8.1
• doctrine/orm: ^2.0
• doctrine/persistence: ^2.0 || ^3.0
• ocramius/doctrine-batch-utils: ^2.4
• psr/event-dispatcher: ^1.0
• psr/log: ^1.1 || ^2.0 || ^3.0
• setono/composite-compiler-pass: ^1.1
• setono/doctrine-orm-trait: ^1.0.1
• sylius/core: ^1.0
• sylius/core-bundle: ^1.0
• sylius/mailer-bundle: ^1.8 || ^2.0
• sylius/order: ^1.0
• sylius/resource-bundle: ^1.6
• symfony/config: ^5.4 || ^6.4 || ^7.0
• symfony/console: ^5.4 || ^6.4 || ^7.0
• symfony/dependency-injection: ^5.4 || ^6.4 || ^7.0
• symfony/event-dispatcher: ^5.4 || ^6.4 || ^7.0
• symfony/http-kernel: ^5.4 || ^6.4 || ^7.0
• symfony/workflow: ^5.4 || ^6.4 || ^7.0
• webmozart/assert: ^1.11

Requires (Dev)

• api-platform/core: ^2.7.16
• babdev/pagerfanta-bundle: ^3.8
• behat/behat: ^3.14
• doctrine/doctrine-bundle: ^2.11
• infection/infection: ^0.27.10
• jms/serializer-bundle: ^4.2
• lexik/jwt-authentication-bundle: ^2.17
• matthiasnoback/symfony-dependency-injection-test: ^4.3 || ^5.1
• phpunit/phpunit: ^9.6.17
• psalm/plugin-phpunit: ^0.18.4
• setono/code-quality-pack: ^2.7
• sylius/sylius: ~1.12.13
• symfony/debug-bundle: ^5.4 || ^6.4 || ^7.0
• symfony/dotenv: ^5.4 || ^6.4 || ^7.0
• symfony/intl: ^5.4 || ^6.4 || ^7.0
• symfony/property-info: ^5.4 || ^6.4 || ^7.0
• symfony/serializer: ^5.4 || ^6.4 || ^7.0
• symfony/web-profiler-bundle: ^5.4 || ^6.4 || ^7.0
• symfony/webpack-encore-bundle: ^1.17.2
• synolia/sylius-mail-tester-plugin: ^2.4
• willdurand/negotiation: ^3.1

MIT

• sylius
• sylius-plugin

README

Send review requests to your customers to receive reviews for your store.

The plugin will create a review request upon customers completing an order. After an initial delay (configurable), a review request will be sent as an email to the customer asking them to review your store.

When processing a review request (i.e. trying to send it), the plugin will run an eligibility check to see if the review request is eligible to be sent. You can hook into this process to decide whether a review request should be sent or not.

Installation

composer require setono/sylius-review-plugin

Add plugin class to your bundles.php:

<?php
$bundles = [
    // ...
    Setono\SyliusReviewPlugin\SetonoSyliusReviewPlugin::class => ['all' => true],
    Sylius\Bundle\GridBundle\SyliusGridBundle::class => ['all' => true],
    // ...
];

Make sure you add it before SyliusGridBundle, otherwise you'll get You have requested a non-existent parameter "setono_sylius_review.model.review_request.class". exception.

Update your database

php bin/console doctrine:migrations:diff
php bin/console doctrine:migrations:migrate

Run commands

There are two commands in this plugin. One for processing review requests and one for pruning the review request table.

php bin/console setono:sylius-review:process
php bin/console setono:sylius-review:prune

You decide yourself how often you want to run these commands. The process command makes sense to run daily, while the prune command can be run weekly or monthly.

Configuration

setono_sylius_review:
    eligibility:
        # The initial delay before the first eligibility check. The string must be parseable by strtotime(). See https://www.php.net/strtotime
        initial_delay: '+1 week'

        # The maximum number of eligibility checks before the review request is automatically cancelled
        maximum_checks: 5
    
    pruning:
        # Review requests older than this threshold will be pruned/removed. The string must be parseable by strtotime(). See https://www.php.net/strtotime
        threshold: '-1 month'
    
    resources:
        review_request:
            options: ~
            classes:
                model: Setono\SyliusReviewPlugin\Model\ReviewRequest
                repository: Setono\SyliusReviewPlugin\Repository\ReviewRequestRepository
                factory: Sylius\Component\Resource\Factory\Factory

Add eligibility checker

You can add your own eligibility checker by implementing the Setono\SyliusReviewPlugin\EligibilityChecker\ReviewRequestEligibilityCheckerInterface.

<?php
use Setono\SyliusReviewPlugin\EligibilityChecker\EligibilityCheck;
use Setono\SyliusReviewPlugin\EligibilityChecker\ReviewRequestEligibilityCheckerInterface;

final class MyEligibilityChecker implements ReviewRequestEligibilityCheckerInterface
{
    public function check(ReviewRequestInterface $reviewRequest): EligibilityCheck
    {
        if(...) {
            return EligibilityCheck::ineligible('The review request is not eligible because of some reason...');
        }
        
        return EligibilityCheck::eligible();
    }
}

When you implement the interface, your service will automatically be added to the list of eligibility checkers. However, if you don't use autoconfiguration, you need to tag your service with setono_sylius_review.review_request_eligibility_checker.

Mail tester plugin

If you use the mail tester plugin you can test the review request email directly from the admin interface. Just go to https://your-store.com/admin/mail/tester and select the setono_sylius_review__review_request in the Subjects dropdown.