distilleries/datatable

这是一个针对 https://datatables.net.cn/ 上的数据表格的服务器和客户端的 laravel 4 包

维护者

详细信息

github.com/Distilleries/Datatable

主页

源代码

安装数: 9,202

依赖者: 1

建议者: 0

安全: 0

星级: 0

关注者: 5

分支: 153

3.1.1 2018-07-04 10:35 UTC

Requires

Requires (Dev)

MIT 9b44edd758c28f4bf99055b752f386afe3fe4d8d

jqueryajaxlaraveldatatables

This package is auto-updated.

Last update: 2024-09-23 06:54:33 UTC

README

这是一个针对 laravel 4 的包，用于 https://datatables.net.cn/ 上的数据表格的服务器和客户端

我开发这个包是因为我对https://github.com/bllim/laravel4-datatables-package上的现有包不满意，所以我开发了这个包，我认为它更优秀。

Image

##重要

如果你从2.1.*或以下版本升级，请确保你调整了app.php中的新别名

    // aliases array:

    //old
    //'Datatable' => 'Chumper\Datatable\Facades\Datatable',

    //new
    'Datatable' => 'Chumper\Datatable\Facades\DatatableFacade',

##已知问题

  • 目前没有我知道的问题

##待办事项

  • 修复即将到来的错误
  • 代码文档

##功能

此包支持

  • 支持集合和查询构建器
  • 易于添加和排序列
  • 包含简单的HTML辅助工具
  • 在列中使用你自己的函数和演示者
  • 在自定义定义的列中搜索（仅限集合）
  • 定义你特定的搜索和排序字段
  • 为表格添加自定义javascript值
  • 已测试！（好吧，可能不是完全的，但我尽力了 :) )

##请注意！

此包的集合部分和查询部分之间存在一些差异。差异如下

有关详细说明，请参阅下面的视频。http://www.youtube.com/watch?v=c9fao_5Jo3Y

请在问题部分告诉我任何问题或你想要的功能。如果你能提供一个指向问题的测试，我将非常感激。

##安装

此包可在 https://packagist.org.cn 上找到，只需将其添加到composer.json中

"chumper/datatable": "2.*"

它还有一个ServiceProvider，用于在Laravel4中使用。将这些行添加到app.php中

    // providers array:
	'Chumper\Datatable\DatatableServiceProvider',

    // aliases array:
    'Datatable' => 'Chumper\Datatable\Facades\DatatableFacade',

然后您可以通过Datatable别名访问它。

要覆盖默认配置选项，可以发布配置文件。

php artisan config:publish chumper/datatable

现在您可以在app/config/packages/chumper/datatable/config.php中编辑这些选项。

##基本用法

您可以使用两种方式使用此插件，在单个路由中或在两个路由中

###两个路由

  • 创建两个路由：一个用于向用户传递视图，另一个用于datatable数据，例如
    Route::resource('users', 'UsersController');
    Route::get('api/users', array('as'=>'api.users', 'uses'=>'UsersController@getDatatable'));
  • 您的主要路由将为用户传递视图。此视图应包含对您的本地副本datatables的引用。在下面的示例中，文件是从datatables/media目录中复制并写入public/assets的。请注意，脚本必须位于调用Datatable之前
    <link rel="stylesheet" type="text/css" href="/assets/css/jquery.dataTables.css">
    <script type="text/javascript" src="/assets/js/jquery.js"></script>
    <script type="text/javascript" src="/assets/js/jquery.dataTables.min.js"></script>

    {{ Datatable::table()
    ->addColumn('id','Name')       // these are the column headings to be shown
    ->setUrl(route('api.users'))   // this is the route where data will be retrieved
    ->render() }}
  • 创建一个控制器函数以返回您的数据，以便Datatables可以读取
    public function getDatatable()
    {
        return Datatable::collection(User::all(array('id','name')))
        ->showColumns('id', 'name')
        ->searchColumns('name')
        ->orderColumns('id','name')
        ->make();
    }

现在您应该在页面上有一个正常工作的数据表格。

###一个路由

在您的路由中，您应使用Datatable::shouldHandle方法，该方法将检查插件是否应该处理请求

    if(Datatable::shouldHandle())
    {
        return Datatable::collection(User::all(array('id','name')))
            ->showColumns('id', 'name')
            ->searchColumns('name')
            ->orderColumns('id','name')
            ->make();
    }

插件将然后查询相同的url以获取信息。shouldHandle方法仅检查ajax请求和是否设置了sEcho。

##HTML示例

	Datatable::table()
    ->addColumn('id',Lang::get('user.lastname'))
	->setUrl(URL::to('auth/users/table'))
    ->render();

