PHPackages team-reflex/presenter - 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. team-reflex/presenter Abandoned → [robclancy/presenter](/?search=robclancy%2Fpresenter)ArchivedLibrary team-reflex/presenter ===================== This is a simple library to help make a Presenter for your objects. v1.4.1(9y ago)05.5kDBADPHPPHP >=5.4.0 Since Apr 9Pushed 6y ago2 watchersCompare [ Source](https://github.com/teamreflex/presenter)[ Packagist](https://packagist.org/packages/team-reflex/presenter)[ RSS](/packages/team-reflex-presenter/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (2)Dependencies (3)Versions (11)Used By (0) Presenter ========= [](#presenter) This library provides a simple class to help make a `Presenter` for your objects or arrays. It also has little extras for use within Laravel with minimal extra code in your controllers (in most cases no extra code). **Deprecated:** This was only forked to maintain compatibility for a company project. Just use robclancy/presenter. [![Build Status](https://camo.githubusercontent.com/5797d4d6e841d4e314827809f692a83ffc1970b68008a725634f589e9ec3aeee/68747470733a2f2f7365637572652e7472617669732d63692e6f72672f726f62636c616e63792f70726573656e7465722e706e67)](http://travis-ci.org/robclancy/presenter) Table of Contents ----------------- [](#table-of-contents) - [Installation](#installation) - [Composer](#composer) - [Manually](#manually) - [Laravel 4](#laravel-4) - [Usage](#usage) - [General Usage](#general-usage) - [Manually Initiate](#manually-initiate) - [Laravel Usage](#laravel-usage) - [Array Usage](#array-usage) - [Extending the Decorator](#extending-the-decorator) - [Change Log](#change-log) - [License](#license) Installation ------------ [](#installation) ### Composer [](#composer) Add `robclancy/presenter` to the "require" section of your `composer.json` file. ``` "robclancy/presenter": "1.3.*" ``` Run `composer update` to get the latest version of the package. ### Manually [](#manually) It's recommended that you use Composer, however you can download and install from this repository. ### Laravel 4 [](#laravel-4) This package comes with an optional service provider for Laravel 4 so that you can automate some extra steps. You will need to have installed using the composer method above, then register the service provider with your application. Open `app/config/app.php` and find the `providers` key. Add ``` 'Robbo\Presenter\PresenterServiceProvider', ``` to the array at some point after ``` 'Illuminate\View\ViewServiceProvider', ``` Now presenters will automatically be created if using the [laravel method](#laravel-usage) described below. Usage ----- [](#usage) `Presenter` is a very simple class that overloads methods and variables so that you can add extra logic to your objects or arrays without adding view logic to areas like your models or controllers and also keeps any extra logic out of your views. ### General Usage [](#general-usage) Let's say you have a list of users and you want to generate a link to the profile of each user. Many people would just build the URL in the view, or worse, in the controller. To separate this logic we instead use a presenter. Let's assume we have a `User` class which simply has an `id` and `username` property. The presenter might look like this. ``` class UserPresenter extends Robbo\Presenter\Presenter { public function url() { return $this->id.'-'.$this->username; } } ``` Now our view should receive an instance of this presenter which would be created with something like `$user = new UserPresenter(new User);`. If we want to link to the users page all we have to do is call `$user->url()`. Now you have good separation of logic and an easy little class you can modify to add properties to your `User` in all areas. However you might not want to be calling methods like this, it could be inconsistant with what you are doing or you might want the code to look a little cleaner. That is where methods with the `present` prefix come in. All we do is update the presenter to the following. ``` class UserPresenter extends Robbo\Presenter\Presenter { public function presentUrl() { return $this->id.'-'.$this->username; } } ``` Now the presenter will call this new method when you execute `$user->url`. Further more you can access this method via `ArrayAccess` by calling `$user['url']`. More on `ArrayAccess` support below. ### Manually Initiate [](#manually-initiate) As mentioned in the above section to create a presenter you simply initiate with the `new` keyword and inject your object or array. ``` class User { // ... } class UserPresenter extends Robbo\Presenter\Presenter { // ... } $user = new User; // handle stuff here // make sure to "convert" to a presenter before the object gets to your views $user = new UserPresenter($user); // Can also create a presenter for arrays $user = [ 'id' => 1, 'username' => 'Robbo', ]; // same as before $user = new UserPresenter($user); ``` ### Laravel Usage [](#laravel-usage) If you are using laravel and have followed the above installation instructions you can use the provided interface `Robbo\Presenter\PresentableInterface` to automate turning your model instances into a `Presenter` from both collections and when a model is sent directly to the view. What the service provider does is extend Laravel's view component with a step before the view object is created. This step turns anything that implements the `PresentableInterface` into a `Presenter` by calling `->getPresenter()`. What this means is you don't need to add anything extra to your controllers to have your views using presenters for your objects. For Example. ``` class UserPresenter extends Robbo\Presenter\Presenter { // ... } class User implements Robbo\Presenter\PresentableInterface { /** * Return a created presenter. * * @return Robbo\Presenter\Presenter */ public function getPresenter() { return new UserPresenter($this); } } ``` Now whenever your `User` model is sent to a view, in a collection, array or by itself it will be turned into a presenter using the provided `getPresenter()` method. So your controller will work with `User` and when you get to your view it will be working with `UserPresenter` with the internal object being `User`. ### Array Usage [](#array-usage) 1.1.x introduces support for arrays. The `Presenter` will implement `ArrayAccess` so in your views you can access your variables with `$presenter['variable']` if you want. But more importantly you can give the `Presenter` an array instead of an object. So you can use presenters to work with array data as well as objects. For example. ``` $user = [ 'id' => 1, 'username' => 'Robbo', ]; class UserPresenter extends Robbo\Presenter\Presenter { public function presentUrl() { // This will work exactly the same as previous examples return $this->id.'-'.$this->username; // You can also do this... return $this['id'].'-'.$this['username']; } } // Now we create a presenter much the same as before $user = new UserPresenter($user); // In our views we can use the $user as if it were still an array echo 'Hello, ', $user['username']; // Or even treat it like the object that it is echo 'Hello, ', $user->username; // And like other examples, we can present the url in the same way echo 'The URL: ', $user->url; echo 'And again: ', $user['url']; ``` ### Extending the Decorator [](#extending-the-decorator) As of 1.2.x I have added in a decorator object. This object takes care of turning an object that has `PresentableInterface` into a `Presenter`. By default, this is done with Laravel's `View` objects. The reasoning behind a new class instead of the previous implementation is so it can be better tested and also to allow you to extend it. Here is an example of extending the `Decorator` so that instead of using the `PresentableInterface` and `getPresenter()` method you can use a public variable on the object called `$presenter`. Note: these instructions are for Laravel usage. First extend the decorator... ``` use Robbo\Presenter\Decorator as BaseDecorator; class Decorator extends BaseDecorator { /* * If this variable implements Robbo\Presenter\PresentableInterface then turn it into a presenter. * * @param mixed $value * @return mixed $value */ public function decorate($value) { if (is_object($value) and isset($value->presenter)) { $presenter = $value->presenter; return new $presenter; } return parent::decorate($value); } } ``` To use your new decorator either add the following to `start/global.php` or into your own service provider. ``` // In start/global.php App::make('presenter.decorator', App::share(function($app) { $decorator = new Decorator; Robbo\Presenter\Presenter::setExtendedDecorator($decorator); return $decorator; }); // In a service provider's 'register' method $this->app['presenter.decorator'] = $this->app->share(function($app) { $decorator = new Decorator; Robbo\Presenter\Presenter::setExtendedDecorator($decorator); return $decorator; }); ``` And that is all there is to it. You can easily automate the creation of presenters to suit your workflow using this method. Change Log ---------- [](#change-log) #### 1.3.0 [](#130) - updated to work with `laravel 4.2.x`, to use in `4.1.x` stay on version `1.2.*` - moved to PSR-4 and now PHP 5.4+ - small refactor and check `isset` again 'present' methods, thanks [BenConstable](https://github.com/robclancy/presenter/pull/25) #### 1.2.0 [](#120) - presenters can now be nested, thanks [alexwhitman](https://github.com/robclancy/presenter/pull/10) - added support for using Laravel's `View::with(array here)`, thanks [skovachev](https://github.com/robclancy/presenter/pull/14) - added ability to use `isset(...)` and `unset(...)` on presenter variables, thanks [nsbucky](https://github.com/robclancy/presenter/pull/15) - added a new decorator for creating the presenter objects. This makes it so you can [extend what happens when decorating an object](#extending-the-decorator) easily #### 1.1.0 [](#110) - the Presenter class now implements ArrayAccess - added ability to use an array as your internal data #### 1.0.2 [](#102) - fixed bug caused by laravel update - added smarter converting of presenters from PresentableInterface'd objects - added object getter `getObject` to retrieve the internal object #### 1.0.1 [](#101) - fixed bug caused by laravel update #### 1.0.0 [](#100) - Initial Release ### License [](#license) Presenter is released under the [DBAD](http://www.dbad-license.org) license. Do what you want just **d**on't **b**e **a** **d**ick. ### Health Score 32 — LowBetter than 72% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity17 Limited adoption so far Community16 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 52.9% 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 ~173 days Recently: every ~315 days Total 9 Last Release 3390d ago PHP version history (2 changes)1.0.0PHP >=5.3.0 1.3.0PHP >=5.4.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/8c4b542cd7b5f3a4f3587cbb2ffe26e815b3c9aa9892c04fc5d93ec8d0db5d5e?d=identicon)[Kairu](/maintainers/Kairu) --- Top Contributors [![robclancy-test](https://avatars.githubusercontent.com/u/123053691?v=4)](https://github.com/robclancy-test "robclancy-test (36 commits)")[![robclancy](https://avatars.githubusercontent.com/u/857111?v=4)](https://github.com/robclancy "robclancy (17 commits)")[![BenConstable](https://avatars.githubusercontent.com/u/817029?v=4)](https://github.com/BenConstable "BenConstable (3 commits)")[![janhartigan](https://avatars.githubusercontent.com/u/580052?v=4)](https://github.com/janhartigan "janhartigan (2 commits)")[![juco](https://avatars.githubusercontent.com/u/495661?v=4)](https://github.com/juco "juco (2 commits)")[![kylekz](https://avatars.githubusercontent.com/u/450516?v=4)](https://github.com/kylekz "kylekz (2 commits)")[![lahaxearnaud](https://avatars.githubusercontent.com/u/1364221?v=4)](https://github.com/lahaxearnaud "lahaxearnaud (2 commits)")[![xKairu](https://avatars.githubusercontent.com/u/169433509?v=4)](https://github.com/xKairu "xKairu (1 commits)")[![jenssegers](https://avatars.githubusercontent.com/u/194377?v=4)](https://github.com/jenssegers "jenssegers (1 commits)")[![skovachev](https://avatars.githubusercontent.com/u/1137946?v=4)](https://github.com/skovachev "skovachev (1 commits)")[![alexwhitman](https://avatars.githubusercontent.com/u/422013?v=4)](https://github.com/alexwhitman "alexwhitman (1 commits)") --- Tags laravelpresenterdecorator ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/team-reflex-presenter/health.svg) ``` [![Health](https://phpackages.com/badges/team-reflex-presenter/health.svg)](https://phpackages.com/packages/team-reflex-presenter) ``` ### Alternatives [robclancy/presenter Decorate your objects using presenters. Primarily to keep presentation logic out of your models. 3451.1M8](/packages/robclancy-presenter)[lewis/presenter Simple view presenter library for Laravel. 174.7k](/packages/lewis-presenter)[deefour/presenter Presenters/Decorators for PHP Objects 122.5k](/packages/deefour-presenter) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)