moddyx/datatable

这是Chumper/Datatable laravel 4包的分支，用于服务器和客户端的datatables，详情请见https://datatables.net.cn/

维护者

详细信息

github.com/moddyx/datatable

主页

源码

问题

安装: 25

依赖: 0

建议者: 0

安全: 0

星级: 0

关注者: 1

分支: 0

dev-master 2022-03-17 08:36 UTC

Requires

  • php: >=7.3.0

MIT 1697de1f54ba2fa6632d78d2ef04b66c2d42e242

  • Nils Plaschke <github.woop@nilsplaschke.de>
  • Christian Da Silva <christian.dasilva.woop@git.ch>

jqueryajaxlaraveldatatables

This package is auto-updated.

Last update: 2024-09-17 14:22:29 UTC

README

这是一个用于https://datatables.net.cn/的datatables服务器和客户端的laravel 4包

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

Image

##重要

如果您升级到v2.2版本，请确保调整您的app.php文件中的新别名

    // aliases array:

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

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

##已知问题

  • 目前没有我知道的

##待办事项

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

##特性

此包支持

  • 支持集合和查询构建器
  • 易于添加和排序列
  • 包括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。

##基本用法

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

###两个路由

  • 创建两个路由：一个用于向用户提供视图，另一个用于datatables数据，例如
    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();
    }

您现在应该在页面上有一个可工作的datatables。

###一个路由

在您的路由中，您应该使用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()生成服务器端datatable处理程序。它将在结果中添加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();

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

setAliasMapping()

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

	{
		"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)

将通过名称获取一个列，主要用于测试和调试，对您来说并不真正有用。

###特定的QueryEngine方法

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

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

###特定的CollectionEngine方法

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调用。

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') }}

在表格视图中（例如，'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

##贡献者

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

##更改日志

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

##应用程序

https://github.com/hillelcoren/invoice-ninja (由Hillel Coren)

##许可证

此软件包受MIT许可证许可