Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tooleks/laravel-presenter
The Laravel Presenter Composer Package
https://github.com/tooleks/laravel-presenter
collection composer data entity laravel mapper mapping php presenter representation view
Last synced: 25 days ago
JSON representation
The Laravel Presenter Composer Package
- Host: GitHub
- URL: https://github.com/tooleks/laravel-presenter
- Owner: tooleks
- License: mit
- Created: 2016-12-06T15:10:50.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-06-02T15:26:47.000Z (over 7 years ago)
- Last Synced: 2024-11-13T13:46:09.791Z (3 months ago)
- Topics: collection, composer, data, entity, laravel, mapper, mapping, php, presenter, representation, view
- Language: PHP
- Homepage: https://packagist.org/packages/tooleks/laravel-presenter
- Size: 81.1 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# The Laravel Presenter Package
The package provides the `Presenter` layer for wrapping model objects into new presentations.
## Features
The package supports:
* Objects and arrays presentation
* Data mapping
* Nested attributes
* Attributes overriding
* The Laravel 5.2 collections
* JSON serialization
* Casting to array/JSON
* Injections into the constructor
## Requirements
"php": "^7.0",
"illuminate/support": "^5.2",
"illuminate/contracts": "^5.2"
## Installation
### Package Installation
Execute the following command to get the latest version of the package:
```shell
composer require tooleks/laravel-presenter
```
### App Configuration
To register the service provider simply add the `Tooleks\Laravel\Presenter\Providers\PresenterProvider::class` into your `config/app.php` to the end of the `providers` array:
```php
'providers' => [
...
Tooleks\Laravel\Presenter\Providers\PresenterProvider::class,
],
```
## Usage Examples
### Model Presentation
To define your presenter class, you need to extend base `Tooleks\Laravel\Presenter\Presenter` class, as shown in the example below.
Override the `getAttributesMap()` method to build attributes map definition.
```php
'wrapped_model_attribute_name'
'nickname' => 'username',
'short_name' => 'first_name',
'full_name' => function () {
return $this->getWrappedModelAttribute('first_name') . ' ' . $this->getWrappedModelAttribute('last_name');
},
'role' => 'role.name',
];
}
}
```
Create a presenter object instance by passing a wrapped model into a `setWrappedModel` method and use it like an object with `nickname`, `short_name`, `full_name`, `role` attributes. The wrapped model may be an `array` or an `object`.
```php
'anna',
'first_name' => 'Anna',
'last_name' => 'P.',
'role' => [
'name' => 'User',
],
];
$userPresenter = app()->make(\App\Presenters\UserPresenter::class)->setWrappedModel($user);
// Create the presenter from the wrapped model array.
$userPresenter = app()->make(\App\Presenters\UserPresenter::class)->setWrappedModel((object) $user);
// Create the presenter from the wrapped model object.
echo $userPresenter->nickname;
// Prints 'anna' string, as we mapped the wrapped model 'username' attribute to the presenter 'nickname' attribute.
echo $userPresenter->short_name;
// Prints 'Anna' string, as we mapped the wrapped model 'first_name' attribute to the presenter 'short_name' attribute.
echo $userPresenter->full_name;
// Prints 'Anna P.' string, as we override the presenter 'full_name' attribute by the anonymous function.
echo $userPresenter->role;
// Prints 'User' string, as we mapped the wrapped model 'role.name' nested attribute to the presenter 'role' attribute.
```
### Collection Presentation
The package also provides the collection macros method `present()` for wrapping each item in the collection into a presenter class.
```php
present(\App\Presenters\UserPresenter::class);
// Create the collection of the 'UserPresenter' items.
```
### Data Mapping
The package provides a simple mechanism for data mapping. All you need is to call `toArray()` method on the presenter object instance.
```php
make(\App\Presenters\UserPresenter::class)->setWrappedModel($user)->toArray();
$mappedDataObject = (object) app()->make(\App\Presenters\UserPresenter::class)->setWrappedModel($user)->toArray();
```
### Using as a Response Data
The `Tooleks\Laravel\Presenter\Presenter` class implements `Illuminate\Contracts\Support\Arrayable`, `Illuminate\Contracts\Support\Jsonable`, `JsonSerializable` interfaces, so you may pass objects of this class directly into the response.
```php
make(\App\Presenters\UserPresenter::class)->setWrappedModel($user);
response($content);
```
## Tests
Execute the following command to run tests:
```shell
./vendor/bin/phpunit
```