README

提供了一个接口，用于提交简单的文本+电子邮件“错误报告”。适用于CCETC网络应用程序的前端和后端。

特点

一个简单的错误报告表单，与SonataAdmin类匹配。错误报告包括电子邮件或用户关系、一段文本、报告日期、请求→服务器属性以及用于处理的垃圾邮件和已打开的布尔值。

每次提交报告时，都会向ccetc_error_report.support_email发送电子邮件。

报告表单提供了一个mailto链接到同一个地址，主题为ccetc_error_report.direct_email_subject。

该捆绑包包含一个简单的帮助页面，其中嵌入表单。

可以在任何模板（前端/后端/错误页面）中渲染表单，但所有提交都将路由到帮助页面。

安装

添加到Composer

    "ccetc/error-report-bundle" : "dev-master"

安装资产

    bin/vendors install

配置

将以下行添加到您的services config.yml配置文件中

	ccetc_error_report:
	  support_email: haggertypat@gmail.com
	  direct_email_subject: Template+Error+Report

选项

• support_email - 用于错误报告通知的电子邮件，以及表单上的直接电子邮件链接
• 直接电子邮件链接的主题（默认：错误报告）

将报告的用户部分/用户关系添加到您的用户类中

    <one-to-many field="errorReportsSubmitted" target-entity="CCETC\ErrorReportBundle\Entity\ErrorReport" mapped-by="userSubmittedBy" />

使用

帮助页面

要包括“帮助页面”，请定义路由

    adminHelp:
            pattern: /adminHelp
            defaults: { _controller: CCETCErrorReportBundle:ErrorReport:errorReport, usePageHeader: true, flash: sonata_flash_success, redirect: sonata_admin_dashboard, baseLayout: SonataAdminBundle::standard_layout.html.twig, formRoute: adminHelp }

    frontendHelp:
            pattern: /help
            defaults: { _controller: CCETCErrorReportBundle:ErrorReport:errorReport, usePageHeader: false, flash: my_message, redirect: home, baseLayout: "::my_layout.html.twig", formRoute: frontendHelp }

路由选项

• usePageHeader: 如果为true，则“帮助”标题将放置在page_header块中。否则，标题将位于内容块顶部。默认：false
• flash: 成功消息的flash名称。默认：message
• redirect: 成功后重定向的路由。默认：home
• baseLayout: 要扩展的布局
• formRoute: 帮助页面的路由，用于在错误时重定向。默认：help

注意：错误报告表单扩展的基础布局必须有一个名为“stylesheets”的块和一个名为“content”的块

模板嵌入

您可以在模板中嵌入表单，前提是您已定义“帮助”路由来处理它。如果有错误，用户将被重定向到帮助页面以完成他们的提交。要在模板中包含表单

    {% render "CCETCErrorReportBundle:ErrorReport:errorReportForm" with {
        'formRoute' : 'help',
        'formText' : 'Please tell us about this error.'
    }%}

选项

• formRoute: 帮助页面的路由，用于在错误时重定向。默认：help
• formText: 在表单上方显示的文本，在直接电子邮件链接之前。默认：有问题吗？

文档

所有问题、想法和功能都在trello板上记录。