PHPackages                             prosopo/views - 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. [Templating & Views](/categories/templating)
4. /
5. prosopo/views

ActiveLibrary[Templating & Views](/categories/templating)

prosopo/views
=============

Blazing fast Views with model-driven approach, Blade and multi-namespace support.

1.0.5(1y ago)101.2k1Apache-2.0PHPPHP ^7.4|^8.0CI passing

Since Dec 18Pushed 1y ago2 watchersCompare

[ Source](https://github.com/prosopo/php-views)[ Packagist](https://packagist.org/packages/prosopo/views)[ Docs](https://github.com/prosopo/php-views)[ RSS](/packages/prosopo-views/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (8)Used By (0)

PHP Views
=========

[](#php-views)

> **PHP Views** is a Composer package designed to simplify templating in PHP. It introduces a model-driven approach, supports multiple namespaces, and includes a custom [Blade](https://laravel.com/docs/11.x/blade) implementation as the default template engine.

Table of Contents
-----------------

[](#table-of-contents)

[1. Introduction](#1-introduction)
[2. Installation and minimal usage](#2-installation-and-minimal-usage)
[3. Model-driven approach](#3-model-driven-approach)
[4. Views Manager](#4-views-manager)
[5. View Renderer](#5-view-renderer)
[6. Contribution](#6-contribution)
[7. Credits](#7-credits)

1. Introduction
---------------

[](#1-introduction)

While many PHP frameworks come with their own solutions for views, there are countless PHP projects without a templating system (including CMS, like WordPress). Writing pure PHP templates can be cumbersome and error-prone. PHP Views aims to make templating simple, flexible, and accessible to anyone.

### Freedom to choose your template engine

[](#freedom-to-choose-your-template-engine)

This package includes a custom [Blade](https://laravel.com/docs/11.x/blade) compiler and uses it as the default template engine. However, flexibility is key. You can integrate [Twig](https://twig.symfony.com/), or any other template engine, with just a few lines of code while still enjoying the benefits of the model-driven approach and other features that PHP Views brings to the table.

### Package Benefits

[](#package-benefits)

- **Blazing fast**: Outperforms the original Laravel Blade (see the benchmark below).
- **Zero Dependencies**: Lightweight and easy to integrate into any project.
- **Wide Compatibility**: PHP 7.4+, 8.0+
- [SOLID architecture](https://en.wikipedia.org/wiki/SOLID): Designed with flexibility in mind, allowing you to easily override modules to meet your specific requirements
- **Namespace Support**: Seamlessly manage multiple templates under a unified, structured approach.
- **Reliable**: Thoroughly tested with [Pest](https://pestphp.com/) and checked by [PHPStan](https://phpstan.org/).

### Usage flexibility

[](#usage-flexibility)

The strength of this package lies in its flexibility. With PHP Views, you’re free to use it in a way that best fits your project:

- **As a Views provider:** Combine a model-driven approach with the built-in Blade engine for clean, dynamic templates.
- **As a standalone Blade engine:** Use its custom Blade implementation for your Blade-based templates.
- **For Model-Driven Flexibility:** Leverage the model-driven approach with any template engine, such as [Twig](https://twig.symfony.com/) or even pure PHP.
- **As a Template Connector:** Integrate and unify templates that utilize different engines under one system.

### Benchmark

[](#benchmark)

We conducted a [PHP performance benchmark](https://github.com/prosopo/php-views/blob/main/benchmark/src/Benchmark.php)to compare this package with the Laravel's Blade (mocked using [jenssegers/blade](https://github.com/jenssegers/blade)) and [Twig](https://twig.symfony.com/). Here are the results for 1000x renders:

ContestantFirst Rendering, MSCached Rendering, MS`prosopo/views` (without models)19.7519.75 (no cache atm)`prosopo/views` (with models)43.7843.78 (no cache atm)`illuminate/view` (Blade from Laravel)181.2456.77 ms`twig/twig`441.139.47 msThe numbers speak for themselves. In uncached rendering, even with model class-related overhead, PHP Views’ implementation significantly outperforms all competitors. While Twig offers a robust caching solution, PHP Views still delivers better performance even than Laravel's Blade engine with caching.

We used the following package versions:

- [illuminate/view](https://packagist.org/packages/illuminate/view) `11.7.0`
- [twig/twig](https://packagist.org/packages/twig/twig) `3.17.1`
- [jenssegers/blade](https://packagist.org/packages/jenssegers/blade) `2.0.1`

Since the [benchmark](https://github.com/prosopo/php-views/blob/main/benchmark/src/Benchmark.php) is included in this repository, you can easily run it locally to verify the results.

1. `git clone https://github.com/prosopo/php-views.git`
2. `composer install; cd benchmark; composer install`
3. `php benchmark {1000}` - pass your renders count

2. Installation and minimal usage
---------------------------------

[](#2-installation-and-minimal-usage)

### 2.1) Installation

[](#21-installation)

PHP Views is distributed as a Composer package, making installation straightforward:

`composer require prosopo/views`

After installation, ensure that your application includes the Composer autoloader (if it hasn’t been included already):

`require __DIR__ . '/vendor/autoload.php';`

### 2.2) Minimal setup

[](#22-minimal-setup)

To get started, you’ll need to create three instances: `ViewTemplateRenderer`, `ViewNamespaceConfig`, and `ViewsManager`.

The main configuration takes place in `ViewNamespaceConfig`, where you define the folder for your templates and the root namespace for the associated models.

```
use Prosopo\Views\View\ViewNamespaceConfig;
use Prosopo\Views\View\ViewTemplateRenderer;
use Prosopo\Views\ViewsManager;

require __DIR__ . '/vendor/autoload.php';

// 1. Make the Template Renderer.
// (By default it uses the built-in Blade, but you can connect any)

$viewTemplateRenderer = new ViewTemplateRenderer();

// 2. Make the namespace config

$namespaceConfig = (new ViewNamespaceConfig($viewTemplateRenderer))
    ->setTemplatesRootPath(__DIR__ . './templates')
    ->setTemplateFileExtension('.blade.php');

// 3. Make the Views Manager instance:

$viewsManager = new ViewsManager();

// 4. Add the root namespace of your Template Models

$viewsManager->registerNamespace('MyPackage\Views', $namespaceConfig);
```

### 2.3) Model definition

[](#23-model-definition)

Now you're ready to create your first model. Similar to many frameworks, such as Laravel, this package embraces a model-driven approach to templates.

Each template is paired with its own Model, where the Model's public properties and methods act as arguments available within the template.

Model class must extend the `BaseTemplateModel` class or implement the `TemplateModelInterface`:

```
namespace MyPackage\Views;

use Prosopo\Views\BaseTemplateModel;

class EmployeeTemplateModel extends BaseTemplateModel
{
    public int $salary;
    public int $bonus;
    public CompanyTemplateModel $company;

    public function total(): int
    {
        return $this->salary + $this->bonus;
    }
}
```

Model template (Blade is used in this example):

```

Your month income is {{ $total() }},
from which {{ $salary }} is a salary, and {{ $bonus }} is a bonus.
Est. taxes: {{ $company->calcTaxes($salary) }}

Company info:

{!! $company !!}
```

As you can see, all the public properties of the model are accessible within the template, including nested models like `$company`. This also enables you to call their public methods directly within the template.

The `BaseTemplateModel` class which we inherited overrides the `__toString()` method, allowing inner models to be rendered as strings using [Blade echo statements](https://laravel.com/docs/11.x/blade) with the HTML support. For instance:

`{!! $innerModel !!}` part of the template will render the model and print the result.

> Naming clarification: this package `does not require` the `Model suffix` in the names of model classes. In this document, we use the Model suffix for class names purely for demonstration purposes.

### 2.4) Automated templates matching

[](#24-automated-templates-matching)

The built-in `ModelTemplateResolver` automatically matches templates based on the Model names and their relative namespaces. This automates the process of associating templates with their corresponding Models.

Example:

- src/
    - Views/
        - `Homepage.php`
        - Settings
            - `GeneralSettings.php`
    - templates/
        - `homepage{.blade.php}`
        - settings/
            - `general-settings{.blade.php}`

We define the root templates folder along with the models root namespace in the `ViewsNamespaceConfig` (as we already did above):

```
$namespaceConfig = (new ViewNamespaceConfig($viewTemplateRenderer))
    ->setTemplatesRootPath(__DIR__ . './templates')
    ->setTemplateFileExtension('.blade.php');

// 3. Make the Views Manager instance:

$viewsManager = new ViewsManager();

// 4. Add the root namespace of your Template Models

$viewsManager->registerNamespace('MyPackage\Views', $namespaceConfig);
```

**Naming Note:** Use dashes in template names, as `camelCase` in Model names is automatically converted to `dash-separated`names.

### 2.5) Usage

[](#25-usage)

The `ViewsManager` instance (which we created during the setup) provides the `createModel` and `renderModel` methods.

You can create, set values, and render a Model in a single step using the callback argument of the `renderView` method, as shown below:

```
echo $viewsManager->renderModel(
    EmployeeTemplateModel::class,
    function (EmployeeTemplateModel $employee) use ($salary, $bonus) {
        $employee->salary = $salary;
        $employee->bonus = $bonus;
    }
);
```

This approach enables a functional programming style when working with Models.

**Multi-step creation and rendering**

When you need split creation, call the `makeModel` method to create the model, and then render later when you need it.

```
$employee = $viewsManager->createModel(EmployeeTemplateModel::class);

// ...

$employee->salary = $salary;
$employee->bonus = $bonus;

// ...

echo $views->renderModel($employee);

// Tip: you can pass the callback as the second argument for both createModel() and renderModel() models
// to customize the Model properties before returning/rendering.
```

**References Advice**

The `ViewsManager` class implements three interfaces: `ViewNamespaceManagerInterface` for `registerNamespace`, `ModelFactoryInterface` for `createModel`, and `ModelRendererInterface` for `renderModel`.

When passing the `ViewsManager` instance to your methods, use one of these interfaces as the argument type instead of the `ViewsManager` class itself.

This approach ensures that only the specific actions you expect are accessible, promoting cleaner and more maintainable code.

> That's it! You’re now ready to start using the package. In the sections below, we'll dive deeper into its configuration and implementation details.

3. Model-driven approach
------------------------

[](#3-model-driven-approach)

This package embraces a model-driven approach to templates. Each template is paired with its own Model, where the Model's public properties and methods act as arguments available within the template.

Model class must extend the `BaseTemplateModel` class or implement the `TemplateModelInterface`:

```
namespace MyPackage\Views;

use Prosopo\Views\BaseTemplateModel;

class EmployeeTemplateModel extends BaseTemplateModel
{
    public int $salary;
    public int $bonus;
}
```

Public model properties intended for use in the template must have a defined type. By default, any public properties without a type will be ignored.

> Naming clarification: This package `does not require` the `Model suffix` in the names of model classes. In this document, we use the Model suffix for class names purely for demonstration purposes.

### 3.1) Benefits

[](#31-benefits)

1. Typed variables: Eliminate the hassle of type matching and renaming associated with array-driven variables.
2. Reduced Routine: During object creation, public fields of the model without default values are automatically initialized with default values.
3. Enhanced Access: Public methods are made available to the template alongside the variables.
4. Unified Interface: Use the `TemplateModelInterface` in your application when accepting or returning a Model to maintain flexibility and avoid specifying the exact component.

### 3.2) Inner models

[](#32-inner-models)

Model can contain one or more nested models or even an array of models. To allow flexibility in deciding the model type later, define its type as `TemplateModelInterface`.

This approach enables you to assign any model to this field during data loading. However, if you want to restrict the field to a specific model, you can define its exact class type:

```
namespace MyPackage\Views;

use Prosopo\Views\BaseTemplateModel;
use Prosopo\Views\Interfaces\Model\TemplateModelInterface;

class EmployeeTemplateModel extends BaseTemplateModel
{
    // Use the abstract interface to accept any Model.
    public TemplateModelInterface $innerModel;
    // Use a specific class only when you want to restrict the usage to it.
    public CompanyTemplateModel $company;
}
```

By default, inner models are passed to templates as objects, enabling you to call their public methods directly. For example:

`{{ $$innerModel->calc($localVar) }}`.

The `BaseTemplateModel` class overrides the `__toString()` method, allowing inner models to be rendered as strings using echo statements, which supports HTML output. For instance:

`{!! $innerModel !!}` will render the model and print the result.

If you prefer, you can configure the `ViewsManager` to pass models as strings instead of objects. Refer to the [ViewsManager section](#4-views-manager) for details.

### 3.3) Custom property defaults

[](#33-custom-property-defaults)

Note: In the `TemplateModel` class, in order to satisfy the Model factory, the constructor is marked as final. If you need to set custom default values, consider using one of the following approaches:

```
namespace MyPackage\Views;

use Prosopo\Views\BaseTemplateModel;

class EmployeeTemplateModel extends BaseTemplateModel
{
    // approach for plain field types.
    public int $varWithCustomDefaultValue = 'custom default value';
    public Company $company;

    protected function setCustomDefaults(): void
    {
        // approach for object field types.
        $this->company = new Company();
    }
}
```

> Tip: If your app Models require additional object dependencies, you can override the `PropertyValueProvider`module to integrate with a Dependency Injection container like [PHP-DI](https://php-di.org/). This allows model properties to be automatically resolved while object creation by your application's DI system.

### 3.4) Custom Model implementation (advanced usage)

[](#34-custom-model-implementation-advanced-usage)

The only requirement for a Model is to implement the `TemplateModelInterface`. This means you can transform any class into a Model without needing to extend a specific base class, or even define public properties:

```
namespace MyPackage\Views;

use Prosopo\Views\Interfaces\Model\TemplateModelInterface;

class AnyClass implements TemplateModelInterface
{
    public function getTemplateArguments(): array
    {
        // you can fill out arguments from any source or define manually.
        return [
            'name' => 'value',
        ];
    }
}
```

Note: If you plan to define inner models, remember that the default `__toString()` implementation is not provided. You will need to either implement it yourself or enable the option to pass models as strings in the `ViewsManager`configuration:

```
$namespaceConfig->setModelsAsStringsInTemplates(true);
```

When this option is enabled, the renderer will automatically convert objects implementing `TemplateModelInterface` into strings before passing them to the template.

4. Views Manager
----------------

[](#4-views-manager)

The `ViewsManager` class provides the `registerNamespace`, `createModel` and `renderModel` methods. It acts as a namespace manager and brings together different namespace configurations.

Each `ViewNamespace` has its own independent setup and set of modules. E.g. among these modules is the `ModelTemplateProvider`, which automates the process of linking models to their corresponding templates.

### 4.1) Setup

[](#41-setup)

```
use Prosopo\Views\View\ViewNamespaceConfig;
use Prosopo\Views\View\ViewTemplateRenderer;
use Prosopo\Views\ViewsManager;

// 1. Make the Template Renderer.
// (By default it uses the built-in Blade, but you can connect any)

$viewTemplateRenderer = new ViewTemplateRenderer();

// 2. Make the namespace config

$namespaceConfig = (new ViewNamespaceConfig($viewTemplateRenderer))
    // required settings:
    ->setTemplatesRootPath(__DIR__ . './templates')
    ->setTemplateFileExtension('.blade.php')
    // optional setting:
    ->setTemplateErrorHandler(function (array $eventDetails) {
        // logging, notifying, whatever.
    })
    // this option enables inner models rendering before passing them into the template
    ->setModelsAsStringsInTemplates(true);

// (This line is necessary only if you defined the templateErrorHandler)
$namespaceConfig->getModules()
    ->setEventDispatcher($viewTemplateRenderer->getModules()->getEventDispatcher());

// 3. Make the Views instance:

$viewsManager = new ViewsManager();

// 4. Add the root namespace of your Template Models

$viewsManager->registerNamespace('MyPackage\Views', $namespaceConfig);

// Tip: you can have multiple namespaces, and mix their Models.
```

### 4.2) Single-step Model creation and rendering

[](#42-single-step-model-creation-and-rendering)

You can create, set values, and render a Model in a single step using the callback argument of the `renderView` method, as shown below:

```
echo $viewsManager->renderModel(
    EmployeeModel::class,
    function (EmployeeModel $employee) use ($salary, $bonus) {
        $employee->salary = $salary;
        $employee->bonus = $bonus;
    }
);
```

This approach enables a functional programming style when working with Models.

### 4.3) Multi-step creation and rendering

[](#43-multi-step-creation-and-rendering)

When you need split creation, use the factory to create the model, and then render later when you need it.

```
$employee = $viewsManager->createModel(EmployeeModel::class);

// ...

$employee->salary = $salary;
$employee->bonus = $bonus;

// ...

echo $views->renderModel($employee);

// Tip: you can still pass the callback as the second renderModel() argument
// to customize the Model properties before rendering.
```

Advice: The `ViewsManager` class implements three interfaces: `ViewNamespaceManagerInterface` (for `registerNamespace`), `ModelFactoryInterface` (for `createModel`), and `ModelRendererInterface` (for `renderModel`).

When passing the `ViewsManager` instance to your methods, use one of these interfaces as the argument type instead of the `ViewsManager` class itself.

This approach ensures that only the specific actions you expect are accessible, promoting cleaner and more maintainable code.

### 4.4) Automated templates matching

[](#44-automated-templates-matching)

The built-in `ModelTemplateResolver` automatically matches templates based on the Model names and their relative namespaces. This automates the process of associating templates with their corresponding Models.

Example:

- src/
    - Views/
        - `Homepage.php`
        - Settings
            - `GeneralSettings.php`
    - templates/
        - `homepage{.blade.php}`
        - settings/
            - `general-settings{.blade.php}`

We define the root templates folder along with the models root namespace in the `ViewsNamespaceConfig`:

```
$namespaceConfig = (new ViewNamespaceConfig($viewTemplateRenderer))
    ->setTemplatesRootPath(__DIR__ . './templates')
    ->setTemplateFileExtension('.blade.php');

// 3. Make the Views Manager instance:

$viewsManager = new ViewsManager();

// 4. Add the root namespace of your Template Models

$viewsManager->registerNamespace('MyPackage\Views', $namespaceConfig);
```

**Naming Note:** Use dashes in template names, as `camelCase` in Model names is automatically converted to `dash-separated`names.

> Tip: In case this approach doesn't work for your setup, you can override the `ModelTemplateResolver` module to implement your own logic. In case the reason is the name-specific only, consider overriding the `ModelNameResolver`module instead.

### 4.5) Custom modules

[](#45-custom-modules)

By default, the `registerNamespace` class creates module instances for the namespace using classes from the current package.

If you need to override the default module behavior, you can define a custom implementation in the configuration and the package will use the specified implementation.

> Tip: You can see the full list of the modules in the `ViewNamespaceModules` class.

#### Example: Using Twig as a Template Renderer (instead of the built-in Blade)

[](#example-using-twig-as-a-template-renderer-instead-of-the-built-in-blade)

```
// 1. Make a facade (for Twig or another template engine)

use Prosopo\Views\Interfaces\Template\TemplateRendererInterface;
use Prosopo\Views\View\ViewNamespaceConfig;
use Prosopo\Views\ViewsManager;

class TwigDecorator implements TemplateRendererInterface
{
    private $twig;

    public function __construct()
    {
        // todo init Twig or another engine.
    }

    public function renderTemplate(string $template, array $variables = []): string
    {
        return $this->twig->render($template, $variables);
    }
}

// 2. Define the namespace config with the facade instance

$twigDecorator = new TwigDecorator();

$namespaceConfig = (new ViewNamespaceConfig($twigDecorator))
    ->setTemplatesRootPath(__DIR__ . './templates')
    ->setTemplateFileExtension('.twig');

// 3. Make the Views:

$viewsManager = new ViewsManager();

// 4. Add the namespace (you can have multiple namespaces)

$viewsManager->registerNamespace('MyPackage\Views', $namespaceConfig);

// ...

$viewsManager->renderModel(MyTwigModel::class);
```

You can override any namespace module in the following way:

```
$namespaceConfig->getModules()
     // override any available module, like TemplateRenderer or Factory:
    ->setModelFactory(new MyFactory());
```

> Note: The package includes only the Blade implementation. If you wish to use a different template engine, like Twig, you need to install its Composer package and create a facade object, as demonstrated above.

### 4.6) Namespace mixing

[](#46-namespace-mixing)

The `ViewsManager` class not only supporting multiple namespaces, but also enabling you to use Models from one namespace within another, preserving their individual setup.

Example of multi-namespace usage:

Suppose you have registered a namespace for Twig templates:

```
$viewsManager->registerNamespace('App\Twig',$configForTwigNamespace);
```

This namespace includes a `Button` model and a `button.twig` template:

Button's model:

```
namespace App\Twig;

use Prosopo\Views\BaseTemplateModel;

class ButtonModel extends BaseTemplateModel {
 public string $label;
}
```

Button's template:

```
{{ label|trim }}
```

Additionally, you registered a namespace for Blade templates:

```
$viewsManager->registerNamespace('App\Blade',$configForBladeNamespace);
```

with a `Popup` model:

Popup's model:

```
namespace App\Blade;

use Prosopo\Views\BaseTemplateModel;

class PopupModel extends BaseTemplateModel {
}
```

Now is the cool part: you can safely use the `App\Twig\ButtonModel` class as a property of the `App\Blade\PopupModel` class, so it looks like this:

Popup's model:

```
namespace App\Blade;

use Prosopo\Views\BaseTemplateModel;
use App\Twig\ButtonModel;

class PopupModel extends BaseTemplateModel {
 public ButtonModel $buttonModel;
}
```

Now you can use the `buttonModel` in the popup's template:

```

    I'm a popup!
    To close, click here - {!! $buttonModel !!}

```

When you call `ViewsManager->makeModel()` for the `PopupModel` class:

1. The `App\Blade\PopupModel` instance will be created using the `ModelFactory` from the `App\Blade` namespace.
2. During automated property initialization, an instance of `App\Twig\ButtonModel` will be created using the `ModelFactory`from for the `App\Twig` namespace.

This design allows you to seamlessly reuse models across different namespaces while respecting the specific configuration of each namespace.

Namespace resolution also occurs when you call `ViewsManager->renderModel()`. In this example:

- `App\Twig\ButtonModel` will be rendered using the `ViewTemplateRenderer` from the `App\Twig` namespace, which is configured for Twig.
- `App\Blade\PopupModel` will be rendered using the `ViewTemplateRenderer` from the `App\Blade` namespace, which is configured for Blade.

5. View Renderer
----------------

[](#5-view-renderer)

`ViewTemplateRenderer` is the class responsible for rendering templates in this package. By default, it integrates the Blade compiler, but it is fully customizable. You can replace the Blade compiler with your own implementation or use a simple stub to enable support for plain PHP template files.

### 5.1) Built-in Blade integration

[](#51-built-in-blade-integration)

[Blade](https://laravel.com/docs/11.x/blade) is an elegant and powerful template engine originally developed for [Laravel](https://laravel.com/). Unlike [Twig](https://twig.symfony.com/), Blade embraces PHP usage rather than restricting it. It enhances templates with syntax sugar (which we all love), making them clean and easy to read.

Blade introduces special shorthand tokens that simplify the most cumbersome syntax constructions, while still being fully-fledged PHP with access to all its functions and capabilities.

Unfortunately, Blade isn't available as a standalone package, so this package includes its own Blade compiler. It provides full support for [Blade's key features](https://laravel.com/docs/11.x/blade) while remaining completely independent of Laravel.

The following Blade tokens are supported:

1. Displaying: `{{ $var }}` and `{!! $var }}`
2. IF Conditions: `@if`, `@else`, `@elseif`, `@endif`
3. Switch conditions: `@switch`, `@case`, `@break`, `@default`, `@endswitch`.
4. Loops: `@foreach`, `@endforeach`, `@for`, `@endfor`, `@break`.
5. Helpers: `@selected`, `@checked`, `@class`.
6. PHP-related: `@use`, `@php`, `@endphp`.

Visit the [official Blade docs](https://laravel.com/docs/11.x/blade) to learn about their usage.

#### Notes on the standalone Blade implementation

[](#notes-on-the-standalone-blade-implementation)

You may have come across packages that attempt to adapt the official Blade engine by creating stubs for its Laravel dependencies, such as the [jenssegers/blade](https://github.com/jenssegers/blade) package. However, we chose not to adopt this approach for several reasons:

- PHP Version Requirements: It mandates PHP 8.2 or higher.
- External Dependencies: It introduces additional external dependencies.
- Potential Breakage: It can become unstable with future Laravel updates (as demonstrated by [past incidents](https://github.com/jenssegers/blade/issues/74).
- Limited Flexibility: Since it wasn’t designed as a standalone component, it lacks some of the customization abilities.
- Global functions: Laravel's implementation includes global helper functions, which becomes a problem when you need to [scope the package](https://github.com/humbug/php-scoper).

Thanks to great Blade's conceptual design, our compiler implementation required fewer than 200 lines of code.

### 5.2) View Renderer setup

[](#52-view-renderer-setup)

```
use Prosopo\Views\View\ViewTemplateRenderer;

$viewTemplateRenderer = new ViewTemplateRenderer();

echo $viewTemplateRenderer->renderTemplate('/my-template.blade.php', [
    'var' => true
]);
```

> Tip #1: by default, `BladeTemplateRenderer` is configured to work with files, but you can also switch it to work with plain strings:

```
use Prosopo\Views\View\ViewTemplateRenderer;
use Prosopo\Views\View\ViewTemplateRendererConfig;

$viewRendererConfig = new ViewTemplateRendererConfig();
$viewRendererConfig->setFileBasedTemplates(false);

$viewTemplateRenderer = new ViewTemplateRenderer($viewRendererConfig);

echo $viewTemplateRenderer->renderTemplate('@if($var)The variable is set.@endif', [
    'var' => true
]);
```

> Tip #2: As you see, the built-in TemplateRenderer implementation is fully standalone and independent of the `Views`class. This means that even if you can't or don't want to use the model-driven approach, you can still utilize it as an independent Blade compiler.

### 5.3) Available View Renderer settings

[](#53-available-view-renderer-settings)

The `ViewTemplateRenderer` supports a variety of settings that let you customize features such as escaping, error handling, and more:

```
use Prosopo\Views\View\ViewTemplateRenderer;
use Prosopo\Views\View\ViewTemplateRendererConfig;

$viewRendererConfig = (new ViewTemplateRendererConfig())
// By default, the Renderer expect a file name.
// Set to false if to work with strings
    ->setFileBasedTemplates(true)
    ->setTemplateErrorHandler(function (array $eventDetails): void {
        // Can be used for logging, notifying, etc.
    })
    ->setCustomOutputEscapeCallback(function ($variable): string {
        if (
            false === is_string($variable) &&
            false === is_numeric($variable)
        ) {
            return '';
        }

        // htmlspecialchars is the default one.
        return htmlentities((string)$variable, ENT_QUOTES, 'UTF-8', false);
    })
    ->setGlobalVariables([
        'sum' => function (int $a, int $b): string {
            return (string)($a + $b);
        },
        'variable' => 'value',
    ])
    ->setEscapeVariableName('escape')
    ->setCompilerExtensionCallback(function (string $template): string {
        // note: just an example, @use is supported by default.
        return (string)preg_replace('/@use\s*\((["\'])(.*?)\1\)/s', '', $template);
    });

$viewTemplateRenderer = new ViewTemplateRenderer($viewRendererConfig);
```

### 5.4) Custom View Renderer modules

[](#54-custom-view-renderer-modules)

By default, the `ViewTemplateRenderer` creates module instances using classes from the current package, including the Blade compiler.

If you need to override the default module behavior, you can define a custom implementation in the configuration. The `ViewTemplateRenderer` will use the specified implementation.

> Tip: You can see the full list of the modules in the `ViewTemplateRendererModules`.

#### Example: Overriding the default Blade compiler to use plain PHP views

[](#example-overriding-the-default-blade-compiler-to-use-plain-php-views)

```
use Prosopo\Views\Interfaces\Template\TemplateCompilerInterface;
use Prosopo\Views\View\ViewNamespaceConfig;
use Prosopo\Views\View\ViewTemplateRenderer;
use Prosopo\Views\View\ViewTemplateRendererConfig;
use Prosopo\Views\ViewsManager;

class CompilerStubForPlainPhpSupport implements TemplateCompilerInterface
{
    public function compileTemplate(string $template): string
    {
        return $template;
    }
}

// ...

$viewTemplateRendererConfig = new ViewTemplateRendererConfig();
$viewTemplateRendererConfig->getModules()
    ->setTemplateCompiler(new CompilerStubForPlainPhpSupport());

$viewTemplateRenderer = new ViewTemplateRenderer($viewTemplateRendererConfig);

$views = new ViewsManager();

$viewNamespaceConfig = new ViewNamespaceConfig($viewTemplateRenderer);
$viewNamespaceConfig
    ->setTemplatesRootPath(__DIR__ . './templates')
    ->setTemplateFileExtension('.php');

$views->registerNamespace('MyApp\Models', $viewNamespaceConfig);
```

Now this namespace is configured to deal with plain PHP template files, while having all the package features, including model-driven approach and template error handling.

6. Contribution
---------------

[](#6-contribution)

We would be excited if you decide to contribute 🤝

Please read the [for-devs.md](https://github.com/prosopo/php-views/blob/main/for-devs.md) file for project guidelines and agreements.

7. Credits
----------

[](#7-credits)

This package was created by [Maxim Akimov](https://github.com/light-source/) during the development of the [WordPress integration for Prosopo Procaptcha](https://github.com/prosopo/procaptcha-wordpress-plugin).

[Procaptcha](https://prosopo.io/) is a privacy-friendly and cost-effective alternative to Google reCaptcha.

Consider using the Procaptcha service to protect your privacy and support the Prosopo team.

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance45

Moderate activity, may be stable

Popularity21

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~18 days

Total

6

Last Release

426d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/ef9e9a7d8c21b026fe3dddc6357fab68b879d81a6773b16d95c437b460ca0140?d=identicon)[prosopo](/maintainers/prosopo)

---

Top Contributors

[![light-source](https://avatars.githubusercontent.com/u/61589446?v=4)](https://github.com/light-source "light-source (63 commits)")

---

Tags

twigbladetemplatesmodelsviews

### Embed Badge

![Health badge](/badges/prosopo-views/health.svg)

```
[![Health](https://phpackages.com/badges/prosopo-views/health.svg)](https://phpackages.com/packages/prosopo-views)
```

###  Alternatives

[league/plates

Plates, the native PHP template system that's fast, easy to use and easy to extend.

1.5k5.9M232](/packages/league-plates)[igaster/laravel-theme

Laravel Themes: Asset & Views folder per theme. Theme inheritance. Blade integration and more...

5161.2M12](/packages/igaster-laravel-theme)[hedronium/spaceless-blade

Adds the @spaceless tag to Blade. (works like in Twig)

32632.8k1](/packages/hedronium-spaceless-blade)[san-kumar/laravel-crud

Laravel CRUD generator: Generate CRUD for any db table with the crud:generate command.

564.4k](/packages/san-kumar-laravel-crud)[daycry/twig

twig for Codeigniter 4

145.1k2](/packages/daycry-twig)[devanych/view-renderer

Simple PHP View Renderer

153.2k1](/packages/devanych-view-renderer)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)