使用单独的表格和脚本

		$table = Datatable::table()
        ->addColumn('Email2','Email', "Test")
        ->noScript();

        // to render the table:
        $table->render()

        // later in the view you can render the javascript:
        $table->script();

这将生成一个包含两列（id，lastname）的HTML表格，并设置ajax请求的URL。

注意：本包不包括 datatable.js，这需要你自己处理。原因是我使用Basset，每个人都想用自己的方式...

如果你想要提供自己的表格模板，只需提供Laravel风格的视图路径。

	Datatable::table()
        ->addColumn('id',Lang::get('user.lastname'))
    	->setUrl(URL::to('auth/users/table'))
        ->render('views.templates.datatable');

##服务器端示例

	Datatable::collection(User::all())
    ->showColumns('id')
    ->addColumn('name',function($model)
        {
            return $model->getPresenter()->yourProperty;
        }
    )->make();

这将根据User::all()集合生成服务器端的数据表格处理器。它将在结果中添加id列和一个名为name的自定义列。请注意，我们需要传递一个函数作为第二个参数，它将始终被用于包含集合的对象。在这种情况下，它将是User模型。

你现在也可以访问所有关系，因此对于书籍模型来说，显示作者关系将变得很容易。

	Datatable::collection(User::all())
    ->showColumns('id')
    ->addColumn('name',function($model)
        {
            return $model->author->name;
        }
    )->make();

注意：如果你将数组的集合传递给collection方法，函数中将有数组，而不是模型。

列的顺序始终由用户定义，并且将是用户向Datatable添加列的相同顺序。

##查询或集合？

query()和collection()之间有区别。集合将在执行任何操作（如搜索或排序）之前进行编译，以便它还可以包含你的自定义字段。因此，集合方法在性能上不如查询方法，因为搜索和排序将在查询数据库之前进行处理。

所以如果你有大量的条目（100k+），集合将不会表现良好，因为我们需要编译整个条目数量以提供准确的数据集。另一方面，查询无法在自定义字段函数上正确执行搜索或orderBy操作。

TLTR：如果没有自定义字段，则使用query()会更快。如果有自定义字段但不想在这些字段上提供搜索和/或排序，则使用query()。如果你有来自其他地方的数据，只需将其包装到集合中即可。如果你有自定义字段并想在这些字段上提供搜索和/或排序，则需要使用集合。

请注意，如果你使用query而不是集合，搜索和排序功能之间存在显著差异。请查看以下视频以获取更多详细信息。

http://www.youtube.com/watch?v=c9fao_5Jo3Y

##可用函数

本包分为两个更小的部分

  1. Datatable::table()
  2. Datatable::collection()
  3. Datatable::query()

后两者用于服务器端，第一个是一个辅助函数，用于生成所需的表格和JavaScript调用。

###集合 & 查询

collection($collection)

将内部引擎设置为集合。为了进一步提高性能，你可以限制列和行的数量，例如。

$users = User::activeOnly()->get('id','name');
Datatable::collection($users)->...

query($query)

这将内部引擎设置为Eloquent查询... 例如。

$users = DB::table('users');
Datatable::query($users)->...

查询引擎比集合引擎快得多，但功能也较少，更多信息请参阅上面的表格。

showColumns(...$columns)

将命名的列添加到结果中。

注意：你需要以你在模型或数组中访问它的格式传递名称。例如：在数据库中：last_name，在模型中lastname -> showColumns('lastname')

你可以提供任意数量的名称。

searchColumns(..$fields)

将允许表格仅允许在指定的列中进行搜索。请注意，集合的行为与构建器对象不同。

注意：如果您想使用查询引擎在数字列上进行搜索，则还可以传递一个搜索列，例如：

   //mysql
   ->searchColumns(array('id:char:255', 'first_name', 'last_name', 'address', 'email', 'age:char:255'))

   //postgree
   ->searchColumns(array('id:text', 'first_name', 'last_name', 'address', 'email', 'age:text'))

这将将在搜索此列时将列转换为给定的类型

orderColumns(..$fields)

将使表格只允许在给定的列中进行排序。请注意，集合的行为与构建器对象不同。

addColumn($name, $function)

将为结果集添加一个自定义字段，在函数中您将获得该行的整个模型或数组，例如：

	Datatable::collection(User::all())
    ->addColumn('name',function($model)
        {
            return $model->author->name;
        }
    )->make();

