Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matt-daneshvar/laravel-resource-actions
A shorter way to write your basic CRUD controller actions.
https://github.com/matt-daneshvar/laravel-resource-actions
laravel resource-actions resource-controller restful-actions
Last synced: 22 days ago
JSON representation
A shorter way to write your basic CRUD controller actions.
- Host: GitHub
- URL: https://github.com/matt-daneshvar/laravel-resource-actions
- Owner: matt-daneshvar
- License: mit
- Created: 2020-07-01T12:53:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-07-03T13:27:17.000Z (over 4 years ago)
- Last Synced: 2024-04-02T13:00:25.971Z (7 months ago)
- Topics: laravel, resource-actions, resource-controller, restful-actions
- Language: PHP
- Homepage:
- Size: 56.6 KB
- Stars: 36
- Watchers: 7
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Resource Actions
[](https://travis-ci.org/matt-daneshvar/laravel-resource-actions)
If you've built a dozen Laravel apps and if you're anything like me,
you're tired of rewriting basic CRUD controllers a thousand times.
This package DRYs up your code by extracting those repetitive actions into a few magical traits.
## Installation
Require the package using composer:
```
composer require matt-daneshvar/laravel-resource-actions
```
## Usage
Once installed, you can write:
```php
class TaskController extends BaseController
{
use Index, Create, Store, Show, Edit, Update, Destroy;
protected $rules = ['name' => 'required|string|max:250'];
}
```
Instead of:
```php
class TaskController extends BaseController
{
protected $rules = ['name' => 'required|string|max:250'];
public function index()
{
return view('task.index', ['tasks' => Task::paginate(20)]);
}
public function create()
{
return view('task.create');
}
public function store(Request $request)
{
$input = $request->validate($this->rules);
Task::create($input);
return back()->with('success', 'A new task is successfully created.');
}
public function show(Task $task)
{
return view('task.show', ['task' => $task]);
}
public function edit(Task $task)
{
return view('task.edit', ['task' => $task]);
}
public function update(Task $task, Request $request)
{
$input = $request->validate($this->rules);
$task->update($input);
return back()->with('success', 'The task is successfully updated.');
}
public function destroy(Task $task)
{
$task->delete();
return back()->with('success', 'The task is successfully deleted.');
}
}
```
### Actions
#### Index
The `index` action returns the `resource.index` view with a paginated collection of the relevant model,
so that you may write:
```php
class TaskController extends BaseController
{
use Index;
}
```
Instead of:
```php
class TaskController extends BaseController
{
public function index()
{
return view('task.index', ['tasks' => Task::paginate(20)]);
}
}
```
#### Create
The `create` action returns the `resource.create` view,
so that you may write:
```php
class TaskController extends BaseController
{
use Create;
}
```
Instead of:
```php
class TaskController extends BaseController
{
public function create()
{
return view('task.create');
}
}
```
#### Store
The `store` action validates the request against the `$rules`,
persists a new model,
and redirects back with a success message.
For this action you may write:
```php
class TaskController extends BaseController
{
use Store;
protected $rules = ['name' => 'required|string|max:250'];
}
```
Instead of:
```php
class TaskController extends BaseController
{
protected $rules = ['name' => 'required|string|max:250'];
public function store(Request $request)
{
$input = $request->validate($this->rules);
Task::create($input);
return back()->with('success', 'A new task is successfully created.');
}
}
```
#### Show
The `show` action returns the `resource.show` view with the relevant model,
so that you may write:
```php
class TaskController extends BaseController
{
use Show;
}
```
Instead of:
```php
class TaskController extends BaseController
{
public function show(Task $task)
{
return view('task.show', ['task' => $task]);
}
}
```
#### Edit
The `edit` action returns the `resource.edit` view with the relevant model,
so that you may write:
```php
class TaskController extends BaseController
{
use Edit;
}
```
Instead of:
```php
class TaskController extends BaseController
{
public function edit(Task $task)
{
return view('task.edit', ['task' => $task]);
}
}
```
#### Update
The `update` action validates the request against the `$rules`,
updates the relevant model,
and redirects back with a success message.
For this action you may write:
```php
class TaskController extends BaseController
{
use Update;
protected $rules = ['name' => 'required|string|max:250'];
}
```
Instead of:
```php
class TaskController extends BaseController
{
protected $rules = ['name' => 'required|string|max:250'];
public function update(Task $task, Request $request)
{
$input = $request->validate($this->rules);
$task->update($input);
return back()->with('success', 'The task is successfully updated.');
}
}
```
#### Destroy
The `destroy` action deletes the relevant model and redirects back with a success message.
For this action you may write:
```php
class TaskController extends BaseController
{
use Destroy;
}
```
Instead of:
```php
class TaskController extends BaseController
{
public function destroy(Task $task)
{
$task->delete();
return back()->with('success', 'The task is successfully deleted.');
}
}
```
### Using All Actions
If you intend to include all 7 resource actions in your controller,
you may use the `ResourceActions` trait as an alias:
```php
class TaskController extends BaseController
{
use ResourceActions;
}
```
Which is equivalent to:
```php
class TaskController extends BaseController
{
use Index, Create, Store, Show, Edit, Update, Destroy;
}
```
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.