Symfony 5 - 自定义 Twig 错误模板 - PHP

介绍

当在 Symfony 应用程序中出现错误时，框架会显示默认的错误页面，这些页面通常难以定制或美化，并且可能不匹配应用程序的风格。

因此，Twig 模板引擎提供了一种简单的方法来自定义错误模板，以便更好地与应用程序整体外观和感觉相匹配。

步骤

以下是自定义 Twig 错误模板的步骤：

1. 创建自定义 Twig 模板

首先，必须创建一个自定义 Twig 模板，该模板将用于显示错误页面。 可以将模板放置在应用程序的 templates 目录中。例如，将模板命名为 error.html.twig。

模板必须包含一个继承自 base.html.twig 模板的 block，例如：

{% extends 'base.html.twig' %}

{% block body %}
    <h1>Oops! Something went wrong.</h1>

    <p>{{ exception.message }}</p>

    {% if app.debug %}
        <pre>{{ exception }}</pre>
    {% endif %}
{% endblock %}

上面的代码片段返回Markdown格式。

2. 注册自定义错误模板

要在 Symfony 应用程序中注册自定义错误模板，必须将以下配置添加到 config/packages/twig.yaml 配置文件中，如果该文件不存在，则可以创建它：

twig:
    exception_controller: App\Controller\ErrorController::show

其中，App\Controller\ErrorController::show 是自定义错误控制器的名称和方法。在下一步中，我们将创建这个控制器。

3. 创建自定义错误控制器

现在，我们需要创建一个错误控制器，该控制器将调用我们在第一步中创建的自定义 Twig 模板，并在应用程序中显示错误页面。 可以将控制器放置在应用程序的 src/Controller 目录中。例如，将其命名为 ErrorController.php。

控制器必须定义一个 show 方法，它将渲染我们之前创建的自定义 Twig 模板。以下是控制器的代码示例：

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;

class ErrorController extends AbstractController
{
    public function show(): Response
    {
        return $this->render('error.html.twig', [
            'exception' => $this->get('twig')->getGlobals()['exception'],
        ]);
    }
}

上面的代码片段返回Markdown格式。

4. 测试错误页面

现在，我们已经注册了自定义 Twig 模板和控制器，可以测试是否已正确配置错误页面。

要测试错误页面，可以在应用程序中触发一个错误，例如访问不存在的 URL。如果一切都设置正确，我们应该看到我们之前创建的自定义错误页面。

上面的代码片段返回Markdown格式。

结论

通过创建自定义 Twig 模板和控制器，我们可以很容易地定制和美化应用程序中的错误页面，并使其与应用程序整体外观和感觉相匹配。