jguido / widget-bundle
此包添加了一个用于以通用方式渲染数据的Widget系统。它还允许生成Widget文件。
Requires
- php: >=5.5.6
- symfony/symfony: >=2.8
This package is not auto-updated.
Last update: 2024-09-14 19:53:06 UTC
README
composer require jguido/widget-bundle
然后将此包添加到您的内核(app/AppKernel.php)
new WidgetBundle\WidgetBundle(),
new ApplicationWidgetBundle\ApplicationWidgetBundle(),
在app/config/routing.yml中添加
bundle_widget:
resource: "@WidgetBundle/Resources/config/routing.yml"
prefix: /
在app/config/config.yml的导入部分添加
- { resource: "@ApplicationWidgetBundle/Resources/config/widgets.yml" }
在布局的样式声明中添加此行
<link href="{{ asset('bundles/widget/css/widget-render.css') }}" rel="stylesheet" media="screen" type="text/css"/>
在布局的javascript声明中添加此行
<script type="text/javascript" src="{{ asset('bundles/widget/js/Widget.js') }}"></script>
用法
有一个用于生成所需Widget文件的命令
php bin/console generate:widget <widget_name>
Widget的渲染是这样进行的
最简单的方式
{{ render_widget('widget.<widget_name>') }}
如果您的Widget路由需要参数
{{ render_widget('widget.<widget_name>', {'param1': param1}) }}
但这样做的话,您将不得不更新包文件(在src/ApplicationWidgetBundle/Widget/your_widget)中的路由定义
Widget内容通过Ajax调用加载,所有DOM事件都是函数性的(window.onload, $(function){...});)
文件结构:src -- ApplicationWidgetBundle ----Resources ------config --------widgets.yml(Widget服务定义) ------views(生成的视图放置的位置) ----Widget(所有Widget(控制器)类内部)
示例(用例)
您想要生成一个名为"test"的包
在控制台
php bin/console generate:widget test
服务定义中会有什么(src/ApplicationWidgetBundle/Resources/config/widgets.yml)
services:
widget.test:
class: ApplicationWidgetBundle\Widget\TestWidget
在Widget类内部
<?php
namespace ApplicationWidgetBundle\Widget;
use WidgetBundle\Base\BaseWidget;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Component\HttpFoundation\Response;
class TestWidget extends BaseWidget
{
/**
* @param $params
* @return mixed
*/
protected function getData($params)
{
throw new \Exception("Not implemented");
}
/**
* @param array|null $params
* @return string
*/
public function getUri(array $params = null)
{
return $this->generateUrl('path_widget_test', $params);
}
/**
* @return Response
* @internal param Request $request
* @Route("/widgets/test/render", name="path_widget_test")
*/
public function widgetAction()
{
return $this->render('ApplicationWidgetBundle:Test:test.html.twig');
}
}
This TestWidget类将作为通用控制器
在views目录内部
一个名为Test的子目录,并在其中包含一个文件test.html.twig
<div class="col-xs-12">
This is widget Test
</div>
您可以通过其他twig视图来渲染它,如下所示
{{ render_widget('widget.test') }}