README

向您的客户发送评价请求以获取您的商店评价。

当客户完成订单后，插件将创建一个评价请求。在初始延迟后（可配置），将通过电子邮件向客户发送评价请求，请他们评价您的商店。

在处理评价请求时（即尝试发送它时），插件将运行资格检查以确定评价请求是否有资格发送。您可以通过 挂钩到此过程 来决定是否发送评价请求。

安装

composer require setono/sylius-review-plugin

将插件类添加到您的 bundles.php

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

确保您在 SyliusGridBundle 之前添加它，否则您将收到 您请求了一个不存在的参数 "setono_sylius_review.model.review_request.class". 异常。

更新您的数据库

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

运行命令

此插件中有两个命令。一个用于处理评价请求，另一个用于修剪评价请求表。

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

您自己决定多久运行这些命令。处理命令适合每天运行，而修剪命令可以每周或每月运行。

配置

setono_sylius_review:
    eligibility:
        # The initial delay before the first eligibility check. The string must be parseable by strtotime(). See https://php.ac.cn/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://php.ac.cn/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

添加资格检查器

您可以通过实现 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($this->getCustomer()->hasGreenEyes()) {
            return EligibilityCheck::ineligible('The review request is not eligible because we don't trust people with green eyes...');
        }
        
        return EligibilityCheck::eligible();
    }
}

当您实现该接口时，您的服务将自动添加到资格检查器的列表中。但是，如果您不使用自动配置，您需要将服务标记为 setono_sylius_review.review_request_eligibility_checker。

邮件测试插件

如果您使用 邮件测试插件，您可以直接从管理界面测试评价请求邮件。只需转到 https://your-store.com/admin/mail/tester 并在 Subjects 下拉菜单中选择 setono_sylius_review__review_request。