padosoft / laravel-presenter
Implementation for Laravel of the presenter design pattern.
Installs: 5 838
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 7
Open Issues: 0
Requires
- php: >=7.4
- illuminate/database: ~5.6|^v6.0|^v7.0|^v8.0|^v9.0|^v10.0|^v11.0
- illuminate/support: ~5.6|^v6.0|^v7.0|^v8.0|^v9.0|^v10.0|^v11.0
Requires (Dev)
- phpunit/phpunit: ~5.2|^6.5.14|^7.5.20|^8.5.26|^9.5.20|^10
- roave/security-advisories: dev-latest
README
Presenter is a design pattern for Laravel which is used to modify the data that comes from your model to your views.
It causes the data to be displayed in a way understandable to humans.
Table of Contents
##Requires
- "php" : ">=5.6.0",
- "illuminate/support": "~5.0|^6.0|^7.0|^8.0|^9.0",
- "illuminate/database": "~5.0|^6.0|^7.0|^8.0|^9.0"
Installation
Laravel 5.x
Execute the following command to get the latest version of the package:
composer require padosoft/laravel-presenter
USAGE
The first step is to store your presenters somewhere - anywhere. These will be simple objects that do nothing more than format data, as required.
Note that your presenter class must extend Laracodes\Presenter\Presenter
:
namespace App\Presenters; use Laracodes\Presenter\Presenter; class UserPresenter extends Presenter { public function fullName() { return $this->model->first_name . ' ' . $this->model->last_name; } public function accountAge() { return $this->model->created_at->diffForHumans(); } ... }
Next, on your model, pull in the Laracodes\Presenter\Traits\Presentable
trait, which will automatically instantiate your presenter class:
namespace App\Models; use Illuminate\Database\Eloquent\Model; use Laracodes\Presenter\Traits\Presentable; class User extends Model { use Presentable; protected $presenter = 'App\Presenters\UserPresenter'; ... }
Done, now you can call it in your views:
<h1>Hello, {{ $user->present()->fullName }}</h1> <h1>Hello, {{ $user->present()->full_name }}</h1> // automatically convert to camelCase
Notice how the call to the present() method (which will return your new or cached presenter object) also provides the benefit of making it perfectly clear where you must go, should you need to modify how a full name is displayed on the page.
Notices
When you call a method that does not exist in its class presenter, this package will automatically call the property in the model with conversion to snake_case.
Ex:
// automatically calls the property in the model <h1>Hello, {{ $user->present()->firstName }}</h1> // automatically convert to snake_case <h1>Hello, {{ $user->present()->first_name }}</h1>
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email instead of using the issue tracker.
Credits
This package is largely inspired by this great package by @laracasts and forked from guilhermegonzaga/presenter.
About Padosoft
Padosoft (https://www.padosoft.com) is a software house based in Florence, Italy. Specialized in E-commerce and web sites.
License
The MIT License (MIT). Please see License File for more information.