uam/datatables-bundle

Datatables jquery 插件打包为 Symfony 组件

5.0.0 2017-03-22 15:59 UTC

README

一个 symfony 2 组件,提供了一种方便的方式将 dataTables jquery 插件包含到您的 symfony 2 应用中。

此组件包含 dataTables 插件的 1.10 版本。它还包括与 bootstrap 相关的插件附加功能。

安装

将组件添加到项目的 composer.json

{
    "require": {
        "uam/datatables-bundle": "~3.0",
        ...
    }
}

运行 composer installcomposer update 以安装组件

$ php composer.phar update uam/datatables-bundle

在应用的 kernel 中启用组件

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new UAM\Bundle\DatatablesBundle\UAMDatatablesBundle(),
    );
}

如果您的 composer.json 中未包含 post-install 或 post-update 的 installAssets 脚本处理程序,则运行以下命令

$ php app/console assets:install

$ php app/console assets:install --symlink

使用方法

要了解如何使用 dataTables jquery 插件本身,请参阅插件的首页 http://www.datatables.net

要使用此组件本身,只需像使用其他组件一样在模板中包含组件的资产。dataTables 插件的资产位于 web/bundles/uamdatatables 目录下。

# template.html.twig

{% stylesheets filter="cssrewrite"
    'bundles/uamdatatables/vendor/datatables-plugins/integration/bootstrap/3/dataTables.bootstrap.css'
	'bundles/uamdatatables/vendor/datatables-plugins/integration/font-awesome/dataTables.fontAwesome.css'
	'bundles/uamdatatables/css/table.css'
%}
	<link href="{{ asset_url }}" type="text/css" rel="stylesheet" media="screen" />
{% endstylesheets %}

{% javascripts
	'bundles/uamdatatables/vendor/datatables/media/js/jquery.dataTables.min.js'
	'bundles/uamdatatables/vendor/datatables-plugins/integration/bootstrap/3/dataTables.bootstrap.min.js'
%}
	<script src="{{ asset_url }}"></script>
{% endjavascripts %}

如果您使用 assetic,您需要在配置文件的 assetic 部分声明 UAMDatatablesBundle。

包含内容

此组件目前包含以下资产

  • jquery dataTables 插件版本 1.10.6
  • dataTables/bootstrap 集成插件
  • dataTables/font-awesome 集成插件

此组件还包括一个 DatatablesEnabledControllerTrait 和相关的资产,以帮助您设计使用 dataTables 列出 DB-entities 的页面。

工作原理

组件的资产通过 bowergulp 管理。

添加更多资产

如果您需要比目前包含的更多 dataTables 资产,请按照以下步骤操作

  • 分支组件
  • 自定义 bower 配置文件 (Resources/config/bower.json)
    • overrides|datatables-plugins|main 部分添加您需要的资产
    • overrides 部分删除您不需要的资产
  • 从组件的 Resources\config 目录运行 gulp

许可证

此组件受 MIT 许可证的许可。

dataTables jquery 插件受 MIT 许可证的许可。

版权

此组件版权属于 United Asian Management Limited

dataTables jquery 插件的版权属于 Allan Jardine (www.sprymedia.co.uk)

所有权利归各自的版权所有者所有。