PHPackages louis1021/presento - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. louis1021/presento ActiveLibrary[Utility & Helpers](/categories/utility) louis1021/presento ================== Presento is a package for PHP 5.6.40 data presenter v1.1.1(6y ago)141MITPHPPHP >=7.0 Since Aug 25Pushed 6y ago1 watchersCompare [ Source](https://github.com/louislee1021/presento)[ Packagist](https://packagist.org/packages/louis1021/presento)[ RSS](/packages/louis1021-presento/feed)WikiDiscussions master Synced 4w ago READMEChangelogDependencies (2)Versions (10)Used By (0) Presento ======== [](#presento) Obtain specific formatting using transformers and filtering fields using presenters. Differentiation and ChangeLog ----------------------------- [](#differentiation-and-changelog) 20191216 10:20 - Updated Installation Command to include dev-master, get rid of stable minimum stability. 20191204 20:08 - Fixed array while there is no transformer and formatDatatable is enabled. 20191126 11:10 - Fixed the transformer while enabled formatDatatable. 20191125 19:55 - Added $multi property to class presenter to add feature of processing more than one record. 20191122 18:05 - Updated the ultimate and the only uses of this package. End of this presento world. 20191122 18:01 - For the clear convention and future use, changing namespace is required. 20191122 17:18 - Added formatting: Datatable 20191122 16:35 - Applied PSR-0 indentation. 20191122 16:32 - Tested all provided functionality successfully with PHPUnit. 20191122 16:30 - Found issues on multi-dimensional array, fixed eventually. 20191122 12:18 - PHP 5.6.40 compatible. 20191122 11:30 - What? Yes. I forked. Credits ------- [](#credits) ### Requirements [](#requirements) ``` PHP >= 5.6.40 ext-json ``` Installation ------------ [](#installation) ``` composer require louislee1021/presento dev-master ``` Functionality ------------- [](#functionality) 1. `Presenter::present()` present only the necessary fields. In `present()` returned array, 2. `Presenter::present()` key aliasing: `'user_id => id'` returns new name `user_id` 3. Deep traversing: `'top_package' => 'projects.0.name'` on array `projects` 4. Nested presenter: `'projects' => [ProjectPresenter::class => ['projects']],` 5. Datatable format, array key removals. Inside Presenter class, add this property: `protected $formatDatatables = true;` 6. Simple transformer override on `user_id => id` : `public function getUserIdProperty($value)` 7. Read multi records `protected $multi = true;` ``` // UserTransformer.php class UserTransformer extends \Louis1021\Presento\Transformer { public function getUserIdProperty($value) { return md5($value); } } // UserPresenter.php class UserPresenter extends \Louis1021\Presento\Presenter { public function present() { return [ 'user_id' => 'id', 'name', 'email', 'type', 'is_active', ]; } public function transformer() { return UserTransformer::class; } } ``` Why Presento? ------------- [](#why-presento) **Presento** is a simple but powerful tools for preparing and presenting data. When we build an API based application, we need to *transform* the data before *present* it through the response. This package will make this task easier for you. Not clear enough? Don't worry, you'll get better idea from the [Usage examples](#usage). Usage ----- [](#usage) **Presento** serves two important purposes. one is **Presentation** and another is **Transformation** of the data. Let's see some examples to understand how to use it. We'll use the following data set to show the examples. Let's say we've this data set fetched from some data source and need to do some transformation or modifications before sending it to the response. ``` $response = [ "id" => 123456, "name" => "Nahid Bin Azhar", "email" => "talk@nahid.im", "type" => 1, "is_active" => 1, "created_at" => "2018-01-02 02:03:04", "updated_at" => "2018-01-02 02:03:04", "deleted_at" => "2018-01-02 02:03:04", "projects" => [ [ "id" => 1, "name" => "Laravel Talk", "url" => "https://github.com/nahid/talk", "license" => "CC0", "created_at" => "2016-02-02 02:03:04" ], [ "id" => 2, "name" => "JsonQ", "url" => "https://github.com/nahid/jsonq", "license" => "MIT", "created_at" => "2018-01-02 02:03:04" ] ] ]; ``` #### Simple Presentation Example [](#simple-presentation-example) When sending this data to the API response, we only want to send the `id`, `name`, `email`, `type`, `is_active` and `projects`. We can simply do that by preparing a Presenter for this like following. ``` // UserPresenter.php class UserPresenter extends \Louis1021\Presento\Presenter { public function present() { return [ 'id', 'name', 'email', 'type', 'is_active', 'projects', ]; } } ``` And you might already guessed how to use it, right? ``` $user = new UserPresenter($response); dump($user->get()); ``` It'd show something like this: ``` [ "id" => 123456, "name" => "Nahid Bin Azhar", "email" => "talk@nahid.im", "type" => 1, "is_active" => 1, "projects" => [ [ "id" => 1, "name" => "Laravel Talk", "url" => "https://github.com/nahid/talk", "license" => "CC0", "created_at" => "2016-02-02 02:03:04" ], [ "id" => 2, "name" => "JsonQ", "url" => "https://github.com/nahid/jsonq", "license" => "MIT", "created_at" => "2018-01-02 02:03:04" ] ] ] ``` Pretty simple, right? #### 'key' aliasing in Presentation example [](#key-aliasing-in-presentation-example) Let's say you want to change some of the 'key' to something different, like the `id` key to `user_id` . How can you do that? Just do the following. ``` // UserPresenter.php class UserPresenter extends \Louis1021\Presento\Presenter { public function present() { return [ 'user_id' => 'id', 'name', 'email', 'type', 'is_active', ]; } } ``` This will format the data like following: ``` [ "user_id" => 123456, "name" => "Nahid Bin Azhar", "email" => "talk@nahid.im", "type" => 1, "is_active" => 1, ] ``` #### Deep traversing in Presentation example [](#deep-traversing-in-presentation-example) You can easily dive deep and get data from a nested level by using `.` (dot) notation. Let's say you want to show the `name` of the first package as the `top_package` in your data. This is how you do it. ``` // UserPresenter.php class UserPresenter extends \Louis1021\Presento\Presenter { public function present() { return [ 'id', 'name', 'email', 'type', 'is_active', 'top_package' => 'projects.0.name', 'projects', ]; } } ``` This will format the data like this: ``` [ "id" => 123456, "name" => "Nahid Bin Azhar", "email" => "talk@nahid.im", "type" => 1, "is_active" => 1, "top_package" => "Laravel Talk", "projects" => [ [ "id" => 1, "name" => "Laravel Talk", "url" => "https://github.com/nahid/talk", "license" => "CC0", "created_at" => "2016-02-02 02:03:04" ], [ "id" => 2, "name" => "JsonQ", "url" => "https://github.com/nahid/jsonq", "license" => "MIT", "created_at" => "2018-01-02 02:03:04" ] ] ] ``` Notice the `top_package` key in the data. #### Simple Transformer Example [](#simple-transformer-example) Let's say our UserPresenter is like this: ``` // UserPresenter.php class UserPresenter extends \Louis1021\Presento\Presenter { public function present() { return [ 'user_id' => 'id', 'name', 'email', 'type', 'is_active', ]; } } ``` And we want to show the `user_id` as *hashed* value instead of an incremental integer value as it is in our database. That means we want to transform the `user_id`. To do that we need to create a Transformer Class like this: ``` // UserTransformer.php class UserTransformer extends \Louis1021\Presento\Transformer { public function getUserIdProperty($value) { return md5($value); } } ``` Notice that, as we will transform the `user_id` property, we named our transformer method as `getUserIdProperty`. So, if you want to transform the `name` property too, you need to just create another method in this class named `getNameProperty` and add the transformation logic inside it. Now, we need to let know the *Presenter* how to *Transform* the data before presenting it. To do that, we need to add the following method in the `UserPresenter` class. ``` // UserPresenter.php public function transformer() { return UserTransformer::class; } ``` So, our final output would be: ``` [ "user_id" => "e10adc3949ba59abbe56e057f20f883e", "name" => "Nahid Bin Azhar", "email" => "talk@nahid.im", "type" => 1, "is_active" => 1, ] ``` Ain't it easy, mate? #### Nested Presenter Example [](#nested-presenter-example) You might notice that there is a collection of `projects` in our data set. If each `project` is a separate resource, you might have a separate Presenter for that. Like this: ``` // ProjectPresenter.php class ProjectPresenter extends \Louis1021\Presento\Presenter { public function present() { return [ 'id', 'name', 'url', 'license', 'created_at', ]; } public function transformer() { return ProjectTransformer::class; } } ``` Can you use this Presenter for each of the `projects` in the *Users* data? Hell Yeah! Just do this: ``` // UserPresenter.php public function present() { return [ 'user_id' => 'id', 'name', 'email', 'type', 'is_active', 'projects' => [ProjectPresenter::class => ['projects']], ]; } ``` Now, each of the `project` in the list of `projects` in *Users* will be presented as defined in the `ProjectPresenter`. #### Base Data format conversion Example [](#base-data-format-conversion-example) As you have seen that, the data set we have used till now is a plain *Array*. But some times it might not be the case. You might need to work with something different, like **Eloquent Model** of Laravel framework. In that case, you can simply add a method called `convert` in your *Presenter* to convert the Base data to an Array format. Let's see an Example: ``` // UserPresenter.php public function convert($data) { if ($data instanceof Model) { return $data->toArray(); } return $data; } ``` That's it. ### Health Score 27 — LowBetter than 49% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity9 Limited adoption so far Community11 Small or concentrated contributor base Maturity59 Maturing project, gaining track record Bus Factor1 Top contributor holds 53.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~9 days Total 9 Last Release 2377d ago Major Versions v0.0.2 → v1.0.02019-08-27 ### Community Maintainers ![](https://www.gravatar.com/avatar/33e1c414c397d798b6aa936792eedd57645d37568ddc1e16425500d93a3529a4?d=identicon)[louis1021](/maintainers/louis1021) --- Top Contributors [![nahid](https://avatars.githubusercontent.com/u/3167309?v=4)](https://github.com/nahid "nahid (32 commits)")[![louislee1021](https://avatars.githubusercontent.com/u/58059563?v=4)](https://github.com/louislee1021 "louislee1021 (14 commits)")[![me-shaon](https://avatars.githubusercontent.com/u/831997?v=4)](https://github.com/me-shaon "me-shaon (13 commits)")[![maki10](https://avatars.githubusercontent.com/u/13304146?v=4)](https://github.com/maki10 "maki10 (1 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/louis1021-presento/health.svg) ``` [![Health](https://phpackages.com/badges/louis1021-presento/health.svg)](https://phpackages.com/packages/louis1021-presento) ``` ### Alternatives [scheb/tombstone Dead code detection with tombstones for PHP 282578.2k2](/packages/scheb-tombstone) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)