Add type hints and return type

yajra · Jun 21, 2022 · 2003665 · 2003665
1 parent 5edbd1a
commit 2003665
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 19 deletions.
diff --git a/src/Generators/stubs/builder.stub b/src/Generators/stubs/builder.stub
@@ -3,21 +3,25 @@
 namespace DummyNamespace;
 
 use DummyModel;
+use Illuminate\Database\Eloquent\Builder as QueryBuilder;
+use Yajra\DataTables\EloquentDataTable;
+use Yajra\DataTables\Html\Builder as HtmlBuilder;
 use Yajra\DataTables\Services\DataTable;
 
 class DummyClass extends DataTable
 {
     /**
      * Build DataTable class.
      *
-     * @param mixed $query Results from query() method.
-     * @return \Yajra\DataTables\DataTableAbstract
+     * @param QueryBuilder $query Results from query() method.
+     * @return \Yajra\DataTables\EloquentDataTable
      */
-    public function dataTable($query)
+    public function dataTable(QueryBuilder $query): EloquentDataTable
     {
         return datatables()
             ->eloquent($query)
-            ->addColumn('action', 'DummyAction');
+            ->addColumn('action', 'DummyAction')
+            ->setRowId('id');
     }
 
     /**
@@ -26,7 +30,7 @@ class DummyClass extends DataTable
      * @param \DummyModel $model
      * @return \Illuminate\Database\Eloquent\Builder
      */
-    public function query(ModelName $model)
+    public function query(ModelName $model): QueryBuilder
     {
         return $model->newQuery();
     }
@@ -36,7 +40,7 @@ class DummyClass extends DataTable
      *
      * @return \Yajra\DataTables\Html\Builder
      */
-    public function htmlBuilder()
+    public function html(): HtmlBuilder
     {
         return DummyBuilder::make();
     }
@@ -46,7 +50,7 @@ class DummyClass extends DataTable
      *
      * @return string
      */
-    protected function filename()
+    protected function filename(): string
     {
         return 'DummyFilename_' . date('YmdHis');
     }

diff --git a/src/Generators/stubs/datatables.stub b/src/Generators/stubs/datatables.stub
@@ -8,20 +8,23 @@ use Yajra\DataTables\Html\Column;
 use Yajra\DataTables\Services\DataTable;
 use Yajra\DataTables\Html\Editor\Fields;
 use Yajra\DataTables\Html\Editor\Editor;
+use Illuminate\Database\Eloquent\Builder as QueryBuilder;
+use Yajra\DataTables\EloquentDataTable;
+use Yajra\DataTables\Html\Builder as HtmlBuilder;
 
 class DummyClass extends DataTable
 {
     /**
      * Build DataTable class.
      *
-     * @param mixed $query Results from query() method.
-     * @return \Yajra\DataTables\DataTableAbstract
+     * @param QueryBuilder $query Results from query() method.
+     * @return \Yajra\DataTables\EloquentDataTable
      */
-    public function dataTable($query)
+    public function dataTable(QueryBuilder $query): EloquentDataTable
     {
-        return datatables()
-            ->eloquent($query)
-            ->addColumn('action', 'DummyAction');
+        return (new EloquentDataTable($query))
+            ->addColumn('action', 'DummyAction')
+            ->setRowId('id');
     }
 
     /**
@@ -30,7 +33,7 @@ class DummyClass extends DataTable
      * @param \DummyModel $model
      * @return \Illuminate\Database\Eloquent\Builder
      */
-    public function query(ModelName $model)
+    public function query(ModelName $model): QueryBuilder
     {
         return $model->newQuery();
     }
@@ -40,7 +43,7 @@ class DummyClass extends DataTable
      *
      * @return \Yajra\DataTables\Html\Builder
      */
-    public function html()
+    public function html(): HtmlBuilder
     {
         return $this->builder()
                     ->setTableId('DummyTableId')
@@ -58,7 +61,7 @@ class DummyClass extends DataTable
      *
      * @return array
      */
-    protected function getColumns()
+    protected function getColumns(): array
     {
         return [
             Column::computed('action')
@@ -75,7 +78,7 @@ class DummyClass extends DataTable
      *
      * @return string
      */
-    protected function filename() : string
+    protected function filename(): string
     {
         return 'DummyFilename_' . date('YmdHis');
     }

diff --git a/src/Generators/stubs/html.stub b/src/Generators/stubs/html.stub
@@ -16,7 +16,7 @@ class DummyClass extends DataTableHtml
      * @return \Yajra\DataTables\Html\Builder
      * @throws \Exception
      */
-    public function handle()
+    public function handle(): Builder
     {
         return $this->setTableId('DummyTableId')
                     ->columns($this->getColumns())
@@ -31,7 +31,7 @@ class DummyClass extends DataTableHtml
     /**
      * @return array
      */
-    protected function getColumns()
+    protected function getColumns(): array
     {
         return [
             Column::computed('action')