emadha / eloquent-views

A Composer Package to add views to eloquent models

Laravel Eloquent Views

A Composer Package to attach a render method to eloquent models.

I find it easier to render models views using a single line of code like model->render('view'); instead of going to controller, or having it inside a @include in blade, or by using multiple lines of code to achieve that. With this package, you can easily do so.

Requirements

This package requires Laravel 5.8 or higher, PHP 7.2 or higher.

Installation

You can install the package via composer:

composer require emadha/eloquent-views

The package will automatically register itself.

You can publish the config with:

php artisan vendor:publish --provider="EmadHa\EloquentViews\ServiceProvider" --tag="config"

The config file has the root diretory of the eloquent views

<?php
return [
    /**
     * The root directory of Eloquent views path in resources
     * by default it's using /resources/eloquent/{model name}
     */
    'path' => 'eloquent',
];

Usage

Adding HasEloquentViews trait to your eloquent models is all you need to start using this package.

...
class Post extends Model {
   use \EmadHa\EloquentViews\HasEloquentViews;
   ...
}

The views directory structure is like this: resources/views/eloquent/{model}/{view} where eloquent is defined in the config file and model is your lowercase model class e.g. post and the view is the view you request to render.

Example:

# Render a single model view
Post::first()->render('block'); // Single block, rendered.

# Build views for a colletion of models
# This will return a collection object.
Post::all()->render('block');

# You can use 'implode' to get this as a single html string e.g. ...->implode(null);
Post::all()->render('block')->implode(null);

This code will look into /resources/views/eloquent/post/block.blade.php and render it.

• The Data will be passed to the view through $model variable.
• You can pass an array in the render method after the first argument Post::first()->render('block', ['moredata'=>'Yes!]);

You can access that data like how you normally would, from a view:

<!-- /resources/views/eloquent/post/block.blade.php -->
<h1> {{ $model->title }} </h1>
<p> {{ $moredata }} </p>

The Beauty of it

How about you use this instead of including or creating the same code all the time ?

<!-- welcome.blade.php -->

<div class="news-items">
   {!! App\NewsItem::all()->render('block')->implode(null) !!}
</div>

And not just that, imagine if you want to have the rendered view output in your controller, for example and api, or search controller, where you want to get the output? This will make this side of project as simple as it can be!

Thank you.