您也可以仅添加一个预定义的列，如DateColumn、FunctionColumn或TextColumn，例如：

	$column = new TextColumn('foo', 'bar'); // Will always return the text bar
	//$column = new FunctionColumn('foo', function($model){return $model->bar}); // Will return the bar column
	//$column = new DateColumn('foo', DateColumn::TIME); // Will return the foo date object as toTimeString() representation
	//$column = new DateColumn('foo', DateColumn::CUSTOM, 'd.M.Y H:m:i'); // Will return the foo date object as custom representation

	Datatable::collection(User::all())
    ->addColumn($column)
    ->make();

您还可以通过结合使用addColumn和showColumns来覆盖QueryMethod返回的结果。您必须将列名与在showColumns中显示的数据库列名完全一致，才能使其生效。

	$column = new FunctionColumn('foo', function ($row) { return strtolower($row->foo); }
	Datatable::query(DB::table('table')->lists('foo'))
	         ->showColumns('foo')
	         ->addColumn($column)
	         ->orderColumns('foo')
	         ->searchColumns('foo')
	         ->make()

这将允许您在QueryEngine中使用可排序和可搜索的列，同时还可以修改该数据库列条目的返回值。

例如：将user_id列链接到它的页面列表

	$column = new FunctionColumn('user_id', function ($row) { return link_to('users/'.$row->user_id, $row->username) }
	Datatable::query(DB::table('table')->lists('user_id', 'username'))
	         ->showColumns('user_id')
	         ->addColumn($column)
	         ->orderColumns('user_id')
	         ->searchColumns('user_id')

请查看特定列以获取更多信息。

setAliasMapping()

将建议Datatable返回与列名映射的数据。因此，而不是

	{
		"aaData":[
			[3,"name","2014-02-02 23:28:14"]
		],
		"sEcho":9,
		"iTotalRecords":2,
		"iTotalDisplayRecords":1
	}

您将获得以下响应：

{
	"aaData":[
		{"id":2,"name":"Datatable","created_at":"Sun, Feb 2, 2014 7:17 PM"}
	],
	"sEcho":2,
	"iTotalRecords":2,
	"iTotalDisplayRecords":1
}

make()

这将处理请求的输入数据并提供结果集。

如果没有这个命令，则不会返回任何响应。

clearColumns()

这将重置所有列，主要用于测试和调试，对您来说并不真的很有用。

如果您没有提供任何列使用showColumn或addColumn，则不会显示任何列。查询或集合中的列对要显示的列没有影响。

getOrder()

这将返回一个数组，包含将显示的列，主要用于测试和调试，对您来说并不真的很有用。

getColumn($name)

将根据名称获取一个列，主要用于测试和调试，对您来说并不真的很有用。

###特定的查询引擎方法

setSearchWithAlias()

如果您想在查询引擎上使用别名列，并且搜索时没有返回正确的结果，那么您应该尝试这个标志。例如：

		Datatable::from(DB::table("users")->select('firstname', "users.email as email2")->join('partners','users.partner_id','=','partners.id'))
        ->showColumns('firstname','email2')
        ->setSearchWithAlias()
        ->searchColumns("email2")

在SQL中，在where部分（用于搜索）不允许使用别名，因此结果计数将不正确。

使用此标志，您将在搜索部分（searchColumns中的email2）启用别名。

请注意，此标志将减慢您的应用程序，因为我们正在手动计数时将结果返回两次。

setSearchOperator($value = "LIKE")

使用此方法，您可以设置搜索上的运算符，例如PostgreSQL上的"ILIKE"以实现不区分大小写。

setExactWordSearch

这将建议引擎只搜索给定的搜索字符串。

###特定的集合引擎方法

setSearchStrip() & setOrderStrip()

如果您使用搜索功能，则可以建议所有列在搜索此列之前删除任何HTML和PHP标签。

如果有用，如果您返回模型详细信息的链接但仍想在列中提供搜索功能，这可能会很有用。

setCaseSensitive($boolean = 'false')

设置搜索方法为区分大小写或不区分大小写，默认为false

###表格

noScript()

设置此属性后，表格将不会渲染JavaScript部分。

您可以使用以下方法手动渲染：

script($view = null)

如果没有提供视图或默认视图，则将渲染JavaScript，并将传递类名、选项和回调函数。

示例

		$table = Datatable::table()
        ->addColumn('Email2','Email', "Test")
        ->noScript();

        // to render the table:
        $table->render()

        // later in the view you can render the javascript:
        $table->script();

setUrl($url)

将设置URL和通过ajax获取内容的选项。

setOptions($name, $value) OR setOptions($array)

将设置单个选项或选项数组用于jQuery调用。

您可以传递类似这样的参数（'MyOption', 'ValueMyOption'）或者一个包含参数的数组，但DataTable中的某些值是JSON，那么如何传递JSON值呢？可以使用另一个数组，例如：setOptions(array("MyOption" => array('MyAnotherOption' => 'MyAnotherValue', 'MyAnotherOption2' => 'MyAnotherValue2')));

//GENERATE

jQuery(.Myclass).DataTable({
    MyOption: {
        MyAnotherOption: MyAnotherValue,
        MyAnotherOption2: MyAnotherValue2,
    }
});

作为建议，请查看vendor/Chumper/datatable/src/views目录下的javascript.blade.php和template.blade.php这两个文件。您将了解所有逻辑，并了解为什么以数组的形式传递参数很重要（json_encode和其他内容）。

setCallbacks($name, $value) 或 setCallbacks($array)

这将设置一个单独的回调函数或一个回调函数数组，用于jQuery调用。Datatables回调函数的描述请见https://datatables.net.cn/usage/callbacks。例如，

    ->setCallbacks(
        'fnServerParams', 'function ( aoData ) {
            aoData.push( { "name": "more_data", "value": "my_value" } );
        }'
    )

addColumn($name)

这将向表中添加一列，列名将在表头显示。因此，您可以提供应该显示的字符串。

如果您想使用服务器端表的别名映射功能，则需要添加一个类似这样的数组

Datatable::table()
    ->addColumn(array(
        'id'            => 'ID',
        'name'          => 'Name',
        'created_at'    => 'Erstellt'
        ))
	->render();

请注意，将关联数组传递给addColumn函数将自动启用表上的别名功能

setAliasMapping(boolean)

在此，您可以显式设置表是否应该使用别名。

countColumns()

这将返回稍后将要渲染的列数。主要用于测试和调试。

getData()

这将返回将作为数组渲染到表中的数据。

getOptions()

获取所有选项的数组。

render($view = template.blade)

渲染表。您可以通过传递一个视图名称来自定义此功能。请参阅包内的模板，以获取有关如何将数据传递到视图的更多信息。

setData($data)

期望一个数组数组，并在表显示时渲染此数据。

setCustomValues($name, $value) 或 setCustomValues($array)

这将设置单个自定义值或自定义值数组，这些值将被传递到视图。您可以在自定义视图文件中访问这些值。例如，如果您想点击行中的任何位置跳转到记录（记录ID在表的第一个列中）

在调用视图中

{{ DataTable::table()
    ->addColumn($columns)
    ->setUrl($ajaxRouteToTableData)
    ->setCustomValues('table-url', $pathToTableDataLinks)
    ->render('my.datatable.template') }}

在datatable视图中（例如，'my.datatable.template')

    @if (isset($values['table-url']))
        $('.{{$class}}').hover(function() {
            $(this).css('cursor', 'pointer');
        });
        $('.{{$class}}').on('click', 'tbody tr', function(e) {
            $id = e.currentTarget.children[0].innerHTML;
            $url = e.currentTarget.baseURI;
            document.location.href = "{{ $values['table-url'] }}/" + $id;
        });
    @endif

