Te-cho / compile-blades by abd_rmdn

A Laravel package for compiling blades nested in 1 file into 1 flattened file.
1,799
64
5
Package Data
Maintainer Username: abd_rmdn
Maintainer Contact: abidul.rdmdn@gmail.com (Abidul Wahab Ramadan)
Package Create Date: 2017-07-01
Package Last Update: 2020-02-14
Home Page: https://packagist.org/packages/te-cho/compile-blades
Language: PHP
License: MIT
Last Refreshed: 2024-03-27 03:07:15
Package Statistics
Total Downloads: 1,799
Monthly Downloads: 1
Daily Downloads: 0
Total Stars: 64
Total Watchers: 5
Total Forks: 22
Total Open Issues: 8

compile-blades

A Laravel package for compiling blades nested in 1 file into 1 flattened file.

Why?

For best performance, you may want to consider flattening your blades on production, cause a lot of nesting consumes time in laravel since each nested level repeats the same pipline process, that consumes time & memory.

Example of problems:

  • https://stackoverflow.com/questions/30673129/laravel-blades-performance/44863712#44863712
  • https://laracasts.com/discuss/channels/laravel/how-to-improve-laravel-views-performance-when-using-multiple-times-same-view-file-or-howto-avoid-repeating-expensive-read-file-operation

Table of Contents

1) Require the package

Next, you'll need to require the package using Composer:

From your project's base path, run:

$ composer require te-cho/compile-blades

2) Configure Laravel

Service Provider

Add the following to the providers key in config/app.php:

'providers' => [
    Techo\CompileBlades\CompileBladesServiceProvider::class,
];

Console

To get access to the compile:blades command, add the following to the $commands property in app/Console/Kernel.php:

protected $commands = [
    \Techo\CompileBlades\Console\CompileBlades::class,
];

Usage

Before getting started, I highly recommend reading through Laravels documentation on Views and Blades.

Flattening Views:

Providing everything is set up and configured properly, all you need to do in order to flatten a view for a certain route or something else, is running the following command:

$ php artisan compile:blades view-name

This will generate a flattened view instead of the current one.

Example:

Lets say we have a view called test.blade.php that is called by one of our controllers, which is including another view inside of it, but the problem is that its looping in it, which causes the include to happen alot which cause performance drops. So we run the following command:

$ php artisan compile:blades test

Input File

test.blade.php subviews/included-test.blade.php

Output File

test.blade.php