ras / flash-alert-bundle
FlashAlertBundle提供了一种简化的方式来处理(添加/显示)Symfony的闪存消息。客户端脚本使用纯JavaScript编写。
2.1.1
2016-01-03 21:38 UTC
Requires
- php: >=5.3.3
- symfony/symfony: >=2.1
- twig/twig: ~1.12
This package is not auto-updated.
Last update: 2024-09-14 16:29:24 UTC
README
FlashAlertBundle是一个开源Bundle,简化了显示成功、错误、信息和警告等闪存警报。
目录
安装
步骤 1: 下载FlashAlertBundle
使用Composer 将以下内容添加到您的composer.json
文件中的"require"部分
"ras/flash-alert-bundle": "dev-master"
并更新您的依赖项
php composer.phar update
使用子模块 在您的项目根目录中执行以下命令
$ git submodule add git@github.com:rasanga/FlashAlertBundle.git vendor/bundles/Ras/FlashAlertBundle $ git submodule update --init
步骤 2: 启用Bundle
在您的app/AppKernel.php
中注册Bundle
<?php ... public function registerBundles() { $bundles = array( ... new Ras\Bundle\FlashAlertBundle\RasFlashAlertBundle(), ... ); ...
步骤(可选),如果您不使用Composer:配置自动加载器
将以下内容添加到您的autoload.php
<?php ... 'Ras' => __DIR__.'/../vendor/bundles',
使用
报告闪存警报
添加以下PHP代码以报告警报消息
$this->get('ras_flash_alert.alert_reporter')->addError("Access denied");
注意:您可以从$this->get('ras_flash_alert.alert_reporter')
调用以下函数之一
addSuccess()
addError()
addWarning()
addInfo()
显示闪存警报
将以下twig代码添加到您想显示警报消息的地方
{{ render_flash_alerts() }}
注意 1:父级twig模板是显示闪存警报的最佳位置
配置
以下参数可以在您的config.yml
或类似文件中重写
ras_flash_alert:
template: '::flashAlerts.html.twig' # defaults to 'RasFlashAlertBundle::layout.html.twig'
isAddStyles: false # defaults to true
isAddJsAlertClose: false # defaults to true
这些也可以在渲染警报时作为参数传递到视图中 - 例如
{{ render_flash_alerts({ 'template': '::flashAlerts.html.twig', 'isAddStyles': false }) }}
覆盖视图模板
- 在
/Resources/views/
或您的bundle中创建模板 - 使用
{{ get_alert_publisher() }}
将警报检索到您的模板中 - 在
FlashAlertBundle/Resources/views/FlashAlert
目录中包含模板块或定义您自己的块(遵循FlashAlertBundle/Resources/views/FlashAlert/flashAlerts.html.twig
了解如何定义自己的模板)
添加自定义样式
该捆绑包默认模板已默认定义了样式。但是,您可以通过将isAddStyles变量配置为false来关闭默认样式,如下所示。
{{ render_flash_alerts({ 'isAddStyles': false }) }}
然后您可以为以下警报类定义自己的样式,如alert
、alert-close
、alert-success
、alert-error
、alert-warning
和alert-info
变更日志
2.0
Add twig method for rendering alerts: `{{ render_flash_alerts() }}`
Add twig method for retrieving alerts: `{{ get_alert_publisher() }}`
Deprecated controller view render
许可
FlashAlertBundle使用MIT开源许可。