manperlop/chumper-datatable-custom

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

维护者

详细信息

github.com/manperlop/chumper-datatable-custom

主页

源代码

问题

安装: 39

依赖项: 0

建议者: 0

安全: 0

星星: 0

关注者: 1

分支: 0

开放问题: 0

dev-master 2015-01-05 01:51 UTC

Requires

Requires (Dev)

MIT fb3716e31f7cc516215c1212b6184aae0179d217

  • Manuel Pérez <manperlop1.woop@gmail.com>

jqueryajaxlaraveldatatables

This package is not auto-updated.

Last update: 2024-09-28 16:38:11 UTC

README

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

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

请注意

此包适用于 1.9 版本的数据表格！它不兼容 1.10+ 版本！我目前正在原型设计 3.x 版本，该版本将仅支持 1.10+ 版本的数据表格。

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 中编辑这些选项。

##基本用法

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

###两个路由

  • 创建两个路由：一个用于向用户交付视图，另一个用于数据表格数据，例如
    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() 之间有一个区别。集合会在执行任何操作（如搜索或排序）之前进行编译，以便也可以包含您自定义的字段。也就是说，collection 方法在性能上不如 query 方法，在 query 方法中，搜索和排序会在查询数据库之前进行处理。

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

TLTR：如果您没有自定义字段，则使用 query() 会更快。如果您有自定义字段但不想对这些字段提供搜索和/或排序，则使用 query()。如果您从其他地方获取数据，则选择 collection。如果您有自定义字段并希望在搜索和/或排序这些字段时使用它们，则需要使用 collection。

请注意，如果使用 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()

这将允许您使用查询引擎进行可排序和可搜索的列，同时允许您修改数据库列条目的返回值。

例如：将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,
    }
});

建议您查看以下2个文件javascript.blade.php && template.blade.php，位于vendor/Chumper/datatable/src/views。您将理解所有逻辑，并了解为什么需要像数组（json_encode和其他内容）那样传递参数。

setCallbacks($name, $value) OR 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) OR 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将按此顺序排序。

{{ 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许可协议的许可