warrickbayman/looker

This package is abandoned and no longer maintained. The author suggests using the thepublicgood/is-presentable package instead.

A really simple PHP view presenter based on Jeffery Ways laracasts\Presenter class

1.0.1 2017-04-15 12:34 UTC

Requires (Dev)

• phpunit/phpunit: ^4.6

MIT

• Warrick Bayman

README

A simple PHP presenter library.

Why

Well, it's quite common to separate your presentation code from your models. When I started with PHP I found myself doing things like:

//User.php

class User extends Model
{
    public function fullName()
    {
        return $this->first_name . ' ' . $this->last_name;
    }
}

// view.php
<?php echo $user->fullName(); ?>

This is bad. So Looker separates your presentation stuff out of your models. It's based on the simple presentation library that Jeffery Way wrote for Laracasts.

Installation

Use composer:

composer require warrickbayman/looker

Usage

In your model add the Looker\Presentable trait:

use Looker\Traits\Presentable;

class User
{
    use Presentable;
}

Create a new view presenter that extends the Looker\Presenter class

use Looker\Presenter;

class User extends Presenter
{
    public function fullName()
    {
        return $this->entity->first_name . ' ' . $this->entity->last_name;
    }
}

Now, in your view:

echo $this->present()->fullName;

From within the presenter, $this->entity is the associated model.

By default, Looker will look in the Http\Presenters namespace for presenter classes, but you can change that. Somewhere in your intialization, call the Looker::init method and pass in the class path for your presenters:

Looker\Looker::init('Presenters');

You can also pass in a "suffix" if you like to do things like add the word "Presenter" to the end of your presenter classes:

Looker\Looker::init('Presenters', 'Presenter');

Now Looker will look for UserPresenter instead of just User.

Overriding Model Members

Looker will automatically override model members. So you can do:

echo $user->present()->dateOfBirth;

even if the dateOfBirth method or property doesn't exist on your presenter. Looker will first look for a method by the same name on the model. If a method doesn't exist, it will then look for a property by the same name. Looker will throw a OverrideFailed exception if there is no method or property to call.