Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coderflexx/laravel-presenter
Decorate Your Models and Write Clean/Reusable Code with Presenters.
https://github.com/coderflexx/laravel-presenter
eloquent laravel php presenters
Last synced: 4 days ago
JSON representation
Decorate Your Models and Write Clean/Reusable Code with Presenters.
- Host: GitHub
- URL: https://github.com/coderflexx/laravel-presenter
- Owner: coderflexx
- License: mit
- Created: 2022-02-11T20:07:09.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T19:42:43.000Z (3 months ago)
- Last Synced: 2025-01-21T03:07:37.457Z (12 days ago)
- Topics: eloquent, laravel, php, presenters
- Language: PHP
- Homepage: https://coderflex.com/open-source/docs/laravel-presenter/introduction
- Size: 121 KB
- Stars: 28
- Watchers: 0
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Laravel Presenter
[](https://packagist.org/packages/coderflexx/laravel-presenter)
[](https://github.com/coderflexx/laravel-presenter/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/coderflexx/laravel-presenter/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[](https://packagist.org/packages/coderflexx/laravel-presenter)
A clean way to present your model attributes without putting them in the wrong file.
- [Laravel Presenter](#laravel-presenter)
- [Installation](#installation)
- [Usage](#usage)
- [Model Implementation](#model-implementation)
- [Create New Model Presenter class](#create-new-model-presenter-class)
- [Using the `Presenter` Generated Class](#using-the-presenter-generated-class)
- [Example](#example)
- [Adding Another Presenter Type](#adding-another-presenter-type)
- [Testing](#testing)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Security Vulnerabilities](#security-vulnerabilities)
- [Credits](#credits)
- [License](#license)
## Installation
You can install the package via composer:
```bash
composer require coderflexx/laravel-presenter
```
You can publish the config file with:
```bash
php artisan vendor:publish --provider="Coderflex\LaravelPresenter\LaravelPresenterServiceProvider"
```
This is the contents of the published config file:
```php
return [
/*
|--------------------------------------------------------------------------
| Presenter Namespace
|--------------------------------------------------------------------------
|
| This value informs LaravelPresenter which namespace you will be
| selecting to store your presenters by default.
| If this value equals to null, "App\Presenter" will be used
| by default.
|
*/
'presenter_namespace' => 'App\\Presenters',
];
```
## Usage
The implementation of this package is so simple, all what you need to do is the following:
## Model Implementation
- Implement `CanPresent` Interface
- Use `UsesPresenters` Trait
```php
use Coderflex\LaravelPresenter\Concerns\CanPresent;
use Coderflex\LaravelPresenter\Concerns\UsesPresenters;
// ...
class User extends Authenticatable implements CanPresent
{
use UsesPresenters;
// ...
}
```
## Create New Model Presenter class
This package gives you an easy way to generate new `Presenter` class, all you need to do is to use `presenter:make` command.
```bash
php artisan presenter:make UserPresenter
```
`UserPresenter` in our case, leaves by default in `App\Presenters`.
This is the contents of the `UserPresenter` file:
```php
'App\\Presenters',
...
];
```
## Using the `Presenter` Generated Class
After you create the presenter class, you need to register it on the `Model` by adding the `$presenters` protected property:
```php
use App\Presenters\UserPresenter;
use Coderflex\LaravelPresenter\Concerns\CanPresent;
use Coderflex\LaravelPresenter\Concerns\UsesPresenters;
// ...
class User extends Authenticatable implements CanPresent
{
use UsesPresenters;
protected $presenters = [
'default' => UserPresenter,
];
}
```
By default, the type of your presenter class is `default`, but you can use as many of presenters you want, just by identifying the type in `$presenters` property.
## Example
Now, after we generated the `presenter` class, and we implemented it successfully in our model, we can use it like so:
In your `UserPresenter` class or any presenter class you generated.
```php
...
class UserPresenter extends Presenter
{
public function fullName()
{
return "{$this->model->first_name} {$this->model->last_name}";
}
}
...
```
We add a new method to present the `fullName`.
In your blade or any place you want, you can do:
```php
$user->present()->fullName
```
Your application will show the full name from the method you added.
## Adding Another Presenter Type
Like I said above, by default the type will be `default` but, you can add more types as you need.
Here is an example:
```php
use App\Presenters\UserPresenter;
use Coderflex\LaravelPresenter\Concerns\CanPresent;
use Coderflex\LaravelPresenter\Concerns\UsesPresenters;
// ...
class User extends Authenticatable implements CanPresent
{
use UsesPresenters;
protected $presenters = [
'default' => UserPresenter,
'setting' => UserSettingPresenter,
];
}
```
Generate new `UserSettingPresenter`
```bash
php artisan presenter:make UserSettingPresenter
```
Add anything to `UserSettingPresenter` method
```php
...
class UserSettingPresenter extends Presenter
{
public function lang()
{
return $this->model->settings->defaultLang;
}
}
...
```
Finally, set `setting` as a type:
```php
$user->present('setting')->lang;
```
By that, you can split your logic and make your code base even cleaner.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Oussama Sid](https://github.com/ousid)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.