包简介

Frontend functionality for Brickhouse

README 文档

README

This library is a templating engine for PHP applications. It has taken inspiration from Blade, Vue and Tempest.

Installation

To install the library, you need to require the package via composer:

composer require brickhouse/view-engine

Usage

To compile and render views, you need to create a resolver for views:

use Brickhouse\View\Engine\Engine;

$resolver = new ViewResolver(basePath: __DIR__);
$renderer = new Renderer($resolver);

The basePath parameter to ViewResolver determines where the resolver will look for layouts, components and views. Depending on the type being resolved, the resolver will look in these directories:

Type	Path (relative to `basePath`)
Views	`views/`
Layouts	`views/layouts/`
Components	`views/components/`

The renderer can then be used to compile and render templates into HTML:

$rendered = $renderer->render('<p>Hello, Max.</p>');

// or...

$rendered = $renderer->renderFile('/path/to/view');

Displaying data

You can use the renderer to interpolate content in the template. You can do so by wrapping the variable in curly braces:

$template = '<p>Hello, {{ $name }}.</p>';
$rendered = $renderer->render($template, ['name' => 'Max']);

The template will then render as:

<p>Hello, Max.</p>

You can also display the results of any PHP function - or really any PHP code:

$template = '<p>UNIX Time: {{ time() }}</p>';
$rendered = $renderer->render($template);

Conditions

The templating engine allows for conditions, which act on any data passed to the template. They provide a more concise way of adding conditional content to your template, without using PHP's control structures.

Conditional statements, along with other control structures, as defined using attributes:

<p :if="count($rows) === 1">There is a single row.</p>
<p :else-if="count($rows) > 1">There is multiple rows.</p>
<p :else>There are no rows.</p>

Just like interpolation, these attributes support any PHP code which can be used inside a normal if-statement.

Loops

In addition to conditional attributes, you can also iterate over elements in a list:

<p :for="$i = 0; $i < 10; $i++">Row index: {{ $i }}</p>

<p :foreach="$users as $user">User ID: {{ $user->id }}</p>

Components

Components allow the template to re-use the same markup multiple places in your application.

You can create a component by creating a new file in the views/components directory, with a .view.php extension, such as alert.view.php:

<div type="alert">
    An error occured.
</div>

You can then reference the component using it's relative path, prefixed with x-:

<html>
    <body>
        <x-alert></x-alert>
    </body>
</html>

Passing attributes

A static component can only do so much, so components also support passing attributes to them, which can then be used inside of the component. For example, if we change the component to use the template:

<div type="alert" class="alert alert-{{ $type }}">
    {{ $message }}
</div>

Then, we can pass the message using an attribute, when using it:

<html>
    <body>
        <x-alert type="error" message="User could not be found."></x-alert>
    </body>
</html>

Slots

You will often want to create more complex components, which needs more than just text interpolation. For this, you can use "slots", which will replace parts of the component markup. Let's take the same component as before, but use slots for it's content:

<div type="alert">
    <slot />
</div>

Then, when we reference the component, we can pass markup into it's body content:

<x-alert>
    <b>Error:</b> user could not be found.
</x-alert>

This will emplace the given content into the slot-tag and render into the following:

<div type="alert">
    <b>Error:</b> user could not be found.
</div>

Fallback / default content

You also don't need to define the content of the slot every time, if it will likely stay the same. For that, it might be better to define the default content of a slot, like so:

<div type="alert">
    <slot>
        <!-- Default content -->
        An error occured.
    </slot>
</div>

If the component is referenced without providing the slot, An error occured. will be shown:

<x-alert></x-alert>

This will render the default content:

<div type="alert">
    An error occured.
</div>

But if we provide content for the slot:

<x-alert>
    <b>Warning:</b> connection lost.
</x-alert>

Then the provided content will be rendered instead:

<div type="alert">
    <b>Warning:</b> connection lost.
</div>

Named slots

Sometimes, you need more than a single slot for a component. To facilitate that, you can use "named slots". Let's use the same alert component:

<div type="alert">
    <span class="alert-title">
        <slot #title />
    </span>

    <slot />
</div>

We have defined an additional slot named title. Slots are named by prefixing the name with a hashtag (#) as an attribute. We can then define the content of the given slot, by using template-tags:

<x-alert>
    </template #title>
        Could not save user.
    </template>

    <template>
        <b>Error:</b> user could not be found.
    </template>
</x-alert>

Here, the template-tag with the #title attribute defines the content of the title-slot, whereas the template-tag without any attributes defines the content of the default slot.

Layouts

Views in an application often share a lot of common elements, such as navigation, headers, footers, etc. To define the common interface, you can use layouts. Layouts are defined much like components, but are stored within views/layouts/ instead of views/components/:

<!-- /views/layouts/app.view.php -->

<!DOCTYPE html>
<html>
    <head>
        <title>Application Title</title>
    </head>
    <body>
        <slot />
    </body>
</html>

Within the layout, we define a slot-tag, which defines where the view content is meant to be rendered. To use the layout, you can reference it by prefixing x-layout:: to the layout path:

<!-- /views/dashboard.view.php -->

<x-layout::app>
    <h1>Dashboard</h1>
</x-layout::app>

Passing attributes

Much like components, layouts also support passing attributes:

<!DOCTYPE html>
<html>
    <head>
        <title>{{ $title ?? 'Application Title' }}</title>
    </head>
    <body>
        <slot />
    </body>
</html>

brickhouse/view-engine 适用场景与选型建议

brickhouse/view-engine 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 71 次下载、GitHub Stars 达 0，最近一次更新时间为 2025 年 01 月 11 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「templating」「framework」「mvc」「brickhouse」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 brickhouse/view-engine 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 brickhouse/view-engine 我们能提供哪些服务？

定制开发 / 二次开发

基于 brickhouse/view-engine 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 brickhouse/view-engine 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

phphleb/hleb 292

PHP Framework HLEB2 is the foundation of the web application. Provides ease of development and application performance.

shoot/shoot 40

Shoot aims to make providing data to your templates more manageable

oxil/kinikit-mvc 0

Kinikit - PHP Application development framework MVC component

ouxsoft/phpmarkup 0

A Processor for Markup written in PHP. Allows extraction of Markup into a data structure, orchestrated nested manipulation of said structure, and output as (optimized) Markup.

melisplatform/melis-templating-plugin-creator 1

Melis Platform Templating Plugin Creator

mcsodbrenner/serpent 3

Serpent is a lightweight and compiling templating engine for PHP. It was designed to seamlessly integrate into existing MVC frameworks. It uses PHP itself as its template language, so you do not need to learn a new markup language. On the other side you get many improvements compared to pure PHP.

brickhouse/view-engine

包简介

关键字：

README 文档

README

Installation

Usage

Displaying data

Conditions

Loops

Components

Passing attributes

Slots

Fallback / default content

Named slots

Layouts

Passing attributes

brickhouse/view-engine 适用场景与选型建议

与 brickhouse/view-engine 相关的其它包

统计信息

GitHub 信息

其他信息