Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaeltintiuc/laravel-component
:bulb: Several starter interfaces and abstract classes for laravel projects
https://github.com/michaeltintiuc/laravel-component
abstract boilerplate helper interface laravel
Last synced: about 1 month ago
JSON representation
:bulb: Several starter interfaces and abstract classes for laravel projects
- Host: GitHub
- URL: https://github.com/michaeltintiuc/laravel-component
- Owner: michaeltintiuc
- License: mit
- Created: 2016-12-13T23:35:56.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-05T19:59:42.000Z (over 7 years ago)
- Last Synced: 2024-11-25T03:25:28.760Z (2 months ago)
- Topics: abstract, boilerplate, helper, interface, laravel
- Language: PHP
- Homepage:
- Size: 41 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# laravel-component
:bulb: Several starter interfaces and abstract classes for laravel projects
## Contents
1. [Installation](#installation)
2. [Usage](#usage)
3. [Contribution](#contribution)
## Installation
Require via composer
```shell
composer require michaeltintiuc/laravel-component
``````
## Usage
### Directory structure
`app/Components/` - holds all component dirs like Users, Posts, Tags, etc
`app/Components/Users` - holds the model class (i.e. User) and all environment dirs like Admin, Site, etc
`app/Components/Users/{ENV}` - holds all classes and `routes.php` related to the environment specific implementation of a component
`app/Components/Users/{ENV}/Requests` - holds form validation classes specific to an environment and component
---
### Controllers
```php
namespace Acme\Components\Users\Admin;
use Illuminate\Http\Request;
use MichaelT\Component\Admin\ComponentController;
class UsersController extends ComponentController
{
public function __construct(Request $request, PostTagsRepo $repo)
{
parent::__construct($request, $repo);
$this->setComponent('user');
$this->setBaseView('admin.users');
$this->setSearchRoute('admin.users.index');
}
public function index(Request $request)
{
if ($request->has('search')) {
return $this->search($request->search);
}
$this->setTitle('All users');
$this->setHeading('Users list');
$users = $this->repo->all();
return $this->view('index')
->with(compact('users'));
}
...
}
```
---
### Repositories
#### Interfaces _aka_ Contracts
```php
namespace Acme\Components\Users\Admin;
use MichaelT\Component\Admin\Contracts\RepoContract;
use MichaelT\Component\Admin\Contracts\Searchable;
interface UsersRepoContract extends RepoContract, Searchable
{
}
```
#### Repository
```php
namespace Acme\Components\Users\Admin;
use Acme\Components\Users\User;
use MichaelT\Component\Admin\ComponentRepo;
use Acme\Components\Users\Admin\UsersRepoContract;
class UsersRepo extends ComponentRepo implements UsersRepoContract
{
public function __construct(User $model)
{
parent::__construct($model);
$this->setComponent('user');
}
public function all()
{
return $this->model->get();
}
public function paginate()
{
return $this->model
->paginate($this->getPerPage());
}
public function find($id)
{
try {
return $this->model->findOrFail($id);
} catch (\Exception $e) {
throw new \FindAdminException($this->error('find'));
}
}
...
}
```
---
### Routes
#### Component
```php
Route::group(['namespace' => 'Acme\Components\Users\Admin'], function () {
Route::resource('users', 'UsersController');
});
```
#### Loading routes
```php
Route::group(['prefix' => 'admin', 'as' => 'admin.'], function () {
Route::group(['middleware' => ['auth']], function () {
require_once app_path().'/Components/Users/Admin/routes.php';
});
});
```
---
### Contribution
Contributions, bug-reports, feature and pull requests are always welcome!