Skip to content

fix: stubs - remove redundant docs #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 4 additions & 12 deletions src/Generators/stubs/builder.stub
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,9 @@ use Yajra\DataTables\Services\DataTable;
class DummyClass extends DataTable
{
/**
* Build DataTable class.
* Build the DataTable class.
*
* @param QueryBuilder $query Results from query() method.
* @return \Yajra\DataTables\EloquentDataTable
*/
public function dataTable(QueryBuilder $query): EloquentDataTable
{
Expand All @@ -24,30 +23,23 @@ class DummyClass extends DataTable
}

/**
* Get query source of dataTable.
*
* @param \DummyModel $model
* @return \Illuminate\Database\Eloquent\Builder
* Get the query source of dataTable.
*/
public function query(ModelName $model): QueryBuilder
{
return $model->newQuery();
}

/**
* Optional method if you want to use html builder.
*
* @return \Yajra\DataTables\Html\Builder
* Optional method if you want to use the html builder.
*/
public function html(): HtmlBuilder
{
return DummyBuilder::make();
}

/**
* Get filename for export.
*
* @return string
* Get the filename for export.
*/
protected function filename(): string
{
Expand Down
18 changes: 4 additions & 14 deletions src/Generators/stubs/datatables.stub
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,9 @@ use Yajra\DataTables\Html\Builder as HtmlBuilder;
class DummyClass extends DataTable
{
/**
* Build DataTable class.
* Build the DataTable class.
*
* @param QueryBuilder $query Results from query() method.
* @return \Yajra\DataTables\EloquentDataTable
*/
public function dataTable(QueryBuilder $query): EloquentDataTable
{
Expand All @@ -28,20 +27,15 @@ class DummyClass extends DataTable
}

/**
* Get query source of dataTable.
*
* @param \DummyModel $model
* @return \Illuminate\Database\Eloquent\Builder
* Get the query source of dataTable.
*/
public function query(ModelName $model): QueryBuilder
{
return $model->newQuery();
}

/**
* Optional method if you want to use html builder.
*
* @return \Yajra\DataTables\Html\Builder
* Optional method if you want to use the html builder.
*/
public function html(): HtmlBuilder
{
Expand All @@ -59,8 +53,6 @@ class DummyClass extends DataTable

/**
* Get the dataTable columns definition.
*
* @return array
*/
public function getColumns(): array
{
Expand All @@ -75,9 +67,7 @@ class DummyClass extends DataTable
}

/**
* Get filename for export.
*
* @return string
* Get the filename for export.
*/
protected function filename(): string
{
Expand Down
3 changes: 0 additions & 3 deletions src/Generators/stubs/html.stub
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ class DummyClass extends DataTableHtml
/**
* Build the html builder.
*
* @return \Yajra\DataTables\Html\Builder
* @throws \Exception
*/
public function handle(): Builder
Expand All @@ -31,8 +30,6 @@ class DummyClass extends DataTableHtml

/**
* Get the dataTable columns definition.
*
* @return array
*/
public function getColumns(): array
{
Expand Down
2 changes: 1 addition & 1 deletion src/config/config.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
* With Model: App\Post
* Export filename: posts_timestamp
*/
'model' => 'Models',
'model' => 'App\\Models',
],

/*
Expand Down