brookinsconsulting/bcerrorpagesbundle

BC Error Pages Bundle for Symfony 3. 提供了一种基本解决方案,用于用设计友好的替代方案覆盖默认的 Symfony 错误页面模板代码和样式。非常适合希望覆盖 Symfony 默认错误页面的开发者。

dev-master 2017-03-07 03:21 UTC

This package is auto-updated.

Last update: 2024-09-29 04:48:45 UTC


README

此包实现了一种解决方案,用于用设计友好的替代方案覆盖默认的 Symfony 错误页面模板代码和样式。非常适合希望覆盖 Symfony 默认错误页面的开发者。

版本

  • BC Error Pages 的当前版本为 0.1.0

  • 上次主要更新:2017年2月24日

版权

  • BC Error Pages 版权所有 1999 - 2017 Brookins Consulting

  • 更多信息请参阅:COPYRIGHT.md

许可证

BC Error Pages 受 GNU 通用公共许可证许可。

完整的许可协议包含在LICENSE文件中。

BC Error Pages 是免费软件:您可以在自由软件基金会的 GNU 通用公共许可证的条款下重新分发和/或修改它,无论是许可证的第 2 版还是您选择的任何后续版本。

BC Error Pages 的分发希望它能被有用,但没有任何保证;甚至没有关于其适销性或适用于特定目的的暗示性保证。有关详细信息,请参阅 GNU 通用公共许可证。

GNU GPL 在某些条件下赋予您使用、修改和重新分发 BC Error Pages 的权利。GNU GPL 许可证随软件分发,请参阅 doc/LICENSE 文件。

它也可在https://gnu.ac.cn/licenses/gpl.txt找到。

您应该已收到与 BC Error Pages 一起的 GNU 通用公共许可证副本,位于 doc/LICENSE。如果没有,请参阅https://gnu.ac.cn/licenses/

根据 GNU GPL 使用 BC Error Pages 是免费的(作为自由)。

有关更多信息或问题,请联系:license@brookinsconsulting.com

要求

使用 BC Error Pages 的以下要求存在

Symfony 版本

  • 请确保您使用 Symfony 版本 2.8+(必需)或更高版本。

  • 设计与测试使用 Symfony 3.2.x

PHP 版本

  • 请确保您有 PHP 5.6 或更高版本。

特性

错误页面模板

  • layout:base.html.twig
  • Exception:error(*).html.twig

命令

  • bc:ep:install - 通过符号链接安装全局模板覆盖(这些通过 composer 默认安装)

Composer 脚本处理程序

  • 在 composer 包安装时运行 bc:ep:install 命令,安装资源和清除缓存

依赖

  • 此解决方案在任何方面都不依赖于 eZ 平台
  • 此解决方案依赖于 symfony/symfony
  • 此解决方案依赖于 symfony/filesystem

用例要求

此解决方案是为了提供一种简单的基础,以使用 bc 品牌样式替换来定制难看但信息丰富的 Symfony 错误页面。

安装

包后安装/更新命令脚本安装

在你的项目或网站的根目录下的 composer.json 文件中添加以下 composer 脚本块,以便自动安装错误页面模板和资源。

"scripts": {
    "symfony-scripts": [
        "Incenteev\\ParameterHandler\\ScriptHandler::buildParameters",
        "BrookinsConsulting\\BcErrorPagesBundle\\Composer\\ScriptHandler::installErrorPagesInApp",
        "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::clearCache",
        "Sensio\\Bundle\\DistributionBundle\\Composer\\ScriptHandler::installAssets"
    ],
    "post-install-cmd": [
        "@symfony-scripts"
    ],
    "post-update-cmd": [
        "@symfony-scripts"
    ]
},

包激活

在文件 app/AppKernel.php 中的 registerBundles 方法中,将以下内容添加到 $bundles = array( 变量定义中。

// Brookins Consulting : BcErrorPagesBundle Requirements
new BrookinsConsulting\BcErrorPagesBundle\BcErrorPagesBundle()

在通过 composer 安装包之前安装上述内容,以确保自动安装错误页面模板和资源脚本能按预期工作。

通过 Composer 安装包

从你的项目根目录运行以下命令来安装包

bash$ composer require brookinsconsulting/bcerrorpagesbundle dev-master;

开发环境路由安装(可选)

编辑你的 app/config/routing.yml 文件,并添加以下代码以导入此包的路由。请注意,此步骤是可选的,只有在你希望手动测试错误页面时才需要。

app_bcerrorpages:
    resource: "@BcErrorPagesBundle/Resources/config/routing_dev.yml"

模板安装

如果不通过 composer 安装则需要

php bin/console bc:ep:install --relative

资源安装

如果不通过 composer 安装则需要

php bin/console assets:install web --symlink --relative

清除缓存

清除 Symfony 缓存(必需)。

php bin/console cache:clear;

模板定制

自定义模板覆盖

如果你需要定制提供的模板,请确保在包的资源本身中进行。

如果需要,你可以基于此包创建分支或变体,以适合你进一步定制模板的需求。

使用

默认情况下,此解决方案在正确安装后配置为虚拟工作。

测试

在正确安装和配置后,此解决方案配置为工作。

只需导航到一个未定义的路由或 URL,以触发 404 错误,并查看新的错误页面模板。

故障排除

阅读 FAQ

有些问题比其他问题更常见。最常见的列在 doc/FAQ.md 中。

支持

如果你发现此文档或 FAQ 中没有处理的问题,你可以通过支持系统联系 Brookins Consulting:http://brookinsconsulting.com/contact