setOrder(array $order)

定义在第一页加载时表将按何种顺序排序。

{{ DataTable::table()
    ->addColumn('ID', 'First Name', 'Last Name')
    ->setUrl($ajaxRouteToTableData)
    ->setOrder(array(2=>'asc', 1=>'asc')) // sort by last name then first name
    ->render('my.datatable.template') }}

##附加功能 使用Datatables API的一些附加功能。

- TableTools

要使用TableTools，您需要将一些文件添加到您的项目中（https://datatables.net.cn/extensions/tabletools/），如果您需要帮助，请下载datatable的包，并在扩展文件夹中的/tabletools下查看示例。之后，所有文件都包含在内，不要忘记像这样传递参数

//In view:

{{
    Datatable::table()
        ->addColumn('your columns here separated by comma')
        ->setUrl('your URL for server side')
        ->setOptions(array(
                            'dom' =>"T<'clear'>lfrtip",
                            'tabletools' => array(
                                                    "aSwfPath" => "your/path/to/swf/copy_csv_cls_pdf.swf",
                                                    "aButtons" => array("copy", "pdf", "xls")
                                                )
                    ))
}}

如果您想获取一些属性，如“我点击了哪一行？”请参见javascript.blade.php和变量$values。

##贡献者

  • jgoux 帮助在数据库数字列上搜索
  • jijoel 帮助回调选项和文档

##变更日志

  • 2.0.0:
    • 分离查询和集合引擎
    • 添加单列搜索
    • 代码清理

##应用程序

https://github.com/hillelcoren/invoice-ninja （由Hillel Coren提供）

##许可

本软件包受MIT许可的许可