Skip to content

Commit 2003665

Browse files
committed
Add type hints and return type
1 parent 5edbd1a commit 2003665

File tree

3 files changed

+26
-19
lines changed

3 files changed

+26
-19
lines changed

src/Generators/stubs/builder.stub

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,25 @@
33
namespace DummyNamespace;
44

55
use DummyModel;
6+
use Illuminate\Database\Eloquent\Builder as QueryBuilder;
7+
use Yajra\DataTables\EloquentDataTable;
8+
use Yajra\DataTables\Html\Builder as HtmlBuilder;
69
use Yajra\DataTables\Services\DataTable;
710

811
class DummyClass extends DataTable
912
{
1013
/**
1114
* Build DataTable class.
1215
*
13-
* @param mixed $query Results from query() method.
14-
* @return \Yajra\DataTables\DataTableAbstract
16+
* @param QueryBuilder $query Results from query() method.
17+
* @return \Yajra\DataTables\EloquentDataTable
1518
*/
16-
public function dataTable($query)
19+
public function dataTable(QueryBuilder $query): EloquentDataTable
1720
{
1821
return datatables()
1922
->eloquent($query)
20-
->addColumn('action', 'DummyAction');
23+
->addColumn('action', 'DummyAction')
24+
->setRowId('id');
2125
}
2226

2327
/**
@@ -26,7 +30,7 @@ class DummyClass extends DataTable
2630
* @param \DummyModel $model
2731
* @return \Illuminate\Database\Eloquent\Builder
2832
*/
29-
public function query(ModelName $model)
33+
public function query(ModelName $model): QueryBuilder
3034
{
3135
return $model->newQuery();
3236
}
@@ -36,7 +40,7 @@ class DummyClass extends DataTable
3640
*
3741
* @return \Yajra\DataTables\Html\Builder
3842
*/
39-
public function htmlBuilder()
43+
public function html(): HtmlBuilder
4044
{
4145
return DummyBuilder::make();
4246
}
@@ -46,7 +50,7 @@ class DummyClass extends DataTable
4650
*
4751
* @return string
4852
*/
49-
protected function filename()
53+
protected function filename(): string
5054
{
5155
return 'DummyFilename_' . date('YmdHis');
5256
}

src/Generators/stubs/datatables.stub

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,23 @@ use Yajra\DataTables\Html\Column;
88
use Yajra\DataTables\Services\DataTable;
99
use Yajra\DataTables\Html\Editor\Fields;
1010
use Yajra\DataTables\Html\Editor\Editor;
11+
use Illuminate\Database\Eloquent\Builder as QueryBuilder;
12+
use Yajra\DataTables\EloquentDataTable;
13+
use Yajra\DataTables\Html\Builder as HtmlBuilder;
1114

1215
class DummyClass extends DataTable
1316
{
1417
/**
1518
* Build DataTable class.
1619
*
17-
* @param mixed $query Results from query() method.
18-
* @return \Yajra\DataTables\DataTableAbstract
20+
* @param QueryBuilder $query Results from query() method.
21+
* @return \Yajra\DataTables\EloquentDataTable
1922
*/
20-
public function dataTable($query)
23+
public function dataTable(QueryBuilder $query): EloquentDataTable
2124
{
22-
return datatables()
23-
->eloquent($query)
24-
->addColumn('action', 'DummyAction');
25+
return (new EloquentDataTable($query))
26+
->addColumn('action', 'DummyAction')
27+
->setRowId('id');
2528
}
2629

2730
/**
@@ -30,7 +33,7 @@ class DummyClass extends DataTable
3033
* @param \DummyModel $model
3134
* @return \Illuminate\Database\Eloquent\Builder
3235
*/
33-
public function query(ModelName $model)
36+
public function query(ModelName $model): QueryBuilder
3437
{
3538
return $model->newQuery();
3639
}
@@ -40,7 +43,7 @@ class DummyClass extends DataTable
4043
*
4144
* @return \Yajra\DataTables\Html\Builder
4245
*/
43-
public function html()
46+
public function html(): HtmlBuilder
4447
{
4548
return $this->builder()
4649
->setTableId('DummyTableId')
@@ -58,7 +61,7 @@ class DummyClass extends DataTable
5861
*
5962
* @return array
6063
*/
61-
protected function getColumns()
64+
protected function getColumns(): array
6265
{
6366
return [
6467
Column::computed('action')
@@ -75,7 +78,7 @@ class DummyClass extends DataTable
7578
*
7679
* @return string
7780
*/
78-
protected function filename() : string
81+
protected function filename(): string
7982
{
8083
return 'DummyFilename_' . date('YmdHis');
8184
}

src/Generators/stubs/html.stub

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class DummyClass extends DataTableHtml
1616
* @return \Yajra\DataTables\Html\Builder
1717
* @throws \Exception
1818
*/
19-
public function handle()
19+
public function handle(): Builder
2020
{
2121
return $this->setTableId('DummyTableId')
2222
->columns($this->getColumns())
@@ -31,7 +31,7 @@ class DummyClass extends DataTableHtml
3131
/**
3232
* @return array
3333
*/
34-
protected function getColumns()
34+
protected function getColumns(): array
3535
{
3636
return [
3737
Column::computed('action')

0 commit comments

Comments
 (0)